From 166f0cb9efcd559e62d8b9c881376e38951c9dbb Mon Sep 17 00:00:00 2001 From: Avi Schwab Date: Tue, 29 Nov 2022 19:15:09 +0000 Subject: [PATCH 1/2] docs: Clean up LB, add Hero, Simple Menu, Card, Promo, Tabs --- .../layout-builder/_index.md | 122 +++++++++++++++--- 1 file changed, 106 insertions(+), 16 deletions(-) diff --git a/content/en/docs/content-structure/layout-builder/_index.md b/content/en/docs/content-structure/layout-builder/_index.md index 59a6a4617..c9f36b505 100644 --- a/content/en/docs/content-structure/layout-builder/_index.md +++ b/content/en/docs/content-structure/layout-builder/_index.md @@ -1,10 +1,10 @@ --- -title: Layout Builder Blocks +title: Layout Builder --- These custom block types exist to support page building with Layout Builder. -## Global Fields +### Global Fields These fields are reused across many of the below components. @@ -13,32 +13,58 @@ These fields are reused across many of the below components. | Section title | field_section_title | Text (plain) | no | 1 | | Section subtitle | field_section_subtitle | Text (plain, long) | no | 1 | -## Custom Blocks +## Accordion -### Accordion +**Machine name:** `lb_accordion` -Machine name: `lb_accordion` - -A component for adding custom Accordions. +Expandable pairs of question/answer or header/section fields. | Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | | ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | | Accordion Item | field_entity_reference_paragraph | Entity reference revisions | no | unlimited | | Bundle: accordion_item | -#### Accordion Item +### Accordion Item -Machine name: `lb_accordion_item` +**Machine name:** `lb_accordion_item` | Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | | ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | | Title | field_title | Text (plain) | | Body | field_body | Text (formatted, long, with summary) | -### Grid CTA +## Cards + +**Machine name:** `lb_cards` + +Flexible card-style components that allow up to 4 cards to display across the page depending on the chosen layout. + +| Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | +| ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | +| Section title | (inherit) | +| Section subtitle | (inherit) | +| Section CTA/Link | field_cta | Link | no | 1 | +| # of columns | field_columns | List (text) | no | 1 | Choose "none" for one-column. | +| Cards | field_cards | Entity reference revisions | no | 4 | | Bundle: Card + +### Card -Machine name: `lb_grid_cta` +**Machine name:** `lb_card` -Grid CTA Layout Builder component. +The Card paragraph is referenced by the Cards block. + +| Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | +| ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | +| Title | field_card_title | Text (plain) | yes | 1 | +| Image | field_card_image | Entity reference | no | 1 | +| Topic Tag | field_card_topic_tag | Text (plain) | no | 1 | | | May be changed to term. | +| Description | field_card_description | Text (plain, long) | no | 1 | +| CTA/Link | field_card_cta | Link | no | 1 | + +## Grid CTA + +**Machine name:** `lb_grid_cta` + +Sets of content with a headline, description, and link displayed in 2 to 4-item wide rows, with the option to include icons or images. | Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | | ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | @@ -48,11 +74,11 @@ Grid CTA Layout Builder component. | # of columns | field_columns | List (text) | yes | 1 | | | Allows 2-4 columns, defaults to 4. | | Grid Items | field_grid_items | Entity Reference | yes | unlimited | | Bundle: Grid Item -#### Grid Item +### Grid Item -Machine name: `lb_cta_item` +**Machine name:** `lb_cta_item` -The Grid Item paragraph is referenced by the Grid CTA. +The Grid Item paragraph is referenced by the Grid CTA component. | Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | | ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | @@ -61,7 +87,24 @@ The Grid Item paragraph is referenced by the Grid CTA. | Grid item media | field_grid_item_icon | Entity reference | no | 1 | | Grid item CTA/link | field_grid_item_cta_link | Link | no | 1 | -### Ping-pong +## Hero Banner + +**Machine name:** `lb_hero` + +A full-width, almost full-height display with a header, description, and call to action overlaid on an image. + +| Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | +| ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | +| Title | field_title | Text (plain) | yes | 1 | +| Description | field_description | Text (formatted, long) | no | 1 | +| Media | field_media | Entity reference | no | 1 | | Bundle: Image, Local Video, Video | +| CTA\Link | field_hero_cta | Link | no | 1 | + +## Ping-pong + +**Machine name:** `lb_ping_pong` + +Usually paired sets of full-width page components that include media, header, description, and call to action arranged horizontally. | Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | | ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | @@ -72,3 +115,50 @@ The Grid Item paragraph is referenced by the Grid CTA. | Item CTA\Link | field_item_cta | Link | no | 2 | The first will use the primary style and the second, secondary. | | Item Image | field_item_image | Entity reference | no | 1 | | Item Image Position | field_item_image_position | List (text) | yes | 1 | Places the image on this side of the page in the full-width display. Image will always be above Description on at narrow widths. + +## Promo Card + +**Machine name:** `lb_promo` + +A title, headline, description, and link that usually display in the right or left sidebar. + +| Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | +| ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | +| Title | field_title | Text (plain) | yes | 1 | +| Body | body | Text (formatted, long, with summary) | no | 1 | +| Icon / Image | field_image | Entity reference | no | 1 | | Bundle: Image | +| CTA / Link | field_cta | Link | no | 1 | + +## Simple Menu + +**Machine name:** `lb_simple_menu` + +A simple 1-level sidebar menu that can display in either the right or left sidebar area. + +| Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | +| ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | +| Icon | field_icon | Entity reference | no | 1 | | Bundle: Image | +| Links | field_lb_simple_menu_links | Link | yes | unlimited | + +## Tabs + +**Machine name:** `lb_tabs` + +Gives users the ability to switch page views by selecting tabs across the top of the page instead of having to navigate to a new page. + +| Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | +| ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | +| Section title | (inherit) | +| Section subtitle | (inherit) | +| Tabs | field_tabs | Entity reference revisions | no | unlimited | | Bundle: Tab | + +### Tab + +**Machine name:** `tab` + +The Tab paragraph is referenced by the Tabs block. + +| Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | +| ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | +| Title | field_title | Text (plain) | yes | 1 | +| Body | field_body | Text (formatted, long, with summary) | no | 1 | From 89f6122cb4e3db818dea44773c2fe130f94679a0 Mon Sep 17 00:00:00 2001 From: Avi Schwab Date: Tue, 29 Nov 2022 23:43:22 +0000 Subject: [PATCH 2/2] docs: Clean up lb help text --- .../en/docs/content-structure/layout-builder/_index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/content-structure/layout-builder/_index.md b/content/en/docs/content-structure/layout-builder/_index.md index c9f36b505..f59486f6b 100644 --- a/content/en/docs/content-structure/layout-builder/_index.md +++ b/content/en/docs/content-structure/layout-builder/_index.md @@ -29,8 +29,8 @@ Expandable pairs of question/answer or header/section fields. | Label | Machine Name | Type | Required | Cardinality | Help text | Field Settings | Notes | | ----- | ------------ | ---- | -------- | ----------- | --------- | -------------- | ----- | -| Title | field_title | Text (plain) | -| Body | field_body | Text (formatted, long, with summary) | +| Title | field_title | Text (plain) | yes | 1 | +| Body | field_body | Text (formatted, long, with summary) | no | 1 | ## Cards @@ -43,7 +43,7 @@ Flexible card-style components that allow up to 4 cards to display across the pa | Section title | (inherit) | | Section subtitle | (inherit) | | Section CTA/Link | field_cta | Link | no | 1 | -| # of columns | field_columns | List (text) | no | 1 | Choose "none" for one-column. | +| # of columns | field_columns | List (text) | no | 1 | Choose "none" for one-column layout. | | Cards | field_cards | Entity reference revisions | no | 4 | | Bundle: Card ### Card @@ -114,7 +114,7 @@ Usually paired sets of full-width page components that include media, header, de | Item Description | field_item_description | Text (formatted, long) | no | 1 | | Item CTA\Link | field_item_cta | Link | no | 2 | The first will use the primary style and the second, secondary. | | Item Image | field_item_image | Entity reference | no | 1 | -| Item Image Position | field_item_image_position | List (text) | yes | 1 | Places the image on this side of the page in the full-width display. Image will always be above Description on at narrow widths. +| Item Image Position | field_item_image_position | List (text) | yes | 1 | Places the image on this side of the page in the full-width display. Image will stack above text at narrow widths. ## Promo Card