From ac8c19c7061d13601af1b301248ca6e8b6573ff4 Mon Sep 17 00:00:00 2001 From: Danny Date: Wed, 27 May 2026 13:55:10 +0100 Subject: [PATCH 01/24] Add resume auto renew changes --- beaver-builder/account/license/renew.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/beaver-builder/account/license/renew.md b/beaver-builder/account/license/renew.md index 02787b35..4f2a1083 100644 --- a/beaver-builder/account/license/renew.md +++ b/beaver-builder/account/license/renew.md @@ -16,16 +16,31 @@ You can view your subscription renewal date by logging into your Beaver Builder ## Cancel Automatic Renewal -If you cancel autorenewal, you will need to manually renew your subscription each year. You can cancel autorenewal at any time from your account page and follow these steps: +If you cancel automatic renewal, you will need to manually renew your subscription each year unless you later resume auto renewal for an eligible subscription. You can cancel automatic renewal at any time from your account page by following these steps: -1. Go to your [My Account](https://www.wpbeaverbuilder.com/my-account/) page and scroll to the **My Subscriptions** section. +1. Go to your **My Account** page and scroll to the **My Subscriptions** section. 2. Click the **Cancel Renewal** button next to the subscription you'd like to cancel. - If you don't see the **Cancel Renewal** button, it means you're not in the autorenewal program and you'll have to renew it manually each year. -:::caution +If you do not see the **Cancel Renewal** button, it means your subscription is not currently set to automatic renewal and you will need to renew it manually each year. + +## Resume Automatic Renewal + +If you previously cancelled automatic renewal, you may be able to turn it back on from the **My Subscriptions** section of your account. + +When a subscription is changed to manual renewal, the **Cancel Renewal** button changes to **Resume Auto Renewal** for eligible subscriptions. -We cannot reinstate auto-renewal once you cancel it, but you can still renew your subscription manually. +1. Go to your **My Account** page and scroll to the **My Subscriptions** section. +2. Click **Resume Auto Renewal** next to the subscription you'd like to reactivate. +If your subscription was paid by credit card through Stripe, Beaver Builder will check with Stripe to confirm that your saved payment details are still valid. + +- If your payment details are valid, automatic renewal will be resumed. +- If your payment details are no longer valid, you'll be redirected to update your card information before automatic renewal can be turned back on. + +If your subscription was paid through PayPal, the **Resume Auto Renewal** button will not appear because PayPal subscriptions cannot be reactivated once automatic renewal has been cancelled. + +:::caution + Automatic renewal can only be resumed for eligible Stripe subscriptions with valid saved card details. PayPal subscriptions cannot be resumed after cancellation and must be renewed manually. ::: If you do not renew your Beaver Builder license, see the [License Expiry](expiry.md) article for more information. From 9741ebe2492e73f9689b3471e07b5187d81c287f Mon Sep 17 00:00:00 2001 From: Danny Date: Wed, 27 May 2026 13:55:22 +0100 Subject: [PATCH 02/24] Fix FAQ for BB Lite --- beaver-builder/introduction/faq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/beaver-builder/introduction/faq.md b/beaver-builder/introduction/faq.md index 38ea5775..a848c7be 100644 --- a/beaver-builder/introduction/faq.md +++ b/beaver-builder/introduction/faq.md @@ -15,6 +15,7 @@ Here are some of the differences between the Lite and Premium versions: - [Limited Modules in comparison to Premium](#what-modules-are-included-in-the-lite-version). - Incompatibility with Beaver Themer. +- No access to [Global Styles](../user-interface/global-styles.md), which is available in Premium only. - Access to only a few pre-made Templates. - Inability to save modules/rows/columns for re-use or to save custom Templates. @@ -30,7 +31,7 @@ between the free and premium versions. | Beaver Builder | ✅ | ✅ | ✅ | ✅ | | Beaver Themer | ❌ | ✅ | ✅ | ✅ | | BB Theme | ❌ | ❌ | ✅ | ✅ | -| WordPress Multisite Network | ❌ | ❌ | ✅ | ✅ | +| [Multisite Capable](#what-is-multisite-capable) | ✅ | ❌ | ✅ | ✅ | | Network-wide settings | ❌ | ❌ | ❌ | ✅ | | White Labeling | ❌ | ❌ | ❌ | ✅ | | Advanced Courses | ❌ | ❌ | ❌ | ✅ | @@ -67,7 +68,6 @@ The lite (free) version of Beaver Builder contains the following subset of modul - [Text](../layouts/modules/text.md) - [Sidebar](../layouts/modules/sidebar.md) - [Video](../layouts/modules/video/video.md) -- [Widget](../layouts/modules/widgets.md) See the [Modules](../layouts/modules/index.md) section for a complete list of all available modules in the premium versions of Beaver Builder. From 78497f7251c25cff3d62c390b455394c014fdaa3 Mon Sep 17 00:00:00 2001 From: Danny Date: Wed, 27 May 2026 13:55:33 +0100 Subject: [PATCH 03/24] Custom attributes --- .../layouts/advanced-tab/custom-attributes.md | 98 +++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 beaver-builder/layouts/advanced-tab/custom-attributes.md diff --git a/beaver-builder/layouts/advanced-tab/custom-attributes.md b/beaver-builder/layouts/advanced-tab/custom-attributes.md new file mode 100644 index 00000000..dcd618ec --- /dev/null +++ b/beaver-builder/layouts/advanced-tab/custom-attributes.md @@ -0,0 +1,98 @@ +--- +id: custom-attributes +title: Custom Attributes +sidebar_label: Custom Attributes +description: The Custom Attributes section in the Advanced tab lets you add custom HTML attributes to any row, column, or module, giving you more control over markup for accessibility, tracking, styling, and custom integrations. +--- + +The Custom Attributes section in the Advanced tab lets you add custom HTML attributes to any row, column, or module, giving you more control over markup for accessibility, tracking, styling, and custom integrations. + +## Custom attributes + +The **Custom Attributes** section in the Advanced tab lets you add custom HTML attributes to any row, column, or module, giving you more control over markup for accessibility, tracking, styling, and custom integrations. + +### Attribute(s) + +Adds one or more HTML attributes to the node. Click the **Add** button to add each attribute. + +:::note + +The **Target** and **Selector** fields are only available for modules. Rows and columns only support the **Wrapper** target. + +::: + +
+Attribute fields + +#### Key + +The HTML attribute name. Must start with a lowercase letter and can contain lowercase letters, numbers, periods (`.`), underscores (`_`), colons (`:`), and hyphens (`-`). Invalid keys are skipped on output. + +For example, entering `foo` as the key outputs an attribute like this in the HTML: + +```html +
+``` + +#### Value + +The attribute value. Values are automatically HTML-escaped on output. + +For example, entering `bar` as the value sets the attribute’s value like this: + +```html +
+``` + +If the value contains special characters, they are automatically escaped in the HTML output: + +```html +
+``` + +#### Target, Modules Only + +Default: `Wrapper` + +Selects where the attribute is applied. + +- **Wrapper:** Applies the attribute to the element's outer wrapper. +- **Custom:** Applies the attribute to an inner element matched by the **Selector** field. + +
+Selector, Custom Target Only + +#### Selector, Custom Target Only + +A CSS selector targeting an inner element within the module. Supports tag names, IDs, classes, the child combinator (`>`), and the wildcard (`*`). + +
+ +
+ +
+Examples + +#### Wrapper target example + +Adding a `data-section` attribute with value `hero` to a row: + +```html +
+ +
+``` + +#### Custom target example + +Adding `aria-label` with value `Navigation links` to a module, targeting the selector `ul`: + +```html +
+
    + +
+
+``` + +
From 2f42bec6776723f6d22a0dfa76d466739e997717 Mon Sep 17 00:00:00 2001 From: Danny Date: Wed, 27 May 2026 14:00:59 +0100 Subject: [PATCH 04/24] All modules now documented and using a new format --- beaver-builder/layouts/modules/accordion.mdx | 590 ++++++ .../modules/accordion/css-customization.md | 82 - .../layouts/modules/accordion/index.md | 27 - .../modules/accordion/link-specific-item.md | 64 - .../modules/accordion/settings/index.md | 19 - .../modules/accordion/settings/items.md | 119 -- .../modules/accordion/settings/style.md | 65 - beaver-builder/layouts/modules/acf-block.mdx | 44 + beaver-builder/layouts/modules/audio.md | 98 - beaver-builder/layouts/modules/audio.mdx | 194 ++ .../layouts/modules/bigcommerce-products.md | 32 - .../layouts/modules/bigcommerce.mdx | 99 + beaver-builder/layouts/modules/box.mdx | 672 ++++++ beaver-builder/layouts/modules/box/index.md | 93 - .../layouts/modules/box/settings/children.md | 71 - .../layouts/modules/box/settings/container.md | 204 -- .../layouts/modules/box/settings/index.md | 19 - .../modules/box/using-align-options.md | 13 - .../layouts/modules/button-group.md | 173 -- .../layouts/modules/button-group.mdx | 302 +++ beaver-builder/layouts/modules/button.mdx | 373 ++++ .../layouts/modules/button/button.md | 172 -- .../button/make-a-button-transparent.md | 26 - .../modules/callout-and-call-to-action.md | 284 --- beaver-builder/layouts/modules/callout.mdx | 774 +++++++ .../layouts/modules/contact-form.mdx | 580 ++++++ ...d-a-google-recaptcha-checkbox-to-a-form.md | 73 - .../modules/contact-form/contact-form.md | 117 -- .../layouts/modules/content-slider.md | 80 - .../layouts/modules/content-slider.mdx | 781 +++++++ beaver-builder/layouts/modules/countdown.md | 91 - beaver-builder/layouts/modules/countdown.mdx | 318 +++ beaver-builder/layouts/modules/cta.mdx | 416 ++++ beaver-builder/layouts/modules/gallery.mdx | 140 ++ .../layouts/modules/gallery/gallery.md | 108 - ...open-a-gallery-lightbox-on-button-click.md | 75 - beaver-builder/layouts/modules/heading.md | 73 - beaver-builder/layouts/modules/heading.mdx | 92 + beaver-builder/layouts/modules/html.md | 44 - beaver-builder/layouts/modules/html.mdx | 213 ++ .../layouts/modules/icon-and-icon-group.md | 79 - beaver-builder/layouts/modules/icon-group.mdx | 276 +++ beaver-builder/layouts/modules/icon.mdx | 200 ++ beaver-builder/layouts/modules/index.md | 130 -- beaver-builder/layouts/modules/index.mdx | 189 ++ beaver-builder/layouts/modules/list.md | 218 -- beaver-builder/layouts/modules/list.mdx | 437 ++++ beaver-builder/layouts/modules/login-form.md | 98 - beaver-builder/layouts/modules/login-form.mdx | 731 +++++++ beaver-builder/layouts/modules/loop.mdx | 288 +++ beaver-builder/layouts/modules/loop/index.md | 74 - .../layouts/modules/loop/settings.md | 194 -- beaver-builder/layouts/modules/map.md | 28 - beaver-builder/layouts/modules/map.mdx | 58 + beaver-builder/layouts/modules/menu.mdx | 857 ++++++++ ...-menu-item-that-links-to-a-page-section.md | 58 - beaver-builder/layouts/modules/menu/menu.md | 325 --- .../layouts/modules/module-blocks.md | 26 - .../layouts/modules/north-commerce.md | 79 - .../layouts/modules/north-commerce.mdx | 151 ++ .../layouts/modules/number-counter.md | 94 - beaver-builder/layouts/modules/numbers.mdx | 248 +++ beaver-builder/layouts/modules/photo.mdx | 234 +++ .../add-hover-effects-to-the-photo-module.md | 181 -- .../display-full-captions-under-photos.md | 26 - beaver-builder/layouts/modules/photo/photo.md | 58 - beaver-builder/layouts/modules/popup.mdx | 420 ++++ .../layouts/modules/post-carousel.mdx | 678 ++++++ beaver-builder/layouts/modules/post-grid.mdx | 1001 +++++++++ .../layouts/modules/post-slider.mdx | 647 ++++++ ...-between-images-in-posts-module-gallery.md | 22 - .../layouts/modules/posts/posts-carousel.md | 86 - ...ousel-and-posts-slider-modules-examples.md | 136 -- .../layouts/modules/posts/posts-slider.md | 95 - beaver-builder/layouts/modules/posts/posts.md | 691 ------ .../layouts/modules/pricing-table.md | 231 --- .../layouts/modules/pricing-table.mdx | 1036 +++++++++ beaver-builder/layouts/modules/rich-text.mdx | 331 +++ beaver-builder/layouts/modules/search.mdx | 641 ++++++ .../search/limit-post-types-search-module.md | 33 - .../layouts/modules/search/search.md | 169 -- beaver-builder/layouts/modules/separator.md | 28 - beaver-builder/layouts/modules/separator.mdx | 76 + beaver-builder/layouts/modules/sidebar.md | 19 - beaver-builder/layouts/modules/sidebar.mdx | 37 + beaver-builder/layouts/modules/slideshow.md | 257 --- beaver-builder/layouts/modules/slideshow.mdx | 395 ++++ .../layouts/modules/social-buttons.md | 23 - .../layouts/modules/social-buttons.mdx | 86 + beaver-builder/layouts/modules/star-rating.md | 53 - .../layouts/modules/star-rating.mdx | 133 ++ .../layouts/modules/subscribe-form.mdx | 1844 +++++++++++++++++ ...form-module-for-mailchimp-double-opt-in.md | 10 - .../modules/subscribe-form/subscribe-form.md | 193 -- beaver-builder/layouts/modules/tabs.mdx | 417 ++++ beaver-builder/layouts/modules/tabs/index.md | 27 - .../modules/tabs/link-specific-item.md | 64 - .../layouts/modules/tabs/settings/index.md | 19 - .../layouts/modules/tabs/settings/items.md | 93 - .../layouts/modules/tabs/settings/style.md | 73 - .../layouts/modules/testimonials.md | 29 - .../layouts/modules/testimonials.mdx | 303 +++ beaver-builder/layouts/modules/text.md | 26 - beaver-builder/layouts/modules/video.mdx | 240 +++ .../video/open-a-video-in-a-lightbox.md | 24 - beaver-builder/layouts/modules/video/video.md | 123 -- beaver-builder/layouts/modules/widgets.md | 40 - beaver-builder/layouts/modules/widgets.mdx | 131 ++ beaver-builder/layouts/modules/woocommerce.md | 190 -- .../layouts/modules/woocommerce.mdx | 271 +++ .../layouts/modules/wordpress-patterns.md | 26 - .../layouts/modules/wordpress-patterns.mdx | 42 + 112 files changed, 17986 insertions(+), 6670 deletions(-) create mode 100644 beaver-builder/layouts/modules/accordion.mdx delete mode 100644 beaver-builder/layouts/modules/accordion/css-customization.md delete mode 100644 beaver-builder/layouts/modules/accordion/index.md delete mode 100644 beaver-builder/layouts/modules/accordion/link-specific-item.md delete mode 100644 beaver-builder/layouts/modules/accordion/settings/index.md delete mode 100644 beaver-builder/layouts/modules/accordion/settings/items.md delete mode 100644 beaver-builder/layouts/modules/accordion/settings/style.md create mode 100644 beaver-builder/layouts/modules/acf-block.mdx delete mode 100644 beaver-builder/layouts/modules/audio.md create mode 100644 beaver-builder/layouts/modules/audio.mdx delete mode 100644 beaver-builder/layouts/modules/bigcommerce-products.md create mode 100644 beaver-builder/layouts/modules/bigcommerce.mdx create mode 100644 beaver-builder/layouts/modules/box.mdx delete mode 100644 beaver-builder/layouts/modules/box/index.md delete mode 100644 beaver-builder/layouts/modules/box/settings/children.md delete mode 100644 beaver-builder/layouts/modules/box/settings/container.md delete mode 100644 beaver-builder/layouts/modules/box/settings/index.md delete mode 100644 beaver-builder/layouts/modules/box/using-align-options.md delete mode 100644 beaver-builder/layouts/modules/button-group.md create mode 100644 beaver-builder/layouts/modules/button-group.mdx create mode 100644 beaver-builder/layouts/modules/button.mdx delete mode 100644 beaver-builder/layouts/modules/button/button.md delete mode 100644 beaver-builder/layouts/modules/button/make-a-button-transparent.md delete mode 100644 beaver-builder/layouts/modules/callout-and-call-to-action.md create mode 100644 beaver-builder/layouts/modules/callout.mdx create mode 100644 beaver-builder/layouts/modules/contact-form.mdx delete mode 100644 beaver-builder/layouts/modules/contact-form/add-a-google-recaptcha-checkbox-to-a-form.md delete mode 100644 beaver-builder/layouts/modules/contact-form/contact-form.md delete mode 100644 beaver-builder/layouts/modules/content-slider.md create mode 100644 beaver-builder/layouts/modules/content-slider.mdx delete mode 100644 beaver-builder/layouts/modules/countdown.md create mode 100644 beaver-builder/layouts/modules/countdown.mdx create mode 100644 beaver-builder/layouts/modules/cta.mdx create mode 100644 beaver-builder/layouts/modules/gallery.mdx delete mode 100644 beaver-builder/layouts/modules/gallery/gallery.md delete mode 100644 beaver-builder/layouts/modules/gallery/open-a-gallery-lightbox-on-button-click.md delete mode 100644 beaver-builder/layouts/modules/heading.md create mode 100644 beaver-builder/layouts/modules/heading.mdx delete mode 100644 beaver-builder/layouts/modules/html.md create mode 100644 beaver-builder/layouts/modules/html.mdx delete mode 100644 beaver-builder/layouts/modules/icon-and-icon-group.md create mode 100644 beaver-builder/layouts/modules/icon-group.mdx create mode 100644 beaver-builder/layouts/modules/icon.mdx delete mode 100644 beaver-builder/layouts/modules/index.md create mode 100644 beaver-builder/layouts/modules/index.mdx delete mode 100644 beaver-builder/layouts/modules/list.md create mode 100644 beaver-builder/layouts/modules/list.mdx delete mode 100644 beaver-builder/layouts/modules/login-form.md create mode 100644 beaver-builder/layouts/modules/login-form.mdx create mode 100644 beaver-builder/layouts/modules/loop.mdx delete mode 100644 beaver-builder/layouts/modules/loop/index.md delete mode 100644 beaver-builder/layouts/modules/loop/settings.md delete mode 100644 beaver-builder/layouts/modules/map.md create mode 100644 beaver-builder/layouts/modules/map.mdx create mode 100644 beaver-builder/layouts/modules/menu.mdx delete mode 100644 beaver-builder/layouts/modules/menu/add-a-menu-item-that-links-to-a-page-section.md delete mode 100644 beaver-builder/layouts/modules/menu/menu.md delete mode 100644 beaver-builder/layouts/modules/module-blocks.md delete mode 100644 beaver-builder/layouts/modules/north-commerce.md create mode 100644 beaver-builder/layouts/modules/north-commerce.mdx delete mode 100644 beaver-builder/layouts/modules/number-counter.md create mode 100644 beaver-builder/layouts/modules/numbers.mdx create mode 100644 beaver-builder/layouts/modules/photo.mdx delete mode 100644 beaver-builder/layouts/modules/photo/add-hover-effects-to-the-photo-module.md delete mode 100644 beaver-builder/layouts/modules/photo/display-full-captions-under-photos.md delete mode 100644 beaver-builder/layouts/modules/photo/photo.md create mode 100644 beaver-builder/layouts/modules/popup.mdx create mode 100644 beaver-builder/layouts/modules/post-carousel.mdx create mode 100644 beaver-builder/layouts/modules/post-grid.mdx create mode 100644 beaver-builder/layouts/modules/post-slider.mdx delete mode 100644 beaver-builder/layouts/modules/posts/increase-space-between-images-in-posts-module-gallery.md delete mode 100644 beaver-builder/layouts/modules/posts/posts-carousel.md delete mode 100644 beaver-builder/layouts/modules/posts/posts-posts-carousel-and-posts-slider-modules-examples.md delete mode 100644 beaver-builder/layouts/modules/posts/posts-slider.md delete mode 100644 beaver-builder/layouts/modules/posts/posts.md delete mode 100644 beaver-builder/layouts/modules/pricing-table.md create mode 100644 beaver-builder/layouts/modules/pricing-table.mdx create mode 100644 beaver-builder/layouts/modules/rich-text.mdx create mode 100644 beaver-builder/layouts/modules/search.mdx delete mode 100644 beaver-builder/layouts/modules/search/limit-post-types-search-module.md delete mode 100644 beaver-builder/layouts/modules/search/search.md delete mode 100644 beaver-builder/layouts/modules/separator.md create mode 100644 beaver-builder/layouts/modules/separator.mdx delete mode 100644 beaver-builder/layouts/modules/sidebar.md create mode 100644 beaver-builder/layouts/modules/sidebar.mdx delete mode 100644 beaver-builder/layouts/modules/slideshow.md create mode 100644 beaver-builder/layouts/modules/slideshow.mdx delete mode 100644 beaver-builder/layouts/modules/social-buttons.md create mode 100644 beaver-builder/layouts/modules/social-buttons.mdx delete mode 100644 beaver-builder/layouts/modules/star-rating.md create mode 100644 beaver-builder/layouts/modules/star-rating.mdx create mode 100644 beaver-builder/layouts/modules/subscribe-form.mdx delete mode 100644 beaver-builder/layouts/modules/subscribe-form/configure-subscribe-form-module-for-mailchimp-double-opt-in.md delete mode 100644 beaver-builder/layouts/modules/subscribe-form/subscribe-form.md create mode 100644 beaver-builder/layouts/modules/tabs.mdx delete mode 100644 beaver-builder/layouts/modules/tabs/index.md delete mode 100644 beaver-builder/layouts/modules/tabs/link-specific-item.md delete mode 100644 beaver-builder/layouts/modules/tabs/settings/index.md delete mode 100644 beaver-builder/layouts/modules/tabs/settings/items.md delete mode 100644 beaver-builder/layouts/modules/tabs/settings/style.md delete mode 100644 beaver-builder/layouts/modules/testimonials.md create mode 100644 beaver-builder/layouts/modules/testimonials.mdx delete mode 100644 beaver-builder/layouts/modules/text.md create mode 100644 beaver-builder/layouts/modules/video.mdx delete mode 100644 beaver-builder/layouts/modules/video/open-a-video-in-a-lightbox.md delete mode 100644 beaver-builder/layouts/modules/video/video.md delete mode 100644 beaver-builder/layouts/modules/widgets.md create mode 100644 beaver-builder/layouts/modules/widgets.mdx delete mode 100644 beaver-builder/layouts/modules/woocommerce.md create mode 100644 beaver-builder/layouts/modules/woocommerce.mdx delete mode 100644 beaver-builder/layouts/modules/wordpress-patterns.md create mode 100644 beaver-builder/layouts/modules/wordpress-patterns.mdx diff --git a/beaver-builder/layouts/modules/accordion.mdx b/beaver-builder/layouts/modules/accordion.mdx new file mode 100644 index 00000000..f757dc8a --- /dev/null +++ b/beaver-builder/layouts/modules/accordion.mdx @@ -0,0 +1,590 @@ +--- +title: Accordion +sidebar_label: Accordion +icon: "list-chevrons-up-down" +description: "Use Accordion to present expandable content sections in a compact layout with manual items or post-based content." +--- + + +Use Accordion to present expandable content sections in a compact layout with manual items or post-based content. + +## Usage + +Use Accordion to display content in expandable and collapsible sections. Build items manually with custom content, or generate them dynamically from posts, pages, or custom post types. + +This module is especially useful for FAQs, product details, onboarding steps, support answers, and any content that benefits from clear structure and progressive disclosure. + +## Module Settings + +The Accordion module settings control where accordion items come from, how item labels and content behave, and how the accordion looks on the front end. + +### Items Tab + +The Items tab defines the item source, item content, and expand or collapse behavior. + +
+Content Source Default: Custom Content + + +Selects whether accordion items come from WordPress posts or manual entries created inside the module. + +- **Post:** Builds accordion items from queried WordPress posts, pages, or custom post types. +- **Custom Content:** Builds accordion items from manual items added directly in the module. + +
+Post Settings + + +
+Post + + +The Post section configures the query used when **Content Source** is set to **Post**. + +
+Post Query + + +
+Post Type Default: Post + + +Selects one or more post types to query for accordion items. +
+ +
+Posts Per Page Default: 5 + + +Sets how many queried posts appear as accordion items. +
+ +
+Ordering settings + +Ordering settings control how queried posts or items are sorted, such as by date, title, menu order, or custom ordering options where available. + +
+ +
+Filtering settings + +Filtering settings control which posts, terms, authors, or content types are included or excluded from the module output. + +
+
+
+
+ +
+Custom Content Settings + + +
+Custom Content + + +The Custom Content section manages manual accordion items created inside the module. + +
+Accordion Items + + +
+Item + + +Adds one or more accordion items and stores the label and content settings for each item. + +
+Item Settings + + +
+Label Supports: Field Connections + + +Sets the heading text displayed for the accordion item. +
+ +
+Type Default: Custom Content + + +Selects whether the item uses custom editor content or a saved Beaver Builder asset. + +- **Saved Row:** Loads a saved row into the accordion item. +- **Saved Column:** Loads a saved column into the accordion item. +- **Saved Module:** Loads a saved module into the accordion item. +- **Saved Template:** Loads a saved template into the accordion item. +- **Custom Content:** Uses editor content added directly in the accordion item. + +
+Select Row + + +
+Select Row (Saved Row Only) + + +When you choose Saved Row as the Type, the Select Saved Row setting becomes available and lists all saved row items you have created. Select one to use that saved row as the accordion item’s content. +
+
+ +
+Select Column + + +
+Select Column (Saved Column Only) + + +When you choose Saved Column as the Type, the Select Saved Column setting becomes available and lists all saved column items you have created. Select one to use that saved column as the accordion item’s content. +
+
+ +
+Select Modules + + +
+Select Modules (Saved Module Only) + + +When you choose Saved Module as the Type, the Select Saved Module setting becomes available and lists all saved module items you have created. Select one to use that saved module as the accordion item’s content. +
+
+ +
+Select Template + + +
+Select Template (Saved Template Only) + + +When you choose Template as the Type, the Select Template setting becomes available and lists all templates you have created. Select one to use that template as the accordion item’s content. +
+
+ +
+Content + + +
+Content (Custom Content Only) Supports: Field Connections + + +Add your own custom content using the WordPress Classic Editor when **Type** is set to **Custom Content**. +
+
+
+
+
+
+
+
+
+ +
+Display + + +The Display section controls label markup, post output, and expand or collapse behavior. + +
+Display Settings + + +
+Label Tag Default: h2 + + +Sets the HTML tag used for each accordion label. + +- **a:** Renders the label with an anchor element that keeps heading semantics. +- **h1:** Renders the label with an `

` heading. +- **h2:** Renders the label with an `

` heading. +- **h3:** Renders the label with an `

` heading. +- **h4:** Renders the label with an `

` heading. +- **h5:** Renders the label with an `

` heading. +- **h6:** Renders the label with an `
` heading. +- **div:** Renders the label with a `
` element. +- **span:** Renders the label with a `` element. + +
+ +
+Content Type (Post Only) Default: Post Content + + +Selects whether post-based items render full post content or post excerpts. This field appears when **Content Source** is set to **Post**. + +- **Post Content:** Displays the full post content inside each accordion item. +- **Post Excerpt:** Displays the post excerpt and reveals excerpt display settings. + +
+Excerpt Settings + + +
+Excerpt Length (Post Excerpt Only) + + +Sets the number of words shown in each post excerpt. +
+ +
+Excerpt More Text (Post Excerpt Only) Default: ... + + +Sets the text appended after each excerpt. +
+ +
+More Link (Post Excerpt Only) Default: Hide + + +Shows or hides a link below each post excerpt. + +- **Show:** Displays a link below the excerpt and reveals **More Link Text**. +- **Hide:** Removes the excerpt link. + +
+More Link Text + + +
+More Link Text (Show Only) Default: Read More + + +Sets the label used for the post excerpt link when **More Link** is set to **Show**. +
+
+
+
+
+ +
+Expand on Tab Default: No + + +Expands an accordion item when its button receives keyboard focus through tab navigation. + +- **Yes:** Opens an accordion item when keyboard users tab to its label. +- **No:** Keeps tab focus from expanding accordion items automatically. + +
+ +
+Collapse Inactive Default: Yes + + +Keeps only one item open at a time or allows multiple items to remain open. + +- **Yes:** Keeps only one accordion item open at a time. +- **No:** Allows multiple accordion items to stay open at the same time. + +
+ +
+Expand First Item Default: No + + +Expands the first accordion item when the module loads. + +- **Yes:** Opens the first accordion item by default when the module loads. +- **No:** Leaves all accordion items collapsed on load. + +
+
+
+ +### Style Tab + +The Style tab controls the size, spacing, colors, icons, and content styling used by the accordion. + +
+Item Size Default: Small + + +Sets the preset size used for accordion labels. + +- **Small:** Keeps the accordion labels compact. Inherits the font size from the theme or parent element. +- **Medium:** Uses a balanced label size for most layouts. Sets the label font size to 20px. +- **Large:** Gives the accordion labels more visual emphasis. Sets the label font size to 26px. + +
+ +
+Item Spacing Default: 10; Supports: Responsive + + +Sets the spacing between accordion items. +
+ +
+Item Border Supports: Responsive + + +Configures the border style, width, radius, and color for each accordion item. + +:::tip + +The Responsive Toggle lets you set different border values for desktop, tablet, and mobile. The **Width** and **Radius** controls also support Link Values so you can keep all sides or corners in sync. +::: + +
+General + + +
+Style Default: Default + + +Selects the line style used for the border. + +
+Available options + + +- Default +- None +- Solid +- Dashed +- Dotted +- Double + +
+ +**Default** uses the module or theme's built-in border styling when one is available. Choose **None** to remove the visible border without clearing any saved width, color, or radius values. +
+ +
+Color + + +Sets the border color using the color picker. This field also supports alpha transparency. +
+ +
+Width Supports: Responsive, Link Values + + +Sets the border width for the top, right, bottom, and left sides using `px`. + +Click into any width field to open a slider, or type a value directly for more precise control. +
+
+
+Radius & Shadow + + +
+Radius Supports: Responsive, Link Values + + +Rounds the corners by setting the top-left, top-right, bottom-right, and bottom-left radius in `px`. + +Larger matching values create softer corners, and very high values can produce pill or circular shapes when the element dimensions allow it. +
+
+Box Shadow + + +Adds a shadow around the element to create depth and separation from surrounding content. + +
+Box Shadow settings + + +
+Color + + +Sets the shadow color and opacity. +
+ +
+X + + +Sets the horizontal shadow offset. Positive values move the shadow to the right, and negative values move it to the left. +
+ +
+Y + + +Sets the vertical shadow offset. Positive values move the shadow downward, and negative values move it upward. +
+ +
+Blur + + +Softens the shadow edge. Higher values create a blurrier, more diffuse shadow. +
+ +
+Spread + + +Expands or contracts the overall size of the shadow. Positive values make the shadow larger, and negative values pull it inward. +
+
+
+
+
+ +
+Label + + +The Label section controls the appearance of accordion headings. + +
+Label Settings + + +
+Text Color Supports: Field Connections + + +Sets the label text color and icon color. +
+ +
+Background Color Supports: Field Connections + + +Sets the background color of the label row. +
+ +
+Padding Supports: Responsive, Link Values + + +Sets the inner spacing of the label row. +
+ +
+Typography Supports: Responsive + + +The font settings for accordion labels. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Icon + + +The Icon section controls icon placement and icon states for accordion labels. + +
+Icon Settings + + +
+Icon Position Default: Right + + +Places the icon on the left or right side of the label. + +- **Left:** Places the icon before the label text. +- **Right:** Places the icon after the label text. + +
+ +
+Icon Default: fas fa-plus; Supports: Field Connections + + +Sets the icon shown when an item is collapsed. +
+ +
+Active Icon Default: fas fa-minus; Supports: Field Connections + + +Sets the icon shown when an item is expanded. +
+ +
+DuoTone Icon Primary Color (DuoTone Icons Only) Supports: Field Connections + + +Sets the primary icon color for Font Awesome DuoTone icons. This field applies when the selected icon uses the DuoTone style. +
+ +
+DuoTone Icon Secondary Color (DuoTone Icons Only) Supports: Field Connections + + +Sets the secondary icon color for Font Awesome DuoTone icons. This field applies when the selected icon uses the DuoTone style. +
+
+
+ +
+Content + + +The Content section controls the appearance of accordion panels. + +
+Content Settings + + +
+Text Color (Custom Content Only) Supports: Field Connections + + +Sets the text color for custom content shown inside accordion panels. This field appears when **Content Source** is set to **Custom Content**. +
+ +
+Background Color Supports: Field Connections + + +Sets the background color of the accordion content panel. +
+ +
+Padding Supports: Responsive, Link Values + + +Sets the inner spacing of the accordion content panel. +
+ +
+Typography (Custom Content Only) Supports: Responsive + + +The font settings for custom content shown inside accordion panels. This field appears when **Content Source** is set to **Custom Content**. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Advanced tab + +The Advanced tab contains common Accordion module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/accordion/css-customization.md b/beaver-builder/layouts/modules/accordion/css-customization.md deleted file mode 100644 index 6da42ea1..00000000 --- a/beaver-builder/layouts/modules/accordion/css-customization.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: css-customization -title: CSS Customization -sidebar_label: CSS Customization -description: Here's some CSS to change the icons to Media Library images in the Accordion module. ---- - -This article showcases several CSS examples that illustrate how custom CSS can be used to style the Accordion module beyond what can be achieved through the module's settings. - -:::tip -The examples below use the Accordion module's `fl-module-accordion` parent class, which, depending on where you add your CSS, will style all Accordion modules used on your website. However, if you wish to customize a specific Accordion module, you should add a custom class name to the module and replace `fl-module-accordion` with the new custom class name. - -```css -.my-custom-class .fl-accordion-item-active { - background-color: #f4f4f4; -} -``` - -::: - -## Active Accordion Item - -The following CSS examples demonstrate how to modify the appearance of the active accordion item. Doing so can increase the visibility in comparison to the inactive items: - -### Background Color - -```css -.fl-module-accordion .fl-accordion-item-active { - background-color: #f4f4f4; -} -``` - -### Label Color - -```css -.fl-module-accordion .fl-accordion-item-active .fl-accordion-button-label { - color: #ff0000; -} -``` - -### Accordion Content Color - -```css -.fl-module-accordion .fl-accordion-item-active .fl-accordion-content { - background-color: #f4f4f4; - color: #000000; -} -``` - -## Replace Expand/Collapse Icons with Images - -You can use the CSS provided below to replace the icons of the collapsed and expanded states in the Accordion module with images of your choice. - -```css -.fl-module-accordion .fl-accordion-button { - width: 100%; - position: relative; -} - -/* Hide Accordion Icons */ -.fl-module-accordion .fl-accordion-button .fl-accordion-button-icon { - display: none; -} - -/* Collapsed Image */ -.fl-module-accordion .fl-accordion-button-label:after { - content: ''; - width: 30px; - height: 30px; - background-image: url(IMAGE URL); - background-size: cover; - position: absolute; - right: 10px; - top: 50%; - transform: translateY(-50%); -} - -/* Expanded Image (Active Accordion) */ -.fl-module-accordion .fl-accordion-item-active .fl-accordion-button-label:after { - background-image: url(IMAGE URL); -} -``` diff --git a/beaver-builder/layouts/modules/accordion/index.md b/beaver-builder/layouts/modules/accordion/index.md deleted file mode 100644 index 640c9b46..00000000 --- a/beaver-builder/layouts/modules/accordion/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: index -title: Accordion -sidebar_label: Accordion ---- - -The Accordion module lets you present a variety of content by expanding and collapsing the text, saving space while maintaining a professional appearance. - -![Accordion module](/img/beaver-builder/modules--accordion--1.jpg) - -## Usage - -The Accordion module is ideal when you have a list of items with detailed information that you want to keep easily accessible without cluttering up the main page. Below are some examples of useful applications for the Accordion module: - -* FAQs -* Q&A -* Feature Lists for products or services - -
- -
- -## In this Section - -import DocCardList from '@theme/DocCardList'; - - \ No newline at end of file diff --git a/beaver-builder/layouts/modules/accordion/link-specific-item.md b/beaver-builder/layouts/modules/accordion/link-specific-item.md deleted file mode 100644 index 4dca7abc..00000000 --- a/beaver-builder/layouts/modules/accordion/link-specific-item.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: link-specific-item -title: Link to a Specific Item -sidebar_label: Link to a Specific Item ---- - -In this article, you will learn how to create a link that navigates to a specific item in an Accordion module. - -## Adding an `ID` - -To begin, first assign an `ID` to the Accordion module, which can be accomplished by following the instructions below: - -1. Open the Accordion module settings and click the [Advanced tab](../../advanced-tab/index.md). - -2. Scroll to the `ID` setting, and set a unique `ID` name for the module. - See the [Advanced tab](../../advanced-tab/html-element.md#id) article for more information about `ID` selectors. - -3. Save changes. - -## Index Values - -Every item in the Accordion module is given a unique index value that starts at `0`. The index value of the initial Accordion item is `0`, the second item is assigned an index value of `1`, the third item has an index value of `2`, and so on. By using these index values in an HTML link, you can generate a link to a specific Accordion item and set it as the active item. - -The below HTML code example demonstrates how the index values are allocated to each Accordion item. In this instance, the Accordion module has been given a unique ID name of `my-accordion` and consists of three Accordion items. - -```html -
-
-
-
-
-
-
-
-
-``` - -## Linking to a Specific Item - -The link structure will differ based on whether the Accordion module is on the same page as your link. To create the link, you can use either the Button or HTML modules in your layout. - -### Same Page - -When the link is on the same page as the Accordion module, you can use a hash character (`#`) followed by an `ID` name and the item's index value separated by a hyphen. For instance, using our example `ID` name of `my-accordion`, the link would be structured as follows: - -```html title='Button module link option' -#my-accordion-1 -``` - -```html title='HTML module link' -My Accordion link -``` - -### Different Page - -To create a link to the Accordion module from a different page on your website, use the complete URL of the target page along with the hash symbol (`#`) followed by the `ID` and index value. For instance, if you want to add the link to your homepage, and the Accordion module is located on a page named Sample Page, the link should appear like this: - -```html title='Button module link option' -https://my-website.com/sample-page#my-accordion-1 -``` - -```html title='HTML module link' -My Accordion link -``` diff --git a/beaver-builder/layouts/modules/accordion/settings/index.md b/beaver-builder/layouts/modules/accordion/settings/index.md deleted file mode 100644 index e329e438..00000000 --- a/beaver-builder/layouts/modules/accordion/settings/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: index -title: Accordion Settings -sidebar_label: Settings ---- - -The Accordion module consists of two primary setting tabs: Items and Style, along with the customary Advanced tab. These setting tabs offer you the flexibility to personalize various aspects of the accordion items to suit your preferences. - -![Accordion module settings](/img/beaver-builder/modules--accordion--settings--1.jpg) - -import DocCardList from '@theme/DocCardList'; - - - -## Advanced tab - -The Advanced tab includes all the standard settings for margins, visibility, animations, and advanced HTML configurations. - -See the [Advanced tab](../../../advanced-tab/index.md) section for more information. \ No newline at end of file diff --git a/beaver-builder/layouts/modules/accordion/settings/items.md b/beaver-builder/layouts/modules/accordion/settings/items.md deleted file mode 100644 index 46f36d6e..00000000 --- a/beaver-builder/layouts/modules/accordion/settings/items.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -id: items -title: Items tab -sidebar_label: Items tab ---- - -In the Items tab, you have the option to select the content source and manage accordion content items by adding, editing, or removing them. - -## Content Source - -The content source allows you to determine what content is displayed. You can choose between posts and custom content. - -### Post - -The Post content source option allows you to automatically populate the Accordion module with pages, posts, or custom post types. - -:::caution - -- The post title becomes the item label of the Accordion item. -- The featured image does not appear in the Accordion item. -- Post info (author, date, categories, or tags) is not displayed. - -::: - -- **Post Type** - Select the post type(s) you wish to populate the Post module with. You can choose pages, posts, or a custom post type, such as WooCommerce Products or a custom post type that you created yourself. - - You can also select more than one post type with the Post Type option. For example, you can display both posts and pages, or both posts and WooCommerce products. - -- **Posts Per Page** - Determines how many accordion items are created. Each item contains one page, post, or custom post type. The default is 5. - -- **Order** - Choose between descending or ascending. - -- **Order By** - The choices are: Author, Comment count, Date, Date last modified, ID, Menu order, Meta value (alphabetic or numeric), Random, Title, Selection order. - - See the [Order By](/beaver-builder/layouts/modules/posts/posts.md#order-by) section in the Post module for more information. - -- **Filter By** - The Filter section allows you to include or exclude a set of posts, pages or custom post types by title, and taxonomy. - - See the [Filter](/beaver-builder/layouts/modules/posts/posts.md#filter) section in the Post module article for more information regarding the filter options. - -### Custom Content - -The Custom Content source option allows you to add your own content using the WordPress classic editor or populate the accordion item with content from a saved row, column, module, or template. - -#### Edit Items - -When you first add an Accordion module to your layout, a blank item will be created for you to edit. To edit an item, click the **Edit Items** link. - -![Edit accordion items](/img/beaver-builder/modules--accordion--2.jpg) - -- **Label** - Enter a name for your accordion item. This appears in the Accordion module settings panel to identify the item and on the frontend. - -- **Content Type** - The choices are: Saved Row, Saved Column, Saved Module, Saved Template, and Custom Content. The Saved content drop down menu automatically lists all previously saved rows, columns, modules, or templates when you select Saved content. - - The Custom Content option allows you to add your own content using the WordPress classic editor. - - :::caution - - Shortcodes used too frequently on the same page or post may impact performance. - - ::: - -- **Content** - Use the WordPress classic editor to add text to your accordion item. You can also add images using the **Add Media** button. - -#### Add Items - -To add more accordion items, click the **Add Item** button. - -#### Item Actions - -Each accordion item has a set of icons which perform the following actions: - -
    -
  • Move (Drag & drop into position).
  • -
  • Duplicate the item.
  • -
  • Delete the item.
  • -
- -![Accordion item actions](/img/beaver-builder/modules--accordion--3.jpg) - -## Display - -The Display section contains the following options: - -- **Content Type** - _(Available when [Post](#post) is selected as a Content Source)_ - - - **Post Content** - Show the full content of each post. - - **Post Excerpt** - Show the post excerpt. - -- **More Link** - _(Available when **Post Excerpt** is selected as the **Content Type**)_ - - Show or hide the Read more link after the post content. If set to Show, you can also customize the default Read more text. - -- **More Link Text** - _(Available when **Post Excerpt** is selected as the **Content Type**)_ - - Customize the default Read more... text. - -- **Collapse inactive** - By default set to Yes, which allows only one item to be expanded at a time. Change to No to allow more than one item to be expanded, - -- **Expand first item** - By default set to No. If set to Yes, the first item will be expanded on the first view, before the user clicks to expand anything. - - :::info - - After you save a label and text in the first item of the Accordion module, it remains open in the editing screen even when the Expand first item field is set to No. This is so that you can see the style settings while editing. The published page correctly follows the Expand first item setting. - - ::: diff --git a/beaver-builder/layouts/modules/accordion/settings/style.md b/beaver-builder/layouts/modules/accordion/settings/style.md deleted file mode 100644 index 05245c68..00000000 --- a/beaver-builder/layouts/modules/accordion/settings/style.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: style -title: Style tab -sidebar_label: Style tab ---- - -In the Style tab, you can customize the color of the text and icons, manage the typography settings, and adjust the spacing. - -## Item - -- **Item Size** - Changes the Accordion item size with specific padding values. - - - **Small** - Sets the padding to `10px 15px`. - - **Medium** - Sets the padding to `15px 20px`. - - **Large** - Sets the padding to `20px 25px`. - -- **Item Spacing** - Control the spacing between accordion items. - -- **Item Border** - The Border section has settings for border, radius, and shadow. - - See the [Borders](../../../../basics/border.md) article for more information. - -## Label - -- **Text Color** - Set the text color of the Accordion label. - -- **Background Color** - Set a background color for Accordion label. - -- **Padding** - Set a specific padding value in pixels for the accordion label. Click the Link Value icon to automatically make all four padding values the same. - -- **Typography** - Set the font size, family, line-height and more for the Accordion label. See the [Typography](basics/typography.md) article for more information. - -## Icon - -- **Icon Position** - Set the position of the accordion expand and collapse icons. The Left option positions the icon before the accordion label. - - The default is **Right**. - -- **Icon** - Choose a custom icon that replaces the default icon. - -- **Active Icon** - Choose a custom icon that replaces the default icon. - -## Content - -- **Text Color** - Set the text color of the Accordion content. - -- **Background Color** - Set a background color for Accordion content. - -- **Padding** - Set a specific padding value in pixels for the accordion content. Click the Link Value icon to automatically make all four padding values the same. - -- **Typography** - Set the font size, family, line-height and more for the Accordion content. See the [Typography](basics/typography.md) article for more information. diff --git a/beaver-builder/layouts/modules/acf-block.mdx b/beaver-builder/layouts/modules/acf-block.mdx new file mode 100644 index 00000000..be4ad561 --- /dev/null +++ b/beaver-builder/layouts/modules/acf-block.mdx @@ -0,0 +1,44 @@ +--- +title: ACF Blocks +icon: "cuboid" +description: "Display Advanced Custom Fields (ACF) blocks inside your Beaver Builder layouts." +--- + + +Display Advanced Custom Fields (ACF) blocks inside your Beaver Builder layouts. + +## Requirements + +The ACF Block module requires **Advanced Custom Fields Pro** to be installed and activated. + +## What are ACF Blocks? + +ACF Blocks are custom content blocks built with the Advanced Custom Fields (ACF) plugin. They let you create your own editor blocks using custom fields, making it easier to build consistent, reusable blocks for both Beaver Builder and the WordPress Block Editor through the familiar ACF field groups interface. + +To create an ACF Block for Beaver Builder, see our [ACF Blocks developer documentation](https://www.advancedcustomfields.com/resources/blocks/) for step-by-step instructions on registering, configuring, and making your block available in the Beaver Builder editor. + +:::note + +ACF blocks that declare JSX support are not compatible with Beaver Builder and will not appear in the available block list. +::: + +## Accessing ACF Blocks + +Blocks created with ACF are available in the **Content Panel > Modules tab > ACF Blocks**. Any categories or icons used to organize and display your blocks in the WordPress Block Editor will also appear there. + +## Block Settings + +The ACF Block module settings are dynamically generated based on the selected block type. + +### Settings Tab + +The Settings tab displays the ACF field group associated with the selected block type. The fields shown depend entirely on how the ACF block was registered and configured by you or your developer. + +To view all available fields for a particular ACF block, go to **WordPress Admin Dashboard > ACF** and open the **Field Group** assigned to that block. + +
+Advanced tab + +The Advanced tab contains common ACF Block's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/audio.md b/beaver-builder/layouts/modules/audio.md deleted file mode 100644 index fdf5fa49..00000000 --- a/beaver-builder/layouts/modules/audio.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -id: audio -title: Audio -sidebar_label: Audio -description: The Audio module displays an audio player with controls to play audio from the Media Library or an audio file from an external source. ---- - -Using the Audio module, you can insert one or more audio files from the -WordPress Media Library or a single audio file from an external source, plus -choose some playback options. - -## Using audio files from the Media Library - -When you choose the Media Library option in the Audio module, click the link -to choose one or more audio files to play. You can upload new files at that -time also. After you add the audio files, some playback options appear. - -If you choose a single audio file, a simple audio player appears in the -rendered output, and you have a choice to auto play the file and loop the -file, as shown in the following screenshot. - -![](/img/audio-1.png) - -If you choose more than one audio file, additional options are displayed in -the settings, as shown in the following screenshot and described below. - -:::info -If the module content disappears when you add an audio file or edit -the Audio module settings, save the module and reload the page in your -browser. You can do this even before you publish the page as long as you have -saved the module. -::: - -![](/img/audio-2.png) - - * **Style** -**Light** displays the playlist in dark text on a white background, while -**Dark** displays the playlist in white text on a dark background. - - * **Show playlist** -**Yes** shows the audio list under the player. **No** shows the first item in -the playlist and displays and autoplays the next item in the playlist when the -first is finished playing. - - * **Show track numbers** -**Yes** numbers the items in the playlist. **No** hides the sequential -numbering. See the following screenshot for an example of the player and -playlist. - - * **Show thumbnail** -**Yes** displays the thumbnail associated with the audio file currently loaded -in the player, if the image is available. **No** doesn't display the image. - - * **Show artist name** -If you specified an artist's name in the Media Library, then **Yes** displays -it in the playlist below the player. **No** doesn't display the artist name in -the playlist. If the Media Library does have Artist metadata specified, the -information on the currently playing file does display whether this setting is -**Yes** or **No**. - -![](/img/audio-3.png) - -## Using audio files from an external source - -You can use the Audio module to play a single audio file from an external -source. - -To get an external audio clip to work, you need a direct URL to the audio -file. Once you supply the URL, some additional options appear, and the -rendered output shows a simple audio player: - -![](/img/audio-4.png) - -## Other ways to embed audio - -If you are trying to link to a sound file on a website where you cannot get a -URL for one or more sound files, the site may have code that you can copy and -paste to embed the file with a player. For example, [SoundCloud has a help page](https://help.soundcloud.com/hc/en-us/articles/115003565128-Embedding-a-track-or-playlist-on-WordPress) that shows how to embed files from their site -into WordPress. In this case, paste the code for the embedded audio into an -HTML module. - -To create a playlist for several audio files from an external source, you need -to write your own custom code or use a playlist plugin. - -## More information about audio in WordPress - -The Audio module is a wrapper for WordPress’ core -[audio](https://wordpress.org/support/article/audio-shortcode/) and -[playlist](https://codex.wordpress.org/Playlist_Shortcode) shortcodes. Follow -the links to the WordPress codex for more information. If you prefer, you can -embed these shortcodes into HTML modules instead of using the Audio module. - -The Beaver Builder Custom Module Developer Guide describes a [Multiple Audios field](../../developer/custom-modules/10-setting-fields-reference.md#multiple-audios-field), which can display a WordPress media lightbox that lets users select -multiple audio files. - -## Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/audio.mdx b/beaver-builder/layouts/modules/audio.mdx new file mode 100644 index 00000000..c92180f2 --- /dev/null +++ b/beaver-builder/layouts/modules/audio.mdx @@ -0,0 +1,194 @@ +--- +title: Audio +sidebar_label: Audio +icon: "music" +description: "Use Audio to add a single audio player or playlist from the WordPress Media Library or a direct audio file URL." +--- + + +Use Audio to add a single audio player or playlist from the WordPress Media Library or a direct audio file URL. + +## Usage + +Use Audio to render a WordPress audio player from either files in the WordPress Media Library or a direct URL to a single audio file. Depending on how the source is configured, the module outputs either one audio player with standard playback controls or a playlist player with optional track display settings. + +Use Audio for podcasts, music tracks, interviews, sermons, voice recordings, and other layouts where visitors need inline playback without custom code. The module renders WordPress's native `[audio]` and `[playlist]` shortcodes, so the Media Library option fits audio managed in WordPress, while the Link option works when you already host a single audio file elsewhere and have its direct file URL. + +## Module Settings + +The Audio module settings control where audio comes from and how a single player or playlist behaves on the front end. + +### General Tab + +The General tab sets the audio source and reveals playback settings based on whether the module is rendering one file or a playlist. + +
+Audio Type + + +Selects whether the module uses the WordPress Media Library or a direct audio file URL. + +- **Media Library:** Builds the player from audio files selected in the WordPress Media Library. Supports single-file playback and playlists when more than one file is selected. +- **Link:** Builds the player from a direct URL to a single hosted audio file. + +
+Media Library + + +
+Audio + + +Selects one or more audio files from the WordPress Media Library. This custom field shows the current number of selected files and includes controls to **Select Audio**, **Edit Playlist**, or **Add Audio Files**. When one file is selected, the single-audio playback settings below apply. When more than one file is selected, playlist settings become available. + +
+Playlist + + +
+Style Default: Light + + +Sets the playlist appearance to a light or dark preset when more than one audio file is selected. +
+ +
+Show Playlist Default: Yes + + +Shows or hides the playlist track list beneath the player when more than one audio file is selected. + +
+Show Track Numbers + + +
+Show Track Numbers (Show Playlist Only) Default: Yes + + +Shows or hides track numbers in the playlist when **Show Playlist** is set to **Yes**. +
+
+
+ +
+Show Thumbnail Default: Yes + + +Shows or hides playlist thumbnail images when they are available for the selected audio files. +
+ +
+Show Artist Name Default: Yes + + +Shows or hides artist metadata in the playlist when it is available for the selected audio files. +
+
+
+
+ +
+Link + + +
+Link Supports: Field Connections + + +Sets the direct URL to a single audio file when **Audio Type** is set to **Link**. The module passes this value directly to the WordPress audio shortcode to render the player. + +Because this field is used as the player source URL, use a direct file link such as `https://example.com/audio/episode-01.mp3` rather than a page URL or third-party embed page. +
+
+ +
+Single Audio Playback + + +
+Auto Play (Single Audio Only) Default: No + + +Automatically starts playback when the module is rendering one audio file, whether that file comes from the Media Library or the **Link** option. +
+ +
+Loop (Single Audio Only) Default: No + + +Repeats the current audio file after it finishes when the module is rendering one audio file. +
+
+
+ +
+Advanced tab + +The Advanced tab contains common Audio module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
+ +## Create a playlist + +To build a playlist in the Audio module, follow these steps: + + +
+Step + + +Open the Audio module settings. +
+
+Step + + +Set **Audio Type** to **Media Library**. +
+
+Step + + +In the **Audio** field, click **Add Audio Files** or **Select Audio** to open the WordPress Media Library. +
+
+Step + + +Choose multiple audio files, then create or insert the playlist from the Media Library modal. +
+
+Step + + +Return to the module settings and adjust playlist options such as **Style**, **Show Playlist**, **Show Thumbnail**, and **Show Artist Name** as needed. +
+ + +Once more than one file is selected, the module switches from single-audio playback to playlist mode and reveals the playlist display settings. + + + + + + + +## Supported audio formats + +The Audio module is built on the native WordPress audio and playlist shortcodes, which determine the file types it can accept. The module supports the following audio formats: + +- `.mp3` +- `.m4a` +- `.ogg` +- `.wav` diff --git a/beaver-builder/layouts/modules/bigcommerce-products.md b/beaver-builder/layouts/modules/bigcommerce-products.md deleted file mode 100644 index a25476e4..00000000 --- a/beaver-builder/layouts/modules/bigcommerce-products.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: bigcommerce-products -title: BigCommerce Products -sidebar_label: BigCommerce Products -description: The BigCommerce Products module provides options to display selected BigCommerce products in page layouts. ---- - -If you have the BigCommerce plugin for WordPress installed, the BigCommerce -Products module is available in the **BigCommerce** section in the **Standard -modules** group in the Content panel for regular Beaver Builder layouts. - -This module lets you add any of the following displays of products or subsets -(as defined in your BigCommerce database): - - * The entire list of products (select **No** for the following three filters to display the entire set) - * Featured products only - * Sale products only - * Recent products only - -Here's a screenshot showing this module used to display sale items: - -![](/img/modules-big-commerce-1.png) - -As you can see in the screenshot, there is only a **Content** tab and -**Advanced** tab, no **Style** tab. However, you can change background and -text color in the row or column settings, as you can see in this screenshot: - -![](/img/modules-big-commerce-2.jpg) - -## Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/bigcommerce.mdx b/beaver-builder/layouts/modules/bigcommerce.mdx new file mode 100644 index 00000000..fc792bf5 --- /dev/null +++ b/beaver-builder/layouts/modules/bigcommerce.mdx @@ -0,0 +1,99 @@ +--- +title: BigCommerce Products +sidebar_label: BigCommerce +icon: "shopping-cart" +description: "Use BigCommerce Products to display a filtered BigCommerce product gallery with optional pagination." +--- + + +Use BigCommerce Products to display a filtered BigCommerce product gallery with optional pagination. + +:::note + +This module is available only when the [BigCommerce for WordPress](https://wordpress.org/plugins/bigcommerce/) plugin is installed and active. +::: + +## Usage + +Use BigCommerce Products to render the BigCommerce product gallery inside a Beaver Builder layout. The module outputs the `[bigcommerce_product]` shortcode and can limit the gallery to featured products, on-sale products, or recently imported products, while optionally splitting results across multiple pages. + +Use BigCommerce Products on store landing pages, sale pages, featured product sections, and other layouts where you want BigCommerce catalog content inside Beaver Builder without building shortcode attributes by hand. It works well for quickly surfacing a focused slice of your catalog in a visual layout. + +## Module Settings + +The BigCommerce Products module settings control which products appear in the gallery and whether the results are paginated. + +### Content Tab + +The Content tab controls pagination and the product filters applied to the gallery output. + +
+Pagination + + +The Pagination section controls whether the gallery is split into multiple pages and how many products each page shows. + +
+Pagination Settings + + +
+Use Pagination Default: No + + +Splits the product gallery across multiple pages. + +
+Products per page + + +
+Products per page Default: 8 + + +Sets how many products appear on each page when **Use Pagination** is set to **Yes**. The field supports values from 0 to 100. +
+
+
+
+
+ +
+Filters + + +The Filters section narrows which BigCommerce products appear in the gallery. + +
+Filter Settings + + +
+Show only featured products? Default: No + + +Limits the gallery to products marked as featured in BigCommerce. +
+ +
+Show only on-sale products? Default: No + + +Limits the gallery to products that are currently on sale. +
+ +
+Show only recent products? Default: No + + +Limits the gallery to recently imported products. On the front end, the shortcode treats recent products as items imported within the last two days unless that window is changed with the `bigcommerce/query/recent_days` filter. +
+
+
+ +
+Advanced tab + +The Advanced tab contains common BigCommerce Products module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/box.mdx b/beaver-builder/layouts/modules/box.mdx new file mode 100644 index 00000000..02767b64 --- /dev/null +++ b/beaver-builder/layouts/modules/box.mdx @@ -0,0 +1,672 @@ +--- +title: Box Module +sidebar_label: Box +icon: "box" +description: "A flexible container to arrange content using Flexbox, CSS Grid, or layered positioning with full control over spacing, backgrounds, and sizing." +--- + + +A flexible container to arrange content using Flexbox, CSS Grid, or layered positioning with full control over spacing, backgrounds, and sizing. + +## Requirements + +The Box module depends on JavaScript code available in **WordPress 5.2** or later. If you are using an earlier version, the Box module will not appear in the Beaver Builder user interface (UI). + +## Usage + +The Box module is a container that holds other modules. It arranges its children using Flexbox, CSS Grid, or layered positioning, giving precise control over alignment, spacing, and sizing across any number of elements. + +Use the Box module when you need spatial control over a group of modules — positioning text beside an image with Flex, building a structured grid of feature cards with Grid, or overlaying a headline on a background photo with Layers. Because Boxes nest inside other Boxes, complex multi-level layouts stay organized through a single consistent building block. + +## Box Module Aliases + +The Box module includes preconfigured aliases for common layouts. They are a useful starting point, especially if you are new to CSS Grid or Flexbox, and can also help you learn by showing how each layout is configured. + +- **Flex Columns:** Uses flexbox to arrange three boxes horizontally within the parent container. +- **3×2 Grid:** Creates a layout with three rows and two columns using grid boxes inside the parent container. +- **4×2 Grid:** Creates a layout with four rows and two columns using grid boxes inside the parent container. +- **Split Header:** Uses a three-column grid layout to create a distinct header structure. +- **Photo Grid:** Creates a 4×3 grid layout that incorporates Photo modules within the parent container. + +## Module Settings + +The Box module settings are organized into two tabs: Container controls the Box itself, and Children controls the defaults applied to all modules placed inside it. + +### Container tab + +The Container tab controls the Box's layout mode, spacing, visual appearance, sizing, and link behavior. + +
+Display + + +Selects how child elements are arranged inside the Box. + +- **Flex:** Arranges children along a single axis using CSS Flexbox. Ideal for one-dimensional layouts where items need to flow, wrap, grow, or shrink relative to one another. +- **Grid:** Arranges children in a two-dimensional layout using CSS Grid. Ideal for structured layouts where precise control over both rows and columns is needed. +- **Layers:** Stacks children on top of one another using CSS Grid. All children occupy the same grid cell by default, creating layered or overlay effects. + +
+Flex settings + + +
+Direction Default: Row; Supports: Responsive + + +Controls the main axis along which child elements are arranged. Changing the direction also affects how the **Align** setting maps to horizontal and vertical axes. + +- **Row:** Items are placed side by side horizontally, left to right. +- **Column:** Items are stacked vertically, top to bottom. +- **Reversed Row:** Items are placed horizontally in reverse order, right to left. +- **Reversed Column:** Items are stacked vertically in reverse order, bottom to top. + +
+ +
+Wrap Default: Normal; Supports: Responsive + + +Controls whether child elements stay on a single line or wrap onto additional lines when there is not enough space. + +- **Normal:** Items do not wrap and remain on a single line. Items may overflow the container if they exceed its width. +- **None:** Explicitly sets `flex-wrap: nowrap`. Functionally similar to Normal but makes the no-wrap intent explicit in CSS. +- **Wrap:** Items wrap onto additional lines when they no longer fit, flowing from top to bottom. +- **Reversed:** Items wrap onto additional lines, but new lines are added above previous ones rather than below. + +
+ +
+Gap Default: 10px; Supports: Responsive + + +Sets the space between child elements. This single value applies uniformly in all directions. Gap creates space only between items — it does not add space on the outer edges of the container. Use **Padding** to add space around the inside of the container boundary. +
+ +
+Align Default: Stretch; Supports: Responsive + + +Controls the alignment of child elements along the vertical and horizontal axes. Two rows of icon buttons are shown — the top row controls the vertical axis and the bottom row controls the horizontal axis. + +The behavior of each axis depends on **Direction**. When Direction is Row or Reversed Row, the horizontal axis is the main axis (`justify-content`) and the vertical axis is the cross axis (`align-items`). When Direction is Column or Reversed Column, the axes are swapped. + +- **Stretch:** Items stretch to fill the full container size along that axis. +- **Start:** Items are packed toward the start of the axis. +- **Center:** Items are centered along the axis. +- **End:** Items are packed toward the end of the axis. +- **Space Evenly:** Spacing between any two adjacent items and between items and the container edges is equal. +- **Space Between:** Items are evenly distributed. The first item is flush with the start edge and the last item is flush with the end edge. +- **Space Around:** Items are distributed with equal space on both sides of each item. + +
+
+ +
+Grid settings + + +
+Grid Supports: Responsive + + +Defines the column and row track structure of the grid. Each track is the space between two grid lines where content is placed. Add tracks using the **+** button, reorder them by dragging the handle, or duplicate and remove them from the ellipsis menu. + +:::tip + +The **Grid overlay** icon appears in the settings panel next to the Grid label. Clicking it toggles a visual grid guideline overlay on the canvas, making it easier to see column and row boundaries while building. +::: + +Each track supports the following types: + +- **Multiple Tracks:** Repeats a track a specified number of times using the CSS `repeat()` function. For example, setting columns to `3` creates `repeat(3, 1fr)` — three equal-width columns. +- **Freeform:** Accepts any valid CSS track size directly, such as `200px`, `minmax(100px, 1fr)`, or `repeat(4, auto)`. +- **Auto:** Track size is determined by its content. Equivalent to the CSS `auto` keyword. +- **1fr:** Adds a single fractional unit. The `fr` unit divides remaining available space proportionally. Multiple `1fr` tracks share space equally; a `2fr` track receives twice as much space as a `1fr` track. + +**Auto Columns** and **Auto Rows** define the size of implicitly created tracks when more items are placed in the grid than explicitly defined tracks can accommodate. +
+ +
+Flow Direction Default: Row; Supports: Responsive + + +Controls how grid items are automatically placed when their position is not explicitly defined. Maps to the CSS `grid-auto-flow` property. + +- **Row:** Items fill each row in turn, adding new rows as needed. Items flow left to right, then wrap to the next row. +- **Column:** Items fill each column in turn, adding new columns as needed. Items flow top to bottom, then wrap to the next column. + +
+ +
+Gap Supports: Responsive + + +Sets the space between rows and columns in the grid independently. Gap applies only between grid tracks and does not add space around the outer edges of the grid. Use **Padding** to add outer spacing. + +- **Row:** Space between horizontal rows. Default is `10px`. +- **Column:** Space between vertical columns. Default is `10px`. + +
+ +
+Align Default: Stretch; Supports: Responsive + + +Controls the alignment of child elements within the grid container along both axes. Two rows of icon buttons are shown — the top row controls the vertical axis (`align-items`) and the bottom row controls the horizontal axis (`justify-items`). + +Unlike Flex, Grid alignment operates independently of a direction setting — vertical always means the block axis and horizontal always means the inline axis. + +- **Stretch:** Items stretch to fill the full size of their grid cell. +- **Start:** Items align to the start edge of their grid cell. +- **Center:** Items center within their grid cell. +- **End:** Items align to the end edge of their grid cell. + +
+
+ +
+Layers settings + + +
+Align Default: Stretch; Supports: Responsive + + +Controls the alignment of child elements within the layered container. Two rows of icon buttons are shown — the top row controls the vertical axis and the bottom row controls the horizontal axis. Both axes default to **Stretch** when switching to Layers so all children fill the container. + +- **Stretch:** Items fill the full size of the container. Use this when all layers should occupy the same space. +- **Start:** Items align to the top (vertical) or left (horizontal) edge of the container. +- **Center:** Items center within the container along that axis. +- **End:** Items align to the bottom (vertical) or right (horizontal) edge of the container. + +
+
+
+ +
+Spacing + + +Controls the internal spacing of the Box container. + +
+Spacing settings + + +
+Padding Supports: Responsive, Link Values + + +Internal spacing between the Box edges and its children. +
+ +
+Gap (Flex and Grid Only) Supports: Responsive + + +Space between child elements. This field appears when **Display** is set to **Flex** or **Grid**. +
+
+
+ +
+Appearance + + +Visual styling for the Box container. + +
+Appearance settings + + +
+Background settings + +Background settings control background type, color, image, gradient, overlay, and related responsive background options where available. + +
+ +
+Border settings + +Border settings control border style, width, color, radius, and related responsive border controls where available. + +
+ +
+
+ +
+Sizing & Placement + + +Controls the Box's own dimensions and position within its parent. + +
+Sizing & Placement settings + + +
+Aspect Ratio Supports: Responsive + + +Sets a fixed width-to-height ratio for the Box. Options are grouped into Basics (Auto, Square), Wide (5:4, 3:2, Video 16:9, Ultra-wide Video 21:9), and Tall (4:5, 2:3, Poster 3:4, Portrait Video 9:16). +
+ +
+Flex (Flex Parent Only) Supports: Responsive + + +Sets how the Box grows, shrinks, and sizes itself when its parent container is set to Flex. + +
+Flex settings + + +
+Grow Supports: Responsive + + +A non-negative number that determines how much extra space the Box takes up relative to its siblings. A value of `0` prevents growth beyond the natural size. +
+ +
+Shrink Default: 1; Supports: Responsive + + +A non-negative number that determines how much the Box shrinks relative to its siblings when there is not enough space. A value of `0` prevents shrinking. +
+ +
+Basis Supports: Responsive + + +Sets the initial size of the Box before available space is distributed. Leave empty to use the Box's natural size (`auto`). +
+
+
+ +
+Grid Column (Grid Parent Only) Supports: Responsive + + +Sets the grid column the Box occupies when its parent container is set to Grid. +
+ +
+Grid Row (Grid Parent Only) Supports: Responsive + + +Sets the grid row the Box occupies when its parent container is set to Grid. +
+ +
+Width Supports: Responsive + + +Sets the width of the Box. Accepts auto, a custom value, or a percentage. +
+ +
+Min Width Supports: Responsive + + +Sets the minimum width of the Box. The Box will not shrink below this value. +
+ +
+Max Width Supports: Responsive + + +Sets the maximum width of the Box. The Box will not grow beyond this value. +
+ +
+Height Supports: Responsive + + +Sets the height of the Box. +
+ +
+Min Height Supports: Responsive + + +Sets the minimum height of the Box. +
+ +
+Max Height Supports: Responsive + + +Sets the maximum height of the Box. +
+ +
+Alignment Supports: Responsive + + +Aligns the Box within its parent container using inline margins. Options are **Left**, **Center**, and **Right**. +
+ +
+Order Supports: Responsive + + +Sets the display order of the Box when it is placed in a Flex or Grid parent. Lower values appear earlier. +
+
+
+ +
+Link + + +Makes the entire Box container clickable. When set, clicking anywhere on the Box navigates to the specified URL. + +:::warning + +When the Link option is enabled, any links inside modules placed within the Box will no longer work because HTML links cannot be nested. +::: + +
+Link settings + +Link settings control the URL, link target, nofollow behavior, download behavior, and other link attributes where available. + +
+
+ +### Children tab + +The Children tab sets the default layout, spacing, and appearance values applied to all modules placed directly inside the Box. + +
+Flexbox (Flex Only) Supports: Responsive + + +Sets default Flexbox child properties applied to all direct children when **Display** is set to **Flex**. Individual children can override these values using their own **Sizing & Placement** settings. + +
+Flexbox child settings + + +
+Grow Supports: Responsive + + +A non-negative number that determines how much of the available extra space a child takes up relative to other children. A value of `0` prevents growth beyond the natural size. A value of `1` allows proportional growth. +
+ +
+Shrink Default: 1; Supports: Responsive + + +A non-negative number that determines how much a child shrinks relative to other children when there is not enough space. A value of `0` prevents shrinking. A value of `1` allows proportional shrinking. +
+ +
+Basis Supports: Responsive + + +Sets the initial size of a child element before available space is distributed. Accepts a numeric value with units: `px`, `%`, `em`, `rem`, `vw`. Leave empty to use the child's natural size (`auto`). +
+
+
+ +
+Grid (Grid Only) + + +Sets default grid placement values applied to all direct children when **Display** is set to **Grid**. Individual children can override these values using their own **Sizing & Placement** settings. + +
+Grid child settings + + +
+Grid Column Supports: Responsive + + +Sets the default column position for children. When both **Start** and **End** are set, **Span** is ignored. These values generate the CSS `grid-column` shorthand. + +
+Grid column settings + + +
+Start Supports: Responsive + + +The grid column line where children begin. Leave empty for automatic placement. +
+ +
+Span Supports: Responsive + + +The number of column tracks children span. Minimum value is `1`. +
+ +
+End Supports: Responsive + + +The grid column line where children end. Leave empty for automatic placement. +
+
+
+ +
+Grid Row Supports: Responsive + + +Sets the default row position for children. When both **Start** and **End** are set, **Span** is ignored. These values generate the CSS `grid-row` shorthand. + +
+Grid row settings + + +
+Start Supports: Responsive + + +The grid row line where children begin. Leave empty for automatic placement. +
+ +
+Span Supports: Responsive + + +The number of row tracks children span. Minimum value is `1`. +
+ +
+End Supports: Responsive + + +The grid row line where children end. Leave empty for automatic placement. +
+
+
+
+
+ +
+Layers (Layers Only) + + +Sets default grid placement values applied to all direct children when **Display** is set to **Layers**. Defaults to full coverage — each child spans the entire width and height of the container. Individual children can override these values using their own **Sizing & Placement** settings. + +
+Layers child settings + + +
+Grid Column Supports: Responsive + + +Sets the default column position for children. Defaults to `start: 1, end: -1`, spanning each child across the full width of the container. + +
+Grid column settings + + +
+Start Default: 1; Supports: Responsive + + +The grid column line where children begin. +
+ +
+Span Supports: Responsive + + +The number of column tracks children span. Leave empty when using Start and End together. +
+ +
+End Default: -1; Supports: Responsive + + +The grid column line where children end. Defaults to `-1` (the last line), ensuring full-width coverage. +
+
+
+ +
+Grid Row Supports: Responsive + + +Sets the default row position for children. Defaults to `start: 1, end: -1`, spanning each child across the full height of the container. + +
+Grid row settings + + +
+Start Default: 1; Supports: Responsive + + +The grid row line where children begin. +
+ +
+Span Supports: Responsive + + +The number of row tracks children span. Leave empty when using Start and End together. +
+ +
+End Default: -1; Supports: Responsive + + +The grid row line where children end. Defaults to `-1` (the last line), ensuring full-height coverage. +
+
+
+
+
+ +
+Padding Supports: Responsive, Link Values + + +Default internal padding applied to each child module within the Box. +
+ +
+Sizing Supports: Responsive + + +Default sizing values applied to all direct child modules. Individual children can override these values using their own Sizing & Placement settings. + +
+Sizing settings + + +
+Width & Height Supports: Responsive + + +Sets default width, minimum width, maximum width, height, minimum height, and maximum height constraints for child modules. +
+ +
+Aspect Ratio Supports: Responsive + + +Sets a default width-to-height ratio for child modules. Options are grouped into Basics (Auto, Square), Wide (5:4, 3:2, Video 16:9, Ultra-wide Video 21:9), and Tall (4:5, 2:3, Poster 3:4, Portrait Video 9:16). +
+
+
+ +
+Appearance Supports: Responsive + + +Default visual styling for child modules. + +
+Child appearance settings + + +
+Text Color Supports: Responsive, Field Connections + + +The default text color for child modules. +
+ +
+Background Type + + +Sets the default background type for child modules. + +- **Color:** Applies a solid background color. +- **Advanced:** Opens the multi-layer background interface for gradients, images, and video. + +
+Color + + +
+Background Color Supports: Responsive, Field Connections + + +The solid background color applied to child modules when **Background Type** is set to **Color**. +
+
+ +
+Advanced + + +
+Background settings + +Background settings control background type, color, image, gradient, overlay, and related responsive background options where available. + +
+
+
+ +
+Border settings + +Border settings control border style, width, color, radius, and related responsive border controls where available. + +
+
+
+ +
+Advanced tab + +The Advanced tab contains common Box module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/box/index.md b/beaver-builder/layouts/modules/box/index.md deleted file mode 100644 index a949ebc0..00000000 --- a/beaver-builder/layouts/modules/box/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -id: index -title: Box Module -sidebar_label: Box -tags: - - 2.8 - - flexbox - - css grid - - layout ---- - -The Box Module allows users to add Flexbox and CSS Grid layouts to Beaver Builder Page Builder Layouts. - -![Box Module](/img/beaver-builder/modules--box-module--index--1.jpg) - -:::info - -While we’ve aimed to make the Box module as user-friendly as possible, having a solid grasp of [Flexbox](https://www.w3schools.com/csS/css3_flexbox.asp) and [CSS Grid](https://www.w3schools.com/csS/css_grid.asp) is strongly recommended. - -::: - -## Requirements - -The Box module requires WordPress 5.2 or later; otherwise, it won't appear in the Beaver Builder user interface (UI) due to its dependence on JavaScript code from WordPress Blocks. - -## Usage - -The Box module operates similarly to a row or column, acting as a versatile container. It utilizes either flexbox or CSS grid, enabling the creation of intricate, fluid, and adaptable layouts. Boxes can be nested, stacked, and organized in both horizontal and vertical orientations, as well as within a grid system. - -Flexbox and CSS Grid are distinct CSS layout models, each offering its own strengths and purposes: - -- **Flexbox** excels in one-dimensional layouts, perfect for arranging items in rows or columns with flexibility in sizing and alignment. -- **CSS Grid**, on the other hand, is tailored for two-dimensional layouts, providing precise control over rows and columns, facilitating more elaborate designs. - -These layout models often complement each other. For example, flexbox can be utilized within individual grid items to manage their internal structure, capitalizing on the combined benefits of both models for comprehensive layout solutions. - -### Usage Examples - -The Box module can be used to create a wide variety of layouts. Here are just a few examples: - -- Effortlessly center content both vertically and horizontally. -- Nest boxes within boxes to create intricate layouts. -- Create a responsive grid of boxes that wraps automatically without utilizing the Responsive Toggle. -- Design complex grid-based layouts for overall page structure. -- Create a card layout by using the Link option in the Box module. -- Reduce the amount of HTML markup in the DOM which can improve page load times and SEO. -- Stack modules on top of each other without the need for custom CSS. - -## Add a Box Module - -To add a Box module to your layout: - -1. Launch Beaver Builder on the page where you want to add the Box module. -2. Click the **+** icon to open the Content Panel. -3. Access the modules library by clicking the **Modules** tab. -4. Scroll down to the **Box** module and drag it to the desired location on the page. - -:::info - -Note that the Box module should be placed inside a row. If you try to drag the Box module onto the page without first placing it inside a row, a row will be automatically created for you. - -::: - -### Nest Boxes - -To nest boxes within boxes, simply drag a Box module into another Box module. This makes it easy to create intricate layouts. Moreover, you can seamlessly combine both flexbox and CSS grid to design sophisticated layouts. - -## Module Aliases - -The Box modules comes with several Modules Aliases that can be used to create common layouts. They are included for convenience and to help users get started with the Box module. - -- **Flex Columns:** - Utilizes flexbox to arrange three boxes horizontally within the parent container. - -- **3×2 Grid:** - Establishes a layout with three rows and two columns using grid boxes inside the parent container. - -- **4×2 Grid:** - Defines a grid structure with four rows and two columns of grid boxes within the parent container. - -- **Split Header:** - Features a grid layout with three columns, creating a distinct header structure. - -- **Photo Grid:** - Constructs a layout consisting of a 4×3 grid incorporating photo modules within the parent container. - -![Box Module Aliases](/img/beaver-builder/modules--box--2.jpg) - -## In this Section - -import DocCardList from '@theme/DocCardList'; - - diff --git a/beaver-builder/layouts/modules/box/settings/children.md b/beaver-builder/layouts/modules/box/settings/children.md deleted file mode 100644 index db572e48..00000000 --- a/beaver-builder/layouts/modules/box/settings/children.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: children -title: Children -sidebar_label: Children ---- - -The Children settings apply to all direct children of the box, providing control over aspects like flex or grid display, sizing, and appearance, including text and background colors. - -- **Grow & Shrink** _(Flex only)_ - The Flex settings allow you to specify the flex-grow, flex-shrink, and flex-basis of the box. - - - The flex-grow property specifies how much the item will grow relative to the rest of the flexible items inside the same container. - - - The flex-shrink property specifies how much the item will shrink relative to the rest of the flexible items inside the same container. - - - The flex-basis property specifies the initial length of a flexible item. - - The flex-grow and flex-shrink properties can be specified as a number, where a larger number indicates a larger share of the available space. The flex-basis property can be specified in pixels (px), percentage (%), em, rem, and vw. - -- **Grid Columns** _(Grid & Layers only)_ - The Grid Column settings allow you to specify the span, start, and end of the box. The span, start, and end can be specified as a number, where a larger number indicates a larger share of the available space. - -- **Grid Rows** _(Grid & Layers only)_ - The Grid Rows settings allow you to specify the span, start, and end of the box. The span, start, and end can be specified as a number, where a larger number indicates a larger share of the available space. - -- **Padding** - Allows you to increase the space around the outside of the container. The padding can be specified in pixels (px), ems, percentage (%), vh, and vw. - - See the Advanced Tab article's [Padding](layouts/advanced-tab/spacing.md#padding) section for more information. - -## Sizing - -- **Width & Height** - The Width & Height settings allow you to specify the min-width, width, max-width and min-height, height, and max-height of the box. The width and height can be specified in pixels (px), percentage (%), em, rem, vw, and vh. - -- **Aspect Ratio** - The Aspect Ratio setting allows you to specify the aspect ratio of the box. The aspect ratio is the ratio of the width to the height of the box. For example, a 16:9 aspect ratio means that for every 16 pixels of width, there are 9 pixels of height. - - You can choose from a variety of preset aspect ratios: - - - **None** - Default value. No aspect ratio is applied. - - **Square** (1:1) - - **Wide** (5:4) - - **Wide** (3:2) - - **Video** (16:9) - - **Ultra-wide Video** (21:9) - - **Tall** (4:5) - - **Tall** (2:3) - - **Poster** (3:4) - - **Portrait Video** (9:16) - -## Appearance - -The Appearance settings allow you to control the text color, background color, border, and box shadow of the box. - -- **Text Color** - The Text Color setting allows you to specify the color of the text within the box. The text color can be specified using the color picker, by entering a hex color code, or using a global color. - -- **Background Color** - The Background Color setting allows you to specify the background color of the box. The background color can be specified using the color picker, by entering a hex color code or using a global color. - - :::info - - The Box module currently supports background color only with more complex background options becoming available in a future release. - - ::: - -- **Border** - The Border settings allow you to specify the border width, border style, and border color of the box. - - See the [Borders](basics/border.md) article for more information. diff --git a/beaver-builder/layouts/modules/box/settings/container.md b/beaver-builder/layouts/modules/box/settings/container.md deleted file mode 100644 index 0e45a792..00000000 --- a/beaver-builder/layouts/modules/box/settings/container.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -id: container -title: Container Settings -sidebar_label: Container Settings ---- - -The Container settings allow you to control the display, alignment, and spacing of the items within the Box module. - -## Display - -The Box module offers three display types: Flex, Grid, and Layers. Certain options, such as direction and wrapping, vary depending on the chosen display type. However, settings like Spacing, Sizing & Placement, Appearance, and Linking remain consistent across all display selections. - -### Flex - -The Flex option allows you to organize items within a box either horizontally or vertically, utilizing CSS Flexbox. Flexbox excels in one-dimensional layouts, perfect for arranging items in rows or columns with flexibility in sizing and alignment. - -The Flex display option offers the following settings: - -- **Direction** - The Direction option sets the main axis, determining the direction in which items (modules) are positioned within the box container. - - Direction supports the following options: - - - **Row** - Default value. The flexible items are displayed horizontally, as a row. - - **Column** - The flexible items are displayed vertically, as a column. - - **Row Reverse** - Same as row, but in reverse order. - - **Column Reverse** - Same as column, but in reverse order. - -- **Align** - The Align setting supports the following options: - - :::info - - When changing the direction option of the Box module from Row to Column, be mindful that the alignment options will shift axis accordingly. Pay attention to this adjustment to ensure the desired layout alignment is preserved. - - ::: - - - **Stretch** - The items are stretched to fit the container (Default value). - - **Start** - The items are positioned at the beginning of the container. - - **Center** - The items are positioned at the center of the container. - - **End** - The items are positioned at the end of the container. - - **Space** - The items are evenly distributed in the container. - - **Evenly** - The items are distributed so that the spacing between any two items (and the space to the edges) is equal. - - **Space Between** - The items are evenly distributed in the container, with half-size spaces on either end. - -- **Wrap** - The Wrap setting supports the following options: - - - **Normal** - Specifies that the flexible items will not wrap (Default value). - - **No Wrap** - Similar to Normal but includes the CSS `nowrap` property (e.g., `flex-wrap: nowrap;`). - - **Wrap** - Specifies that the flexible items will wrap if necessary. - - **Wrap Reverse** - Specifies that the flexible items will wrap, if necessary, in reverse order. - -### Grid - -The Grid option allows you to organize items within a box in a grid layout, utilizing CSS Grid. CSS Grid is tailored for two-dimensional layouts, providing precise control over rows and columns, facilitating more elaborate designs. - -:::tip - -The Grid icon - provides an easy way to toggle a visual grid guidelines overlay when working with CSS Grid layouts. This gives you a more intuitive way to align and structure content as you build, making it perfect for designers who prefer a visual approach to grid based layouts. It helps you quickly spot spacing issues, understand how elements relate to one another, and fine tune your design with greater accuracy. This feature is especially helpful for newer users, since it removes the guesswork and makes the grid building process more clear and approachable. - -::: - -The Grid display option offers the following settings: - -- **Grid** - The Grid settings allow you to specify the number of rows and columns in the grid. In CSS Grid, a track is a space between gridlines, i.e. a space where you can add content. The number of tracks is determined by the number of rows and columns. - - By Clicking the **+** icon, you can add additional rows and columns to the grid. The options for each row and column include: - - :::tip - - Duplicating or removing rows and columns can be done by clicking the vertical ellipsis icon when hovering over a specific row or column. Additionally, you can utilize drag and drop functionality to rearrange rows and columns – simply click and hold the drag handle icon, then move the row or column to your preferred location. - - ::: - - - **Multiple Tracks** - Allows you to specify the number of tracks (e.g., 4). - - **Freeform Tracks** - Allows you can enter your own CSS properties (e.g., `repeat (4, 1fr);`). - - **Auto** - The size of the grid track will depend on the content of the item. - - **1fr** - Adds a `1fr` to the grid track. The `fr` unit is a fractional unit and `1fr` is for 1 part of the available space. - -- **Flow** - In CSS Grid, the flow direction determines how grid items are placed within the grid container, with options like "row" for a horizontal flow and "column" for a vertical flow, influencing the arrangement of items in rows or columns accordingly. - - The Flow setting supports the following options: - - - **Row** - The grid items are laid out along the grid's rows (Default value). - - **Column** - The grid items are laid out along the grid's columns. - -- **Align** - The Align setting supports the following options: - - - **Stretch** - The items are stretched to fit the container (Default value). - - **Start** - The items are positioned at the beginning of the container. - - **Center** - The items are positioned at the center of the container. - - **End** - The items are positioned at the end of the container. - - **Space** - The items are evenly distributed in the container. - - **Evenly** - The items are distributed so that the spacing between any two items (and the space to the edges) is equal. - - **Space Between** - The items are evenly distributed in the container, with half-size spaces on either end. - -### Layers - -The Layers option allows you to organize items within a box in a layered layout, utilizing CSS Grid. For example, you can use the Layers option to add text to a Photo module. - -The Layers display option offers the following settings: - -- **Align** - The Align setting supports the following options: - - - **Stretch** - The items are stretched to fit the container (Default value). - - **Start** - The items are positioned at the beginning of the container. - - **Center** - The items are positioned at the center of the container. - - **End** - The items are positioned at the end of the container. - - **Space** - The items are evenly distributed in the container. - - **Evenly** - The items are distributed so that the spacing between any two items (and the space to the edges) is equal. - - **Space Between** - The items are evenly distributed in the container, with half-size spaces on either end. - -## Spacing - -The Spacing settings allow you to control the spacing between items within the Box module using using gap (Flex & Grid only) and padding. - -- **Gap** (Flex & Grid only) - The Gap setting allows you to specify the amount of space between items within the Box module. For Grid, you can specify the gap for both rows and columns. For Flex, you can specify the gap for all directions. The gap can be specified in pixels (px), vh, and vw. - - :::tip - - The gap setting is only available for the Flex and Grid display options. - - ::: - -- **Padding** - Allows you to increase the space around the outside of the container. The padding can be specified in pixels (px), ems, percentage (%), vh, and vw. - - See the Advanced Tab article's [Padding](layouts/advanced-tab/spacing.md#padding) section for more information. - -## Sizing & Placement - -These settings allow you to control how this box fits within its parent container. - -- **Aspect Ratio** - The Aspect Ratio setting allows you to specify the aspect ratio of the box. The aspect ratio is the ratio of the width to the height of the box. For example, a 16:9 aspect ratio means that for every 16 pixels of width, there are 9 pixels of height. - - You can choose from a variety of preset aspect ratios: - - - **None** - Default value. No aspect ratio is applied. - - **Square** (1:1) - - **Wide** (5:4) - - **Wide** (3:2) - - **Video** (16:9) - - **Ultra-wide Video** (21:9) - - **Tall** (4:5) - - **Tall** (2:3) - - **Poster** (3:4) - - **Portrait Video** (9:16) - -- **Flex** - The Flex settings allow you to specify the flex-grow, flex-shrink, and flex-basis of the box. - - - The flex-grow property specifies how much the item will grow relative to the rest of the flexible items inside the same container. - - - The flex-shrink property specifies how much the item will shrink relative to the rest of the flexible items inside the same container. - - - The flex-basis property specifies the initial length of a flexible item. - - The flex-grow and flex-shrink properties can be specified as a number, where a larger number indicates a larger share of the available space. The flex-basis property can be specified in pixels (px), percentage (%), em, rem, and vw. - -- **Grid Columns** - The Grid Column settings allow you to specify the span, start, and end of the box. The span, start, and end can be specified as a number, where a larger number indicates a larger share of the available space. - -- **Grid Rows** - The Grid Rows settings allow you to specify the span, start, and end of the box. The span, start, and end can be specified as a number, where a larger number indicates a larger share of the available space. - -- **Width & Height** - The Width & Height settings allow you to specify the min-width, width, max-width and min-height, height, and max-height of the box. The width and height can be specified in pixels (px), percentage (%), em, rem, vw, and vh. - -## Appearance - -The Appearance settings allow you to control the text color, background color, border, and box shadow of the box. - -- **Text Color** - The Text Color setting allows you to specify the color of the text within the box. The text color can be specified using the color picker, by entering a hex color code, or using a global color. - -- **Background** - The Background settings allow you to specify the background color, image, or gradient for the box. - - See the [Multi-layerBackgrounds](/basics/multi-layer-backgrounds.md) article for more information. - -- **Border** - The Border settings allow you to specify the border width, border style, and border color of the box. - - See the [Borders](basics/border.md) article for more information. - -## Linking - -The Linking settings allow you to add a link to the box. The link is applied to the entire box, including any child modules. This is a great way to create a card layout. - -You also have the option to open the link in a new tab, include the `rel="nofollow"` attribute to indicate that the Google search spider should not follow the link, and initiate a download using the `download` attribute. - -:::caution - -If a link is added to a box, any other links within the same box will be disabled. For instance, if you include a Button module in a box, the link on the Button module will be disabled. This limitation arises from the inability to nest links within other links. - -::: diff --git a/beaver-builder/layouts/modules/box/settings/index.md b/beaver-builder/layouts/modules/box/settings/index.md deleted file mode 100644 index 0f1763b6..00000000 --- a/beaver-builder/layouts/modules/box/settings/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: index -title: Box Module Settings -sidebar_label: Settings ---- - -The Box module consists of two primary setting tabs: Container and Children, along with the customary Advanced tab. These setting tabs offer you the flexibility to create a wide variety of complex layouts. - -![Box Module Settings](/img/beaver-builder/modules--box-settings--1.jpg) - -import DocCardList from '@theme/DocCardList'; - - - -## Advanced tab - -The Advanced tab includes all the standard settings for margins, visibility, animations, and advanced HTML configurations. - -See the [Advanced tab](../../../advanced-tab/index.md) section for more information. \ No newline at end of file diff --git a/beaver-builder/layouts/modules/box/using-align-options.md b/beaver-builder/layouts/modules/box/using-align-options.md deleted file mode 100644 index 001dbc0a..00000000 --- a/beaver-builder/layouts/modules/box/using-align-options.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: using-align-options -title: Using Align Options -sidebar_label: Using Align Options -tags: - - 2.8 -draft: true ---- - -The align options within the Box module empower you to utilize flexbox for controlling the alignment of modules placed within boxes. Supported align options include Stretch, Start, Center, End, Space, Evenly, and Space Between. - -## Stretch - diff --git a/beaver-builder/layouts/modules/button-group.md b/beaver-builder/layouts/modules/button-group.md deleted file mode 100644 index e4cf3ec3..00000000 --- a/beaver-builder/layouts/modules/button-group.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -id: button-group -title: Button Group -sidebar_label: Button Group -description: The Button Group module displays multiple buttons in a single column, either horizontally or vertically. ---- - -The Button Group module is a way to display multiple buttons in a single column, either horizontally or vertically. - -![Button group module example](/img/button-group-30a865c5.png) - -It's based on the [Button module](/beaver-builder/layouts/modules/button/button.md), so the settings are very similar. - -In the Button Group module, there's a **Style** tab that applies to all of the buttons, and then there's a **Style** tab for each button you create. Any setting on an individual button's **Style** tab overrides the global setting for the button group. - -:::tip **Tip** -If you're using the Beaver Builder Theme, the buttons' initial style comes from the settings at **Customize > General > Buttons**. The button's default text color -is white text for darker accent colors and black text for lighter colors. The -default font family for the button text depends on the font family set for the -`` tag. -::: - -We'll break down the settings by [global button tabs](#global-button-tabs) and [single button tabs](#single-button-tabs). - -## Global button tabs - -### Buttons Tab (global) - -**Button group label** -An optional label for accessibility that adds an `aria` attribute with the value you specify here. For example, if you add the label button group for this setting, the rendered HTML shows the attribute `aria="button group"`. - -**Button 1** -Click **Edit button** to configure the first button. - -**Add button** -Click to create each additional button. - -### Style Tab (global) - -This tab has four sections: a top section, **Text**, **Background**, and **Border**. - -#### 1 Top section (global) - -Here's a diagram that illustrates the global padding, spacing, and width settings in this section. Each setting is described below. - -![Button group padding, spacing, and width](/img/button-group-2.png) - -- **Layout** - Choose a horizontal or vertical placement of the buttons. - -:::tip **Tip** -A horizontal layout wraps the buttons to another line as screen size decreases. A vertical layout wraps the button text to another line as screen size decreases. Enter R on the keyboard to enter [Responsive Mode](/beaver-builder/layouts/responsive-design/editor.md) to compare layouts at smaller screen sizes. -::: - -- **Width** - This setting controls the width of the buttons in the group. The values are **Default** and **Custom** but the behavior varies according to the type of layout. - When **Width** is **Default** and **Layout** is **Horizontal**, the width of each button varies according to the individual button text plus **Button padding**. This means that buttons with more text are wider: - ![Button group - Default width setting for horizontal layouts](/img/button-group-3.png) - Buttons wrap to a second horizontal line if necessary but the text doesn't wrap. - When **Width** is **Default** and **Layout** is **Vertical**, the button spans the entire width of the container minus the **Container padding** amount. Button text wraps if necessary. - When **Width** is set to **Custom** in either horizontal or vertical layouts, the width of every button is set to the custom width you specify. Text wraps if necessary: - ![Button group - Custom width setting for horizontal layouts](/img/button-group-4.png) -- **Align** (responsive) - This setting horizontally aligns the entire button container within its row or column. -- **Container padding** (responsive) - Adjusts the padding between the edge of the button group container and the group of buttons. -- **Button padding** (responsive) - Adjusts the padding between the edge of each button and the button's content. You can override this setting with the **Padding** setting on each button's **Style** tab. -- **Button spacing** (responsive) - Increase or decrease the amount of horizontal or vertical space around the outside of each button. You can set the spacing as `px`, `em`, `%`, or `vw`. - -#### 2 Text section (global) - -You can override all of the settings in this section on each button's **Style** tab. - -- **Text color** - Set the button text color in the resting state. -- **Text hover color** - Set the button color on mouse hover. If this setting is left blank, the **Text - color** setting applies for hover also. -- **Typography section** (responsive) - See [this article](basics/typography.md) about the **Typography** section settings. - -#### 3 Background section (global) - -You can override all of the settings in this section on each button's **Style** tab. - -- **Background color** - Set the fill color for the button in the resting state. -- **Background hover color** - Set the button's fill color on hover. If this setting is left blank, the **Background color** setting applies to hover also. -- **Background style** - **Flat**: consistent fill color - **Gradient**: gradient of the background color, lighter on top and darker on - the bottom. -- **Background animation** - **Disabled** by default. If set to **Enabled**, there's a 0.2-second linear - transition from resting state to hover state. - -#### 4 Border section (global) - -You can override all of the settings in this section on each button's **Style** tab. - -**Border** (responsive) -Creates a border around each button. See [this article](basics/border.md) for more information about the settings in the **Border** section. You can override this setting on each button's **Style** tab. -**Border hover color** -Changes the background color of the buttons on hover. - -### Advanced tab (global) - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. - -## Single-button tabs - -### General tab (single) - -This tab has the following settings. - -- **Text** - The text that appears on the button. -- **Icon** - Optional icon to appear on the button. If you select an icon, there are two - additional fields: - **Icon position**: Before or after the button text. - **Icon visibility**: The icon can be always visible or appear on hover only. -- **Click action** - **Link** or **Lightbox**. With **Link**, there's a URL field. With - **Lightbox**, there's a **Lightbox Content** section with **Content type** - to either embed content into an HTML field or provide a video link. - See the [click action examples in the Button module article](/beaver-builder/layouts/modules/button/button.md#set-the-click-action-to-a-lightbox). - -### Style tab (single) - -This tab has four sections: a top section, **Text**, **Background**, and **Border**. - -#### 1 Top section (single) - -- **Padding** (responsive) - Adjusts the padding between the edge of the button and the button's content. - -- Text align - See [this article](basics/typography.md#align) for a description of how the alignment toggle settings work. - -#### 2 Text section (single) - -- **Text color** - Set the button text color in the resting state. -- **Text hover color** - Set the button color on mouse hover. If this setting is left blank, the **Text - color** setting applies for hover also. -- **Typography section** (responsive) - See [this article](basics/typography.md) about the **Typography** section settings. - -#### 3 Background section (single) - -- **Background color** - Set the fill color for the button in the resting state. -- **Background hover color** - Set the button's fill color on hover. If this setting is left blank, the **Background color** setting applies to hover also. -- **Background style** - **Flat**: consistent fill color - **Gradient**: gradient of the background color, lighter on top and darker on - the bottom. -- **Background animation** - **Disabled** by default. If set to **Enabled**, there's a 0.2-second linear - transition from resting state to hover state. - -#### 4 Border section (single) - -**Border** (responsive) -Places a border on the edge of the button. See [this article](basics/border.md) for more information about the settings in the **Border** section. -**Border hover color** -Changes the background color of the buttons on hover. diff --git a/beaver-builder/layouts/modules/button-group.mdx b/beaver-builder/layouts/modules/button-group.mdx new file mode 100644 index 00000000..4b44984e --- /dev/null +++ b/beaver-builder/layouts/modules/button-group.mdx @@ -0,0 +1,302 @@ +--- +title: Button Group +sidebar_label: Button Group +icon: "stretch-horizontal" +description: "Display multiple buttons together in a single module with shared global styles and per-button overrides for text, icons, click actions, and appearance." +--- + + +Display multiple buttons together in a single module with shared global styles and per-button overrides for text, icons, click actions, and appearance. + +## Usage + +The Button Group module displays multiple buttons in a single layout element. It renders a group container with a shared style baseline — configure layout, typography, colors, backgrounds, and borders at the group level, then override appearance settings on each individual button as needed. + +Use the Button Group module for paired calls to action, navigation groups, or any situation where two or more buttons appear together and share a consistent visual style. + +:::note + +The Button Group module is designed for multiple buttons displayed together. If you only need a single button, use the [Button](/beaver-builder/layouts/modules/button) module instead. +::: + +## Module settings + +The Button Group module settings control the button list, shared group styling, and per-button behavior. + +### Buttons tab + +The Buttons tab is where you build and manage the list of buttons in the group. + +
+Button Group Label + + +An optional accessibility label for the button group container. The value is added as an `aria-label` attribute on the rendered HTML element. + +For example, entering `Hero Buttons` outputs `aria-label="Hero Button Group"` in the HTML. Use this to improve screen reader context when the group's purpose is not clear from surrounding content. + +```html wrap +
+``` +
+ +
+Add Buttons + + +Manages the list of buttons in the group. Click **Add button** to add a new button to the group, or click **Edit** on an existing button to open its settings. + +Each row in the list also includes **Move**, **Duplicate**, and **Delete** action icons: + +- **Move:** Drag and drop the button row to change the order in which buttons appear in the group. +- **Duplicate:** Creates a copy of the button, including all its General and Style tab settings, and adds it to the end of the list. +- **Delete:** Removes the button from the group. + +:::note + +The **Move** and **Delete** actions only appear once the group contains more than one button. +::: + +Each button has its own General tab and Style tab, described in [Individual button settings](#individual-button-settings). + +:::note + +Deleting a button cannot be undone after you click **Publish**. +::: +
+ +### Style tab + +The Style tab controls layout, spacing, alignment, and the shared visual appearance of all buttons in the group. + +:::note + +Global style settings apply to every button by default. You can override them on any individual button's Style tab. +::: + +
+Layout + + +Controls the direction, width, alignment, and spacing of the button group. + +
+Layout settings + + +
+Layout + + +Controls the direction in which buttons are arranged. + +- **Horizontal:** Buttons are placed side by side. When screen width decreases, buttons wrap to a new line. +- **Vertical:** Buttons are stacked. When text is too long to fit, it wraps within the button rather than pushing to a new line. + +
+ +
+Width Default: Default + + +Controls the global width of buttons in the group. + +- **Default:** In a Vertical layout, each button stretches to fill the full width of the container. In a Horizontal layout, each button is sized based on its content. +- **Custom:** Sets a uniform width for all buttons in the group, aligned within the container based on the Align setting. + +
+Custom Width + + +
+Custom Width (Custom Only) Default: 200; Supports: Responsive + + +Sets a fixed width for all buttons in `px`, `vw`, or `%` when **Width** is set to **Custom**. +
+
+
+ +
+Align Supports: Responsive + + +Controls the alignment of the buttons within the button group container. Options are **Left**, **Center**, and **Right**. + +In a Horizontal layout, alignment positions the row of buttons within the container. In a Vertical layout, alignment controls the horizontal position of each button within the container. This field is hidden when Layout is set to **Vertical** and Width is set to **Default**. +
+ +
+Container Padding Supports: Responsive + + +Adjusts the padding between the edge of the button group container and the buttons inside it. +
+ +
+Button Padding Supports: Responsive + + +Adjusts the padding between the edge of each button and its content. This is a global default that can be overridden on each button's individual Style tab. +
+ +
+Button Spacing Supports: Responsive + + +Controls the horizontal or vertical space between buttons in the group. +
+
+
+ +
+Text + + +Sets the default text color and typography for all buttons in the group. Individual button Style tabs can override these settings. + +
+Text settings + + +
+Text Color + + +The button text color in the resting state. +
+ +
+Text Hover Color + + +The text color when the button is hovered. Defaults to the resting color if left blank. +
+ +
+Typography Supports: Responsive + + +The font settings for button text. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Background + + +Sets the default background appearance for all buttons in the group. Individual button Style tabs can override these settings. + +
+Background settings + + +
+Background Color + + +The fill color in the resting state. +
+ +
+Background Hover Color + + +The fill color when the button is hovered. Defaults to the resting color if left blank. +
+ +
+Background Style Default: Flat + + +Selects the background rendering style. + +- **Flat:** Applies a solid fill. +- **Auto Gradient:** Applies a lighter top and darker bottom gradient based on the background color. +- **Advanced Gradient:** Replaces the background color with custom gradients. Selecting this option hides **Background Color** and **Background Hover Color** and reveals the **Background Gradient** and **Background Hover Gradient** fields. + +
+Background Gradient + + +
+Background Gradient (Advanced Gradient Only) + + +Configures the gradient colors, type, angle, and position when **Background Style** is set to **Advanced Gradient**. +
+ +
+Background Hover Gradient (Advanced Gradient Only) + + +Configures the hover gradient colors, type, angle, and position when **Background Style** is set to **Advanced Gradient**. +
+
+
+ +
+Background Animation (Flat Only) + + +Available when **Background Style** is set to **Flat**. When enabled, applies a 0.2-second linear transition between the resting and hover background states. +
+
+
+ +
+Border + + +Sets the default border for all buttons in the group. Individual button Style tabs can override these settings. + +
+Border settings + + +
+Border settings + +Border settings control border style, width, color, radius, and related responsive border controls where available. + +
+ +
+Border Hover Color + + +The border color used when the button is hovered. +
+
+
+ +### Individual button settings + +Each button in the group has its own settings, accessible by clicking **Edit** on any button in the Buttons tab. Individual button settings are divided into a General tab and a Style tab. + +
+Button module settings + +Each button uses the same core controls as the Button module, including text, link, icon, spacing, typography, background, and border settings. + +
+ +
+Advanced tab + +The Advanced tab contains common Button Group module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
+ +:::note + +The Advanced tab is global, so it is not available for individual button items in the Button Group module. As a result, the ID setting applies to the parent node div, not to each button. +::: diff --git a/beaver-builder/layouts/modules/button.mdx b/beaver-builder/layouts/modules/button.mdx new file mode 100644 index 00000000..507a1f44 --- /dev/null +++ b/beaver-builder/layouts/modules/button.mdx @@ -0,0 +1,373 @@ +--- +title: Button +sidebar_label: Button +icon: "rectangle-horizontal" +description: "Use Button to add a styled call to action that links to content, runs custom click behavior, or opens lightbox content." +relatedModules: ["button", "callout", "cta"] +--- + + +Use Button to add a styled call to action that links to content, runs custom click behavior, or opens lightbox content. + +## Usage + +Use Button to output a single call-to-action element with optional text and icon styling. Depending on **Click Action**, the module renders a standard link, a clickable button that runs custom JavaScript, or a lightbox trigger that opens inline HTML content or a video overlay. + +Use Button for primary page calls to action, download links, outbound links, popup videos, and small interactive triggers that need module-level styling control. It fits layouts where one button needs precise spacing, width, colors, gradients, and border styling without switching to a grouped button module. + +## Module Settings + +The Button module settings control button content, click behavior, lightbox content, and visual styling. + +### General Tab + +The General tab sets the button label, icon behavior, and click action. + +
+Text Default: Click Here; Supports: Field Connections + + +Sets the text displayed inside the button. +
+ +
+Icon Supports: Field Connections + + +Adds an optional icon to the button. + +
+Icon Position + + +
+Icon Position (Icon Only) Default: Before Text + + +Places the icon before or after the button text when an icon is selected. +
+
+ +
+Icon Visibility + + +
+Icon Visibility (Icon Only) Default: Always Visible + + +Keeps the icon visible or fades it in on hover when an icon is selected. +
+
+
+ +
+Click Action Default: Link + + +Selects whether the button acts as a link, runs custom button code, opens lightbox content, or copies text to the clipboard. + +
+Link settings + +Link settings control the URL, link target, nofollow behavior, download behavior, and other link attributes where available. + +
+ +
+Button + + +
+Button Code (Button Only) + + +JavaScript executed when the button is clicked. The code runs on the front end, not inside the builder. + +```js + // Example: show an alert on click + alert('Button clicked'); +``` + +:::tip + +WordPress loads jQuery in no-conflict mode. Use `jQuery` instead of `$` in this field to avoid JavaScript errors. +::: +
+
+ +
+Lightbox + + +
+Lightbox Content + + +This section is available when **Click Action** is set to **Lightbox** and controls what opens in the lightbox overlay. + +
+Lightbox Content settings + + +
+Content Type Default: HTML + + +Selects whether the lightbox displays inline HTML or a video. + +
+HTML Content + + +
+HTML Content (HTML Only) Supports: Field Connections + + +Adds custom HTML rendered inside the lightbox when **Content Type** is set to **HTML**. +
+
+ +
+Video Link + + +
+Video Link (Video Only) Supports: Field Connections + + +Sets the video URL opened in the lightbox when **Content Type** is set to **Video**. +
+
+
+
+
+
+ +
+Copy Text + + +
+Text to Copy (Copy Text Only) + + +Sets the text copied to the visitor's clipboard when the button is clicked. Available when **Click Action** is set to **Copy Text**. +
+ +
+Copy Success Message (Copy Text Only) Default: Copied! + + +Sets the confirmation message shown after the text is copied. Available when **Click Action** is set to **Copy Text**. +
+
+
+ +### Style Tab + +The Style tab controls the button width, spacing, colors, gradients, and border styling. + +
+Width Default: Auto + + +Sets whether the button sizes to its content, fills the available width, or uses a custom width. + +
+Align + + +
+Align (Auto and Custom Only) Default: Left; Supports: Responsive + + +Sets the horizontal alignment of the button wrapper when **Width** is set to **Auto** or **Custom**. +
+
+ +
+Custom Width + + +
+Custom Width (Custom Only) Default: 200; Supports: Responsive + + +Sets a fixed button width in `px`, `vw`, or `%` when **Width** is set to **Custom**. +
+
+
+ +
+Padding Supports: Responsive, Link Values + + +Sets the inner spacing around the button text and icon. +
+ +
+Text + + +The Text section controls button label colors and typography. + +
+Text Settings + + +
+Text Color Supports: Responsive, Field Connections + + +Sets the text color for the button label and icon. +
+ +
+Text Hover Color Supports: Responsive, Field Connections + + +Sets the text color for the button label and icon on hover. +
+ +
+Typography Supports: Responsive + + +Controls the typography of the button label. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Icon + + +This section is available when the selected icon is a Font Awesome DuoTone icon. + +
+DuoTone Icon Colors + + +
+DuoTone Icon Primary Color Supports: Field Connections + + +Sets the primary color of the selected DuoTone icon. +
+ +
+DuoTone Icon Secondary Color Supports: Field Connections + + +Sets the secondary color of the selected DuoTone icon. +
+
+
+ +
+Background + + +The Background section controls the button fill style, color, gradients, and hover animation. + +
+Background settings + + +
+Background Style Default: Flat + + +Selects **Flat**, **Auto Gradient**, or **Advanced Gradient** for the button background. + +
+Background Color + + +
+Background Color (Flat and Auto Gradient Only) Supports: Responsive, Field Connections + + +Sets the button background color when **Background Style** is **Flat** or **Auto Gradient**. Auto Gradient uses this color to build its base gradient and falls back to `#a3a3a3` when no color is set. +
+
+ +
+Background Hover Color + + +
+Background Hover Color (Flat and Auto Gradient Only) Supports: Responsive, Field Connections + + +Sets the hover background color when **Background Style** is **Flat** or **Auto Gradient**. When left empty, the hover state falls back to **Background Color**. +
+
+ +
+Background Animation + + +
+Background Animation (Flat Only) Default: Disabled; Supports: Responsive + + +Enables or disables the button background transition when **Background Style** is set to **Flat**. +
+
+ +
+Background Gradient + + +
+Background Gradient (Advanced Gradient Only) + + +Configures the default gradient colors, type, angle, and position when **Background Style** is set to **Advanced Gradient**. +
+
+ +
+Background Hover Gradient + + +
+Background Hover Gradient (Advanced Gradient Only) + + +Configures the hover gradient colors, type, angle, and position when **Background Style** is set to **Advanced Gradient**. +
+
+
+
+
+ +
+Border settings + +Border settings control border style, width, color, radius, and related responsive border controls where available. + +
+ +
+Border Hover Color Supports: Responsive, Field Connections + + +Sets the border color used on hover and focus. +
+ +
+Advanced tab + +The Advanced tab contains common Button module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/button/button.md b/beaver-builder/layouts/modules/button/button.md deleted file mode 100644 index 384dbf0c..00000000 --- a/beaver-builder/layouts/modules/button/button.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -id: button -title: Button -sidebar_label: Button module -description: The Button module resembles a physical button. The click action is either a link or a lightbox, where you can add custom HTML or embed a video. ---- - -The Button module is an exactly that: an object that you insert into your layout that resembles a physical button. - -## Uses of this module - -- Traditionally, a web button is a pretty package for a link that sends visitors elsewhere when clicked. - ![](/img/button-module-with-link.jpg) -- The button can also [open a lightbox](#set-the-click-action-to-a-lightbox), which displays a video or any other content that you can insert with a shortcode, HTML, or code such as an ` - - -You can add a menu item whose link goes to a specific section on the same page -or a section on a different page. This works both with menus you set up in your theme and menus in the Beaver Builder Menu module. It's particularly useful for single-page websites where you have a menu for the various sections on that page. - -:::info -If the section is on the same page as the link, there's a smooth scroll to the -linked section. If the link goes to a section on a different page, there's an -immediate jump to that section on the other page. -::: - -This technique involves two steps: adding a unique ID (called an *anchor*) to the target section in a Beaver Builder layout, then adding the link with that anchor to your menu. - -## 1. Create the anchor for the link target - -:::tip **Tip** -You can add the ID to a module, a column, or a row, but the target -tends to position best if you add the ID to the row containing the item you -want to link to. Also, if the section is near the end of the page, the -scrolling may not go all the way down to the section with the ID. This is a -property of how browsers handle links to anchors. -::: - - 1. In the Beaver Builder editor, open the row (or column or module) that you plan to link to. - 2. Click the **Advanced** tab and scroll down to the **HTML elements** section. - 3. For the **ID** setting, add a unique value such as `my-unique-id`. -ID values may only contain alphanumeric characters, hyphens, or underscores. - -:::tip **Tip:** -It's a best practice to prefix ID and class values with a namespace. The namespace prefix plays a double role. - -First, it helps identify where the ID or class comes from. For example, Beaver Builder uses the namespace `fl-`, so when you're inspecting the HTML source for a page, it's easy to identify the Beaver Builder code as opposed to, say, that of other plugins. - -Second, a namespace helps to avoid accidentally using words that are reserved for use in coding languages like [PHP](https://www.php.net/manual/en/reserved.php) and [JavaScript](https://www.w3schools.com/js/js_reserved.asp) or duplicating IDs and classes from other products. - -For example, if your business name is Best Website Designs, you might choose `bwd-` as your namespace prefix and your ID value might be `bwd-menutarget-1`. Just make sure each ID value is unique on your site. -::: - -## 2. Add the unique ID to a menu item - - 1. On the WordPress admin menu, click **Appearance > Menus** and make sure the menu you want to use is displayed. - 2. In the left column expand the **Custom links** category. -![](/img/how-to-tips-add-menu-that-links-1.png) - - 3. Enter the full URL of the target page in which the section occurs, followed by the pound sign and your ID. For example, if the section occurs on the page ** , then your URL would be: -** - - 4. Enter whatever link text you want your menu item to display. - 5. Click **Add to menu**. diff --git a/beaver-builder/layouts/modules/menu/menu.md b/beaver-builder/layouts/modules/menu/menu.md deleted file mode 100644 index 50b57b2f..00000000 --- a/beaver-builder/layouts/modules/menu/menu.md +++ /dev/null @@ -1,325 +0,0 @@ ---- -id: menu -title: Menu -sidebar_label: Menu module -description: The Menu module inserts any WordPress menu into your layout, with many layout and style options that can be tailored for responsiveness. ---- - -The Menu module can give you more options for menu content, style, and layout than the menu available in your theme or widget area. It also gives you the ability to insert a menu anywhere in your layout. - -The Menu module displays items from [a WordPress menu that you designate](#menu). It has [several choices of layout](#layout). Menu alignment, colors, and typography are set on [the **Style** tab](#style-everything). - -## Ideas for using a Menu module - -- Use special menus in your Beaver Builder page layouts. For example, if you have one group of static pages on your site related to a particular topic, you could create a special menu for the pages in that particular group and display the links in a Menu module on the main page in that group. -- If you have FAQs that contain fairly long answers, create a separate post for each individual FAQ, then create a menu item for each post, then use that menu in a Menu module embedded in your page content. That menu serves as a table of contents linking to the post that contains the answer. The following screenshot shows an example of a menu used as an FAQ table of contents. - -![Menu module used to display an FAQ](/img/menu-module-1.jpg) - -## General tab - -### Menu - -In the **Menu** field, choose the WordPress menu that you have defined in **Appearance > Menus** from the WordPress admin panel. This menu defines which items are displayed in the menu. - -If the website has no menu, this field says **No menu found** with a link to add one, which opens **Appearance > Menus** in a new tab. When you're finished, close the additional tab and reload your layout page in the previous tab to display the new menu choice. - -### Layout - -The **Layout** setting has four layout options, described in detail in the following sections. - -On large screens, **Horizontal** layouts tend to work better in wide short columns, while **Vertical**, **Accordion**, and **Expanded** layouts tend to work better in narrow tall columns. - -Why? The horizontal layout's menu boundary is fit to the menu items. In the following screenshot, you can see a horizontal menu with a color background, inside its column. - -![](/img/menu-module-horizontal-layout-in-column.png) - -The following screenshot shows a vertical layout with a color background in the same column. The menu's boundary is sized to fill the column width and the submenu and search icons are right-justified. You can adjust the width of the module by changing the column width or adding margins or padding to the containing row or column, or increase the margin of the Menu module itself. - -![](/img/menu-module-vertical-layout-in-column.png) - -The Accordion and Expanded layouts look the same as the vertical layout. Their differences lie in how their submenus behave. - -#### Layout: Horizontal - -This option is a standard horizontal layout that supports dropdown submenus, with a **Submenu layout** choice of a down arrow, plus sign, or nothing. This screenshot shows a horizontal menu with a down arrow for the item with a submenu. - -![](/img/menu-module-horizontal-layout.jpg) - -You can also add an image to a horizontal layout that appears centered between the menu items by using the [**Centered + inline logo** settings](#centered--inline-logo). - -#### Layout: Vertical - -As described above, the vertical menu fills the width of the column, with the submenu icon and search icon right-justified. - -The submenu expands to the right and overlays the next column, as shown here: - -![](/img/menu-module-vertical-layout-submenu-outside.jpg) - -:::tip **Tip** -Vary the submenu color opacity at **Style > Dropdowns > Dropdown background color** to control whether content displayed underneath the submenu bleeds through or not. -::: - -If the vertical menu is in the rightmost column, the submenu displays to the right if there is room between the right edge of the menu and the edge of the browser screen, as shown in this screenshot. - -![](/img/menu-module-vertical-layout-submenu-outside-browser-edge.jpg) - -If there's no room to expand to the right, it expands to the left. For narrower menus, this means the submenu can cover items in the main menu while it's displayed: - -![](/img/menu-module-vertical-layout-submenu-inside-browser-edge.jpg) - -The behavior changes when the menu is displayed as an icon. See [the section on responsive behavior](#set-responsive-behavior). - -#### Layout: Accordion - -The Accordion layout is a vertical layout that expands the menu to display submenu items inline when the toggle icon is clicked. Here's a screenshot showing two submenu items after the down arrow on the **Home** menu link was clicked. - -![Menu module, submenu items in an accordion layout](/img/menu-module-accordion-layout-submenu-flush.png) - -:::tip -You can see from the screenshot that the submenu is left-aligned with the main menu items, so it's a good idea to change the submenu background color at **Style > Dropdown**. -::: - -#### Layout: Expanded - -The Expanded layout is similar to the [WordPress Navigation Menu widget](https://en.support.wordpress.com/widgets/navigation-menu-widget/). The following screenshot shows an example. Top-level menu and submenu items are displayed in a list and both top-level and submenu items are left-aligned. - -![Menu module, expanded layout](/img/menu-module-expanded-layout.png) - -:::tip - -- You can distinguish submenu items from main menu items with different background colors. The hover color shown in the screenshot comes from the **Style > Dropdowns > Link hover background color**. The **Style > Dropdowns > Dropdown background color** is ignored. - ::: - -### Submenu icon - -The **Submenu icon** option is available for **Horizontal**, **Vertical**, and **Accordion** layouts. The choices are as follows: - -- Horizontal and vertical layouts: down **Arrows**, **Plus sign**, **None** -- Accordion layout: **Arrows** or **Plus sign** - -### Menu name - -The value you set for **Menu name** appears in two places: - -- The responsive Menu button, if you have chosen that in the [**Responsive Toggle** section](#responsive-toggle). -- The ARIA label in the HTML output, to help accessibility tools identify the menu. - For example, if you change the default value **Menu** to **primary menu**, the HTML included with the Menu module appears like this: - -```html - -``` - -### Centered + inline logo - -When **Layout** is set to **Horizontal**, there's a **Centered + inline logo** section with an option to add a logo that appears in the center of the menu items, as in this example. - -![Menu module centered inline logo](/img/2-5-features-menu-module-centered-inline-logo.png) - -This section has two fields: - -- **Logo image** - Click **Select photo** to add the image. -- **Inline logo position** - When there's an odd number of menu items, the logo cannot appear exactly in the center, so you can choose whether it appears to the left or the right of center. In the following screenshot, **Inline logo position** is set to **Right**, so there are four menu items on the left and three on the right. The [WooCommerce Dynamic Cart](#), which shows information about the cart contents, counts as one menu item, as does the search icon. - -![Menu module centered inline logo Right](/img/menu-module-centered-inline-logo-right.png) - -:::tip -Horizontal menu items wrap onto a second line as screen size decreases, so be sure to test responsive behavior. The alignment of the wrapped line follows the alignment setting in the **Style > Menu** section. -::: - -### Add search - -In the **Search** section of the **General** tab, you can show or hide a search icon to the menu, shown in this screenshot. - -![Menu module, search icon clicked](/img/menu-module-vertical-expanded-search-form.jpg) - -You can replace the default icon with an icon from the [available icon sets](settings/icons.md). - -In the [**Search menu** section of the **Style** tab](#search-menu-section), you can style both the search icon and the search form that appears when you click the icon. - -### Set responsive behavior - -The **Responsive** section on the **General** tab controls how the menu layout changes as screen width becomes smaller, with the following settings. - -#### Responsive toggle - -- **Hamburger icon** - The hamburger icon is three horizontal lines. If you want a background color, as shown in this screenshot, set it at **Style > Dropdowns > Dropdown background color**. - ![Hamburger icon with background color](/img/menu-module-hamburger-icon.png) -- **Hamburger icon + label** - This setting includes both the Hamburger icon and a MENU label, with an optional background (set on the **Style** tab). - ![Hamburger icon plus label with background color](/img/menu-module-hamburger-icon-plus-label.png) -- **Menu button** - This setting is a button with a label. By default, the menu button label is **Menu** unless you have a custom setting for [**Menu name**](#menu-name). - ![Menu button example](/img/menu-module-menu-button.png) -- **None** - With this setting, the menu items continue to be displayed on smaller devices rather than changing to a Hamburger icon or Menu button. - For a menu whose **Layout** setting is **Horizontal**, another setting appears immediately underneath the **None** setting, called **Stacked layout**. As shown in the following screenshot, if this setting **No**, the menu remains horizontal and wraps on small devices. If **Yes**, then on smaller devices the menu items are displayed in an Accordion (vertical) list. - ![Menu module, resonsive toggle non, stacking option](/img/menu-module-responsive-section.png) - For all other menu layouts, the **None** setting displays an [Accordion layout](#layout-accordion). - With the **None** setting, you won't see the settings for **Responsive style** and **Responsive breakpoint** described in the following two sections. - -#### Responsive style - -This setting has the following options for menu expansion when the responsive icon or button is clicked. - -- **Inline** - The expanded menu falls below the hamburger. This works for centered menus but doesn’t work if, for example, you have a hamburger in a small column on the right. The menu gets squished. -- **Below row** - This option removes the menu in the markup and puts it below the column that the menu is in. This means that expanded menus in small columns still appear inline but don’t get squished. -- **Overlay** - See [this Beaver Builder Theme article](/bb-theme/defaults-for-layouts-content/headers-nav-menus/choose-how-menus-open-responsively#responsive-menu-dropdown) for an example. -- **Flyout overlay** - See [this Beaver Builder Theme article](/bb-theme/defaults-for-layouts-content/headers-nav-menus/choose-how-menus-open-responsively#flyout-overlay) for an example. -- **Flyout push** - See [this Beaver Builder Theme article](/bb-theme/defaults-for-layouts-content/headers-nav-menus/choose-how-menus-open-responsively#flyout-push) for an example. -- **Flyout push with opacity** - See [this Beaver Builder Theme article](/bb-theme/defaults-for-layouts-content/headers-nav-menus/choose-how-menus-open-responsively#flyout-push-with-opacity) for an example. - -#### Responsive breakpoint - -By default, the responsive menu appears on small devices only, but you can change the behavior to medium and small devices, or all devices. - -## WooCommerce tab - -If the WooCommerce plugin is installed, there's a **WooCommerce** tab with settings for the WooCommerce dynamic cart, which includes quantity or pricing information. The following screenshot shows the difference between the **Cart** menu item added to the WordPress menu at **Appearance > Menus** versus the dynamic cart added with the Menu module: - -![Menu module WooCommerce tab](/img/menu-module-woocommerce-tab.png) - -This tab has the following settings. - -- **Menu cart** - If you choose **Hide**, the word **Cart** appears instead of the dynamic cart. -- **Cart icon** - You can replace the default Cart icon with another icon from your [icon library](settings/icons.md). -- **Show on checkout** - This setting determines whether the dynamic cart icon appears in the menu on the Checkout page. -- **Display type** - This setting lets you choose which dynamic information appears with the icon: number of items in the cart, total purchased, or both. - -You can style the options you choose in the **WooCommerce dynamic cart** section of the **Style** tab. - -## Style tab - -The **Style** tab has the following options. - -### Menu section - -This section has two settings: - -- **Menu alignment** - Left, center, or right alignment of main menu items. -- **Menu background color** - -### Links section - -- **Link color** - Set the color of the menu items when they're not active. -- **Link hover color** - Set the color of the menu items that are either active (displaying that page), on hover with a mouse, or immediately after being tapped. -- **Link hover background color** - You can optionally set a background color for the menu items that are either active (displaying that page), on hover with a mouse, or immediately after being tapped. - -:::info -If you're using the Beaver Builder Theme, the default menu link colors appear in the color you defined in **Appearance > Customize > General > Accent Color**, and you can customize this color. -::: - -- **Link padding** - The number of pixels or ems of padding between menu item text and the menu item boundary. -- **Link typography** - See the article about typography settings [Typography section](basics/typography.md) to style your menu text. - -:::note **Notes:** -If you are using the Beaver Builder Theme, the default font family is what you defined for content in **Customize > General > Text**. -::: - -### Separators section - -Set **Show separators** to **Yes** to display horizontal lines between menu items. - -### Dropdowns section - -These settings control submenu items in the following categories - -#### Dropdown color settings - -This screenshot shows an example of the dropdown color settings listed below. - -![Style tab Dropdowns section color settings](/img/menu-module-style-dropdowns-section.png) - -- **Link color** -- **Link hover color** -- **Link hover background color** -- **Dropdown background color** -- **Dropdown shadow** - Shows a drop shadow on the submenu items. - -#### Dropdown padding - -- **Dropdown padding** - Adds padding between the dropdown boundary box border and the block of menu item text. Here's an example of **Dropdown padding** set to 20px, **Dropdown link padding** set to 0px: - ![Dropdown padding 20, dropdown link padding 0](/img/menu-module-dropdown-padding-set.png) -- **Dropdown link padding** - Adds padding around the text for each dropdown menu item. Here's an example of **Dropdown padding** set to 0px, **Dropdown link padding** set to 20px. Because the dropdown link padding is set both on top and bottom, the distance between the two submenu items increases to 40px: - ![Dropdown padding 0, dropdown link padding 20](/img/menu-module-dropdown-link-padding-set.png) - -#### Dropdown border - -You can add a border, round the corners, and add a shadow around the dropdown submenus. See the article about [border settings](basics/border.md). - -#### Dropdown typography - -See the article about typography settings [Typography section](basics/typography.md) to style your submenu text. - -### Responsive dropdowns - -You can style the following responsive dropdown settings differently from the dropdown settings for larger devices: - -- Link color -- Link hover color -- Link hover background color -- Dropdown background color - -### Responsive Toggle section - -If **General > Responsive toggle** is set to anything other than **None**, there's also a **Responsive toggle** section on the **Style** tab where you can set the size of the Responsive toggle plus submenu dropdown background colors, text colors, and borders, as shown in this screenshot. - -![Menu module responsive toggle on Style tab](/img/menu-module-style-tab-responsive-toggle.png) - -### Search Menu section - -If **General > Search menu** is set to **Show**, there's a **Search menu** section on the **Style** tab where you can style not only the search icon but also the search form, which appears when you click the search icon. This section has the following settings. - -- **Icon size** -- **Icon color** -- **Icon hover color** -- **Form width** -- **Form background color** -- **Form background hover color** -- **Form border** - See the article about [border settings](basics/border.md). -- **Form border hover** -- **Form padding** - -### WooCommerce Menu Cart style settings - -If you have WooCommerce installed and the **Menu Cart** option set to **Show** on the WooCommerce tab, then the **Style** tab has a **WooCommerce menu cart** section with the following settings. - -- **Background color** -- **Hover background color** -- **Color** - This setting changes the color of both the icon and any other options you have set to display. -- **Hover color** -- **Typography** - See the article about typography settings [Typography section](basics/typography.md). - -## Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/module-blocks.md b/beaver-builder/layouts/modules/module-blocks.md deleted file mode 100644 index 4b020066..00000000 --- a/beaver-builder/layouts/modules/module-blocks.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: module-blocks -title: Module Blocks -sidebar_label: Module Blocks -description: Learn how to use Module Blocks in the WordPress Editor. ---- - -Module Blocks are Beaver Builder modules that are developed as WordPress blocks for use in the WordPress block editor. These blocks maintain all the features and settings found in their module counterparts. - -## Using Module Blocks - -1. In the WordPress block editor, click the + plus icon. -2. Click the **Browser All** button. -3. In the block library sidebar, scroll down to the Beaver Builder section where you can find all module blocks. - -:::tip - -You can also use the `/beaver` command to quickly access a list of all Beaver Builder module blocks. Simply type `/beaver` in the WordPress block editor and a modal window will appear with a list of all available module blocks. You can then select the module block you want to use. - -![Use the `/beaver` command in the WordPress block editor](/img/beaver-builder/settings--module-blocks--2.jpg) - -::: - -## Configure Module Blocks - -Each module block has the same features and settings as its module counterpart. When you add a module block to the block editor, you can configure the module block in the block settings sidebar _(right-hand side of the block editor)_. diff --git a/beaver-builder/layouts/modules/north-commerce.md b/beaver-builder/layouts/modules/north-commerce.md deleted file mode 100644 index e0244487..00000000 --- a/beaver-builder/layouts/modules/north-commerce.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -id: north-commerce -title: North Commerce -sidebar_label: North Commerce -description: If you have the North Commerce plugin installed, you can use the Beaver Builder North Commerce module to display products in your layouts. ---- - -The North Commerce module is a Beaver Builder module that allows you to display North Commerce products on your website. The module becomes available in the Beaver Builder UI when you have the North Commerce plugin installed. - -:::info - -The North Commerce module utilizes North Commerce shortcodes to showcase various layouts, offering a convenient and straightforward method to present your North Commerce products on your website. This eliminates the need to manually write any shortcodes. - -See the [North Commerce documentation](https://docs.northcommerce.com/north-commerce/shortcodes/product-collections) for more information on shortcodes and how to use them. - -::: - -## General Tab - -The General tab allows you to select the layout of your North Commerce module. - -### Layout - -You can choose from the following display layout options: - -- **None** - No layout is selected. This is the default option. - -- **Product Page** - The Product Page layout displays a single product. - - - **Product Slug** - Enter the product slug to display a specific product. - -- **Product Gallery** - The Product Gallery layout displays a gallery of products. - -- **Product Slider** - The Product Slider layout displays a slider of products. - -- **Checkout** - The Checkout layout displays the North Commerce checkout form. - -- **Cart** - The Cart layout displays the contents of the user's cart. - -## Style Tab - -The Style tab allows you to style the North Commerce module. - -### Button - -- **Style** - Choose the style for the state of the button. This toggle allows you to select the button style for the default and hover states. - - - **Default Style** - The default button style. - - - **Hover Style** - The button style when hovered over. - -- **Text Color** - Choose the color of the button text. - -- **Icon Color** - Choose the color of the button icon. - -- **Background Color** - Choose the background color of the button. - -### Button Border - -The Button Border settings allow you to style the border of the button. When the Hover option is enabled, you can style the button border when hovered over. - -See the [Border](basics/border.md) article for more information on the border settings. - -## Advanced tab - -There are all the usual [**Advanced** tab settings](../advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. \ No newline at end of file diff --git a/beaver-builder/layouts/modules/north-commerce.mdx b/beaver-builder/layouts/modules/north-commerce.mdx new file mode 100644 index 00000000..b5138755 --- /dev/null +++ b/beaver-builder/layouts/modules/north-commerce.mdx @@ -0,0 +1,151 @@ +--- +title: North Commerce +sidebar_label: North Commerce +icon: "shopping-bag" +description: "Use North Commerce to display products, galleries, sliders, cart, and checkout from your North Commerce store." +--- + + +Use North Commerce to display products, galleries, sliders, cart, and checkout from your North Commerce store. + +## Usage + +Use North Commerce to render store content from the North Commerce plugin inside a Beaver Builder layout. The module outputs the North Commerce shortcode that matches the selected layout, which can render a single product page, a product gallery, a product slider, the cart, or the checkout. The module is available only when the North Commerce plugin is active. + +Use this module on storefront pages, landing pages, and templates that need to surface North Commerce content without writing the shortcode by hand. It fits store layouts that mix Beaver Builder rows and modules with native North Commerce flows for browsing products and completing a purchase. + +## Module Settings + +The North Commerce module settings choose which store layout the module renders and style the action button used in the cart and checkout flows. + +### General Tab + +The General tab selects the North Commerce layout to render and the product targeted by a single product page. + +
+Layout Default: None + + +Selects which North Commerce layout the module renders. The selected layout determines which shortcode the module outputs. + +- **None:** Renders nothing. Use this state while configuring the module. +- **Product Page:** Renders a single product page. Reveals the **Product Slug** field for choosing which product to display. +- **Product Gallery:** Renders a grid of products from the North Commerce store. +- **Product Slider:** Renders products in a horizontal slider. +- **Cart:** Renders the North Commerce cart. +- **Checkout:** Renders the North Commerce checkout. + +
+Product Page Settings + + +
+Product Slug + + +The slug of the product to display when **Layout** is set to **Product Page**. When left empty, the shortcode runs without a target product. +
+
+
+ +### Style Tab + +The Style tab controls the appearance of the Add to Cart and checkout action buttons rendered by North Commerce. + +
+Button + + +The Button section controls the colors used for the Add to Cart and checkout action buttons in the default and hover states. + +
+Button settings + + +
+Style Default: Default Style + + +Switches the color controls between the button's default and hover states. + +- **Default Style:** Reveals the **Text Color**, **Icon Color**, **Background Color**, and **Border** controls used in the resting state. +- **Hover Style:** Reveals the **Text Hover Color**, **Icon Hover Color**, and **Background Hover Color** controls used on hover and focus. + +
+ +
+Text Color Supports: Field Connections + + +The text color of the action button in its default state. This field appears when **Style** is set to **Default Style**. +
+ +
+Icon Color Supports: Field Connections + + +The fill color applied to icons inside the action button in its default state. This field appears when **Style** is set to **Default Style**. +
+ +
+Background Color Supports: Field Connections + + +The background color of the action button in its default state. This field appears when **Style** is set to **Default Style**. +
+ +
+Text Hover Color Supports: Field Connections + + +The text color of the action button on hover and focus. This field appears when **Style** is set to **Hover Style**. +
+ +
+Icon Hover Color Supports: Field Connections + + +The fill color applied to icons inside the action button on hover and focus. This field appears when **Style** is set to **Hover Style**. +
+ +
+Background Hover Color Supports: Field Connections + + +The background color of the action button on hover and focus. This field appears when **Style** is set to **Hover Style**. +
+
+
+ +
+Button Border + + +The Button Border section controls the border of the action button in the default and hover states. + +
+Button Border settings + + +
+Border Supports: Responsive + + +The border style, width, radius, and color of the action button. This field appears when **Style** is set to **Default Style**. +
+ +
+Border Hover Color Supports: Field Connections + + +The border color of the action button on hover and focus. +
+
+
+ +
+Advanced tab + +The Advanced tab contains common North Commerce module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/number-counter.md b/beaver-builder/layouts/modules/number-counter.md deleted file mode 100644 index d543705f..00000000 --- a/beaver-builder/layouts/modules/number-counter.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: number-counter -title: Number Counter -sidebar-label: Number Counter -description: The Number Counter module displays a number in an animated fashion, with the counter going from zero to the number or percent you specify. ---- - -The Number Counter module displays a number in an animated fashion, with the counter going from zero to the number or percent you specify. - -You can configure the Number Counter module in many different ways, as you can see in this screenshot with four Number Counter modules. - -![Examples of circle and bar number counters with various labels](/img/number-counter-21086a65.png) - -- You can choose a circle, a horizontal bar, or just the number. -- You can choose the number to be displayed as a percent or standard (an absolute value). -- If you choose standard numbers, you can add a prefix (such as the dollar sign) or a suffix (such as a euro sign) to the number. -- You can add text over or under the number, or neither. -- You can specify colors and typography for the counter and text, and -- You can change the animation speed and delay for the counter, circle, and bar to progress from zero to its number value. - -If you want to compare two or more numbers, add a Number Counter module to display each number, as shown in the screenshot example. Here are the same four Number Counter modules moved into a different layout: - -![Number counters from previous example in a different layout](/img/number-counter-f3441c12.png) - -## Number Counter module settings - -### General tab - -- **Layout** - See the screenshots above for examples of the choices of circles, bars, or only numbers. If you choose **Bars counter**, there's an additional setting for **Number position**: the number can appear inside, above, or below the bar, or be hidden entirely. -- **Number type** - Choose **Percent** or **Standard**. The **Standard** setting means the actual number provided in the next setting. -- **Number** - The number that represents progress so far. -- **Total** - The number that represents the total amount, the goal, and so on. - If you choose **Percent** as the number type, the number is displayed as a percent with a percent symbol following. It's calculated as the value in the **Number** field divided by the number in the **Total** field. - If you choose **Standard** as the number type, the value in the **Number** field is displayed as the number. The progress counter in the circle or bar is shown as the percent of the value in the **Number** field divided by the number in the **Total** field. -- **Text before number** - This setting is to optionally add any text that you want to appear above the number. -- **Text after number** - This setting is to optionally add any text that you want to appear below the number. -- **Number prefix** - This option is only available when the number type is **Standard**. It lets you add a symbol or text immediately before the number with no intervening space, such as **$**. -- **Number suffix** - This option is only available when the number type is **Standard**. It lets you add a symbol or text immediately after the number with no intervening space, such as **€**. - For another example, if your number type is **Standard** and you entered a percent value such as **50** in the **Number** field and **100** in the **Total** field, you could add a **%** symbol here as a suffix. -- **Animation speed** - The number of seconds to reach the **Number** value, shown in the circle, the bar, and the number itself. You can use decimals for partial seconds. -- **Animation delay** - Number of seconds before the animation begins. You can use decimals for partial seconds. - -### Style tab - -The **Style** tab has an unnamed top section with text color and typography settings, and a section with style options for the circle or bar, depending on what you selected for **Layout**. - -#### Top section - -- **Text color** - If you have settings for **Text before number** or **Text after number** on the **General** tab, this setting controls the color of that text. -- **Text typography** - This is the [standard Beaver Builder **Typography** section](basics/typography.md), with settings for the font family, weight, size, spacing, and so on. It applies to the text before or after the number if you have added any. -- **Number color** - The color of the number displayed, plus the color of the optional **Number prefix** or **Number suffix** for **Standard** number types. -- **Number typography** - The standard **Typography** section. - -#### Bar Styles section - -This section appears only when **Layout** on the **General** tab is set to **Bars counter**. - -- **Bar foreground color** - Sets the color of the portion of the bar that indicates the **Number** value. -- **Bar background color** - Sets the color of the portion of the bar that indicates the **Total** value. -- **Bar height** (responsive) - Sets the height of the bar. This number can be varied by device size, using the [responsive settings icon](/beaver-builder/layouts/responsive-design/toggle.md). - -#### Circle Bar Styles section - -This section appears only when **Layout** on the **General** tab is set to **Circle counter**. - -- **Circle size** - Sets the outer diameter of the circle. -- **Circle stroke size** - Sets the width of the stroke. -- **Circle foreground color** - Sets the color of the portion of the circle that indicates the **Number** value. -- **Circle background color** - Sets the color of the portion of the circle not taken up by the foreground circle. - -### Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/numbers.mdx b/beaver-builder/layouts/modules/numbers.mdx new file mode 100644 index 00000000..8fc1b712 --- /dev/null +++ b/beaver-builder/layouts/modules/numbers.mdx @@ -0,0 +1,248 @@ +--- +title: Number Counter +sidebar_label: Number Counter +icon: "tally-5" +description: "Use Number Counter to display an animated number, percentage, circle, or bar that counts up when it scrolls into view." +--- + + +Use Number Counter to display an animated number, percentage, circle, or bar that counts up when it scrolls into view. + +## Usage + +Use Number Counter to render an animated number that counts from a start value to an end value when the module scrolls into view. The module supports three layouts: a plain number, a circular progress indicator, and a horizontal bar. Numbers can display as a percentage or as a standard number with optional prefix and suffix text, and the animation speed and delay are configurable. + +Use Number Counter on landing pages, About pages, statistics sections, and pricing or service pages where animated metrics reinforce a key figure. It fits any layout that needs a single, focused stat such as customer counts, completion rates, satisfaction scores, or fundraising progress. + +## Module Settings + +The Number Counter module settings control the layout, the counter values, the surrounding text, and the appearance of the number, circle, and bar styles. + +### General Tab + +The General tab sets the layout, counter values, surrounding text, and animation timing. + +
+Layout Default: Only Numbers + + +Selects the visual style used for the counter. + +- **Only Numbers:** Renders the animated number on its own with no progress indicator. +- **Circle Counter:** Renders a circular SVG progress ring around the number. +- **Bars Counter:** Renders a horizontal progress bar with the number positioned relative to it. + +
+ +
+Number Position Default: Inside Bar + + +Controls where the number appears relative to the bar. This field is available when **Layout** is set to **Bars Counter**. + +- **Inside Bar:** Places the number inside the progress bar. +- **Above Bar:** Places the number above the bar. +- **Below Bar:** Places the number below the bar. +- **Hidden:** Hides the number and shows only the bar. + +
+ +
+Number Type Default: Percent + + +Selects how the counter value is interpreted and displayed. + +- **Percent:** Treats the value as a percentage and appends a `%` sign automatically. +- **Standard:** Displays the value as a plain number and reveals the **Number Prefix** and **Number Suffix** fields. + +
+ +
+Start Counter Default: 0; Supports: Field Connections + + +The starting value the counter animates from. +
+ +
+End Counter Default: 100; Supports: Field Connections + + +The final value the counter animates to. +
+ +
+Total Units Default: 100; Supports: Field Connections + + +The total number of units used to calculate progress for the **Circle Counter** and **Bars Counter** layouts. For example, if **End Counter** is set to 250 and **Total Units** is set to 500, the counter animates to 50 percent. **Total Units** should not be less than **Start Counter** or **End Counter**. +
+ +
+Text Before Number Supports: Field Connections + + +Optional text displayed above the number. Leave it empty for none. +
+ +
+Text After Number Supports: Field Connections + + +Optional text displayed after the number. Leave it empty for none. +
+ +
+Number Prefix + + +Text inserted directly before the number when **Number Type** is set to **Standard**. For example, use `US$ ` to render values such as `US$ 10`. +
+ +
+Number Suffix + + +Text inserted directly after the number when **Number Type** is set to **Standard**. For example, use `%` to render values such as `10%`. +
+ +
+Animation Speed Default: 1 + + +The number of seconds the counter takes to complete its animation. +
+ +
+Animation Delay Default: 1 + + +The number of seconds to wait before the counter animation starts after the module scrolls into view. +
+ +### Style Tab + +The Style tab controls the colors and typography of the surrounding text and the number, along with the appearance of the circle and bar layouts when they are selected. + +
+Text Color + + +The color applied to the **Text Before Number** and **Text After Number** content. +
+ +
+Text Typography Supports: Responsive + + +The font settings for the **Text Before Number** and **Text After Number** content. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+ +
+Number Color + + +The color applied to the animated number, including any prefix and suffix. +
+ +
+Number Typography Supports: Responsive + + +The font settings for the animated number, including any prefix and suffix. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+ +
+Circle Bar Styles + + +This group is available when **Layout** is set to **Circle Counter**. + +
+Circle Bar Styles + + +
+Circle Size Default: 200 + + +The overall width and height of the circle, in pixels. +
+ +
+Circle Stroke Size Default: 10 + + +The stroke thickness of the circle, in pixels. +
+ +
+Circle Foreground Color Default: #f7951e + + +The color of the active progress portion of the circle. +
+ +
+Circle Background Color Default: #eaeaea + + +The color of the unfilled track behind the circle. +
+
+
+ +
+Bar Styles + + +This group is available when **Layout** is set to **Bars Counter**. + +
+Bar Styles + + +
+Bar Foreground Color Default: #f7951e + + +The color of the active progress portion of the bar. +
+ +
+Bar Background Color Default: #eaeaea + + +The color of the unfilled track behind the bar. +
+ +
+Bar Height Default: 42; Supports: Responsive + + +The height of the bar, in pixels. +
+
+
+ +
+Advanced tab + +The Advanced tab contains common Number Counter module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/photo.mdx b/beaver-builder/layouts/modules/photo.mdx new file mode 100644 index 00000000..9d610a08 --- /dev/null +++ b/beaver-builder/layouts/modules/photo.mdx @@ -0,0 +1,234 @@ +--- +title: Photo +sidebar_label: Photo +icon: "image" +description: "Use Photo to upload an image or display one from the Media Library with cropping, alignment, captions, and link options." +--- + + +Use Photo to upload an image or display one from the Media Library with cropping, alignment, captions, and link options. + +## Usage + +Use Photo to display a single image from the WordPress Media Library or from an external URL. The module outputs a responsive image with optional crop presets, alignment controls, container fill behavior, and an optional caption shown on hover or below the image. It can also wrap the image in a link to a custom URL, a lightbox, the photo file, or a generated photo page. + +Use Photo for hero images, content figures, profile or team headshots, product shots, gallery thumbnails, and any layout that needs a single configurable image with consistent styling. It fits straightforward image placements where you want crop and alignment controls without building a custom HTML block. + +## Module Settings + +The Photo module settings control the image source, link behavior, caption display, and image styling. + +### General Tab + +The General tab sets the photo source, hover title, caption display, and link behavior. + +
+Photo Source Default: Media Library + + +Selects whether the image comes from the WordPress Media Library or an external URL. + +- **Media Library:** Picks an image from the WordPress Media Library. +- **URL:** Loads an image from an external URL. + +
+Media Library Settings + + +
+Photo Supports: Field Connections + + +The image selected from the WordPress Media Library. This field appears when **Photo Source** is set to **Media Library**. +
+
+ +
+URL Settings + + +
+Photo URL Supports: Field Connections + + +The external URL of the image to display. This field appears when **Photo Source** is set to **URL**. +
+ +
+Image title attribute Supports: Field Connections + + +The text used for the image `title` attribute. When left blank, the module uses the image filename. This field appears when **Photo Source** is set to **URL**. +
+
+
+ +
+Show title attribute on mouse hover Default: No + + +Controls whether the image `title` attribute is rendered so browsers display it as a tooltip on hover. + +- **No:** Omits the `title` attribute on the image. +- **Yes:** Renders the `title` attribute so it appears as a hover tooltip. + +
+ +
+Caption + + +The Caption section controls whether a caption is displayed and what text it uses. + +
+Caption Settings + + +
+Show Caption Default: Never + + +Selects when the caption appears. + +- **Never:** Hides the caption. +- **On Hover:** Reveals the caption when the visitor hovers over the image. +- **Below Photo:** Renders the caption beneath the image. + +
+Caption + + +
+Caption Supports: Field Connections + + +The caption text shown with the image. When left blank, the module falls back to the caption stored on the Media Library attachment. This field appears when **Show Caption** is set to **On Hover** or **Below Photo**. +
+
+
+
+
+ +
+Link + + +The Link section controls whether the image is wrapped in a link and where that link points. + +
+Link Settings + + +
+Link Type Default: None + + +Selects how the image is linked when clicked. + +- **None:** Renders the image without a link. +- **URL:** Wraps the image in a custom link. +- **Lightbox:** Opens the image in a lightbox. +- **Photo File:** Links directly to the original image file. +- **Photo Page:** Links to the WordPress attachment page for the image. + +
+Link URL + + +
+Link URL Supports: Field Connections + + +The destination used when **Link Type** is set to **URL**. + +
+Link settings + +Link settings control the URL, link target, nofollow behavior, download behavior, and other link attributes where available. + +
+
+
+ +
+Lightbox Photo Size + + +
+Lightbox Photo Size Default: Large + + +Selects which registered image size is loaded in the lightbox when **Link Type** is set to **Lightbox**. +
+
+
+
+
+ +### Style Tab + +The Style tab controls cropping, sizing, alignment, border, caption typography, and container fill behavior. + +
+Crop + + +Applies a preset aspect ratio to the image. The module generates and caches a cropped copy of the source image. + +- **None:** Uses the original image without cropping. +- **Landscape:** Crops to a wide landscape ratio. +- **Panorama:** Crops to an ultra-wide panoramic ratio. +- **Portrait:** Crops to a tall portrait ratio. +- **Square:** Crops to a 1:1 square. +- **Circle:** Crops to a 1:1 square and renders the image as a circle. + +
+ +
+Width Supports: Responsive + + +Sets the rendered width of the image using `px`, `vw`, or `%`. +
+ +
+Align Default: Center; Supports: Responsive + + +Sets the horizontal alignment of the image within its wrapper. +
+ +
+Border settings + +Border settings control border style, width, color, radius, and related responsive border controls where available. + +
+ +
+Caption Typography Supports: Responsive + + +The font settings for the caption text. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+ +
+Fill Container + + +Controls how the image fits and positions itself when the wrapper has a fixed width and height. Uses CSS `object-fit` and `object-position` so the image can fill the container without distortion. +
+ +
+Advanced tab + +The Advanced tab contains common Photo module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/photo/add-hover-effects-to-the-photo-module.md b/beaver-builder/layouts/modules/photo/add-hover-effects-to-the-photo-module.md deleted file mode 100644 index cf05d6b4..00000000 --- a/beaver-builder/layouts/modules/photo/add-hover-effects-to-the-photo-module.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -id: add-hover-effects-to-the-photo-module -title: Add hover effects to the Photo module -sidebar_label: Add hover effects to the Photo module -description: Here's how to add cool hover effects to Photo module images. ---- - -Using a custom class and some custom CSS, you can add some really cool hover -effects to images. - -
- -
- -1. Add a [Photo module](/beaver-builder/layouts/modules/photo/photo.md) to your page. -2. Configure the Photo module as you normally would. -3. Click the **Advanced** Tab -4. In the **HTML element** section, add one of the following values to the **Class** field, depending on which effect you want. See the description of each effect in the sections below. - - - Hover Zoom In: `hover-zoom-in` - - Hover Zoom Out: `hover-zoom-out` - - Hover Zoom Out and Rotate: `hover-zoom-out-rotate` - - Hover Unblur: `hover-unblur` - - Grayscale to Color: `gray-scale-img` - - Sepia to Color: `sepia-img` - -5. Add the CSS for the effect wherever you put your custom CSS. - Copy the CSS for the effect you want from one of the following sections and see [this article](basics/custom-code.md) about where to add custom CSS code. - -:::tip -If you have multiple Photo modules in a row and want to apply an effect to the entire set, add the effect’s CSS to the **Class** field on the **Advanced** tab in the row settings rather than the Photo module settings. The effect will apply to every Photo module contained in the row. -::: - -## CSS for hover effects - -:::info -The transition speeds in these CSS examples are set to `.3s`. You can change the -value to speed up or slow down the effect. For example, `1s` will slow the -change. -::: - -### Hover Zoom In - -This effect adds a smooth zoom effect when you hover over the image. - -```css -/* Zoom in on hover */ -.hover-zoom-in .fl-photo-content { - overflow: hidden; -} -.hover-zoom-in .fl-photo-content .fl-photo-img { - -webkit-transition: 0.3s ease-in-out; - transition: 0.3s ease-in-out; - will-change: transform; -} -.hover-zoom-in .fl-photo-content .fl-photo-img:hover { - -webkit-transition: 0.3s ease-in-out; - transition: 0.3s ease-in-out; - -webkit-transform: scale(1.3); - transform: scale(1.3); -} -``` - -### Hover Zoom Out - -This effect adds a smooth zoom out effect when you hover over the image. - -```css -/* Zoom out on hover*/ -.hover-zoom-out .fl-photo-content { - overflow: hidden; -} -.hover-zoom-out .fl-photo-content .fl-photo-img { - -webkit-transition: 0.3s ease-in-out; - transition: 0.3s ease-in-out; - -webkit-transform: scale(1.3); - transform: scale(1.3); - will-change: transform; -} -.hover-zoom-out .fl-photo-content .fl-photo-img:hover { - -webkit-transition: 0.3s ease-in-out; - transition: 0.3s ease-in-out; - -webkit-transform: scale(1); - transform: scale(1); -} -``` - -### Hover Zoom Out and Rotate - -This effect shows the image zoomed in and rotated 45 degrees in its default -state and adds a smooth zoom out and rotates to upright when you hover over -the image. - -```css -/* Zoom out & rotate on hover */ -.hover-zoom-out-rotate .fl-photo-content { - overflow: hidden; -} -.hover-zoom-out-rotate .fl-photo-content .fl-photo-img { - -webkit-transform: rotate(15deg) scale(1.4); - transform: rotate(15deg) scale(1.4); - -webkit-transition: 0.3s ease-in-out; - transition: 0.3s ease-in-out; - will-change: transform; -} -.hover-zoom-out-rotate .fl-photo-content .fl-photo-img:hover { - -webkit-transform: rotate(0) scale(1); - transform: rotate(0) scale(1); -} -``` - -### Hover Unblur - -This effect displays the image in a blurred state and unblurs it on hover. - -```css -/* Unblur on hover */ -.hover-unblur .fl-photo-content { - overflow: hidden; - -webkit-backface-visibility: hidden; -} -.hover-unblur .fl-photo-content .fl-photo-img { - -webkit-filter: blur(3px); - filter: blur(3px); - -webkit-transition: 0.3s ease-in-out; - transition: 0.3s ease-in-out; - will-change: filter; -} -.hover-unblur .fl-photo-content .fl-photo-img:hover { - -webkit-filter: blur(0); - filter: blur(0); -} -``` - -### Grayscale to Color - -This effect displays the image in grayscale and brings the color back on -hover. - -```css -/* Grayscale To Color */ -.gray-scale-img .fl-photo-content { - overflow: hidden; - -webkit-backface-visibility: hidden; -} -.gray-scale-img .fl-photo-content .fl-photo-img { - -webkit-filter: grayscale(100%); - filter: grayscale(100%); - -webkit-transition: 0.3s ease-in-out; - transition: 0.3s ease-in-out; - will-change: filter; -} -.gray-scale-img .fl-photo-content .fl-photo-img:hover { - -webkit-filter: grayscale(0); - filter: grayscale(0); -} -``` - -### Sepia to Color - -This effect displays the image in sepia tones and brings the color back on -hover. - -```css -/* Sepia To Color */ -.sepia-img .fl-photo-content { - overflow: hidden; - -webkit-backface-visibility: hidden; -} -.sepia-img .fl-photo-content .fl-photo-img { - -webkit-filter: sepia(100%); - filter: sepia(100%); - -webkit-transition: 0.3s ease-in-out; - transition: 0.3s ease-in-out; - will-change: filter; -} -.sepia-img .fl-photo-content .fl-photo-img:hover { - -webkit-filter: sepia(0); - filter: sepia(0); -} -``` diff --git a/beaver-builder/layouts/modules/photo/display-full-captions-under-photos.md b/beaver-builder/layouts/modules/photo/display-full-captions-under-photos.md deleted file mode 100644 index bdb24e13..00000000 --- a/beaver-builder/layouts/modules/photo/display-full-captions-under-photos.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: display-full-captions-under-photos -title: Display full captions under photos -sidebar_label: Display full captions under photos -description: Here's how to avoid captions under images getting truncated in the Photo or Gallery module. ---- - -By default, if you display captions in the Photo or Gallery module, the -caption is cut off at the first line with an ellipsis mark. This happens -whether the caption is set to **On hover** or **Below photo**. - -![](/img/how-to-tips-display-full-caption-1.jpg) - -If you display the caption below the photo, you can use the following CSS -snippet to display the full caption. See [this article](basics/custom-code.md) about where to add custom CSS code. - -```css -.fl-photo-caption.fl-photo-caption-below { - text-overflow: initial; - white-space: normal; -} -``` - -Now you'll get the full caption, and it will wrap as the screen is sized down: - -![](/img/how-to-tips-display-full-caption-2.jpg) diff --git a/beaver-builder/layouts/modules/photo/photo.md b/beaver-builder/layouts/modules/photo/photo.md deleted file mode 100644 index 233752c3..00000000 --- a/beaver-builder/layouts/modules/photo/photo.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: photo -title: Photo -sidebar-label: Photo module -description: The Photo module displays individual photos from your WordPress Media Library or a custom URL and style options such as cropping, borders, and shadows. ---- - -The Photo module lets you insert an individual photo from your WordPress Media -Library or a custom URL. - -![](/img/photo-module-1.png) - -Here are some of the options with the Photo module: - -* You can select the photo from your Media Library or use a URL. If the file is from the Media Library, you can select the size of the photo to display. - -* You can crop the photo into several geometric shapes: Landscape, Panorama (longer and shorter than landscape), Portrait, Square, Circle. - - :::info - Cropping will cut off parts of your photo, depending on the shape of - the original photo and the shape of the crop. - ::: - -* You can specify the alignment of the photo within the column: left, center, or right. If you display a caption, both the photo and the caption will be aligned according to this selection. - -* You can display the caption of the image and specify how and where the caption appears in relation to the photo: on hover (appearing at the inside bottom of the photo) or below the photo. If you're getting the photo from an external URL, there's a field for you to enter a caption. - - :::note **Note:** - Longer captions are truncated at the end of the first line. See [this article](/beaver-builder/layouts/modules/photo/display-full-captions-under-photos.md) for how to display the full caption. - ::: - -* You can add a link to the photo, with several choices of where the link goes: - * A URL, for example, to another web page. - * A lightbox - A popup where the photo appears in a dark background over the page. If you've - set the **Show caption** field to **On hover** or **Below photo**, the - caption will appear below the photo in the lightbox in both cases. - ![](/img/photo-module-2.jpg) - - * Photo file - The photo file is displayed by itself. - ![](/img/photo-module-3.jpg) - - * Photo page (for Media Library photos only) - The photo is displayed with the header, footer, and sidebar of the website. - ![](/img/photo-module-4.jpg) - -* There are the standard Advanced tab features: margins, animation, and showing/hiding on particular device sizes. - -:::tip **Tip** -It's a best practice to keep photos to the exact size that you need. -Although the photos are automatically sized to fit your display, a larger -photo increases page open time. -::: - -## Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/popup.mdx b/beaver-builder/layouts/modules/popup.mdx new file mode 100644 index 00000000..f17391ca --- /dev/null +++ b/beaver-builder/layouts/modules/popup.mdx @@ -0,0 +1,420 @@ +--- +title: Popup +sidebar_label: Popup +icon: "picture-in-picture-2" +description: "Use Popup to build dialogs, popovers, and flyouts that overlay page content with configurable triggers, scheduling, and dismiss behavior." +--- + + +Use Popup to build dialogs, popovers, and flyouts that overlay page content with configurable triggers, scheduling, and dismiss behavior. + +## Usage + +The Popup module renders a container using the HTML Popover API, creating a dialog, popover, or flyout that appears over page content. You add any Beaver Builder content inside it — text, images, forms, or other modules — and control when it opens through automatic triggers such as a time delay, scroll depth, or exit intent, or by linking an anchor element or Invoker Command to its Popup ID. + +Use the Popup module to build newsletter opt-ins, promotional overlays, confirmation dialogs, video players, or side drawers that appear at the right moment in the visitor's session. + +:::note + +The Popup module relies on the HTML Popover API, which is supported in all current major browsers. Visitors using significantly outdated browser versions may not see the popup correctly. +::: + +## Module Settings + +The Popup module settings control the popup ID, automatic trigger behavior, active dates, dismiss options, and visual appearance. + +### General Tab + +The General tab sets the popup ID, trigger conditions, scheduling dates, and how visitors dismiss the popup. + +
+Trigger + + +The Trigger section sets the popup ID and controls when the popup opens automatically. + +
+Trigger Settings + + +
+Popup ID + + +Sets a custom ID for the popup element. Use this ID to open the popup with an anchor link (for example, `#my-popup-id`) or with an Invoker Command. The ID must be unique and must not contain spaces. When left empty, a unique ID is generated automatically. + +:::note + +If you leave this field empty, Beaver Builder generates an ID automatically using the format `fl-popup-` followed by a unique string it assigns to each module instance, for example `fl-popup-3a8f21bc`. Because the generated ID is not predictable, set a custom ID whenever you need to open this popup from a button, link, or other element. +::: +
+ +
+Show On + + +Selects when the popup appears automatically. Multiple options can be active at the same time. When no options are selected, the popup only opens when triggered directly via its ID. + +- **Delay:** Opens the popup after the set number of seconds. Setting the delay to `0` shows the popup as soon as the page loads. +- **Scroll:** Opens the popup when the visitor has scrolled the set percentage of the page. Values of `0%` have no effect — the scroll trigger only activates for values above `0%`. +- **Exit:** Opens the popup when the visitor moves their cursor toward the top of the browser window, which typically indicates they are about to switch tabs or navigate away. The exit trigger fires once per page load. + +When multiple triggers are selected, the popup opens as soon as any one condition is met. The remaining triggers do not fire after the popup has already been shown. + +
+Automatic Trigger Settings + + +
+Show Delay (Delay Only) Default: 0 + + +Sets the number of seconds to wait before showing the popup. This field appears when **Show On** includes **Delay**. +
+ +
+Show on Percent Scrolled (Scroll Only) Default: 0 + + +Sets the percentage of the page the visitor must scroll before the popup appears. This field appears when **Show On** includes **Scroll**. +
+ +
+Show Once Default: Disabled + + +Prevents the popup from appearing again after it has already been shown. This field appears when any automatic trigger is active. + +- **Per User:** Shows the popup once and sets a browser cookie to prevent it appearing again. The popup can reappear if the visitor clears their cookies or visits from a different browser or device. +- **Per Session:** Shows the popup once per browser session using session storage. The session clears when the visitor closes the tab or browser window, so the popup may appear again on their next visit. +- **Disabled:** Shows the popup every time the trigger condition is met, on every page load. + +
+
+
+
+
+ +
+Schedule + + +The Schedule section limits when the popup is active based on date. + +
+Schedule Settings + + +
+Show Start Date Supports: Field Connections + + +Sets the date from which the popup begins displaying. Leave empty to show the popup immediately. +
+ +
+Show End Date Supports: Field Connections + + +Sets the date after which the popup stops displaying. Leave empty to show the popup indefinitely. +
+
+
+ +
+Dismiss + + +The Dismiss section controls how visitors close the popup. + +
+Dismiss Settings + + +
+Close on ESC/Click Outside Default: Disabled + + +Enables or disables closing the popup by pressing the Escape key or clicking outside the popup container. + +- **Enabled:** Closes the popup when the visitor presses Escape or clicks outside the popup. +- **Disabled:** Keeps the popup open unless the visitor uses the close button or another dismiss action. + +
+ +
+Close Button Default: Enabled + + +Shows or hides the built-in close button inside the popup. + +- **Enabled:** Renders a close button inside the popup. +- **Disabled:** Removes the close button from the popup. + +
+
+
+ +
+Loop Options + + +The Loop Options section controls navigation between popup instances when the Popup is placed inside a Loop module. + +
+Loop Options Settings + + +
+Loop Navigation Arrows Default: Enabled + + +Shows or hides the previous and next navigation arrows that let visitors move between popup instances rendered by a Loop module. When enabled, the arrows can be styled in the **Loop Navigation Arrows** section on the Style tab. + +- **Enabled:** Renders the loop navigation arrows. +- **Disabled:** Removes the loop navigation arrows. + +
+
+
+ +### Style Tab + +The Style tab controls the popup's position, dimensions, background, border, close button appearance, and loop navigation arrows. + +
+Sizing & Placement + + +The Sizing & Placement section sets where the popup appears on the screen and its dimensions. + +
+Sizing & Placement Settings + + +
+Position Default: Center + + +Sets where the popup appears on the screen. + +- **Center:** Centers the popup on both axes. +- **Center Left:** Centers the popup vertically on the left edge. +- **Center Right:** Centers the popup vertically on the right edge. +- **Top Left:** Places the popup in the top-left corner. +- **Top Center:** Centers the popup horizontally at the top. +- **Top Right:** Places the popup in the top-right corner. +- **Bottom Left:** Places the popup in the bottom-left corner. +- **Bottom Center:** Centers the popup horizontally at the bottom. +- **Bottom Right:** Places the popup in the bottom-right corner. + +
+ +
+Width & Height Default: 500px, 100%, & 200px; Supports: Responsive + + +Sets the width, max-width, min-height, height, max-height, and min-width of the popup container. Defaults to a width of 500px, a max-width of 100%, and a min-height of 200px. +
+ +
+Padding Supports: Responsive, Link Values + + +Sets the inner spacing of the popup container. +
+
+
+ +
+Appearance + + +The Appearance section controls the popup background, backdrop overlay, and border. + +
+Appearance Settings + + +
+Background settings + +Background settings control background type, color, image, gradient, overlay, and related responsive background options where available. + +
+ +
+Backdrop Default: rgba(171, 183, 196, 0.3); Supports: Responsive + + +Sets the background style of the overlay layer shown behind the popup. +
+ +
+Border settings + +Border settings control border style, width, color, radius, and related responsive border controls where available. + +
+
+
+ +
+Close Button + + +The Close Button section controls the appearance of the built-in close button. These settings apply when **Close Button** is set to **Enabled** in the General tab. + +
+Close Button Settings + + +
+Button Type Default: Icon + + +Sets whether the close button displays an icon or a text label. + +- **Icon:** Renders the close button as an icon. +- **Text:** Renders the close button as a text label. + +
+Icon Settings + + +
+Button Icon Supports: Field Connections + + +Sets the icon used for the close button when **Button Type** is set to **Icon**. When left empty, a default × icon is used. +
+
+ +
+Text Settings + + +
+Button Text Default: Close + + +Sets the text label used for the close button when **Button Type** is set to **Text**. +
+
+
+ +
+Button Attachment Default: Popup; Supports: Responsive + + +Controls whether the close button is positioned relative to the popup container or the browser window. + +- **Popup:** Positions the close button relative to the popup container. +- **Window:** Positions the close button relative to the browser window, keeping it visible even when the popup is taller than the viewport. + +
+ +
+Button Position Supports: Responsive, Link Values + + +Sets the top, right, bottom, and left offset of the close button. Defaults to −45px from the top and right edges. +
+ +
+Button Padding Supports: Responsive, Link Values + + +Sets the inner spacing of the close button. Defaults to 5px on all sides. +
+ +
+Button Size Default: 40; Supports: Responsive + + +Sets the width and height of the close button icon, or the font size when **Button Type** is set to **Text**. +
+ +
+Button Color Default: #333333; Supports: Responsive, Field Connections + + +Sets the icon fill color or text color of the close button. +
+ +
+Button Background Supports: Responsive, Field Connections + + +Sets the background color of the close button. +
+ +
+Border settings + +Border settings control border style, width, color, radius, and related responsive border controls where available. + +
+
+
+ +
+Loop Navigation Arrows + + +The Loop Navigation Arrows section styles the previous and next navigation buttons rendered when a Popup is placed inside a Loop module. Each loop item gets its own popup instance. The navigation arrows let visitors move between those popups without closing and reopening each time. + +For example, you can build a grid of blog post cards where each card has a "Read more" button that opens the full post content in a popup. Once a popup is open, the previous and next arrows let visitors cycle through the other posts without closing the popup. + +:::tip + +When the popup is placed inside a loop, include the current post ID in the [Popup ID value](#param-popup-id), such as `my-popup-[wpbb post:id]`, so each popup instance stays unique. +::: + +
+Loop Navigation Arrow Settings + + +
+Horizontal Offset Default: 0; Supports: Responsive + + +Sets the horizontal distance of the previous and next arrow buttons from the popup edges. +
+ +
+Button Size Default: 42; Supports: Responsive + + +Sets the width and height of each navigation arrow button. +
+ +
+Icon Color Default: #333333; Supports: Responsive, Field Connections + + +Sets the icon color of the navigation arrow buttons. +
+ +
+Button Background Supports: Responsive, Field Connections + + +Sets the background color of the navigation arrow buttons. +
+ +
+Button Border Supports: Responsive + + +Configures the border style, width, radius, and color of the navigation arrow buttons. +
+
+
+ +
+Advanced tab + +The Advanced tab contains common Popup module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/post-carousel.mdx b/beaver-builder/layouts/modules/post-carousel.mdx new file mode 100644 index 00000000..6e74f382 --- /dev/null +++ b/beaver-builder/layouts/modules/post-carousel.mdx @@ -0,0 +1,678 @@ +--- +title: Posts Carousel +sidebar_label: Posts Carousel +icon: "gallery-horizontal" +description: "Use Posts Carousel to display a sliding carousel of WordPress posts with configurable layout, content, and slider controls." +--- + + +Use Posts Carousel to display a sliding carousel of WordPress posts with configurable layout, content, and slider controls. + +## Usage + +Use Posts Carousel to display queried WordPress posts in a horizontal sliding carousel built on bxSlider. The module renders each post as a slide that can include the featured image, post title, post info such as author and date, post content or excerpt, an optional more link, and an optional icon. Slider behavior, autoplay, transition direction, navigation arrows, dots, and play/pause controls are all configured per instance. + +Use Posts Carousel on home pages, blog landing pages, and template parts that need to surface multiple posts in a compact area. It fits featured-content sections, related-post strips, product or portfolio highlights driven by a custom post type, and any layout where a static grid takes up too much space. + +## Module Settings + +The Posts Carousel module settings control the slider behavior, the post query, the layout of each slide, and the styling of the carousel items, text, and navigation arrows. + +### Slider Tab + +The Slider tab configures the carousel layout, autoplay, transition behavior, and slider controls. + +
+Layout Default: Grid + + +Selects the visual layout used for each slide. + +- **Grid:** Renders each post as a card with the featured image, title, info, and content stacked. This layout exposes the **Content** section, **Post Content** style section, and **More Link** style section. +- **Gallery:** Overlays the post title and info on top of the featured image with a hover transition. This layout exposes the **Icons** section and the **Post Hover Transition** field. + +
+ +
+Auto Play Default: Yes + + +Starts the carousel automatically on page load. Options are **Yes** and **No**. +
+ +
+Loop Default: No + + +Continues the carousel from the first slide after the last slide. Options are **Yes** and **No**. +
+ +
+Delay Default: 5 + + +The delay between slide transitions, in seconds. +
+ +
+Transition Direction Default: Right To Left + + +Sets the direction the carousel slides. + +- **Right To Left:** Advances slides toward the left. +- **Left To Right:** Advances slides toward the right. + +
+ +
+Transition Speed Default: 1 + + +The duration of the transition animation between slides, in seconds. +
+ +
+Slider Controls + + +The Slider Controls section configures the navigation elements shown with the carousel. + +
+Slider Controls + + +
+Show Dots Default: Yes + + +Shows or hides the pagination dots beneath the carousel. +
+ +
+Show Arrows Default: No + + +Shows or hides the previous and next arrows on the sides of the carousel. Setting this to **Yes** reveals the **Nav Arrows** section in the Style tab. +
+ +
+Show Play/Pause Default: No + + +Shows or hides a play and pause control for the carousel. +
+
+
+ +### Layout Tab + +The Layout tab controls how many posts appear, how each slide is sized and spaced, and what content each slide includes. + +
+Posts + + +The Posts section controls the number of slides, slide sizing, and the per-slide hover transition used for the **Gallery** layout. + +
+Posts + + +
+Number of Posts Default: 10 + + +The total number of posts to load into the carousel. +
+ +
+Number of Posts to Move Default: 1 + + +The number of slides advanced on each transition. +
+ +
+Post Max Width Default: 300 + + +The maximum width of each slide, in pixels. +
+ +
+Post Spacing Default: 30 + + +The horizontal space between slides, in pixels. +
+ +
+Equalize Column Heights (Grid Only) Default: No + + +Forces all visible slides to share the same height. This field appears when **Layout** is set to **Grid**. +
+ +
+Post Hover Transition (Gallery Only) Default: Fade + + +The animation used when hovering each slide in the **Gallery** layout. + +- **Fade:** Fades the overlay in on hover. +- **Slide Up:** Slides the overlay up into view. +- **Slide Down:** Slides the overlay down into view. +- **Scale Up:** Scales the overlay up into view. +- **Scale Down:** Scales the overlay down into view. + +
+
+
+ +
+Featured Image + + +The Featured Image section controls whether each slide displays the post's featured image and how the image is sized and cropped. + +
+Featured Image + + +
+Image Default: Show + + +Shows or hides the featured image on each slide. Setting this to **Show** reveals the **Size** and **Crop** fields. + +
+Image Settings + + +
+Size Default: medium + + +The registered WordPress image size used for the featured image. +
+ +
+Crop Default: Landscape + + +The crop ratio applied to the featured image. + +- **None:** Uses the original aspect ratio from the selected size. +- **Landscape:** Crops to a wide landscape ratio. +- **Panorama:** Crops to a wider panoramic ratio. +- **Portrait:** Crops to a tall portrait ratio. +- **Square:** Crops to a 1:1 square. +- **Circle:** Crops to a 1:1 square and applies a circular mask. + +
+
+
+
+
+ +
+Icons (Gallery Only) + + +The Icons section adds an optional icon to each slide. This section appears when **Layout** is set to **Gallery**. + +
+Icons + + +
+Use Icon for Posts Default: No + + +Shows or hides an icon on each slide. Setting this to **Yes** reveals the icon configuration fields. + +
+Icon Settings + + +
+Post Icon Supports: Field Connections + + +The icon displayed on each slide. +
+ +
+Post Icon Position Default: Above Text + + +The position of the icon relative to the post text. + +- **Above Text:** Places the icon above the title and info. +- **Below Text:** Places the icon below the title and info. + +
+ +
+Post Icon Size Default: 24 + + +The size of the icon, in pixels. +
+
+
+
+
+ +
+Post Info + + +The Post Info section controls the author and date metadata shown on each slide. + +
+Post Info + + +
+Author Default: Show + + +Shows or hides the post author on each slide. +
+ +
+Date Default: Show + + +Shows or hides the post date on each slide. Setting this to **Show** reveals the **Date Format** field. + +
+Date Format + + +
+Date Format Default: Default + + +The format used for the post date. **Default** uses the WordPress site date format. The remaining options are PHP date formats such as `M j, Y`, `F j, Y`, `m/d/Y`, `m-d-Y`, `d M Y`, `d F Y`, `Y-m-d`, and `Y/m/d`. +
+
+
+
+
+ +
+Content (Grid Only) + + +The Content section controls the post content and more link shown on each slide. This section appears when **Layout** is set to **Grid**. + +
+Content + + +
+Content Default: Hide + + +Shows or hides the post excerpt on each slide. Setting this to **Show** reveals the **Content Length** field and the **Post Content** section in the Style tab. + +
+Content Length + + +
+Content Length + + +The maximum number of words shown in the excerpt. Leave empty to use the WordPress default excerpt length. +
+
+
+ +
+More Link Default: Hide + + +Shows or hides a read-more link below the excerpt. Setting this to **Show** reveals the **More Link Text** field and the **More Link** section in the Style tab. + +
+More Link Text + + +
+More Link Text Default: Read More + + +The text displayed on the more link. +
+
+
+
+
+ +### Style Tab + +The Style tab controls colors and typography for the slide background, post title, post info, post content, more link, and navigation arrows. + +
+Carousel Item + + +The Carousel Item section sets the slide background and the icon colors used in the **Gallery** layout. + +
+Carousel Item + + +
+Background Color Default: #ffffff; Supports: Field Connections + + +The color applied to the overlay behind the text on each slide. +
+ +
+Icon Color (Gallery Only) Supports: Field Connections + + +The color of the post icon. This field appears when **Layout** is set to **Gallery** and **Use Icon for Posts** is set to **Yes**. +
+ +
+DuoTone Icon Primary Color Supports: Field Connections + + +For Font Awesome DuoTone icons only: the primary color applied to the icon. +
+ +
+DuoTone Icon Secondary Color Supports: Field Connections + + +For Font Awesome DuoTone icons only: the secondary color applied to the icon. +
+
+
+ +
+Post Title + + +The Post Title section styles the post title text on each slide. + +
+Post Title + + +
+Color Supports: Field Connections + + +The color of the post title. +
+ +
+Hover Color (Grid Only) Supports: Field Connections + + +The color of the post title on hover and focus. This field appears when **Layout** is set to **Grid**. +
+ +
+Typography Supports: Responsive + + +The font settings for the post title. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Post Info + + +The Post Info section styles the author and date text on each slide. + +
+Post Info + + +
+Color Supports: Field Connections + + +The color of the post info text. +
+ +
+Link Color (Grid Only) Default: #cccccc; Supports: Field Connections + + +The color of links inside the post info, such as the author link. This field appears when **Layout** is set to **Grid**. +
+ +
+Link Hover Color (Grid Only) Default: #ffffff; Supports: Field Connections + + +The color of post info links on hover and focus. This field appears when **Layout** is set to **Grid**. +
+ +
+Typography Supports: Responsive + + +The font settings for the post info text. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Post Content (Grid Only) + + +The Post Content section styles the excerpt text on each slide. This section appears when **Layout** is set to **Grid** and **Content** is set to **Show**. + +
+Post Content + + +
+Color Supports: Field Connections + + +The color of the post content text. +
+ +
+Link Color Supports: Field Connections + + +The color of links inside the post content. +
+ +
+Link Hover Color Supports: Field Connections + + +The color of post content links on hover and focus. +
+ +
+Typography Supports: Responsive + + +The font settings for the post content text. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+More Link (Grid Only) + + +The More Link section styles the read-more link on each slide. This section appears when **Layout** is set to **Grid** and **More Link** is set to **Show**. + +
+More Link + + +
+Color Supports: Field Connections + + +The color of the more link text. +
+ +
+Hover Color Supports: Field Connections + + +The color of the more link on hover and focus. +
+ +
+Typography Supports: Responsive + + +The font settings for the more link text. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Nav Arrows + + +The Nav Arrows section styles the previous and next arrow controls. This section appears when **Show Arrows** is set to **Yes** in the Slider tab. + +
+Nav Arrows + + +
+Arrows Background Color Supports: Field Connections + + +The background color of the arrow controls. +
+ +
+Arrows Background Style Default: Circle + + +The shape used behind each arrow. + +- **Circle:** Renders the arrow background as a circle. +- **Square:** Renders the arrow background as a square. + +
+ +
+Arrows Color Supports: Field Connections + + +The color of the arrow icons. +
+
+
+ +### Query Tab + +The Query tab configures the data source used to populate the carousel. + +
+Source Default: Custom Query + + +Selects whether the carousel runs its own query or inherits the main page query. + +- **Custom Query:** Builds a query inside the module using the **Custom Query** and **Filter** sections below. +- **Main Query:** Reuses the main WordPress query for the current page, such as an archive or search results page. + +
+ +
+Custom Query + + +The Custom Query section configures the query used when **Source** is set to **Custom Query**. + +
+Custom Query + + +
+Post Type Default: Post + + +Selects one or more post types to query for the carousel. +
+ +
+Ordering settings + +Ordering settings control how queried posts or items are sorted, such as by date, title, menu order, or custom ordering options where available. + +
+ +
+Offset Default: 0 + + +Skips the specified number of posts that match the query before returning results. +
+ +
+Exclude Current Post Default: No + + +Excludes the post being viewed from the carousel results. Useful in single templates that show related posts. +
+ +
+Filtering settings + +Filtering settings control which posts, terms, authors, or content types are included or excluded from the module output. + +
+
+
+ +
+Advanced tab + +The Advanced tab contains common Posts Carousel module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/post-grid.mdx b/beaver-builder/layouts/modules/post-grid.mdx new file mode 100644 index 00000000..c6715c5a --- /dev/null +++ b/beaver-builder/layouts/modules/post-grid.mdx @@ -0,0 +1,1001 @@ +--- +title: Posts +sidebar_label: Posts +icon: "layout-grid" +description: "Use Posts to display a queried list of WordPress posts in columns, masonry, gallery, or list layouts with full control over content, style, and pagination." +--- + + +Use Posts to display a queried list of WordPress posts in columns, masonry, gallery, or list layouts with full control over content, style, and pagination. + +## Usage + +Use Posts to render queried WordPress content as a grid, masonry layout, image gallery, or vertical list. The module wires WordPress query controls to a configurable layout, exposes the featured image, post info, terms, and excerpt or full content per post, and supports paginated, infinite scroll, or load-more navigation. + +Use Posts on blog index pages, archive replacements, related-content sections, taxonomy landing pages, portfolio galleries, and singular templates that surface secondary content. It fits any layout that needs a flexible loop driven by post type, taxonomy, author, or custom field criteria. + +## Module Settings + +The Posts module settings control the loop layout, the featured image and post meta that appear, the visual styling of cards and text, the underlying query, and the pagination behavior at the bottom of the list. + +### Layout Tab + +The Layout tab selects the overall layout style and configures the post container, featured image, post info, terms, and content for each item. + +
+Layout Default: Masonry + + +Sets the overall layout used to render the loop. Each option exposes its own dedicated styling and posts settings. + +- **Columns:** Renders posts in equal-width, fixed-column rows. +- **Masonry:** Renders posts in a flexible grid with variable item heights. +- **Gallery:** Renders only featured images with a hover overlay. +- **List:** Renders posts in a single vertical stack with optional left or right images. + +
+ +
+Posts + + +The Posts section controls the per-item dimensions, spacing, container element, and title heading tag. Available when **Layout** is **Columns**, **Masonry**, or **List**. + +
+Posts settings + + +
+Equal Heights (Columns Only) Default: No; Supports: Responsive + + +Forces every post in the same row to share the tallest item's height. Available when **Layout** is **Columns**. +
+ +
+Post Width (Masonry Only) Default: 300 + + +Sets the target column width in pixels for each post tile. Available when **Layout** is **Masonry**. +
+ +
+Columns (Columns Only) Default: 3; Supports: Responsive + + +Sets the number of columns rendered per row. Available when **Layout** is **Columns**. Default values per breakpoint are 3 (default), 3 (large), 2 (medium), and 1 (responsive). +
+ +
+Post Spacing (Columns and Masonry Only) Default: 60 + + +Sets the gap in pixels between posts. Available when **Layout** is **Columns** or **Masonry**. +
+ +
+Post Spacing (List Only) Default: 40 + + +Sets the bottom margin in pixels between posts. Available when **Layout** is **List**. +
+ +
+Post Padding (Columns and Masonry Only) Default: 20 + + +Sets the inner padding in pixels around each post's text content. Available when **Layout** is **Columns** or **Masonry**. +
+ +
+Post Padding (List Only) Default: 0 + + +Sets the inner padding in pixels for each post in a List layout. Available when **Layout** is **List**. +
+ +
+Posts Element Default: <li>(unwrapped in divs) + + +Selects the HTML5 element used for each post item to improve accessibility and machine readability. + +- **\:** Renders each post inside a generic `div` element. +- **\:** Renders each post inside an `article` element, the most semantically appropriate option for blog content. +- **\(wrapped in divs):** Renders each post as an `li` element wrapped inside container `div` elements. +- **\(unwrapped in divs):** Renders each post as an `li` element without the additional wrapping `div` elements. + +
+Posts Element Class for UL + + +
+Posts Element Class for UL + + +Adds a custom CSS class to the parent `ul` element. This field appears when **Posts Element** is set to **\(unwrapped in divs)**. +
+
+
+ +
+Posts Element Class Supports: Field Connections + + +Adds a custom CSS class to each post element. +
+ +
+Posts Title Tag Default: <h2> + + +Selects the heading tag used for each post title. Options are `

`, `

`, `

`, `

`, `

`, `
`, and `

`. +

+
+
+ +
+Featured Image + + +The Featured Image section controls whether the featured image is rendered, where it sits relative to the post content, its size and dimensions, and the fallback used when a post has no thumbnail. + +
+Featured Image settings + + +
+Image Default: Show + + +Shows or hides the featured image for each post. +
+ +
+Image Position (Columns and Masonry Only) Default: Above Title + + +Places the image above the title or above the rest of the content for **Columns** and **Masonry** layouts. + +- **Above Title:** Renders the image above the post title. +- **Above Content:** Renders the image above the content but below the title. + +
+ +
+Image Position (List Only) Default: Above Content + + +Places the image relative to the post text in a **List** layout. + +- **Above Title:** Renders the image above the post title. +- **Above Content:** Renders the image above the content but below the title. +- **Left:** Floats the image to the left of the entire post. +- **Left Content:** Floats the image to the left of the content only. +- **Right:** Floats the image to the right of the entire post. +- **Right Content:** Floats the image to the right of the content only. + +
+Image Width + + +
+Image Width (Beside Layout Only) Default: 33 + + +Sets the percentage of the post width that the image occupies. Appears when **Image Position** is **Left**, **Left Content**, **Right**, or **Right Content**. +
+
+
+ +
+Image Size Default: medium + + +Selects the registered WordPress image size used to render the featured image. +
+ +
+Equal Height Image Default: Disabled + + +Normalizes featured image dimensions across posts. + +- **Disabled:** Uses the natural dimensions of each image. +- **Fixed Height:** Forces every image to the height set in **Image Height**. +- **Aspect Ratio:** Forces every image to a CSS aspect ratio set in **Aspect Ratio**. + +
+Image Height + + +
+Image Height (Fixed Height Only) Default: 200; Supports: Responsive + + +Sets a fixed image height in pixels when **Equal Height Image** is **Fixed Height**. +
+
+ +
+Aspect Ratio + + +
+Aspect Ratio (Aspect Ratio Only) Supports: Responsive + + +Sets the CSS aspect ratio in `width/height` notation, for example `16/9`. Used when **Equal Height Image** is **Aspect Ratio**. +
+
+
+ +
+Image Spacing (Columns and Masonry Only) Default: 0 + + +Sets the spacing in pixels between the featured image and the post text. Available when **Layout** is **Columns** or **Masonry**. +
+ +
+Image Spacing (List Only) Default: 0 + + +Sets the spacing in pixels between the featured image and the post text. Available when **Layout** is **List**. +
+ +
+Fallback Image + + +Selects an image used when a post has no featured image. Leave empty to skip the image entirely for those posts. +
+
+
+ +
+Post Info + + +The Post Info section controls which post meta fields appear with each item. Available when **Layout** is **Columns**, **Masonry**, or **List**. + +
+Post Info settings + + +
+Author Default: Show + + +Shows or hides the post author. Available when **Layout** is **Columns**, **Masonry**, or **List**. + +
+Enable Author Link + + +
+Enable Author Link Default: Yes + + +Wraps the author name in a link to the author archive when **Author** is **Show**. +
+
+
+ +
+Date Default: Show + + +Shows or hides the post date. + +
+Date Format + + +
+Date Format Default: Default + + +Selects the format used to render the post date when **Date** is **Show**. **Default** uses the WordPress general date format. Other options are formatted samples such as `M j, Y`, `F j, Y`, `m/d/Y`, `m-d-Y`, `d M Y`, `d F Y`, `Y-m-d`, and `Y/m/d`. +
+
+
+ +
+Comments (List Only) Default: Show + + +Shows or hides the comment count next to each post. Available when **Layout** is **List**. +
+ +
+Comments (Columns and Masonry Only) Default: Hide + + +Shows or hides the comment count next to each post. Available when **Layout** is **Columns** or **Masonry**. +
+ +
+Separator Default: | + + +The character or string rendered between the visible post info items. +
+
+
+ +
+Post Terms + + +The Post Terms section controls the rendering of taxonomy terms attached to each post. Available when **Layout** is **Columns**, **Masonry**, or **List**. + +
+Post Terms settings + + +
+Terms Default: Hide + + +Shows or hides the list of hierarchical taxonomy terms assigned to each post. + +
+Terms Label + + +
+Terms Label Default: Posted in + + +The label rendered before the list of terms when **Terms** is **Show**. +
+
+ +
+Terms Separator + + +
+Terms Separator Default: , + + +The character or string rendered between individual terms when **Terms** is **Show**. +
+
+
+
+
+ +
+Post Content + + +The Post Content section controls the rendered post body and the optional read-more link. Available when **Layout** is **Columns**, **Masonry**, or **List**. + +
+Post Content settings + + +
+Content Default: Show + + +Shows or hides the post content area for each item. +
+ +
+Content Type (List Only) Default: Excerpt + + +Selects whether the post body renders as a trimmed excerpt or the full post content. Available when **Layout** is **List**. + +- **Excerpt:** Renders the WordPress excerpt, optionally trimmed to a fixed word count. +- **Full Text:** Renders the complete post content. + +
+Content Length + + +
+Content Length (Excerpt Only) + + +Sets the maximum number of words rendered in the excerpt when **Content Type** is **Excerpt**. Leave empty to use the default WordPress excerpt length. +
+
+
+ +
+More Link Default: Hide + + +Shows or hides an inline read-more link at the end of each post. + +
+More Link Text + + +
+More Link Text Default: Read More + + +The text used for the inline read-more link when **More Link** is **Show**. +
+
+
+
+
+ +### Style Tab + +The Style tab controls the visual appearance of post cards, text, gallery overlays, and the gallery hover icon. + +
+Posts + + +The Posts section controls per-card styling. Available when **Layout** is **Columns**, **Masonry**, or **List**. + +
+Posts settings + + +
+Post Alignment + + +Sets the horizontal text alignment used inside each post. +
+ +
+Post Background Color Supports: Field Connections + + +Sets the background color of each post container. +
+ +
+Border settings + +Border settings control border style, width, color, radius, and related responsive border controls where available. + +
+
+
+ +
+Text + + +The Text section controls the typography and color of the title, post info, content, and inline links. Available when **Layout** is **Columns**, **Masonry**, or **List**. + +
+Text settings + + +
+Title Color Supports: Field Connections + + +Sets the color of the post title link. +
+ +
+Title Typography Supports: Responsive + + +The font settings for the post title. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+ +
+Post Info Color Supports: Field Connections + + +Sets the color of post info text such as the author, date, and comment count. +
+ +
+Post Info Typography Supports: Responsive + + +The font settings for the post info row. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+ +
+Content Color Supports: Field Connections + + +Sets the color of the post content text. +
+ +
+Content Typography Supports: Responsive + + +The font settings for the post content. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+ +
+Link Color Supports: Field Connections + + +Sets the color of inline links inside the post content. +
+ +
+Link Hover Color Supports: Field Connections + + +Sets the color of inline links inside the post content on hover. +
+
+
+ +
+Hover Transition (Gallery Only) Default: Fade + + +Sets the transition used when the gallery overlay appears on hover. Available when **Layout** is **Gallery**. + +- **Fade:** Cross-fades the overlay over the image. +- **Slide Up:** Slides the overlay in from the bottom. +- **Slide Down:** Slides the overlay in from the top. +- **Scale Up:** Scales the overlay in from a smaller size. +- **Scale Down:** Scales the overlay in from a larger size. + +
+ +
+Overlay Colors (Gallery Only) + + +The Overlay Colors section styles the text and background of the hover overlay rendered on top of each gallery image. Available when **Layout** is **Gallery**. + +
+Overlay Colors settings + + +
+Overlay Text Color Default: ffffff; Supports: Field Connections + + +Sets the color of the post title displayed inside the overlay. +
+ +
+Overlay Background Color Default: 333333; Supports: Field Connections + + +Sets the background color of the overlay panel rendered behind the title text. +
+
+
+ +
+Icons (Gallery Only) + + +The Icons section adds an optional decorative icon to each gallery item. Available when **Layout** is **Gallery**. + +
+Icons settings + + +
+Use Icon for Posts Default: No + + +Enables a per-post icon rendered inside the gallery overlay. + +
+Post Icon + + +
+Post Icon (Use Icon for Posts Only) Supports: Field Connections + + +Selects the icon used for each gallery item when **Use Icon for Posts** is **Yes**. +
+
+ +
+Post Icon Position + + +
+Post Icon Position (Use Icon for Posts Only) Default: Above Text + + +Places the icon above or below the gallery title text when **Use Icon for Posts** is **Yes**. Options are **Above Text** and **Below Text**. +
+
+ +
+Post Icon Color + + +
+Post Icon Color (Use Icon for Posts Only) Supports: Field Connections + + +Sets the icon color when **Use Icon for Posts** is **Yes**. +
+
+ +
+Post Icon Size + + +
+Post Icon Size (Use Icon for Posts Only) Default: 24 + + +Sets the icon size in pixels when **Use Icon for Posts** is **Yes**. +
+
+
+ +
+DuoTone Icon Primary Color Supports: Field Connections + + +For Font Awesome DuoTone icons only: the primary color applied to the icon. +
+ +
+DuoTone Icon Secondary Color Supports: Field Connections + + +For Font Awesome DuoTone icons only: the secondary color applied to the icon. +
+
+
+ +### Query Tab + +The Query tab configures the source of the loop, the post type, sorting, dynamic and custom field filters, and how many posts are returned. + +
+Source Default: Custom Query + + +Selects whether the module renders its own custom query or inherits the current page's main WordPress query. + +- **Custom Query:** Builds a query using the post type, ordering, dynamic filters, and custom field filters configured in this tab. +- **Main Query:** Uses the current page's main query, for example the archive query on a category page or the search query on a search results page. + +
+ +
+Custom Query + + +The Custom Query section configures the post type, sorting, offset, and self-exclusion behavior used when **Source** is **Custom Query**. + +
+Custom Query settings + + +
+Post Type Default: Post + + +Selects one or more registered post types used in the query. +
+ +
+Ordering settings + +Ordering settings control how queried posts or items are sorted, such as by date, title, menu order, or custom ordering options where available. + +
+ +
+Offset Default: 0 + + +Skips this many matching posts from the start of the query before returning results. +
+ +
+Exclude Current Post Default: No + + +Excludes the post being viewed from the query when the module renders inside a singular template or Themer layout. +
+
+
+ +
+Filtering settings + +Filtering settings control which posts, terms, authors, or content types are included or excluded from the module output. + +
+ +
+Custom field filter settings + +Custom field filters limit queried content by matching custom field keys, values, and comparison rules where available. + +
+ +### Pagination Tab + +The Pagination tab controls how additional pages of results are displayed and includes the styling controls for the load-more button. + +
+Pagination Style Default: Numbers + + +Selects how additional posts are loaded after the first page. + +- **Numbers:** Renders standard numbered pagination links below the loop. +- **Scroll:** Loads additional posts automatically as the visitor scrolls toward the end of the loop. +- **Load More Button:** Renders a button below the loop that loads additional posts on click. +- **None:** Hides pagination and displays only the first page of results. + +
+Auto-scroll on Pagination + + +
+Auto-scroll on Pagination (Numbers Only) Default: Yes + + +Scrolls the page to the top of the loop when a new page of results is loaded. Appears when **Pagination Style** is **Numbers**. +
+
+
+ +
+Posts Per Page Default: 10 + + +Sets the maximum number of posts returned per page of results. +
+ +
+No Results Message Default: Sorry, we couldn't find any posts. Please try a different search. + + +The message displayed when the query returns no posts. +
+ +
+Show Search Default: Show + + +Renders a WordPress search form below the no-results message when no posts are found. +
+ +
+Load More Button (Load More Button Only) + + +The Load More Button section configures the button text and the loading-state label used during AJAX requests. Available when **Pagination Style** is **Load More Button**. + +
+Load More Button settings + + +
+Button Text Default: Load More + + +The label displayed on the load-more button. +
+ +
+Loading text + + +The label displayed on the button while the next page of posts is being fetched. Falls back to **Loading...** when left empty. +
+
+
+ +
+Button Icon (Load More Button Only) + + +The Button Icon section adds an optional icon to the load-more button. Available when **Pagination Style** is **Load More Button**. + +
+Button Icon settings + + +
+Button Icon Supports: Field Connections + + +Selects the icon rendered next to the button text. + +
+Button Icon Position + + +
+Button Icon Position Default: Before Text + + +Places the icon before or after the button text when an icon is selected. Options are **Before Text** and **After Text**. +
+
+ +
+Button Icon Visibility + + +
+Button Icon Visibility Default: Always Visible + + +Keeps the icon visible or fades it in on hover when an icon is selected. Options are **Always Visible** and **Fade In On Hover**. +
+
+
+
+
+ +
+Button Style (Load More Button Only) + + +The Button Style section sets the size and inner spacing of the load-more button. Available when **Pagination Style** is **Load More Button**. + +
+Button Style settings + + +
+Button Width Default: Auto + + +Sets the button width to **Auto** or **Full Width**. +
+ +
+Button Padding Supports: Responsive, Link Values + + +The inner spacing of the load-more button. +
+
+
+ +
+Button Text (Load More Button Only) + + +The Button Text section controls the typography and color of the load-more button label. Available when **Pagination Style** is **Load More Button**. + +
+Button Text settings + + +
+Button Text Color Supports: Field Connections + + +Sets the text color of the button label. +
+ +
+Button Text Hover Color Supports: Field Connections + + +Sets the text color of the button label on hover and focus. +
+ +
+Button Typography Supports: Responsive + + +The font settings for the button label. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Button Background (Load More Button Only) + + +The Button Background section controls the background color, fill style, and hover transition of the load-more button. Available when **Pagination Style** is **Load More Button**. + +
+Button Background settings + + +
+Button Background Color Supports: Field Connections + + +Sets the default background color of the button. +
+ +
+Button Background Hover Color Supports: Field Connections + + +Sets the background color of the button on hover and focus. +
+ +
+Button Background Style Default: Flat + + +Selects a **Flat** or **Gradient** background style for the button. +
+ +
+Button Background Animation Default: Disabled + + +Enables or disables the transition between the normal and hover background colors. Options are **Disabled** and **Enabled**. +
+
+
+ +
+Button Border (Load More Button Only) + + +The Button Border section controls the border style and hover color of the load-more button. Available when **Pagination Style** is **Load More Button**. + +
+Button Border settings + + +
+Button Border Supports: Responsive + + +The border style, width, color, and radius for the load-more button. +
+ +
+Button Border Hover Color Supports: Field Connections + + +Sets the border color of the button on hover and focus. +
+
+
+ +
+Advanced tab + +The Advanced tab contains common Posts module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/post-slider.mdx b/beaver-builder/layouts/modules/post-slider.mdx new file mode 100644 index 00000000..48a6d6f0 --- /dev/null +++ b/beaver-builder/layouts/modules/post-slider.mdx @@ -0,0 +1,647 @@ +--- +title: Posts Slider +sidebar_label: Posts Slider +icon: "gallery-horizontal-end" +description: "Use Posts Slider to display a slider of WordPress posts with featured image, post info, and excerpt content." +--- + + +Use Posts Slider to display a slider of WordPress posts with featured image, post info, and excerpt content. + +## Usage + +Use Posts Slider to render a slideshow of queried WordPress posts, pages, or custom post types in a single rotating panel. Each slide combines the post's featured image with optional post title, author, date, comment count, excerpt, and a Read More link, and the slideshow is driven by configurable height, autoplay, loop, transition, and timing controls. + +This module is most useful for blog feature areas, homepage hero sections, related-content blocks, and landing pages where a small set of posts should rotate automatically with strong visual emphasis. It works well anywhere a static post grid would feel too dense and a single highlighted post at a time better matches the page design. + +## Module Settings + +The Posts Slider module settings control the slider behavior, the layout of each slide, the visual styling of slide content, and the underlying post query. + +### Slider Tab + +The Slider tab controls the slider dimensions, autoplay, transitions, and the visible navigation controls. + +
+Height Default: 400px + + +The minimum height of the slider in pixels. Slide content can expand the height beyond this value. +
+ +
+Auto Play Default: Yes + + +Starts each slide rotating automatically on page load. +
+ +
+Loop Default: No + + +Returns the slider to the first slide after the last slide, so the rotation continues without stopping. +
+ +
+Delay Default: 5 + + +The time in seconds each slide remains visible before advancing to the next slide. +
+ +
+Transition Default: Slide + + +The animation used when moving between slides. + +- **Fade:** Cross-fades between slides without moving them horizontally. +- **Slide:** Slides each post horizontally into view. + +
+ +
+Transition Speed Default: 1 + + +The duration in seconds of the transition animation between slides. +
+ +
+Number of Posts Default: 10 + + +The maximum number of posts loaded into the slider as slides. +
+ +
+Slider Controls + + +The Slider Controls section sets which navigation elements appear on top of the slider. + +
+Slider Controls + + +
+Show Dots Default: Yes + + +Shows or hides the pagination dots used to jump between slides. +
+ +
+Show Arrows Default: No + + +Shows or hides the previous and next arrow controls. Selecting **Yes** also reveals the **Nav Arrows** group in the Style tab. +
+ +
+Show Play/Pause Default: No + + +Shows or hides a play and pause toggle for the slider rotation. +
+
+
+ +### Layout Tab + +The Layout tab controls how the featured image, post info, and post content appear on each slide. + +
+Featured Image + + +The Featured Image section controls whether and how the featured image is displayed on each slide. + +
+Featured Image + + +
+Show Featured Image? Default: Show + + +Shows or hides the featured image on each slide. Selecting **Hide** removes the related image fields from the layout. + +
+Image Settings + + +
+Image Default: Background + + +Selects how the featured image is rendered on the slide. + +- **Background:** Renders the featured image as the slide background, with the post content overlaid on top. +- **Thumbnail:** Renders the featured image as an inline thumbnail next to the post content. + +
+ +
+Size Default: Large + + +The registered image size used for the featured image. +
+ +
+Crop Default: Landscape + + +The crop applied to the thumbnail image when **Image** is set to **Thumbnail**. + +- **None:** Uses the original image without cropping. +- **Landscape:** Crops the image to a wide horizontal aspect ratio. +- **Panorama:** Crops the image to a very wide panoramic aspect ratio. +- **Portrait:** Crops the image to a tall vertical aspect ratio. +- **Square:** Crops the image to a 1:1 square. +- **Circle:** Crops the image to a circle. + +
+
+
+
+
+ +
+Post Info + + +The Post Info section controls which metadata appears next to each post title. + +
+Post Info + + +
+Author Default: Show + + +Shows or hides the post author on each slide. +
+ +
+Date Default: Show + + +Shows or hides the post date on each slide. + +
+Date Format + + +
+Date Format Default: Default + + +The format used to display the post date when **Date** is set to **Show**. + +- **Default:** Uses the date format configured in the WordPress settings. +- **M j, Y:** Short month name, day, and four-digit year, for example `Jan 1, 2025`. +- **F j, Y:** Full month name, day, and four-digit year, for example `January 1, 2025`. +- **m/d/Y:** Numeric month, day, and four-digit year separated by slashes. +- **m-d-Y:** Numeric month, day, and four-digit year separated by hyphens. +- **d M Y:** Day, short month name, and four-digit year. +- **d F Y:** Day, full month name, and four-digit year. +- **Y-m-d:** Four-digit year, numeric month, and day separated by hyphens. +- **Y/m/d:** Four-digit year, numeric month, and day separated by slashes. + +
+
+
+ +
+Comments Default: Show + + +Shows or hides the post comment count on each slide. +
+
+
+ +
+Post Content + + +The Post Content section controls the post excerpt and the optional Read More link displayed on each slide. + +
+Post Content + + +
+Post Content Default: Show + + +Shows or hides the post excerpt on each slide. Selecting **Show** also reveals the **Post Content** style group in the Style tab. + +
+Content Length + + +
+Content Length + + +The maximum number of words used for the excerpt when **Post Content** is set to **Show**. Leave empty to use the default WordPress excerpt length. +
+
+
+ +
+More Link Default: Hide + + +Shows or hides the Read More link below the excerpt. Selecting **Show** also reveals the **More Link** style group in the Style tab. + +
+More Link Text + + +
+More Link Text Default: Read More + + +The text displayed for the Read More link when **More Link** is set to **Show**. +
+
+
+
+
+ +### Style Tab + +The Style tab controls the appearance of the slide content area, post title, post info, post content, More Link, and the optional navigation arrows. + +
+Content + + +The Content section controls the position, sizing, and background of the text overlay on each slide. + +
+Content + + +
+Position Default: Left + + +The horizontal or vertical placement of the text content over the slide background. Available when **Image** is set to **Background**. + +- **Left:** Aligns the content to the left side of the slide. +- **Right:** Aligns the content to the right side of the slide. +- **Bottom:** Aligns the content to the bottom of the slide. + +
+ +
+Position (Thumbnail Only) Default: Left + + +The placement of the text content next to the featured image when **Image** is set to **Thumbnail**. + +- **Left:** Places the content to the left of the thumbnail. +- **Right:** Places the content to the right of the thumbnail. + +
+ +
+Text Width Default: 50% + + +The width of the text content area as a percentage of the slide width. Available when **Position** is set to **Left** or **Right**. +
+ +
+Text Padding Default: 50px + + +The inner spacing around the text content area in pixels. +
+ +
+Background Color Default: #333333; Supports: Field Connections + + +The color of the overlay placed behind the text content when the featured image is rendered as a background. +
+ +
+Background Gradient Default: No + + +Fades the background color overlay into a transparent edge in the direction set by **Position**, instead of filling a flat block. +
+ +
+Background Height Default: 100% + + +Controls how the background overlay sizes to the slide. + +- **Auto:** Sizes the overlay to fit the height of the text content. +- **100%:** Stretches the overlay to fill the full height of the slide. + +
+
+
+ +
+Post Title + + +The Post Title section controls the markup and appearance of each post title. + +
+Post Title + + +
+Title Tag Default: h2 + + +The HTML tag used for each post title. Options are **h1**, **h2**, **h3**, **h4**, **h5**, and **h6**. +
+ +
+Color Default: #cccccc; Supports: Field Connections + + +The text color of each post title. +
+ +
+Hover Color Default: #ffffff; Supports: Field Connections + + +The text color of each post title on hover. +
+ +
+Typography Supports: Responsive + + +The font settings for post titles. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Post Info + + +The Post Info section controls the appearance of the author, date, and comment count metadata. + +
+Post Info + + +
+Color Default: #ffffff; Supports: Field Connections + + +The text color of the post info metadata. +
+ +
+Link Color Default: #cccccc; Supports: Field Connections + + +The link color of the post info metadata. +
+ +
+Link Hover Color Default: #ffffff; Supports: Field Connections + + +The link color of the post info metadata on hover. +
+ +
+Typography Supports: Responsive + + +The font settings for the post info metadata. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Post Content + + +This group is available when **Post Content** is set to **Show** in the Layout tab. + +
+Post Content + + +
+Color Default: #ffffff; Supports: Field Connections + + +The text color of the post excerpt content. +
+ +
+Link Color Default: #cccccc; Supports: Field Connections + + +The color of inline links inside the post excerpt content. +
+ +
+Link Hover Color Default: #ffffff; Supports: Field Connections + + +The color of inline links inside the post excerpt content on hover. +
+ +
+Typography Supports: Responsive + + +The font settings for the post excerpt content. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+More Link + + +This group is available when **More Link** is set to **Show** in the Layout tab. + +
+More Link + + +
+Color Supports: Field Connections + + +The text color of the Read More link. +
+ +
+Hover Color Supports: Field Connections + + +The text color of the Read More link on hover. +
+ +
+Typography Supports: Responsive + + +The font settings for the Read More link. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Nav Arrows + + +This group is available when **Show Arrows** is set to **Yes** in the Slider tab. + +
+Nav Arrows + + +
+Arrows Background Color Supports: Field Connections + + +The background color of the previous and next arrow controls. +
+ +
+Arrows Background Style Default: Circle + + +The shape of the background behind each arrow control. + +- **Circle:** Renders the arrow background as a circle. +- **Square:** Renders the arrow background as a square. + +
+ +
+Arrows Color Supports: Field Connections + + +The fill color of the previous and next arrow icons. +
+
+
+ +### Query Tab + +The Query tab configures the WordPress query used to load posts into the slider. + +
+Source Default: Custom Query + + +Selects how the slider gets its posts. + +- **Custom Query:** Build a custom WordPress query by specifying post type, sort order, and filters. +- **Main Query:** Use the current page's main WordPress query, useful inside Beaver Themer archive layouts where the page context determines the query. + +
+Custom Query settings + + +
+Post Type Default: Post + + +Selects one or more post types to query. Supports posts, pages, and registered custom post types. +
+ +
+Ordering settings + +Ordering settings control how queried posts or items are sorted, such as by date, title, menu order, or custom ordering options where available. + +
+ +
+Offset Default: 0 + + +Skips the specified number of posts at the start of the query results, useful when the most recent posts appear elsewhere on the page. +
+ +
+Exclude Current Post Default: No + + +Excludes the post currently being viewed from the query results. Useful for related-post sliders on single post templates. +
+ +
+Filtering settings + +Filtering settings control which posts, terms, authors, or content types are included or excluded from the module output. + +
+ +
+Authors + + +Filters the query to posts by specific authors entered by username. +
+ +
+Custom field filter settings + +Custom field filters limit queried content by matching custom field keys, values, and comparison rules where available. + +
+
+
+ +
+Advanced tab + +The Advanced tab contains common Posts Slider module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
diff --git a/beaver-builder/layouts/modules/posts/increase-space-between-images-in-posts-module-gallery.md b/beaver-builder/layouts/modules/posts/increase-space-between-images-in-posts-module-gallery.md deleted file mode 100644 index 097127d3..00000000 --- a/beaver-builder/layouts/modules/posts/increase-space-between-images-in-posts-module-gallery.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: increase-space-between-images-in-posts-module-gallery -title: Increase space between Posts in Posts Gallery module -sidebar_label: Increase space between Posts in Posts Gallery module -description: Here's some CSS code to use if you want space between the post images in a Posts module Gallery layout. ---- - -When you choose the **Gallery** layout style in the Posts module, by default there is no space between the featured images for each Post in the gallery, such as in the following screenshot. - -![](/img/how-to-tips-space-in-post-gallery-1.png) - -You can use the following CSS rule to increase spacing between the featured images in the display: - -```css -.fl-post-gallery-post { - margin: 20px; -} -``` - -Increasing to a `20px` margin separates the space between images as shown in the following screenshot. You can see that the increased margins can also lead to different break points in the rows. - -![](/img/how-to-tips-space-in-post-gallery-2.png) diff --git a/beaver-builder/layouts/modules/posts/posts-carousel.md b/beaver-builder/layouts/modules/posts/posts-carousel.md deleted file mode 100644 index 911f8ae1..00000000 --- a/beaver-builder/layouts/modules/posts/posts-carousel.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: posts-carousel -title: Posts Carousel -sidebar-label: Posts Carousel module -description: The Posts Carousel module displays a set of posts or pages that moves horizontally across the screen, with many layout and content filtering options. ---- - -In the Posts Carousel module, a set of posts or pages is displayed as a single row of posts in either Grid layout (with post title and info underneath the featured image) or Gallery view (with post title and info replacing the featured image on mouseover), as shown in the following screenshots of the two layouts. - -![](/img/post-carousel-module-1.jpg) - -Autoplay, looping of the posts, and navigation icons (dots, arrows) are all optional. - -:::tip **Tip** -Not sure which Posts module to use? See [the comparison article](/beaver-builder/layouts/modules/posts/posts-posts-carousel-and-posts-slider-modules-examples.md). -::: - -## Slider tab - -| Section | Field | Description | -| ------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -|   | Layout | **Grid** displays the post title and post info below the featured image. **Gallery** displays the featured image, with post title and info replacing the featured image on mouseover. In Grid layout, you can hide the featured image on the **Layout** tab, with the result that the post info displays where the image normally appears. Gallery layout does not have the option to hide the featured image, since the result would be the same as for Grid layout. | -|   | Auto play | If **Yes**, the display moves through the posts automatically, unless the user intervenes by clicking on the dots or arrows or moving the cursor over one of the posts. If **No**, there is no animation and user must use the navigational aids. | -|   | Delay | Number of seconds each post is displayed. This setting is used only if **Auto play** is enabled. | -|   | Loop | If **Yes**, the list of posts is displayed in a repeating continuous carousel. If **No**, the list of posts ends when the last post is reached. This behavior occurs whether autoplay is enabled or not. | -|   | Transition speed | When autoplay is enabled, the speed in seconds at which one slide moves to the next when the **Delay** time has finished. | -|   | Number of posts | Maximum number of posts to display. Which posts are selected depends on the filters set on the **Content** tab. | -|   | Number of slides to move at a time | Advances the display of posts or pages forward by the number in this field. By default the value is **1**. | -| **Slider controls** | Show dots | If **Yes**, a set of horizontal dots is displayed at the bottom of the carousel. The number of dots equals the **Number of posts** value, and one dot is highlighted to indicate which post in the sequence is being displayed. Visitors can manually change the display by clicking one of the dots. | -|   | Show arrows | If **Yes**, a left and right arrow is displayed on either side of the post list so user can move ahead or back manually. You can style the arrow color, background color, and background shape on the **Style** tab. | - -## Layout tab - -| Section | Field | Description | -| ------------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Posts** | Post max width | Determines the maximum width of each post in the list. Depending on display width of the browser, a larger max width means larger featured images and fewer items visible in the carousel row. As browser width decreases, the display decreases to a single item and eventually the idth of that single item decreases. | -|   | Post spacing | Number of pixels between posts in the list. | -|   | Equalize column heights | **(Grid** layout only) If set to **Yes**, the border around every post is the same size. | -|   | Post hover transition | **(Gallery** layout only) The type of animation when the post title and post info replace the featured image on mouseover. | -| **Featured image** | Image | **(Grid** layout only) Show or hide the featured image. | -|   | Size | Which size image from the WordPress Media Library to use.
**Note:** The image will always be sized to fit the post max width, so this setting affects image resolution rather than the actual size of the image on the page. This setting doesn't change the amount of crop. Increasing mage size increases the size of the file loaded, which can affect page load time. | -|   | Crop | Crops the featured image to a particular shape. Note that this may cut out some parts of the image. | -| **Icons (Gallery layout only)** | Use icon for posts | Choose **Yes** to display an icon on the line above or below the text when the post title and post info are displayed on mouseover. | -|   | Post icon | (Appears when Post icon is set to **Yes** for **Gallery** layout)
Choose the icon to be displayed. | -|   | Post icon position | (Appears when Post icon is set to Yes for **Gallery** layout)
Choose whether the icon appears above or below the post title and post info. | -|   | Post icon size | (Appears when **Post icon** is set to **Yes** for **Gallery** layout)
Specify icon size in pixels. | -| **Post info** | Author | Show or hide the post author. | -|   | Date | Show or hide the post date. | -|   | Date format | (Appears when **Date** is set to **Show** )
Select **Default** to use the WordPress date format specified in **Settings > General** or override the default with a specific date format. | -|   | Comments | Show or hide the number of comments. | -| **Content (Grid layout only)** | Content | Show or hide post content. If set to **Yes**, the entire post excerpt is displayed, if the post has content in the **Excerpt** field. If there's no excerpt, the WordPress default of the first 55 words of the post content is displayed, with an ellipsis of three dots at the end to show there is more content. | -|   | More link | Show or hide the **Read more** link after the post content.
If set to **Show**, you can also customize the default **Read more** text. | -|   | More link text | Customize the default **Read more** text. | - -## Style tab - -| Section | Field | Description | -| ---------------------------------------------------------------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| **Carousel item** | Background color | A background color that can be seen for items with no featured image. | -|   | Icon color | The color of the icon, when one has been set on the **Layout** tab. | -| **Post title** | Color | Text color of the post title. | -|   | Typography | The standard Beaver Builder [typography section](basics/typography.md) for the post title. | -| **Post info** | Color | Text color of the post info. | -|   | Typography | The standard Beaver Builder [typography section](basics/typography.md) for the post info. | -| **Nav arrows** (Only when **Show arrows** is set to **Yes** on the **Slider** tab) | Arrows background color | Sets the color of a circle or square background behind the navigation arrows. When no color is set, there is no background circle or square. | -|   | Arrows background style | When Arrows background color is set, this option sets the arrow background to a circle or a square. | -|   | Arrows color | Sets the color of the arrows themselves. | - -## Content tab - -| Section | Field | Description | -| ---------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -|   | Source | Main query or custom query. The default for a standard Beaver Builder layout is **Custom query**, which enables all the other fields on this tab.
In Beaver Themer, the default is **Main query**, because normally for a Themer layout you want the query for posts to be based on whatever archive page the query is created for. | -| **Custom query** | Post type | Choose pages, posts, or a custom post type, such as WooCommerce Products or a custom post type that you create yourself. | -|   | Order | Descending or ascending, and whether it is by date, numerical, or alphabetical depends on the **Order by** setting. | -|   | Order by | The choices are **Author**, **Comment count**, **Date**, **Date last modified**, **ID**, **Menu order**, **Meta value** (alphabetic or numeric), **Random**, **Title**.
If you display pages in **Menu order**, you are effectively displaying a menu, with the added ability to display a content summary of the page.
The **Meta value** option enables ordering by a custom field. If you select either the alphabetic or numeric **Meta value** option, a **Meta key** field appears so you can enter the key (`meta_key`). | -|   | Offset | Enter an integer if you want to skip a certain number of posts in the order specified in the **Order** setting. | -|   | Exclude current post | Excludes the current post from the query. This is useful when you are using the module to create a list of related posts on a single post page. | -| **Filter** | Posts, Pages, Products, etc. | (The label matches the single post name for the **Post type** you set)
Include or exclude a set of posts, page, products, etc., by title. Start typing a word, and the titles containing that word will be displayed for you to choose. Keep selecting titles until you have the set you want to include or exclude. You can reorder matched selections and they are reflected in the front end. See an example for the Posts module at [Selection Order in Filtering](/beaver-builder/layouts/modules/posts/posts.md#selection-order-in-filtering). | -|   | Categories | (Hidden when the **Post type** setting is **Pages** )
You can include or exclude categories to display. The third setting, **Match related categories except**, is useful in Singular-type Themer layouts when you want to use the Posts module to display a list of related posts, and you want to display the related posts in a family of categories except for the specific categories that you name. | -|   | Tags | (Hidden when the **Post type** setting is **Pages** )
You can include or exclude tags to display. The choices are the same as for including or excluding categories. | -|   | Authors | You can include or exclude posts or pages by specific authors. | - -## Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/posts/posts-posts-carousel-and-posts-slider-modules-examples.md b/beaver-builder/layouts/modules/posts/posts-posts-carousel-and-posts-slider-modules-examples.md deleted file mode 100644 index c1ffb686..00000000 --- a/beaver-builder/layouts/modules/posts/posts-posts-carousel-and-posts-slider-modules-examples.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -id: posts-posts-carousel-and-posts-slider-modules-examples -title: Posts, Posts Carousel, and Posts Slider modules examples -sidebar_label: Posts, Posts Carousel, and Posts Slider modules examples -description: Here are a number of visual examples of Posts, Posts Carousel, and Posts Slider modules to help you decide which one to choose. ---- - -There are three modules that insert a display of Posts or Pages into a Beaver Builder layout: Posts, Posts Carousel, and Posts Slider. The difference in the modules is the way the posts or pages are displayed and the settings that are available to configure layout, content, and style. In addition, the modules can have more than one layout. See the individual articles about the [Posts](/beaver-builder/layouts/modules/posts/posts.md), [Posts Carousel](/beaver-builder/layouts/modules/posts/posts-carousel.md), and [Posts Slider](/beaver-builder/layouts/modules/posts/posts-slider.md) modules for details about settings. - -## Which of the posts modules to choose? - -The main distinction between the Posts module and the other two modules is that the Posts Carousel and Posts Slider modules can be animated, while the Posts module cannot. - -The Posts module displays a subset of posts in a variety of layouts. You can control the number of posts displayed and also control pagination of the display. There are a number of screenshot examples in the following section. - -:::tip **Tip** -If you want to display the full text of a post, you must use a Posts module and choose the **List** layout type. -::: - -In a carousel, a few items are presented in a horizontal row, with animation or the manual ability to progress through a larger set. In the Posts Carousel module, the post or page title and other information are overlaid on the featured image. The following screenshot shows one of the variations of the Posts Carousel module, with the navigation shown as dots below the posts. See more examples later in this article. - -![](/img/post-modules-examples-1.jpg) - -In a slider, an image is usually displayed in a background that fills the screen horizontally, overlaid by text, cycling through a set of image/text combinations. Here's an example of a Posts Slider module layout. See more examples later in this article. - -![](/img/post-modules-examples-2.jpg) - -## Posts module examples - -### Posts module – Columns layout - -Posts or pages are displayed in top-aligned column groups. In this example, the columns are not set to equal height, so each group is top- aligned, but the bottom borders are adjusted to fit the posts. - -![](/img/post-modules-examples-3.jpg) - -### Posts module – Masonry layout - -Posts or pages are displayed with alternating heights, as shown in this screenshot: - -![](/img/post-modules-examples-4.jpg) - -### Posts module – Gallery layout - -Gallery layout displays featured images in blocks of equal height and width with no space between. Mousing over an image shows post information, as shown in the following screenshot. You cannot display post content with Gallery layout. - -![](/img/post-modules-examples-5.jpg) - -When the post has no featured image, only the post information is displayed. - -### Posts module – List layout - -In **List** layout, posts or pages are displayed in a vertical list takes up the full single-column width. The featured image can be set to appear in any of the following locations: - - * **Above title** -![](/img/post-modules-examples-6.jpg) - - * **Above content** -![](/img/post-modules-examples-7.jpg) - - * **Left** -The image is top-aligned with the title. -![](/img/post-modules-examples-8.jpg) - - * **Left content (Version 1.10.7)** -The image is top-aligned with the post content. -![](/img/post-modules-examples-9.jpg) - - * **Right** -The image is top-aligned with the title. -![](/img/post-modules-examples-10.jpg) - - * **Right content** -The image is top-aligned with the post content. -![](/img/post-modules-examples-11.jpg) - -## Posts Carousel module - -### Gallery layout - -The Gallery layout of the Posts Carousel module displays the featured image in a single row of blocks of uniform height and width, and when you mouse over the image the title and post info are displayed with a color background, as shown in the screenshot below. You can't display post content with the Gallery layout. - -![](/img/post-modules-examples-12.jpg) - -### Grid layout - -The Grid layout of the Posts Carousel module displays the thumbnails of featured images with post title, optional post info, and optional post excerpt underneath. The column height can be equalized, which means the content borders are the same size and the columns are top-aligned. - -![](/img/post-modules-examples-13.png) - -## Posts Slider module - -The Posts Slider module only has one layout style: an animated display of one post or page at a time, with post or page text overlaid. - -The featured image can be displayed in two ways. - - * The featured image can be set to display as the background with the post info and post excerpt appearing on top, as in the following screenshot: - -![](/img/post-modules-examples-14.jpg) - - * The featured image can be set to a thumbnail, with the post info and excerpt appearing to the left or right of it, as in this screenshot: - -![](/img/post-modules-examples-15.jpg) - -When the featured image appears in the background, you can set the post text to the left, right, or bottom of the slide. When the featured image appears as a thumbnail you can set the post text to appear to the left or right of the image. - -You can also set a background color for the text portion of the slide. You can choose whether the background color is the full height of the slide or covers only the portion of the slide where the text is displayed. You can also choose the opacity of the background color and whether the background has a gradient. - -:::tip **Tip** -To stretch the slides to the full width of the browser window, in the Row settings make the row full width, the content full width, and set the row padding to 0px on left and right. Change the Posts Slider module margins to 0px on left and right. -::: - -The following screenshots show some more examples of the text background settings. - -In the next screenshot, **Text background height** is set to **Auto**, and text padding is set to 50 px. With text placed on the left, the text background extends to the slide border on the top and left and extends 50px beyond the text on the right and bottom. - - **Posts Slider with text left, featured image in background, text background color #333333, 80% opacity, auto height, no gradient:** - -![](/img/post-modules-examples-16.jpg) - -Compare with the next screenshot, in which **Text background height** is set to **100%**. In this case, the text background extends to the slide border on the top , left, and bottom and extends 50px beyond the text on the right. - -**Posts Slider with text left, featured image in background, text background 50% opacity, full height, no gradient:** - -![](/img/post-modules-examples-17.jpg) - -The following slide matches the settings in the previous slide, but with a gradient. Note how the opacity is the full 50% opacity at the left edge and decreases towards the center. - -**Posts Slider with text left, featured image in background, text background 50% opacity, full height, gradient:** - -![](/img/post-modules-examples-18.jpg) - -With thumbnail images, the text background is always a solid color and fills the slide background, as shown in the following screenshot. Text background opacity and gradient do not apply to thumbnail layouts. - -**Posts Slider with text right, featured image as thumbnail, text background set to dark gray:** - -![](/img/post-modules-examples-19.jpg) diff --git a/beaver-builder/layouts/modules/posts/posts-slider.md b/beaver-builder/layouts/modules/posts/posts-slider.md deleted file mode 100644 index 2950f5f2..00000000 --- a/beaver-builder/layouts/modules/posts/posts-slider.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: posts-slider -title: Posts Slider -sidebar_label: Posts Slider module -description: The Posts Slider module displays a set of posts or pages that display one at a time, either sliding or fading to the next slide. ---- - -In the Posts Slider module, a set of posts or pages is displayed with either a -sliding or a fade-in animation. The featured image of each post becomes the -background image in the slide (unless you select the option to hide it), with -post info and content overlaid on the slide. See examples of Posts Slider -layouts in [this article](/beaver-builder/layouts/modules/posts/posts-slider.md). - -:::info -Some features are distributed across more than one tab. For example, -you can set the featured image to display as a thumbnail instead of a -background on the **Layout** tab. On the **Style** tab, you can then set the -post title, post info, and excerpt to appear to the left or right of the -thumbnail. -::: - -## Slider tab - -| Section | Field | Description | -| ------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -|   | Height | Minimum height of the posts slider. The height will expand to fit the photo being displayed.
**Tip:** If you don't like the expanding and shrinking to accommodate various photo heights, preprocess your photos so they are all the same height. | -|   | Auto play | If **Yes**, the display moves through the posts automatically, unless the user intervenes by clicking on the dots or arrows or moving the cursor over one of the posts. If **No**, there is no animation and user must use the navigational aids. | -|   | Delay | Number of seconds each post is displayed. This setting is used only if **Auto play** is enabled. | -|   | Loop | If **Yes**, the list of posts is displayed in a repeating continuous carousel. If **No**, the list of posts ends when the last post is reached. This behavior occurs whether autoplay is enabled or not. | -|   | Transition | Choose the type of animation for the transition to the next post: **Fade** or **Slide**. | -|   | Transition speed | When autoplay is enabled, the speed in seconds at which one slide moves to the next when the **Delay** time has finished. | -|   | Number of posts | Maximum number of posts to display. Which posts are selected depends on the filters set on the **Content** tab. | -| **Slider controls** | Show dots | If **Yes**, a set of horizontal dots is displayed at the bottom of the carousel. The number of dots equals the **Number of posts** value, and one dot is highlighted to indicate which post in the sequence is being displayed. Visitors can manually change the display by clicking one of the dots. | -|   | Show arrows | If **Yes**, a left and right arrow is displayed on either side of the post list so user can move ahead or back manually. You can style the arrow color, background color, and background shape on the **Style** tab. | - -## Layout tab - -| Section | Field | Description | -| --------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -|   | Show featured image? | Choose **Show** to display the post featured image. Choose **Hide** to show only text with a solid color background. | -| **Featured image (appears when featured image is set to Show)** | Image | Display image as the slide background or as a thumbnail. **Thumbnail** displays the post title and post info to the left and the featured image thumbnail to the right in each slide. | -|   | Size | Which size image from the WordPress Media Library to use.
**Note:** The image will always be sized to fit the post max width, so this setting affects image resolution rather than the actual size of the image on the page. This setting doesn't change the amount of crop. Increasing mage size increases the size of the file loaded, which can affect page load time. | -|   | Crop | (Appears when **Image** is set to **Thumbnail**)
Crops the featured image to a particular shape. Note that this may cut out some parts of the image. | -| **Post info** | Author | Show or hide the post author. | -|   | Date | Show or hide the post date. | -|   | Date format | (Appears when **Date** is set to **Show**)
Select **Default** to use the WordPress date format specified in **Settings > General** or override the default with a specific date format. | -|   | Comments | Show or hide the number of comments. | -| **Content** | Content | Show or hide post content. If set to **Yes**, the entire post excerpt is displayed, if the post has content in the **Excerpt** field. If there's no excerpt, the WordPress default of the first 55 words of the post content is displayed, with an ellipsis of three dots at the end to show there is more content. | -|   | More link | Show or hide the **Read more** link after the post content.
If set to **Show**, you can also customize the default **Read more** text. | -|   | More link text | Customize the default **Read more** text. | - -## Style tab - -| Section | Field | Description | -| ---------------------------------------------------------------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Content** | Position | If **Image** on the **Layout** tab is set to **Background**, this setting determines which part of the slide the post text appears in: **Left**, **Right**, or **Bottom**. If **Image** is set to **Thumbnail**, this setting determines the orientation of post text in relation to the thumbnail: post text on the left or post text on the right. | -|   | Text width | (Applies only when **Position** is set to **Left** or **Right**)
The percent of the width of the slide that the post content covers. | -|   | Text padding | Sets the amount of space on all four sides of the post text. | -|   | Background color | Color of the text background. | -|   | Background gradient | (Applies only when the featured image is set to **Background**)
If set to **Yes** , automatically adds an opacity gradient to the specified text background color. The gradient uses the text background color and the text background opacity at the left edge (for text on the left) or right edge (for text on the right) and decreases in opacity towards the center of the slide. There's an example of a text background gradient [in the Posts Slider section of this article](/beaver-builder/layouts/modules/posts/posts-posts-carousel-and-posts-slider-modules-examples.md/#posts-slider-module). | -|   | Text background height | (Applies only when the featured image is set to **Background**)
If set to **Auto** , the text background color adjusts to fit the area of text shown on the slide plus the **Text padding** specified in the **Text** section.
If set to **100%** , the text background color covers the entire height of the slide. (The text background width is the width of the text plus padding.) See examples [in the Posts Slider section of this article](/beaver-builder/layouts/modules/posts/posts-posts-carousel-and-posts-slider-modules-examples.md/#posts-slider-module).
**Note:** When **Position** in the **Text** section on the **Style** tab is set to **Bottom** , the text background effect will always be the equivalent of the **Auto** setting, even when set to **100%**. | -| **Post title** | Title tag | The heading style of the post title. | -|   | Color | Color of the post title. | -|   | Hover color | Hover color of the post title. | -|   | Typography | The standard Beaver Builder [typography section](basics/typography.md) for the post title. | -| **Post info** | Color | Color of the post info text. | -|   | Link color | Color of text links. | -|   | Link hover color | Hover color of text links. | -|   | Typography | The standard Beaver Builder [typography section](basics/typography.md) for the post info. | -| **Post content** | Color | Color of the post content. | -|   | Link color | Color of text links. | -|   | Link hover color | Hover color of text links. | -|   | Typography | The standard Beaver Builder [typography section](basics/typography.md) for the post content. | -| **Nav arrows** (Only when **Show arrows** is set to **Yes** on the **Slider** tab) | Arrows background color | Sets the color of a circle or square background behind the navigation arrows. When no color is set, there is no background circle or square. | -|   | Arrows background style | Sets the arrow background to a circle or a square. | -|   | Arrows color | Sets the color of the arrows themselves. | - -## Content tab - -| Section | Field | Description | -| ---------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -|   | Source | Main query or custom query. The default for a standard Beaver Builder layout is **Custom query**, which enables all the other fields on this tab.
In Beaver Themer, the default is **Main query**, because normally for a Themer layout you want the query for posts to be based on whatever archive page the query is created for. | -| **Custom query** | Post type | Choose pages, posts, or a custom post type, such as WooCommerce Products or a custom post type that you create yourself. | -|   | Order | Descending or ascending, and whether it is by date, numerical, or alphabetical depends on the **Order by** setting. | -|   | Order by | The choices are **Author**, **Comment count**, **Date**, **Date last modified**, **ID**, **Menu order**, **Meta value** (alphabetic or numeric), **Random**, **Title**.
If you display pages in **Menu order**, you are effectively displaying a menu, with the added ability to display a content summary of the page.
The **Meta value** option enables ordering by a custom field. If you select either the alphabetic or numeric **Meta value** option, a **Meta key** field appears so you can enter the key (`meta_key`). | -|   | Offset | Enter an integer if you want to skip a certain number of posts in the order specified in the **Order** setting. | -|   | Exclude current post | Excludes the current post from the query. This is useful when you are using the module to create a list of related posts on a single post page. | -| **Filter** | Posts, Pages, Products, etc. | (The label matches the single post name for the **Post type** you set)
Include or exclude a set of posts, page, products, etc., by title. Start typing a word, and the titles containing that word will be displayed for you to choose. Keep selecting titles until you have the set you want to include or exclude. You can reorder matched selections and they are reflected in the front end. See an example for the Posts module at [Selection Order in Filtering](/beaver-builder/layouts/modules/posts/posts.md#selection-order-in-filtering). | -|   | Categories | (Hidden when the **Post type** setting is **Pages**)
You can include or exclude categories to display.
The third setting, **Match related categories except**, is useful in Singular-type Themer layouts when you want to use the Posts module to display a list of related posts, and you want to display the related posts in a family of categories except for the specific categories that you name. | -|   | Tags | (Hidden when the **Post type** setting is **Pages** )
You can include or exclude tags to display. The choices are the same as for including or excluding categories. | -|   | Authors | You can include or exclude posts or pages by specific authors. | - -## Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/posts/posts.md b/beaver-builder/layouts/modules/posts/posts.md deleted file mode 100644 index ad36e177..00000000 --- a/beaver-builder/layouts/modules/posts/posts.md +++ /dev/null @@ -1,691 +0,0 @@ ---- -id: posts -title: Posts -sidebar_label: Posts -description: The Posts module allows you to display posts, pages, or custom post types in a variety of layouts, such as columns, gallery, list, or masonry. -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -The Posts module allows you to display posts, pages, or custom post types in a variety of layouts, such as columns, gallery, list, or masonry. You can display posts by taxonomy or author using the filter options. - -![Beaver Builder Posts module](/img/beaver-builder/modules--post-module--1.jpg) - -## Layout tab - -Using the Layout tab, you can customize the layout and control which elements are displayed in your posts, such as the featured image, date, and comments. - -### Layout - -![Posts module layouts](/img/beaver-builder/modules--post-module--2.jpg) - -#### Columns - -Posts are displayed in top-aligned rows. Title, metadata, and content appear under featured image. Columns layout lets you choose number of columns. - -#### Masonry - -Posts are displayed in columns but vertical spacing is fit to the height of the post (unless the equal heights setting is selected). Masonry layout lets you choose the width of each post in pixels. - -#### Gallery - -Post title and metadata are overlaid on the featured image and displayed on mouseover. There is no option to display content. if there is no featured image, an image icon is displayed. Gallery layout offers no options to set number of columns or post width. - -:::tip -It is recommended that all featured images have similar dimensions in order to achieve the best results and to maintain consistency -::: - -#### List - -The posts are listed vertically in a single column. - -### Post layout - -:::caution -Post Layout is only available when Beaver Themer is installed. -::: - -#### Default - -Use the layout selected from the [Layout option](#layout). - -#### Custom - -Enables the Custom Post Layout Editor, allowing you to customize the post layout using HTML, shortcodes, and Beaver Themer field connections. A CSS tab is also available in the Custom Post Layout Editor for entering CSS that applies only to that Post module. - -![Post module's custom post layout editor](/img/beaver-builder/modules--post-module--3.jpg) - -:::info -The Custom Post Layout Editor overrides whatever layout you select from the [Layout option](#layout). -::: - -#### WooCommerce Classes - -Adds the `woocommerce` and `woocommerce-page` classes to module wrapper. - -:::caution -Only available when **Custom** is selected. -::: - -```markup -
-``` - -### Equal Heights - -Equalizes the height of all posts to fit the post with the greatest height. - -:::caution -Available for Columns and Masonry layouts only. -::: - -:::tip -Setting **Equal Heights** to **Yes** for the **Masonry** layout changes the masonry appearance to look like the **Columns** layout. The major difference is that you set width of each post in **Masonry** layout and number of columns in **Columns** layout. -::: - -### Columns - -Control the maximum number of columns for the Post module. Automatically adjusts as screen size reduces. The Column option supports the [Responsive Toggle](/beaver-builder/layouts/responsive-design/toggle.md) allowing you to choose a different number of columns per-device. - -:::caution -Available for Columns layout only. -::: - -### Post width - -Width of each post display in pixels. The default value is `300px`. - -:::caution -Masonry layout only. -::: - -### Post Spacing - -Allows you to control the distance between the individual posts horizontally and vertically, in pixels. The Post spacing value does not affect the spacing above the top layer of posts, but it does affect the spacing below the bottom layer of posts. - -### Post Padding - -Allows you to control the padding inside the individual posts. The featured image is not affected by this setting, so if there is a featured image the upper post padding occurs between the featured image and the post text. - -### Posts Element - -Allows you to choose an appropriate HTML5 sectioning content element replacing the default `
`. Choose between `
` (default), `
`, and `
  • `. Using these elements on your pages gives your content more semantic meaning, improving accessibility and machine-readability. - -### Posts Element Class - -Allows you assign a custom class to the `
    `. - -```markup title="Example" -
    -
    -

    Hello World

    -
    -

    Welcome to WordPress. This is your first post. Edit or delete it, then start writing!

    -
    -
    - Read More... -
    -
    -
    -``` - -### Post Title Tag - -Choose an appropriate heading tag for the post title. You can choose between `

    `, `

    `, `

    `, `

    `, `

    `, and `
    `. - -Default is `

    `. - -### Featured Image - -Show or hide the post's featured image. - -:::tip -It is recommended that all featured images have similar dimensions in order to achieve the best results and to maintain consistency. -::: - -:::caution -Available for all layouts except Gallery. Gallery layouts automatically use the featured image as the background image. -::: - -### Fallback image - -Choose a fallback image to appear for posts without featured images. - -### Image position - -Set the position of the featured image relative to post title or post content. - -- **Columns & Masonry** - Above Post Title or Above Post Content. -- **List** - Above Title, Above Content, Left, Left Content, Right, and Right Content. - -:::caution -Available for all layouts except Gallery. -::: - -### Image Size - -Choose which image size from the WordPress Media Library to use. - -:::tip -Any [Custom Image Sizes](advanced/custom-image-sizes.md) added also become available in the list. -::: - -:::caution -Available for all layouts except Gallery. -::: - -### Equal Height Images - -Choose whether all featured images should have the same height. You can select from the following options: - -- **Disabled:** Featured images will display at their natural height. -- **Fixed Height:** All featured images will have a consistent, fixed height. -- **Aspect Ratio:** All featured images will maintain the same aspect ratio. - -When selecting **Fixed Height** or **Aspect Ratio**, the CSS property `object-fit` will be set to `cover` to maintain each image's aspect ratio. - -### Image Spacing - -Adds padding to the around the image. Where the spacing occurs depends on the Image position setting. - -- **Above Title**: The number of pixels above, left, and right of the image. -- **Above Content**: The number of pixels left and right of the image. -- **Left or Left Content** _(List only)_: Spacing between the image and the text to the right. -- **Right or Right Content** _(List only)_: Spacing between the image and the text to the left. - -### Image width - -When Image position is **Left**, **Left Content**, **Right** or **Right Content** the Image width setting determines the column width for the image. - -:::caution -Available for List layout only. -::: - -### Author - -Show or hide the post author. - -### Enable Author Link - -Enable or disable the author link. - -### Date - -Show or hide the post date. - -### Date format - -Select **Default** to use the WordPress date format specified in **WordPress Admin Dashboard Settings > General** or override the default with a specific date format. - -:::info -Appears when **Date** is set to **Show**. -::: - -### Comments - -Show or hide the number of comments. - -:::caution -Available for Columns, Masonry, and List layouts only. -::: - -### Separator - -Choose the character that separates the display of author, date, and comments on the same line. - -The default is the Pipe `|` symbol. - -:::caution -Available for Columns, Masonry, and List layouts only. -::: - -### Terms - -Show or hide the post terms. - -### Terms Label - -Choose the text that prefixes the post terms. The default is **Posted in**. For example, **Posted in Uncategorized**. - -### Terms Separator - -Choose the character that separates the display of terms on the same line. - -The default is a comma `,`. - -### Content - -Show or hide post content. If set to **Yes**, the post excerpt is displayed, with an ellipsis of three dots at the end to show there is more content. - -### Content Type - -- **Excerpt** - Show the post excerpt. -- **Full Text** - Show the full content of each post. - If **Full Text** is selected, the **Content Length** option is no longer available. - -:::caution -Available for List layout only. -::: - -:::tip -WordPress removes all formatting from excerpts by default. If the post contains HTML formatting, the excerpt may appear incorrectly. To solve this problem, add a [custom excerpt](https://wordpress.org/support/article/excerpt-b/) that includes the HTML formatting. -::: - -### Content length - -Set a custom number of words in the post excerpt to display. - -The default is **55**. - -### More link - -Show or hide the Read more link after the post content. If set to **Show**, you can also customize the default Read more text. - -### More Link Text - -Customize the default **Read more...** text. - -:::info -Appears if **More Link** is set to **Show** -::: - -### WooCommerce - -The WooCommerce options appear in the [Layout tab](#layout-tab) when WooCommerce is installed. - -- **Product Ordering** - Show or hide product ordering and product results information (Showing 1–16 of 22 results). -- **Sale** - Show or hide the On Sale label. -- **Rating** - Show or hide the product rating. -- **Price** - Show or hide the product price. -- **Cart** - Show or hide the add to cart button. -- **Show Hidden Products** - Show or hide [hidden products](https://woocommerce.com/document/managing-products/#setting-catalog-visibility-options-and-feature-status). - -### Events Calendar - -The Events Calendar options appear in the [Layout tab](#layout-tab) when the Events Calendar is installed. - -- **Event Date** - Show or hide the event date. -- **Event Venue** - Show or hide the event venue. -- **Event Address** - Show or hide the event address. -- **Event Cost** - Show or hide the event cost. -- **Events Order By** - The choices are: Default, Start Date, and End Date. Selecting **Default** uses the sorting option via the [Content tab](#content-tab). -- **Events Order** - Choose between descending or ascending. -- **Show Events** - The choices are: Future Events, Past Events, Todays Events, All Events, and [Featured Events](https://theeventscalendar.com/knowledgebase/k/featured-events/). - -## Style tab - -The Style tab allows you to style the individual elements of the post, including the post title, contents, and the read more link, by adjusting the colors and typography. - -:::info -Style tab options vary based on [Post Layout](#post-layout). -::: - -:::caution -The Style tab is unavailable if [Post Layout](#post-layout) is set to **Custom**. Posts can be styled using the CSS tab in the Custom Layout Editor. -::: - -### Post alignment - -Sets the overall alignment of the post title, post info, and post content. This setting can be overridden for each component in the **Typography** subsection for each component (title, info, content) in the **Text** section of the **Style** tab. - -### Post Background Color - -Set a background color for each post using the color picker. - -### Border - -The Border section has settings for border, radius, and shadow. - -:::info -The Post module has a `1px` border by default. To remove the border, set the **Border > Style** option to **None**. -::: - -See the [Borders](../../../basics/border.md) article for more information. - -### Title Color - -Set the color of the post title. - -### Title Typography - -You can style the title of the post using the [Typography](basics/typography.md) options, including font size, family, line height, and more. - -### Post Info Color - -Color of the post info (author, date, comments, separator). - -:::info -By default the link color in the Post Info is set by the theme's accent color, if there is one. If you set Post info color, the color of the entire Post Info line is this color, with no distinction between text and links. -::: - -### Post Info Typography - -You can style the post info using the [Typography](basics/typography.md) options, including font size, family, line height, and more. - -### Content Color - -Color of post content. - -### Content Typography - -You can style the content of the post using the [Typography](basics/typography.md) options, including font size, family, line height, and more. - -### Link Color - -Sets the color of links in full-text post content or custom excerpts. - -### Link Hover Color - -Sets the hover color of links in full-text post content or custom excerpts. - -### Gallery Layout - -The following styling options are available for the [Gallery layout](#layout) only. - -- **Hover transition** - The type of transition when a user mouses over a post in the display: fade, slide up or down, scale up or down. -- **Overlay Text Color** - The color of text overlaid on the featured image. -- **Overlay Background Color** - The color of the overlay placed on the featured image. This setting is generally used to make the overlay text color more legible. Opacity is set in the color picker. -- **Use Icon for Posts** - Choose **Yes** to display an icon on the line above or below the text. -- **Post Icon** - Select the icon you want to display. -- **Post Icon Position** - Above or below the text. -- **Post Icon Color** - Set the Icon color. -- **Post Icon Size** - Icon size in pixels. - -### WooCommerce - -The WooCommerce options appear in the [Style tab](#style-tab) when WooCommerce is installed. - -- **Product Sale Background** - Set the Sale background color. -- **Product Sale Text Color** - Set the Sale text color. -- **Product Rating Foreground** - Set the product rating foreground color. -- **Product Rating Background** - Set the product rating background color. -- **Product Rating Font Size** - Set the product rating font size. -- **Product Price Text Color** - Set the product price color. -- **Product Price Font Size** - Set the product price font size. - -#### WooCommerce Cart Button - -- **Background Color** - Set the background color for the add to cart button. -- **Text Color** - Set the text color for the add to cart button. -- **Hover Background Color** - Set the background hover color for the add to cart button. -- **Hover Text Color** - Set the text hover color for the add to cart button. - -## Content tab - -The Content tab allows you to control the source of your posts and what content is displayed using the filter options. - -### Source - -Choose between Main Query or Custom Query. The default query is **Custom Query**. - -#### Main Query - -The main query is used to display the primary content on that page or post. Most of the time, the main query will not be appropriate for Beaver Builder layouts and a custom query should be used instead. - -:::tip -It is recommended to use the main query over the custom query when creating Beaver Themer archive layouts, such as the blog page, categories, tags, and search results. -::: - -:::info Example -Suppose you create a Beaver Themer archive layout and assign it to all archives on your website with a custom query as the source in the Post module. All archives on your website will display the same posts. - -However, when you use the main query as the source and view your archive pages, the posts will display correctly. -::: - -:::caution -The custom query and filter options are removed when main query is selected. The main query cannot be customized or filtered via the Post module. To do this, you will need to use the [`pre_get_posts()`](https://developer.wordpress.org/reference/hooks/pre_get_posts/) hook. -::: - -#### Custom Query - -The custom query is the most appropriate option for Beaver Builder layouts, as it reflects the configuration of the custom query options and filters. - -You can use the custom query option if you wish to display specific pages, posts, or custom post types on any of your pages or posts. For example, your homepage could be used as a showcase for WooCommerce products. - -### Post Type - -Select the post type(s) you wish to populate the Post module with. You can choose pages, posts, or a custom post type, such as WooCommerce Products or a custom post type that you created yourself. - -You can also select more than one post type with the Post Type option. For example, you can display both posts and pages, or both posts and WooCommerce products. - -### Order - -Descending or ascending, and whether it is by date, numerical, or alphabetical depends on the **Order by** setting. - -:::info Example -A featured post could be displayed on your homepage using a Post module configured to display one post. You could then place another Post module below and use an offset of 1 to skip over the featured post. -::: - -### Order By - -The choices are: **Author**, **Comment count**, **Date**, **Date last modified**, **ID**, **Menu order**, **Meta value** (alphabetic or numeric), **Random**, **Title**, **Selection order**. - -- **Menu order** can be used with a plugin such as [Post Types Order](https://wordpress.org/plugins/post-types-order/) to order the posts or custom posts in the same way you arrange them in the back end. - -- **Meta value** option enables ordering by a custom field. If you select either the alphabetic or numeric **Meta value** option, a **Meta key** field appears so you can enter the key (`meta_key`). - -- **Selection Order** allows you to use drag and drop to reorder posts, pages, or custom post types added to the Filter settings. The order in which your posts, pages, or custom post types appear is reflected in the order of the items that appear on the page. - - ![Reorder posts, pages, or custom post types using drag and drop](/img/beaver-builder/modules--post-module--4.gif) - - :::info - Selection order works only for selected posts, pages, and custom posts. It doesn't work for selected categories, tags, or authors. - - The Ascending and Descending settings don't affect the order of posts when Selection order is used. - ::: - -### Offset - -The Offset option allows you to exclude a certain number of pages or posts from the Post module. - -For example, using the Offset option, you can skip the most recent post on your website on pages that use more than one Post module. - -### Exclude Current Post - -Excludes the current post from the query. This is useful when you are using the Post module to create a list of related posts on a single post page. - -### Filter - -The Filter section allows you to include or exclude a set of posts, pages or custom post types by title, taxonomy, and author. - -Filter options vary depending on the post type selected. The post category and tag filters will not be available if you select Products (WooCommerce). - -:::caution -If you use [Multi-select Post Types](#post-type), filters from one post type apply to all post types because there is an AND filter relationship. For example, if you choose to display both posts and pages but filter to show only one specific page for pages, there will be no posts displayed. -::: - -:::info -Start typing a word, and the filter options will display any title that matches what you typed. Keep selecting titles until you have the set you want to include or exclude. You can reorder the selections and how they are reflected in the front end. See also Selection Order in Filtering. -::: - -- **Post** - Include or exclude a post or multiple posts, by typing the post title(s). -- **Page** - Include or exclude a page or multiple pages, by typing the page title(s) -- **Custom Post Type** - Include or exclude a set of posts from the custom post type, by the custom post type title(s). -- **Categories** - Include or exclude posts assigned to a specific category. -- **Custom Taxonomies** - Include or exclude custom post types assigned to custom taxonomies. For example, if WooCommerce is installed, the Product Categories and Product Tag taxonomies are available. - - :::info - **Match related categories except**, is useful in Singular-type Themer layouts when you want to use the Posts module to display a list of related posts, and you want to display the related posts in a family of categories except for the specific categories that you name. - ::: - -- **Tags** - Include or exclude posts assigned to a specific tag. -- **Authors** - Include or exclude posts or pages by specific authors. - -### Custom Field Filter - -The Custom Field Filter section allows you to include or exclude a set of posts, pages or custom post types by custom field. You can add as many custom fields as you want. - -#### Relation - -The Relation option allows you to apply logic to filter by custom fields. The rules operate with `AND` or `OR` logic. - -#### Edit/Add Custom Field - -- **Label** - Labels are used to identify custom fields. They appear in the Custom Field Filter section. -- **Meta Key** - Custom field key or field name. -- **Meta Value** - Custom field value. -- **Type** - A list of all available field types supported. Choose between: - - - **Numeric** - - **Binary** - - **Text** - - **Date** - - **Date Time** - - **Decimal** - - **Signed** - - **Time** - - **Unsigned** - -- **Compare** - You can use the Compare option to check whether or not the field value matches, or if it is greater than, less than, or the same as, depending on the comparison operator. Choose from the following operators: - - - **Equals** - - **Does not equal** - - **Greater than** - - **Less than** - - **Greater than or equal to** - - **Less than or equal to** - - **Exists** - - **Not Exists** - -## Pagination tab - -The **Pagination** tab has settings that let you divide a large collection of posts into multiple pages. - -### Pagination style - -- **Numbers** - The pagination appears as numbers under the posts, and when a different number is clicked, a new page loads with the new set of posts. -- **Scroll** - A new set of posts are loaded into subsequent rows on the same page as the user scrolls down. -- **Load More Button** - The Load More Button appears under the initial set of posts, and when clicked it generates the next set of posts. The user must keep clicking to get each next set of posts. This setting works better than Scroll when you want your users to have more control over the display, or when network bandwidth is low and you don't want to use resources loading more sets of posts unless the user really wants to see them. - - :::tip - You can use the Load More Button style options to control the button's background, text, and icon colors. - ::: - -- **None** - No Pagination. Use this setting when you want to display only a subset of posts. For example, you might want to display only the three most recent posts. - -### Posts Per Page - -Determines how many posts constitute each set. The default is 10 posts. - -:::tip -Posts Per Page does not set the number of columns across the page. That is controlled automatically according settings on the [Layout tab](#layout-tab) and screen width. For example, if the screen size allows 3 posts per row and your **Posts Per Page** is set to **5**, you will see three posts in the first row and two posts in the second row in the first chunk of posts. -::: - -:::info -When **Source** on the [Content tab](#content-tab) is set to **Main query**, the **Posts per page** setting does not appear. In this case, the number of posts that appears on the page is determined by the WordPress value for the **Blog pages show at most** field at **WordPress Admin Dashboard > Settings > Reading**. -::: - -### No Results Message - -The message displayed when there are no posts to display. - -:::tip -This option also supports shortcodes, which lets you add more complex layouts (rows, columns, modules, templates) than just text. -::: - -### Show Search - -Show or hide a search form when no posts are found. See the screenshot below the table. - -### Load More Button Styling - -This section appears when [Pagination Style](#pagination-style) is set to **Load More Button**. - -- **Button Text** - The text that appears on the Load More Button. -- **Button Icon** - Optional icon to appear on the button. If you select an icon, there are two additional fields: - - **Icon position**: Before or after the button text. - - **Icon visibility**: The icon can be always visible or appear on hover only. -- **Button Width** - - **Auto Width**: Width adjusts to fit the text and icon. - - **Full Width**: The width expands to the content area minus the module's margin settings. -- **Button Padding** - Set a specific padding value in pixels. Click the Link Value icon to automatically make all four padding values the same. -- **Button Text Color** - Set the button text color in the resting state. -- **Button Text Hover Color** - Set the button color on hover. If this setting is left blank, the Text color setting applies for hover also. -- **Button Typography** - See the [Typography](basics/typography.md) article for more information. -- **Button Background Color** - Set the fill color for the button in the resting state. -- **Button Background Hover Color** - Set the button's fill color on hover. If this setting is left blank, the Background Color setting applies to hover also. -- **Button Background Style** - - **Flat**: consistent fill color - - **Gradient**: gradient of the background color, lighter on top and darker on the bottom. -- **Button Background Animation** - Disabled by default. If set to Enabled, there's a 0.2-second linear transition from resting state to hover state. -- **Button Border** - See the Border article for more information. -- **Button Border Hover Color** - Set the border hover color for the button. - -## Advanced tab - -There are all the usual Advanced tab settings for margins, visibility, animations, and advanced HTML settings. - -See the [Advanced tab](/beaver-builder/layouts/advanced-tab/index.md) for more information. - -## Sticky Posts - -The [Sticky Post](https://wordpress.org/support/article/sticky-posts/) feature in WordPress allows you to place a post at the top of the [Posts page (blog)](https://wordpress.org/support/article/creating-a-static-front-page/), regardless of when it was published, and it will remain there until a new sticky post is published. - -By default, the Post module **ignores** the sticky posts feature and displays them in the order specified in the [Order By](#order-by) option. - -You can override this behavior by using the `fl_builder_loop_query_args_filter` filter. - -```php -function fl_builder_loop_query_args_filter($query_args) -{ - $query_args["ignore_sticky_posts"] = false; - return $query_args; -} -add_filter("fl_builder_loop_query_args", "fl_builder_loop_query_args_filter"); -``` - -:::caution -The Sticky Post feature is only available for Post type post and not for custom post types. -::: diff --git a/beaver-builder/layouts/modules/pricing-table.md b/beaver-builder/layouts/modules/pricing-table.md deleted file mode 100644 index 8e397440..00000000 --- a/beaver-builder/layouts/modules/pricing-table.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -id: pricing-table -title: Pricing Table -sidebar_label: Pricing Table -description: The Pricing Table module inserts a table of columns that display columns that compare features and pricing. ---- - -The Pricing Table module is a table with as many columns -as you like and settings that make it easy to compare pricing and features across columns. You can control nearly every aspect of the table. - -Here's an example of a simple pricing table: - -_Figure 1: Simple pricing table example_ -![Screenshot of a simple pricing table](/img/layouts--modules--pricing-table-module--4.png) - -Pricing tables created with a previous version of Beaver Builder may use a legacy border, shown in the following screenshot. - -_Figure 2: Legacy borders in the Pricing Table module_ -![Pricing table with thicker "legacy" borders](/img/pricing-module-1.png) - -The Legacy border style has fewer customization options but is the default for backward compatibility. - -Here's an example of some of the features you can build into the Pricing Table module: - -_Figure 3: Example of advanced features in the Pricing Table module_ -![Ribbon, icons, tooltips, monthly vs. yearly toggle](/img/layouts--modules--pricing-table-module--3.png) - -The tooltip has text that appears when the user clicks the Tooltip icon, shown in this screenshot. - -_Figure 4: The result of clicking a tooltip in a feature list_ -![Pricing module feature showing tooltip icon and tooltip](/img/layouts--modules--pricing-table-module--5.png) - -You can add HTML markup to any of the settings that accept text, such as the title, price, and features. - -For example, suppose you want to show a crossed-out price with a sale price -displayed in red, shown in Figure 5. In the **Price** field for -that line, enter the following markup: - -```html -$99 $79 -``` - -_Figure 5: HTML markup example to display the sale price_ -![Example of using HTML markup to show a sale price](/img/pricing-module-2.jpg) - -## Settings for the overall pricing table - -### Pricing Boxes tab - -#### Pricing Options section - -This section displays the pricing boxes that form each column in the table. - -- Click **Add pricing box** to create a new pricing column. - This opens the panel with setting for individual pricing boxes -- You can click an icon to the right of any existing price to move the pricing box up or down in the list, duplicate the pricing box, or delete the pricing box. - -#### General section - -- **Enable dual billing** - **Yes** creates the **Monthly/Yearly** toggle at the top of the page, or whatever custom billing intervals you specify. This lets users click the slider button to compare monthly and yearly prices for the items in the table. - If this feature is enabled, there are two additional settings: **Billing option 1** and **Billing option 2**, where you can change the monthly/yearly toggle to different time intervals. - -#### Icons section - -- **Default feature icon** - If you want every feature in every pricing column to show an icon before the feature, such as the checkmarks shown in Figure 1, you can select the icon here. -- **Feature tooltip icon** - By default, the tooltips are displayed with a question mark, shown in Figure 3 You can choose a different icon for this setting if you want. - -### Style tab - -The **Style** tab has three sections: **General style**, **Border**, and **Feature list style**. - -:::info -Style settings in individual pricing boxes override the corresponding general settings. -::: - -#### General Style section - -- **Highlight** - You can choose which row in the column headers to highlight with a color background: the Price row, the Title row, or neither row. The default is a dark gray background and white text but you can adjust these colors on the **Style** tab for the individual pricing boxes. -- **Column height** - **Auto** makes the length of the pricing box fit the content in the column. **Equalize** makes every pricing box the length of the longest one and the bottom buttons in all the pricing boxes are aligned. -- **Features min height** - Sets a custom minimum height for the features in all of the pricing boxes. -- **Advanced spacing** - Creates space to the left and right of all the pricing boxes. - -#### Border section - -- **Border type** - You have a choice of **Standard** (Figure 1) or **Legacy** (Figure 2). - -The **Standard** border type has the regular Border section with settings for a [border and border effects](basics/border.md). - -The **Legacy** border type has the following settings: - -- **Border style** - This option controls the width of the border. The choices are **Rounded** or **Straight**. -- **Border size** - The choices are **Large**, **Medium**, or **Small**. Figure 2 has a **Large** border width. - -#### Feature List Style section - -This section has styles that apply to all of the features in all of the pricing boxes. - -- **Show list separator** - Shows a horizontal line between the features in the list. -- **Separator line color** - Sets the color of the separator. -- **Feature icon size** - Sets the size of icons in the feature lists. -- **Feature icon color** - Sets the color of icons in the feature lists. -- **Feature text color** - Sets the color of the feature text. -- **Feature list text typography** - The standard Beaver Builder [Typography section](basics/typography.md) for setting font family, weight, spacing, and so on. -- **Tooltip icon size** -- **Tooltip icon color** - The color of the circular background behind the tooltip icon. By default, the color is gray (#808080). -- **Tooltip text color** - The color of the text in the tooltip that appears after you click the tooltip icon. By default, the color is light black (#333333). -- **Tooltip background color** - The color that appears behind the tooltip text. - -### Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. - -## Individual pricing box settings - -If you click any of the pricing boxes in the list on the **Pricing boxes** tab, a new panel opens with three tabs: **General**, **Button**, and **Style**. - -### General tab for each pricing box - -The **General** tab has four sections: **Title**, **Ribbon**, **Price box**, and **Features**. - -#### Title section - -- Title - Enter the text you want for the title. - -#### Ribbon section - -- **Show ribbon** - If you choose **Yes**, there are two additional options: -- **Ribbon Text** - Enter the text you want for the ribbon. -- **Ribbon position** - The **Top** setting places the ribbon in a box above the title. The **Top left** and **Top right** choices are diagonal. If the ribbon occludes the title of the pricing box, you can adjust the **Ribbon height** and **Ribbon offset** on the **Style** tab. - -#### Price box section - -- **Price** - Enter the price you want to display. Include the currency symbol here if you want one. -- **Duration** - If there is a duration to the price, or other information you want to display after the price, enter the text here. - -#### Features section - -This section lets you enter the individual features. Each feature has the following settings. - -- **Description** - Enter the feature text. - -If you want to enter additional settings for this feature, click the down arrow to reveal the following two settings. - -- **Feature icon** - If you want to add an icon for this feature only, select it here. - -- **Tooltip** - If you want a tooltip for this feature, enter the tooltip text. - -Click the **Add price features** button to enter the next feature. - -### Button tab for each pricing box - -These settings are the same as settings for the [Button module](/beaver-builder/layouts/modules/button/button.md). - -- **Button text** -- **Button URL** -- **Button icon** -- **Button style** -- **Button text** -- **Button background** -- **Button border** - -### Style tab for each pricing box - -This tab has the following sections: **General style**, **Title style**, **Price style**, **Ribbon style**, and **Feature list style**. - -#### General Style section - -- **Box color** -- **Accent color** -- **Accent text color** -- **Box top margin** - -#### Title Style section - -- **Title color** -- **Title typography** - -#### Price Style section - -- **Typography** - -#### Ribbon Style section - -Here's a screenshot example of settings for a ribbon in the **Top position**. - -_Figure 6: Ribbon style settings, individual pricing box_ -![Screenshot of ribbon style settings, individual pricing box](/img/layouts--modules--pricing-table-module--6.png) - -- **Ribbon text color** -- **Ribbon background color** -- **Ribbon height** - Sets the height of the ribbon color background. -- **Ribbon height offset** or **Ribbon side offset** - Adjusts the ribbon height when the location for the ribbon is **Top**. Adjusts the ribbon side offset when the location for ribbon is **Top right** or **Top left**. - -#### Feature List Style section - -This section styles the individual feature icon and text and the tooltip icon and text. - -- **Feature icon color** -- **Feature text color** -- **Tooltip icon color** -- **Tooltip text color** diff --git a/beaver-builder/layouts/modules/pricing-table.mdx b/beaver-builder/layouts/modules/pricing-table.mdx new file mode 100644 index 00000000..4c5d92bb --- /dev/null +++ b/beaver-builder/layouts/modules/pricing-table.mdx @@ -0,0 +1,1036 @@ +--- +title: Pricing Table +sidebar_label: Pricing Table +icon: "table-properties" +description: "Use Pricing Table to build side-by-side pricing boxes with feature lists, ribbons, dual billing, and call-to-action buttons." +--- + + +Use Pricing Table to build side-by-side pricing boxes with feature lists, ribbons, dual billing, and call-to-action buttons. + +## Usage + +Use Pricing Table to compare plans, packages, or tiers in a row of pricing boxes. Each box supports a title, ribbon, price with duration, feature list with optional icons and tooltips, and a call-to-action button. The module renders an embedded Button module per box and supports an optional dual billing toggle so visitors can switch between two billing options, such as monthly and yearly. + +Use Pricing Table on sales pages, product pages, signup flows, and landing pages where prospects need a quick comparison of plans and a clear path to convert. It fits SaaS pricing, membership tiers, service packages, and donation levels where each option needs its own feature list and CTA. + +## Module Settings + +The Pricing Table module settings control the pricing boxes and their content, the icons and tooltips used in feature lists, and the shared styling for borders, feature lists, the dual billing toggle, and billing terms. + +### Pricing Boxes Tab + +The Pricing Boxes tab manages the individual pricing boxes shown in the table, the dual billing toggle, and the default icons used across feature lists. + +
    +Pricing Box + + +The Pricing Box repeater adds, removes, and reorders the columns shown in the pricing table. Each entry opens its own settings form with **General**, **Button**, and **Style** tabs. + +
    +General Tab + + +
    +Title + + +The heading shown at the top of the pricing box. +
    + +
    +Ribbon + + +The Ribbon section adds a labeled banner to the pricing box, often used to mark a featured or recommended plan. + +
    +Ribbon Settings + + +
    +Show Ribbon Default: No + + +Shows or hides the ribbon on this pricing box. Selecting **Yes** reveals the ribbon text and position fields and the **Ribbon Style** section in the Style tab. +
    + +
    +Ribbon Text Supports: Field Connections + + +The text displayed inside the ribbon. Nothing displays if left empty. +
    + +
    +Ribbon Position Default: Top + + +Sets where the ribbon attaches to the pricing box. + +- **Top:** Places a full-width ribbon above the pricing box. +- **Top Right:** Places a diagonal ribbon in the top right corner of the box. +- **Top Left:** Places a diagonal ribbon in the top left corner of the box. + +
    +
    +
    + +
    +Price Box + + +The Price Box section sets the price values displayed in the box. + +
    +Price Box Settings + + +
    +Price Default: $ 0.00 + + +The primary price displayed in the box. When **Enable Dual Billing?** is set to **No**, this is the only price shown. +
    + +
    +Duration + + +The text shown next to the price, such as `per Year`. Used when **Enable Dual Billing?** is set to **No**. +
    + +
    +Price Option 2 Default: $ 0.00 + + +The price shown for the second billing option. Displayed when **Enable Dual Billing?** is set to **Yes** and the visitor toggles to the second option. +
    +
    +
    + +
    +Features + + +The Features section manages the feature list shown inside the pricing box. + +
    +Price Features + + +
    +Price Features + + +A repeater of feature rows for this pricing box. Each row accepts a description, an optional icon that overrides the default feature icon, and optional tooltip text shown when the visitor activates the tooltip icon. +
    +
    +
    +
    + +
    +Button Tab + + +
    +Button Text Default: Get Started + + +The label displayed on the call-to-action button. +
    + +
    +Button URL Supports: Field Connections + + +The destination link used when the button is clicked. + +
    +Link settings + +Link settings control the URL, link target, nofollow behavior, download behavior, and other link attributes where available. + +
    +
    + +
    +Separate Billing Option URLs Default: No + + +Controls whether the button uses a single URL for both billing options or a separate URL for each. Set to **Yes** to reveal **Button URL (Option 2)**, which is used when the visitor toggles to the second billing option. + +
    +Button URL (Option 2) + + +
    +Button URL (Option 2) Supports: Field Connections + + +The link used for the second billing option when **Separate Billing Option URLs** is set to **Yes**. + +
    +Link settings + +Link settings control the URL, link target, nofollow behavior, download behavior, and other link attributes where available. + +
    +
    +
    +
    + +
    +Button Icon + + +The Button Icon section adds and styles an optional icon on the button. + +
    +Button Icon Settings + + +
    +Button Icon Supports: Field Connections + + +Selects an icon from the icon picker, or removes the current icon. +
    + +
    +Button Icon Position Default: Before Text + + +Places the icon before or after the button text when an icon is selected. +
    + +
    +Button Icon Visibility Default: Always Visible + + +Keeps the icon visible or fades it in on hover when an icon is selected. + +- **Always Visible:** The icon is shown at all times. +- **Fade In On Hover:** The icon fades in when the button is hovered. + +
    +
    +
    + +
    +Button Style + + +The Button Style section controls the size, alignment, and inner spacing of the button. + +
    +Button Style Settings + + +
    +Button Width Default: Full Width + + +Sets the button width. + +- **Auto:** The button width fits its text and padding. Reveals **Button Align**. +- **Full Width:** The button stretches to fill the column. + +
    +Button Align + + +
    +Button Align Default: Center; Supports: Responsive + + +The horizontal alignment of the button when **Button Width** is set to **Auto**. +
    +
    +
    + +
    +Button Padding Supports: Responsive + + +The inner spacing of the button. +
    +
    +
    + +
    +Button Text + + +The Button Text section controls the color and typography of the button label. + +
    +Button Text Settings + + +
    +Button Text Color Default: ffffff; Supports: Field Connections + + +The color of the button label. +
    + +
    +Button Text Hover Color Supports: Field Connections + + +The color of the button label on hover and focus. +
    + +
    +Button Typography Supports: Responsive + + +The font settings for the button label. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    +
    +
    + +
    +Button Background + + +The Button Background section controls the background color, fill style, and hover transition of the button. + +
    +Button Background Settings + + +
    +Button Background Color Supports: Field Connections + + +The default background color of the button. +
    + +
    +Button Background Hover Color Supports: Field Connections + + +The background color used when the button is hovered or focused. +
    + +
    +Button Background Style Default: Flat + + +Selects between a solid or gradient button background. + +- **Flat:** Uses the **Button Background Color** as a solid fill. +- **Gradient:** Renders a gradient based on the configured background colors. + +
    + +
    +Button Background Animation Default: Disabled + + +Enables or disables the transition between the normal and hover background states. +
    +
    +
    + +
    +Button Border + + +The Button Border section controls the border around the button. + +
    +Button Border Settings + + +
    +Button Border Supports: Responsive + + +The border style, width, radius, and color applied to the button. +
    + +
    +Button Border Hover Color Supports: Field Connections + + +The border color used when the button is hovered or focused. +
    +
    +
    +
    + +
    +Style Tab + + +
    +General Style + + +The General Style section controls the box colors, accent colors, and top margin for this pricing box. + +
    +General Style Settings + + +
    +Box Border Default: F2F2F2; Supports: Field Connections + + +The color used for the border around this pricing box. +
    + +
    +Box Color Default: ffffff; Supports: Field Connections + + +The background color of the pricing box body. +
    + +
    +Accent Color Default: 66686b; Supports: Field Connections + + +The accent color used for the highlighted area, such as the price or title region depending on the **Highlight** setting. +
    + +
    +Accent Text Color Default: ffffff; Supports: Field Connections + + +The text color used inside the highlighted area. +
    + +
    +Box Top Margin Default: 0; Supports: Responsive + + +The top margin applied to this pricing box, useful for offsetting a featured column. +
    +
    +
    + +
    +Title Style + + +The Title Style section controls the appearance of the pricing box title. + +
    +Title Style Settings + + +
    +Title Color Default: 333333 + + +The color of the pricing box title. +
    + +
    +Title Typography Supports: Responsive + + +The font settings for the pricing box title. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    +
    +
    + +
    +Price Style + + +The Price Style section controls the appearance of the price value. + +
    +Price Style Settings + + +
    +Price Color + + +The color of the price text. +
    + +
    +Typography Supports: Responsive + + +The font settings for the price text. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    +
    +
    + +
    +Ribbon Style + + +This section is available when **Show Ribbon** is set to **Yes** in the General tab. + +
    +Ribbon Style Settings + + +
    +Ribbon Text Color Default: FFFFFF; Supports: Field Connections + + +The text color used inside the ribbon. +
    + +
    +Ribbon Background Color Default: F8463F; Supports: Field Connections + + +The background color of the ribbon. +
    + +
    +Typography Supports: Responsive + + +The font settings for the ribbon text. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    + +
    +Ribbon Height Default: 30 + + +The height of the ribbon, in pixels. +
    + +
    +Ribbon Top Margin Default: -15 + + +The top margin applied to the ribbon when **Ribbon Position** is set to **Top**, in pixels. +
    + +
    +Top Ribbon Padding Default: 0 + + +The inner spacing of the ribbon when **Ribbon Position** is set to **Top**. +
    + +
    +Top Ribbon Border + + +The border style, width, radius, and color applied to the ribbon when **Ribbon Position** is set to **Top**. +
    + +
    +Ribbon Side Offset Default: 40 + + +The horizontal offset of the ribbon, in pixels, when **Ribbon Position** is set to **Top Right** or **Top Left**. +
    +
    +
    + +
    +Feature List Style + + +The Feature List Style section overrides the shared feature list colors for this pricing box. + +
    +Feature List Style Settings + + +
    +Feature Icon Color + + +The color applied to the feature icons in this box. Overrides the shared **Feature Icon Color** in the Style tab. +
    + +
    +Feature Text Color + + +The color applied to the feature text in this box. Overrides the shared **Feature Text Color** in the Style tab. +
    + +
    +Tooltip Icon Color + + +The color applied to the tooltip icon in this box. Overrides the shared **Tooltip Icon Color** in the Style tab. +
    + +
    +Tooltip Text Color + + +The text color used inside tooltips in this box. Overrides the shared tooltip text color set in the Style tab. +
    + +
    +Tooltip Background Color + + +The background color used for tooltips in this box. Overrides the shared tooltip background color set in the Style tab. +
    +
    +
    +
    +
    + +
    +General + + +The General section controls the dual billing toggle and the labels used for each billing option. + +
    +General Settings + + +
    +Enable Dual Billing? Default: No + + +Adds a toggle that lets visitors switch between two billing options, such as monthly and yearly. Selecting **Yes** reveals the billing option labels, billing term fields, the **Toggle Price Button** style section, and the **Billing Term Style** section. +
    + +
    +Billing Option 1 Default: Monthly + + +The label shown next to the first billing toggle option. +
    + +
    +Billing Option 2 Default: Yearly + + +The label shown next to the second billing toggle option. +
    + +
    +Billing Term (Option 1) + + +The text shown next to the first price when dual billing is enabled, such as `per month`. Leave empty to hide. +
    + +
    +Billing Term (Option 2) + + +The text shown next to the second price when dual billing is enabled, such as `per year`. Leave empty to hide. +
    +
    +
    + +
    +Icons + + +The Icons section sets the default icons used across all pricing boxes for feature list items and tooltips. Individual feature rows can override the feature icon. + +
    +Icons Settings + + +
    +Default Feature Icon Supports: Field Connections + + +The icon shown next to each feature when no icon is set on the feature row. Individual feature rows can override this. +
    + +
    +Feature Tooltip Icon Default: fas fa-question-circle; Supports: Field Connections + + +The icon used to trigger feature tooltips. Defaults to the question mark icon when not specified. +
    +
    +
    + +### Style Tab + +The Style tab controls the shared appearance of the pricing table, including the highlight area, column heights, borders, feature list styling, the dual billing toggle button, and billing term text. + +
    +General Style + + +The General Style section controls the highlighted area, column height behavior, and outer spacing of the pricing table. + +
    +General Style Settings + + +
    +Highlight Default: Price + + +Selects which region of each pricing box is rendered with the **Accent Color** background. + +- **Price:** Highlights the price region of each box. +- **Title:** Highlights the title region of each box. +- **None:** Disables the accent highlight. + +
    + +
    +Column Height + + +Controls how box heights align across the pricing table. + +- **Equalize:** Sets all columns to the same height as the tallest column. +- **Auto:** Lets each column size to its own content. Reveals **Features Min Height**. + +
    +Features Min Height + + +
    +Features Min Height Default: 0 + + +The minimum height applied to the feature list area, in pixels. Use this to normalize box heights when columns have different numbers of features. +
    +
    +
    + +
    +Advanced Spacing Default: 12; Supports: Responsive + + +The horizontal spacing between pricing boxes, in pixels. +
    +
    +
    + +
    +Border + + +The Border section controls how borders are drawn around each pricing box. + +
    +Border Settings + + +
    +Border Type Default: Legacy + + +Selects which border system the module uses. + +- **Standard:** Uses a single border control with style, width, radius, and color. Reveals **Standard Border**. +- **Legacy:** Uses the original preset-based border. Reveals **Border Style** and **Border Size**. + +
    +Standard Border Settings + + +
    +Standard Border + + +The border style, width, radius, and color applied to each pricing box when **Border Type** is set to **Standard**. +
    +
    + +
    +Legacy Border Settings + + +
    +Border Style Default: Rounded + + +Selects between rounded or straight corners when **Border Type** is set to **Legacy**. + +- **Rounded:** Applies rounded corners to each pricing box. +- **Straight:** Uses square corners on each pricing box. + +
    + +
    +Border Size Default: Wide + + +Sets the visual weight of the legacy border preset. + +- **Large:** A wide border around each pricing box. +- **Medium:** A balanced border weight. +- **Small:** A thin border around each pricing box. + +
    +
    +
    +
    +
    + +
    +Feature List Style + + +The Feature List Style section controls the shared appearance of feature lists, separator lines, and tooltips across all pricing boxes. + +
    +Feature List Style Settings + + +
    +Show List Separator Default: Yes + + +Shows or hides a horizontal separator line between feature rows. Selecting **Yes** reveals **Separator Line Color**. + +
    +Separator Line Color + + +
    +Separator Line Color Default: rgba(0,0,0,0.15) + + +The color of the line drawn between feature rows. +
    +
    +
    + +
    +Feature Icon Size Supports: Responsive + + +The size of each feature icon, in pixels. +
    + +
    +Feature Icon Color Default: 808080 + + +The color applied to feature icons across all pricing boxes. +
    + +
    +Feature Text Color Default: 808080 + + +The color applied to feature text across all pricing boxes. +
    + +
    +Feature List Text Typography Supports: Responsive + + +The font settings for feature list text. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    + +
    +Tooltip Style Default: Dark + + +Selects the visual style used by feature tooltips. + +- **Dark:** Uses a dark tooltip background with light text. Reveals **Tooltip Text Color** and **Tooltip Background Color** for the dark variant. +- **Light:** Uses a light tooltip background with dark text. Reveals **Tooltip Text Color** and **Tooltip Background Color** for the light variant. +- **Legacy:** Uses the original tooltip styling. Reveals **Tooltip Text Color** and **Tooltip Background Color** for the legacy variant. + +
    + +
    +Tooltip Trigger Default: Click + + +Determines how a tooltip opens. + +- **Click:** Opens the tooltip when the visitor clicks the tooltip icon. +- **Hover:** Opens the tooltip when the visitor hovers the tooltip icon. + +
    + +
    +Tooltip Icon Size Supports: Responsive + + +The size of each tooltip icon, in pixels. +
    + +
    +Tooltip Icon Color Default: 808080 + + +The color of the tooltip icon shown next to feature text. +
    + +
    +Tooltip Text Color Default: 333333 + + +The text color used inside legacy tooltips. Applies when **Tooltip Style** is set to **Legacy**. +
    + +
    +Tooltip Background Color + + +The background color used inside legacy tooltips. Applies when **Tooltip Style** is set to **Legacy**. +
    + +
    +Tooltip Text Color (Dark Only) Default: ffffff + + +The text color used inside dark tooltips. Applies when **Tooltip Style** is set to **Dark**. +
    + +
    +Tooltip Background Color (Dark Only) Default: 1f2937 + + +The background color used inside dark tooltips. Applies when **Tooltip Style** is set to **Dark**. +
    + +
    +Tooltip Text Color (Light Only) Default: 111111 + + +The text color used inside light tooltips. Applies when **Tooltip Style** is set to **Light**. +
    + +
    +Tooltip Background Color (Light Only) Default: ffffff + + +The background color used inside light tooltips. Applies when **Tooltip Style** is set to **Light**. +
    +
    +
    + +
    +Toggle Price Button + + +This section is available when **Enable Dual Billing?** is set to **Yes** in the Pricing Boxes tab. + +
    +Toggle Price Button Settings + + +
    +first_option Price Button Color Default: #d5d5d5; Supports: Field Connections + + +The background color of the toggle slider when the first billing option is active. +
    + +
    +second_option Price Button Color Default: #919293; Supports: Field Connections + + +The background color of the toggle slider when the second billing option is active. +
    + +
    +Toggle Price Label Color Default: 333333 + + +The color of the labels shown on either side of the toggle. +
    + +
    +Toggle Price Button Typography Supports: Responsive + + +The font settings for the toggle labels. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    +
    +
    + +
    +Billing Term Style + + +This section is available when **Enable Dual Billing?** is set to **Yes** in the Pricing Boxes tab. + +
    +Billing Term Style Settings + + +
    +Price Term Color + + +The color applied to the billing term text shown next to each price. +
    + +
    +Price Term Typography Supports: Responsive + + +The font settings for the billing term text shown next to each price. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    +
    +
    + +
    +Advanced tab + +The Advanced tab contains common Pricing Table module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    diff --git a/beaver-builder/layouts/modules/rich-text.mdx b/beaver-builder/layouts/modules/rich-text.mdx new file mode 100644 index 00000000..1f613a8e --- /dev/null +++ b/beaver-builder/layouts/modules/rich-text.mdx @@ -0,0 +1,331 @@ +--- +title: Rich Text Editor Module +sidebar_label: Rich Text Editor +icon: "type" +description: "Add and format rich text in your layouts using the WordPress Classic Editor." +--- + + +Add and format rich text in your layouts using the WordPress Classic Editor. + +## Usage + +Use the Text Editor module to insert paragraphs, headings, lists, links, and other rich text content into your layout. It uses the classic WordPress visual editor, making it easy to format content without writing HTML. + +The module supports both visual and text (HTML) editing modes, allowing you to fine-tune markup when needed. Styling options let you control text color, alignment, typography, and spacing so your content stays consistent with the rest of your design. + +:::tip + +The Text module is best for content-focused editing. If you need advanced custom markup, scripts, or embedded code snippets, use the HTML module instead. +::: + +## Module Settings + +The Text Editor module settings control the content and visual appearance of text in your layout. + +### General Tab + +The General tab contains the core content for the Text Editor module. + +
    +Text Editor Supports: Field Connections + + +The Text Editor uses the WordPress Classic Editor, a WYSIWYG editor built on top of TinyMCE, with two editing modes. + +- **Visual:** The default WYSIWYG mode. Content is displayed roughly as it will appear on the front end, and formatting is applied through toolbar buttons. +- **Text:** A raw HTML editing mode for writing or editing HTML directly. The toolbar in this mode offers simplified quick-tag buttons that insert HTML tags around selected text. + +
    + +### Style Tab + +The Style tab controls the visual appearance of the text content. + +
    +Text Color Supports: Responsive, Field Connections + + +Sets the text color. +
    + +
    +Typography Supports: Responsive + + +The font settings for the text content. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    + +
    +Advanced tab + +The Advanced tab contains common Text Editor module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    + +## Using the Toolbar + +The toolbar provides formatting controls available in the Visual editing mode. To use them, highlight the text you want to format, then click the corresponding toolbar button. + +
    +Rich text toolbar + +The rich text toolbar provides formatting controls for text, links, lists, alignment, media, and other editor actions available in the text editor. + +
    + + +
    +Paragraph Format Dropdown + + +A dropdown menu that lets you change the block-level format of the selected text. Options include: + +- **Paragraph**: Standard body text, wrapped in a `

    ` tag. This is the default. +- **Heading 1**: The largest heading, `

    `. Typically reserved for the page or post title. +- **Heading 2**: A major section heading, `

    `. +- **Heading 3**: A subsection heading, `

    `. +- **Heading 4**: A smaller subsection heading, `

    `. +- **Heading 5**: A minor heading, `

    `. +- **Heading 6**: The smallest heading, `
    `. +- **Preformatted**: Monospaced, whitespace-preserving text wrapped in a `
    ` tag. Useful for displaying code snippets or ASCII art.
    +
    +
    +
    +Bold + + +Applies strong emphasis to the selected text. This wraps the content in a `` HTML tag, which renders the text in **bold**. Use this to highlight important words or phrases. +
    + +
    +Italic + + +Applies emphasis to the selected text. This wraps the content in an `` HTML tag, rendering the text in *italics*. Use this for titles, foreign words, or subtle emphasis. +
    + +
    +Bulleted List (Unordered List) + + +Converts the selected lines into a bulleted, unordered list using the `
      ` and `
    • ` HTML tags. Each line becomes a separate list item preceded by a bullet point. +
    + +
    +Numbered List (Ordered List) + + +Converts the selected lines into a numbered, ordered list using the `
      ` and `
    1. ` HTML tags. Each line becomes a sequentially numbered list item. +
    + +
    +Blockquote + + +Wraps the selected text in a `
    ` HTML tag. This is used to visually set apart quoted content from the rest of the text, typically rendered as an indented block with a left border, depending on the theme. +
    + +
    +Align Left + + +Aligns the selected block of text to the left margin. This is typically the default text alignment. +
    + +
    +Align Center + + +Centers the selected block of text horizontally within the content area. +
    + +
    +Align Right + + +Aligns the selected block of text to the right margin. +
    + +
    +Insert/Edit Link + + +Opens a dialog to insert a hyperlink on the selected text, or to edit an existing link. You can specify: + +- **URL**: The destination web address. +- **Link Text**: The clickable text that is displayed, defaults to the selected text. +- **Open in New Tab**: A checkbox to set the link's `target` attribute to `_blank`. +- **Search for existing content**: An expandable field that lets you search for and link to existing pages or posts on your site. + +
    + +
    +Remove Link (Unlink) + + +Removes the hyperlink from the selected linked text, leaving the text itself intact. The `` tag is stripped while the inner text content is preserved. +
    + +
    +Distraction-Free Writing Mode + + +An icon in the toolbar area (or accessible from the editor's top bar) that expands the editor to fill the entire browser window, hiding the WordPress admin sidebar, menus, and other interface elements. This provides a clean, focused writing environment. Press Escape or click the exit button to return to the normal view. +
    + +
    +Toolbar Toggle (Kitchen Sink) + + +Toggles the visibility of the second row of toolbar buttons. When the editor first loads, only Row 1 is shown. Clicking this button expands the toolbar to reveal the additional formatting options described below. +
    + +
    +Font Size + + +A dropdown menu in the second toolbar row that lets you adjust the size of the selected text. Options typically range from 8pt to 36pt (such as 8, 10, 12, 14, 18, 24, and 36). The selected size is applied using an inline font-size style. This is useful when you need specific text to appear larger or smaller than the surrounding content without changing its heading level. +
    + +
    +Horizontal Line + + +Inserts a horizontal rule (`
    `) at the cursor position. This creates a thematic break or visual divider between sections of content. +
    + +
    +Text Color + + +Opens a color picker that lets you change the color of the selected text. The editor provides a palette of preset colors as well as the option to enter a custom hex color value. The color is applied using an inline `style` attribute. +
    + +
    +Paste as Text + + +Toggles "Paste as Text" mode on or off. When enabled, any content you paste into the editor is stripped of all formatting, bold, italic, colors, links, and more, and inserted as plain text. This is useful when copying content from external sources like Word, Google Docs, or web pages, where you want to avoid importing unwanted styles and markup. +
    + +
    +Clear Formatting (Eraser) + + +Removes all inline formatting, bold, italic, underline, text color, font size, and so forth, from the selected text. Block-level formatting such as headings and lists is not affected. This is useful for cleaning up text that has accumulated excessive or inconsistent formatting. +
    + +
    +Special Character + + +Opens a dialog containing a grid of special characters and symbols that are not readily available on a standard keyboard. Examples include em dashes, copyright symbols, currency signs, accented characters, arrows, and mathematical symbols. Clicking a character inserts it at the cursor position. +
    + +
    +Decrease Indent (Outdent) + + +Reduces the indentation level of the selected block by one step. This is primarily used within nested lists to move a list item up one level, or to remove indentation from a paragraph. +
    + +
    +Increase Indent + + +Increases the indentation level of the selected block by one step. Within lists, this nests the selected list item under the item above it. For paragraphs, it adds a visual indentation from the left margin. +
    + +
    +Undo + + +Reverts the most recent change made in the editor. Each click steps back one action in the editing history. +
    + +
    +Redo + + +Re-applies the most recently undone change. This is the opposite of Undo and only works after an Undo action has been performed. +
    + + +## Additional Features + +Beyond the toolbar buttons, the Classic Editor includes several other features worth knowing. + +### Drag-and-drop + +The editor supports drag-and-drop for reordering content and for uploading media. You can drag an image file directly from your desktop into the editor area, and WordPress will automatically upload it and insert it into your content. + +### Visual and text tab switching + +You can freely switch between Visual and Text mode at any time. WordPress preserves your content when switching, though be aware that certain complex HTML structures may be slightly reformatted by the Visual editor's parser when toggling back and forth. + +:::tip + +To avoid these issues, it is best to choose one tab and stay with it for the duration of your editing session. +::: + +### HTML and shortcode considerations + +The Text module supports standard content markup, but it is intended for editorial content first. For advanced custom HTML structures, inline stylesheets, JavaScript, shortcodes, or third-party embed scripts, use the HTML module instead for better control and maintainability. + +### Underline and justify + +The toolbar is missing Underline and Justify controls as WordPress removed them in version 4.7. Underline was removed since underlined text on the web is often mistaken for a hyperlink, which can create confusion and accessibility issues. Justify was removed as it was considered inconsistent across browsers and could reduce readability by creating uneven spacing between words. + +However, the [keyboard shortcuts](#keyboard-shortcuts) still remain, so you can still use them if you wish to underline text, which is generally not recommended, or justify your text. + +:::warning + +Underlining regular text is generally considered poor web writing practice because it can be mistaken for a link, so it should be avoided or used sparingly. +::: + +:::tip + +If you prefer to restore the Underline and Justify toolbar controls, you can install the [Advanced Editor Tools plugin](https://wordpress.org/plugins/tinymce-advanced/). It adds additional editor features and brings the Underline and Justify buttons back to the toolbar. +::: + +### Style tab vs text color toolbar + +Using the Text Color toolbar control will override any text color set in the Style tab for the selected text, as the toolbar applies the color as an inline style on a `` element, and inline styles take precedence over CSS-based styling. + +## Keyboard Shortcuts + +The following table summarizes the most useful keyboard shortcuts available in the Classic Editor. On Mac, replace `Ctrl` with `Cmd` unless otherwise noted. + +| Action | Windows / Linux | Mac | +| ------------------- | ----------------------- | ----------------------- | +| Bold | `Ctrl + B` | `Cmd + B` | +| Italic | `Ctrl + I` | `Cmd + I` | +| Underline | `Ctrl + U` | `Cmd + U` | +| Insert Link | `Ctrl + K` | `Cmd + K` | +| Undo | `Ctrl + Z` | `Cmd + Z` | +| Redo | `Ctrl + Y` | `Cmd + Shift + Z` | +| Strikethrough | `Alt + Shift + D` | `Ctrl + Option + D` | +| Insert Read More | `Alt + Shift + T` | `Ctrl + Option + T` | +| Bulleted List | `Alt + Shift + U` | `Ctrl + Option + U` | +| Numbered List | `Alt + Shift + O` | `Ctrl + Option + O` | +| Blockquote | `Alt + Shift + Q` | `Ctrl + Option + Q` | +| Align Left | `Alt + Shift + L` | `Ctrl + Option + L` | +| Align Center | `Alt + Shift + C` | `Ctrl + Option + C` | +| Align Right | `Alt + Shift + R` | `Ctrl + Option + R` | +| Justify | `Alt + Shift + J` | `Ctrl + Option + J` | +| Heading 1 | `Alt + Shift + 1` | `Ctrl + Option + 1` | +| Heading 2 | `Alt + Shift + 2` | `Ctrl + Option + 2` | +| Heading 3 | `Alt + Shift + 3` | `Ctrl + Option + 3` | +| Heading 4 | `Alt + Shift + 4` | `Ctrl + Option + 4` | +| Heading 5 | `Alt + Shift + 5` | `Ctrl + Option + 5` | +| Heading 6 | `Alt + Shift + 6` | `Ctrl + Option + 6` | +| Keyboard Shortcuts | `Alt + Shift + H` | `Ctrl + Option + H` | +| Distraction-Free | `Alt + Shift + W` | `Ctrl + Option + W` | diff --git a/beaver-builder/layouts/modules/search.mdx b/beaver-builder/layouts/modules/search.mdx new file mode 100644 index 00000000..35641320 --- /dev/null +++ b/beaver-builder/layouts/modules/search.mdx @@ -0,0 +1,641 @@ +--- +title: Search +sidebar_label: Search +icon: "search" +description: "Use Search to add a WordPress search form with configurable layout, optional inline AJAX results, and post type filtering." +--- + + +Use Search to add a WordPress search form with configurable layout, optional inline AJAX results, and post type filtering. + +## Usage + +Use Search to add a WordPress search form to a layout with control over the input, button, and form layout. The module submits queries to the standard WordPress search and can either redirect visitors to the site search results page or render results inline below the form using AJAX. When AJAX results are enabled, the module renders each match with optional featured image, title link, and excerpt, and supports filtering the query by one or more post types. + +Use Search in site headers, hero sections, dedicated search pages, or any layout where visitors need to find content quickly. The Layout setting covers compact icon-only buttons, full-screen overlay search, expanding inputs, and stacked or inline arrangements, which makes the module suitable for both prominent search experiences and minimal utility placements. + +## Module Settings + +The Search module settings control the form layout, the appearance of the input and button, and how search results are returned to the visitor. + +### Layout Tab + +The Layout tab sets the form structure, input label, placeholder, and button options. + +
    +Layout Default: All Inline + + +Selects the structural arrangement of the input and the search button. + +- **Input Only:** Shows only the search input with no visible button. +- **All Inline:** Places the label, input, and button on a single row. +- **Button Only:** Shows only a search button that triggers an expanding input, a full-screen overlay, or a reveal action. +- **All Stacked:** Stacks the label, input, and button vertically. + +
    +Input Label + + +
    +Input Label Default: Show + + +Shows or hides the label above or beside the input. This field appears when **Layout** is set to **All Inline** or **All Stacked**, or when **Layout** is **Button Only** with **Action** set to **Reveal**. +
    +
    + +
    +Placeholder Text + + +
    +Placeholder Text Default: Search... + + +The placeholder text displayed inside the search input. +
    +
    + +
    +Button Text + + +
    +Button Text Default: Search + + +The text displayed on the search button. This field appears when **Layout** is set to **All Inline**, **All Stacked**, or **Button Only**. +
    +
    + +
    +Action + + +
    +Action Default: Expand on click + + +Determines how the search input is presented when **Layout** is set to **Button Only**. + +- **Expand on click:** The input expands inline from the button when the button is clicked. +- **Full Screen:** The input opens in a full-screen overlay with a close button. +- **Reveal:** The button reveals an inline input alongside or below the button. + +
    +Expand Position + + +
    +Expand Position Default: Left + + +Sets the side the input expands toward when **Action** is set to **Expand on click**. Options are **Left** and **Right**. +
    +
    +
    +
    +
    + +
    +Button Icon + + +The Button Icon section adds an optional icon to the search button and configures DuoTone colors and icon position. + +
    +Button Icon + + +
    +Icon Supports: Field Connections + + +Selects an icon displayed on the search button. The Icon Position field appears when an icon is selected. +
    + +
    +DuoTone Primary Color Supports: Field Connections + + +For Font Awesome DuoTone icons only: the primary color applied to the icon. +
    + +
    +DuoTone Secondary Color Supports: Field Connections + + +For Font Awesome DuoTone icons only: the secondary color applied to the icon. +
    + +
    +Icon Position Default: Before Text + + +Places the icon before or after the button text when an icon is selected. Options are **Before Text** and **After Text**. +
    +
    +
    + +### Style Tab + +The Style tab controls the appearance of the form wrapper, the full-screen overlay, the label, the input, and the button. + +
    +Form + + +The Form section controls the dimensions, alignment, padding, background, and border of the search form wrapper. + +
    +Form + + +
    +Width Default: Full Width + + +Sets the width of the form wrapper. + +- **Auto:** Sizes the wrapper to its content. +- **Full Width:** Stretches the wrapper to the full width of its container. +- **Custom:** Uses a fixed maximum width set in **Custom Width**. + +
    +Custom Width + + +
    +Custom Width Default: 1100 + + +The maximum width of the search form container. This field appears when **Width** is set to **Custom**. Supports `px` and `%` units. +
    +
    + +
    +Alignment + + +
    +Alignment Default: center; Supports: Responsive + + +The horizontal alignment of the form within its container. This field appears when **Width** is set to **Auto** or **Custom**. +
    +
    +
    + +
    +Height Default: 0; Supports: Responsive + + +The minimum height of the form wrapper. Content expands the height automatically. Supports `px`, `vw`, and `vh` units. +
    + +
    +Padding Default: 10; Supports: Responsive + + +The inner spacing of the form wrapper. +
    + +
    +Background Color Supports: Field Connections + + +The background color of the form wrapper. +
    + +
    +Background Hover Color Supports: Field Connections + + +The background color of the form wrapper on hover. +
    + +
    +Border + + +The border style, width, radius, and color of the form wrapper. +
    + +
    +Border Hover + + +The border style used when the form wrapper is hovered or focused. +
    +
    +
    + +
    +Fullscreen + + +This section is available when **Layout** is set to **Button Only** and **Action** is set to **Full Screen**. + +
    +Fullscreen + + +
    +Input Width Default: 600 + + +The maximum width of the input field inside the full-screen overlay. Supports `px` and `%` units. +
    + +
    +Overlay Background Color Supports: Field Connections + + +The background color of the full-screen overlay behind the input. +
    + +
    +Close Button Default: Show + + +Shows or hides the close button used to dismiss the full-screen overlay. +
    +
    +
    + +
    +Label + + +This section is available when **Input Label** is set to **Show**. + +
    +Label + + +
    +Padding Supports: Responsive + + +The inner spacing around the input label. +
    + +
    +Color Supports: Field Connections + + +The text color of the input label. +
    + +
    +Typography Supports: Responsive + + +The font settings for the input label. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    +
    +
    + +
    +Input + + +The Input section controls the appearance of the search input field. + +
    +Input + + +
    +Padding Default: 12; Supports: Responsive + + +The inner spacing of the search input. +
    + +
    +Typography Supports: Responsive + + +The font settings for the search input. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    + +
    +Color Supports: Field Connections + + +The text and placeholder color of the search input. +
    + +
    +Hover Color Supports: Field Connections + + +The text and placeholder color of the search input on hover and focus. +
    + +
    +Background Color Supports: Field Connections + + +The background color of the search input. +
    + +
    +Background Hover Color Supports: Field Connections + + +The background color of the search input on hover and focus. +
    + +
    +Border + + +The border style, width, radius, and color of the search input. +
    + +
    +Border Hover + + +The border style used when the search input is hovered or focused. +
    +
    +
    + +
    +Button + + +The Button section controls the appearance of the search button. This section is available when **Layout** is set to **All Inline**, **All Stacked**, or **Button Only**. + +
    +Button + + +
    +Alignment Default: center + + +The horizontal alignment of the button within its wrapper. This field appears when **Width** is set to **Auto** or **Custom**. +
    + +
    +Width Default: Auto + + +Sets the width of the search button. + +- **Auto:** Sizes the button to its content. +- **Custom:** Uses a fixed width set in **Custom Width**. + +
    +Custom Width + + +
    +Custom Width Default: 200 + + +The fixed width of the search button. This field appears when **Width** is set to **Custom**. Supports `px`, `vw`, and `%` units. +
    +
    +
    + +
    +Padding Supports: Responsive + + +The inner spacing of the search button. +
    + +
    +Text Color Supports: Field Connections + + +The text color of the search button. +
    + +
    +Text Hover Color Supports: Field Connections + + +The text color of the search button on hover and focus. +
    + +
    +Typography Supports: Responsive + + +The font settings for the search button. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    + +
    +Background Color Supports: Field Connections + + +The background color of the search button. +
    + +
    +Background Hover Color Supports: Field Connections + + +The background color of the search button on hover and focus. +
    + +
    +Background Style Default: Flat + + +Selects a **Flat** or **Gradient** background for the search button. +
    + +
    +Border Supports: Responsive + + +The border style, width, radius, and color of the search button. +
    + +
    +Border Hover Supports: Responsive + + +The border style used when the search button is hovered or focused. +
    + +
    +Icon Color Supports: Field Connections + + +The color applied to the button icon. This section is available when an **Icon** is selected in the Layout tab. +
    + +
    +Icon Hover Color Supports: Field Connections + + +The color applied to the button icon on hover and focus. This section is available when an **Icon** is selected in the Layout tab. +
    +
    +
    + +### Content Tab + +The Content tab determines how search results are returned and configures the inline AJAX result layout. + +
    +Results Default: Redirect to search page + + +Selects how submitted searches are presented. + +- **Redirect to search page:** Submits the form to the WordPress search results page. +- **Display results below via Ajax:** Loads matching posts inline below the form without a page reload. + +
    +Post Type + + +
    +Post Type + + +Narrows AJAX search results to one or more selected post types. This field appears when **Results** is set to **Display results below via Ajax**. +
    +
    +
    + +
    +Ajax Result + + +This section is available when **Results** is set to **Display results below via Ajax**. + +
    +Ajax Result + + +
    +Width Default: Full Width + + +Sets the width of the inline result container. + +- **Full Width:** Stretches the result container to the full width of its parent. +- **Custom:** Uses a fixed maximum width set in **Custom Width**. + +
    +Custom Width + + +
    +Custom Width Default: 1100 + + +The maximum width of the AJAX result container. This field appears when **Width** is set to **Custom**. Supports `px` and `%` units. +
    +
    +
    + +
    +Featured Image Default: Show + + +Shows or hides the featured image for each result. When set to **Show**, the **Size**, **Crop**, and **Fallback Image** fields appear. + +
    +Size + + +
    +Size Default: medium + + +The registered WordPress image size used to render the featured image. +
    +
    + +
    +Crop + + +
    +Crop Default: landscape + + +Selects the crop applied to the featured image. Options are **None**, **Square**, and **Circle**. +
    +
    + +
    +Fallback Image + + +
    +Fallback Image + + +The image displayed when a result has no featured image set. +
    +
    +
    + +
    +Content Default: Hide + + +Shows or hides the post excerpt for each result. + +
    +Content Length (Words) + + +
    +Content Length (Words) Default: 55 + + +The maximum number of words shown in each result excerpt. This field appears when **Content** is set to **Show**. +
    +
    +
    + +
    +No Results Message Default: Sorry, we couldn't find any posts. Please try a different search. + + +The message displayed when an AJAX search returns no matching posts. +
    +
    +
    + +
    +Advanced tab + +The Advanced tab contains common Search module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    diff --git a/beaver-builder/layouts/modules/search/limit-post-types-search-module.md b/beaver-builder/layouts/modules/search/limit-post-types-search-module.md deleted file mode 100644 index 7bd68564..00000000 --- a/beaver-builder/layouts/modules/search/limit-post-types-search-module.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: limit-post-types-search-module -title: Limit post types in Search module results -sidebar_label: Limit post types in Search module results -description: Here's some code that limits which post types are searched in all of the Search modules on your site. ---- - -By default, the Search module searches pages, posts, and any custom post types that exist. You can limit the search to specific post types with some custom code. For example, you could search the WooCommerce **product** post type only. - -The code varies according to whether or not AJAX is enabled on your site. - -## AJAX enabled - -Set a filter that uses `fl_builder_loop_query_args` to specify which post types are allowed in search. - -In the following code example, `post` and `product` are specified in the array as the post types to search. Add your code to *functions.php* in your child theme. - -```php -add_filter( 'fl_builder_loop_query_args', function( $args ){ - if ( isset( $args['s'] ) ) { - $args['post_type'] = array( 'post', 'product' ); - } - return $args; -}); -``` - -:::info -The code affects all Search modules on your site. -::: - -## AJAX disabled - -If AJAX is disabled, use `pre_get_posts` instead. See [this WordPress documentation](https://developer.wordpress.org/reference/hooks/pre_get_posts/). diff --git a/beaver-builder/layouts/modules/search/search.md b/beaver-builder/layouts/modules/search/search.md deleted file mode 100644 index 2415a519..00000000 --- a/beaver-builder/layouts/modules/search/search.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -id: search -title: Search module -sidebar_label: Search -description: The Search module adds a search input field and Submit button to your layout with many layout and style options. ---- - -The Search module lets you place a standard WordPress search form in your layout. It has a standard input form and a button to activate the search query. - -The search functionality and search results are the same as a standard WordPress search widget. - -## Layout choices and behavior - -### Layout -On the **Layout** tab you can choose from the layouts shown in this screenshot and described below: - -![](/img/search-fbe9a433.png) - -#### Input text only - -Only the search input field appears, not the button. Search is activated by using the Return key on the keyboard. With this option, you can customize the text on the Search button. - -#### Inline - -The Search button appears to the right of the search field at all device sizes. You can customize the input field placeholder text or the button text. You can add a button icon to the left or right of the button text. - -#### Button only - -Only the Search button appears, and clicking the button expands to display the input field according to the option set in the *Action* field. When the action is **Expand on click**, the search input field appears to the left of the button. The user enters the search terms and presses Return on the keyboard. - -:::info -Clicking the Search button when the input field is expanded serves to collapse the input field to show only the button again. In this configuration, you might consider changing the placeholder text to indicate that the user should enter text and hit Return. -::: - -When the action is **Full screen**, clicking the Search button opens a fullscreen window with the search input field displayed there. The user enters the search terms and presses Return on the keyboard, which opens the standard WordPress Search Results archive page. - -In either configuration, you can also change the placeholder text, the button text, and add an icon to the left or right of the button text. - -#### Stacked - -The Search button is centered under the search field at all device sizes. The user enters the search terms and clicks the Search button or presses Return on the keyboard. - -### Text and icons on the Layout tab - -You can customize the placeholder text message. For the button, you can change the button text and add an icon to the left or right. Other settings for the placeholder and button text and icons, such as color, are on the **Style** tab. See the next section. - -## Style choices - -:::note Note: -If you're using the Beaver Builder Theme, the buttons' initial style comes from the settings at **Customize > General > Buttons**. The button's default text color -is white text for darker accent colors and black text for lighter colors. The -default font family for the button text depends on the font family set for the -`` tag. -::: - -The **Style** tab has settings for nearly every aspect of the search form. The settings are divided into the following categories: the main settings, an **Input text** section, a **Button** section, and a **Button icon colors** section. - -### Main settings on the Style tab - -In this section, you can customize settings that apply to the module: width, minimum height, horizontal alignment, background color, border, and padding. Some of the same settings are available specifically for the input field and button in other sections of the **Style** tab, as described later in this article. - -#### Width - -The **Width** field applies to the width of the module, regardless of layout type. Choices are: -* **Auto** -No width is set for the module. -* **Full width** -The module width is set to 100%. -**Custom** -A **Custom width** field appears so you can set a custom maximum width. - -For **Button only** layouts with a **Fullscreen** input field, the **Width** setting applies to the module that displays the button, not to the input field in the fullscreen view. The Width setting doesn't change the button width but rather the module width, so the width setting is most apparent when you set a background color or border. - -:::tip **Tip** -The Button width itself can be set in the **Button** section. For the **Fullscreen** option, a **Fullscreen** section appears at the bottom of the **Style** tab where you can adjust the width of the input field in the window that opens to display it. -::: - -#### Height - -Optionally set a minimum height for the form. Note that this setting does not change the height of the form or the Search button but rather the height of the module, with the search form vertically centered. You can change the input form and button height in other sections. - -#### Alignment - -If the **Width** setting is **Auto** or **Custom**, you can select a **Left**, **Right**, or **Center** horizontal alignment. No alignment setting (none of the alignment icons selected) means the alignment will follow the browser default. - -#### Background color - -Sets a background color for the module. The size of the background is affected by the **Width**, **Height**, and **Padding** settings. - -#### Hover background color - -Upon mouse hover over the module, the background color is replaced with the hover background color. - -#### Border - -The **Border** section has the standard Beaver Builder border settings. The border appears outside the background color if one is set. If no background color is set, the placement of the border is affected by the **Width**, **Height**, and **Padding** settings. - -#### Border hover - -These settings apply on mouse hover over the module. - -#### Padding - -Increases the space between the module border and the search controls (input field, button). Note that there are Padding settings in other sections of the **Style** tab that apply to the padding inside the input field or button. - -### Input text section on the Style tab - -These settings affect the input field's text and styles. - -* **Color** section -Changes the color of the text in the input field, both the placeholder text and the text that the user enters. -* **Typography** -Standard Beaver Builder typography options for the input field text, both placeholder and search input. -* **Border** -The input field border by default is light gray but you can use this Border section to change the border type, color, width, and radius, and you can add a border shadow. -* **Border hover** -Set border options that replace the input field's border settings on mouse hover. -* **Padding** -Set padding options for the space between the input field's border and its text. - -### Button section on the Style tab - -This section's settings affect the text and styles for the button. This section does not appear when the layout is set to **Input text only**. - -* **Alignment** -Select a **Left**, **Right**, or **Center** horizontal alignment. No alignment setting (none of the alignment icons selected) means the alignment will follow the browser default. -* **Width** -Choose between **Auto** and **Custom** width to control the width of the button. If **Custom** is chosen, a new field open for you to input the custom max width of the button. -* **Padding** -Set the padding for the button to change the distance between the button edges and the button text. -* **Text color** -Set the text color for the button. -* **Text hover color** -Set the color of the text on mouse hover. -* **Typography** -Set the typography options for the button text. -* **Button background color** -Set the background color for the button -* **Button background hover color** -Set the background color for the button on mouse hover. -* **Button background style** - Choose between: - * **Flat** - * **Gradient** – the gradient is automatically generated. -* **Border** -Set the border options for the button. -* **Border hover** -Set the border options for the button on mouse hover. - -### Button icon colors section on the Style tab - -If you chose an icon on the Layout tab, you can set the **Icon color** and **Icon hover color** in this section. - -## Set where to display search results - -On the **Content** tab, you can choose where to display the search results. There are two choices: - -* **Redirect to Search page** -This option opens the standard WordPress search results page, which is a type of WordPress archive. If you have the Beaver Themer add-on, you can style this page with an Archive-type Themer layout. -* **Display results below via Ajax** -This choice displays the results immediately below the input field in a bordered box such as this: - ![](/img/search-29516eda.png) - By default, the bordered search box is **Full width**, which means the same width as the search input field. You can set a custom width in the **Width** setting to change the size of the search results box. You can also choose whether to display the featured image, a fallback image, and an excerpt of the content. An example of these options is shown in this screenshot, in which **Width** is set to **800px** and both **Featured image** and **Content** are set to **Show**. - ![](/img/search-10ac9fea.png) - You can also customize the text when no results are found. - -## Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/separator.md b/beaver-builder/layouts/modules/separator.md deleted file mode 100644 index f254bdf9..00000000 --- a/beaver-builder/layouts/modules/separator.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: separator -title: Separator -sidebar_label: Separator -description: The Separator module inserts a horizontal line to separate content with options to control width, color, alignment, and thickness of the line. ---- - -The Separator module inserts a horizontal line to separate content. - -## **General** tab - -- **Color** - By default, the line is a light gray color. -- **Height** (responsive) - This is the thickness of the line style. For double lines, as the **Height** value increases, the thickness of both lines and the space between them increases. This setting can be set differently for each device size. By default, the height is 1px. -- **Width** (responsive) - The width of the line relative to row width. You can choose a **%**, **px**, or **vw** unit of measurement. By default, the line is 100% wide. -- **Alignment** (left, center, right) (responsive) -- **Style** - The choices are **Solid**, **Dashed**, **Dotted**, **Double**. - -:::info -The **Double** line style must have a height of at least 3px set to display as a double line. -::: - -## Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/separator.mdx b/beaver-builder/layouts/modules/separator.mdx new file mode 100644 index 00000000..8da8e66c --- /dev/null +++ b/beaver-builder/layouts/modules/separator.mdx @@ -0,0 +1,76 @@ +--- +title: Separator +sidebar_label: Separator +icon: "minus" +description: "Use Separator to add a configurable horizontal divider line that breaks up content within a layout." +--- + + +Use Separator to add a configurable horizontal divider line that breaks up content within a layout. + +## Usage + +Use Separator to render a horizontal divider line that visually breaks up content. The module outputs a single styled line whose color, height, width, alignment, and border style are all configurable, with responsive support for adjusting each setting per device. + +Use Separator between sections, paragraphs, or grouped elements when you need a clean visual break without adding a full row or background. It fits long-form content, landing page sections, and any layout where a simple rule helps separate ideas or call attention to a transition. + +## Module Settings + +The Separator module settings control the divider's color, dimensions, alignment, and border style. + +### General Tab + +The General tab contains all of the divider's appearance settings. + +
    +Color Default: cccccc; Supports: Responsive, Field Connections + + +Sets the color of the divider line. Supports alpha transparency. +
    + +
    +Height Default: 1; Supports: Responsive + + +Sets the thickness of the divider line in pixels. +
    + +
    +Width Default: 100; Supports: Responsive + + +Sets the length of the divider line. Accepts **%**, **px**, or **vw** units. +
    + +
    +Align Default: Center; Supports: Responsive + + +Sets the horizontal alignment of the divider within its wrapper. + +- **Left:** Aligns the divider to the left edge of its wrapper. +- **Center:** Centers the divider horizontally within its wrapper. +- **Right:** Aligns the divider to the right edge of its wrapper. + +
    + +
    +Style Default: Solid; Supports: Responsive + + +Sets the border style used to render the divider line. Double borders must have a **Height** of at least 3px to render properly. + +- **Solid:** Renders the divider as a single continuous line. +- **Dashed:** Renders the divider as a series of short dashes. +- **Dotted:** Renders the divider as a series of dots. +- **Double:** Renders the divider as two parallel lines. + +
    + +
    +Advanced tab + +The Advanced tab contains common Separator module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    diff --git a/beaver-builder/layouts/modules/sidebar.md b/beaver-builder/layouts/modules/sidebar.md deleted file mode 100644 index c0719f9d..00000000 --- a/beaver-builder/layouts/modules/sidebar.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: sidebar -title: Sidebar -sidebar_label: Sidebar -description: The Sidebar module creates a WordPress sidebar in a Beaver Builder layout, containing any set of WordPress widgets that your theme allows. ---- - -The Sidebar module gives you the ability to insert any of your WordPress -sidebars into your layouts. - -The widgets in the sidebar can be configured by going to **Appearance > Widgets** in the WordPress admin panel. - -:::info -The Beaver Builder Theme has only one sidebar, called the Primary -Sidebar. If you want to create a different sidebar or which widgets appear -there, you must use a plugin or write code. -::: - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/sidebar.mdx b/beaver-builder/layouts/modules/sidebar.mdx new file mode 100644 index 00000000..5665bfef --- /dev/null +++ b/beaver-builder/layouts/modules/sidebar.mdx @@ -0,0 +1,37 @@ +--- +title: Sidebar +sidebar_label: Sidebar +icon: "panel-right" +description: "Use Sidebar to display a WordPress sidebar registered by the current theme inside a Beaver Builder layout." +--- + + +Use Sidebar to display a WordPress sidebar registered by the current theme inside a Beaver Builder layout. + +## Usage + +Use Sidebar to render a WordPress sidebar registered by the active theme directly inside a Beaver Builder layout. The module outputs the selected sidebar in place, so any widgets assigned to it through **Appearance > Widgets** appear wherever the module is placed. + +Use Sidebar when you want to reuse an existing widget area inside a custom layout, such as adding a blog sidebar to a landing page, placing a footer widget area inside a row, or surfacing theme-registered widget areas in builder-driven templates without recreating the widgets manually. + +## Module Settings + +The Sidebar module settings select which registered sidebar to display. + +### General Tab + +The General tab selects the sidebar to render. + +
    +Sidebar + + +Selects which registered WordPress sidebar to display. The dropdown is populated from sidebars registered by the active theme or by other plugins through WordPress's `register_sidebar()` function. Manage the widgets shown inside the selected sidebar from **Appearance > Widgets** in the WordPress admin. +
    + +
    +Advanced tab + +The Advanced tab contains common Sidebar module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    diff --git a/beaver-builder/layouts/modules/slideshow.md b/beaver-builder/layouts/modules/slideshow.md deleted file mode 100644 index a0a4b705..00000000 --- a/beaver-builder/layouts/modules/slideshow.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -id: slideshow -title: Slideshow -sidebar_label: Slideshow -description: The Slideshow module displays a gallery of image "slides" with a choice of transitions. ---- - -## Uses of this module - -Use a slideshow module when you want to display a set of images in the foreground, one at a time. Besides the traditional horizontal slide transition, there are a number of other types of transitions from one image to the next, as described in the Playback tab section below. The images come from a gallery you create either in the WordPress Media Library or in SmugMug. You can display the image title, but if there is other content you want to display and the image is of secondary importance, see the related modules described below. - -## Display options - -Besides various types of transitions of the slides themselves, there are various options to display navigation and play controls, an image caption, social media links, thumbnails of the gallery, and a fullscreen toggle, all described in the following sections. - -Here's a screenshot of an image slideshow, showing the three main areas: - -* The slides are taken from a gallery of images that you specify. -* Large navigation arrows can be displayed on either side of the slides, or with wider slides the icons are overlaid on the slides. -* The control bar appears above or below the images, depending on your settings. -All of the icons that appear in the control bar can be displayed or hidden, as explained in more detail below. - -*Figure 1: Slideshow module, annotated* - -![Screenshot pointing out the slides, navigation arrows, and control bar](/img/slideshow-module-1.jpg) - -## Slideshow module settings - -### General tab - -This tab has the following settings. - -* **Source** -WordPress Media Library or SmugMug. - -* **Photos** (Media Library only) -Contains links to create a gallery of images in your Media Library or to edit an existing gallery. - -* **Feed URL** (SmugMug galleries only) -Enter the URL for the RSS feed here. For help with linking to a SmugMug gallery, see the [Gallery module overview](/beaver-builder/layouts/modules/gallery/gallery.md#use-a-smugmug-gallery). - -#### Display section - -* **Height** -Sets the height of the box in which images and controls are displayed. The default height is 500px. - -* **Skin color** -There's not much difference, but choose **Light** if you have light-colored images and background and **Dark** if you have dark-colored images and backgroiund. Individual image size is adjusted to maintain this height. - -* **Crop** -Since the Height setting keeps the height of each image constant, the Crop setting determines whether the width of the image will adjust to display the full image (so width will vary depending on each image) or the image width expands to the full width of the column (minus margin and padding) and crops the left and right edges if necessary. - -* **Disable right-click** -Does not allow image to be downloaded. - -#### Click Action section - -* **Type** -None, or choose **Link** to add a URL that will serve as a single destination for the entire set of images. You can't set a separate link for each image. - -* **Link URL** -If you selected **Link** for the **Click action**, enter the destination URL here. - -### Playback tab - -* **Auto Play** -**Yes** (the default) means the images transition automatically and can be overridden by any navigation controls that are displayed. **No** means the user must advance the images using the navigation controls. - -* **Speed** -Number of seconds the full image is displayed. The default is 3 seconds. - -* **Transition** -Choose among the following types of transitions from one image to the next. -The default transition is **Fade**. - - * **None** - The next image is immediately displayed instead of a transition effect. - - * **Fade** - Slide loses opacity while the next slide comes into view. - - * **Ken Burns** - The Ken Burns movement is applied during both the display and transition times with a quick fade transition to the next slide. - - * **Slide horizontal** - Typical horizontal movement from right to left - - * **Slide vertical** - Current slide moves upwards followed by next slide. There is no white space between the current and next slide. - - * **Blinds** - Vertical bands of white space appear over the image and become narrower until the full image is displayed. - - * **Bars** - The next image appears with an overlay of nearly transparent gray squares during a fade transition..The effect works best at short transition times. For longer transitions the effect more resembles the Fade transition. - - * **Random bars** - Vertical light gray bars of random width and spacing overlay the next image and fade out. - - * **Boxes** - The next image appears with an overlay of nearly transparent gray squares during a fade transition. - - * **Random boxes** - Random gray rectangles overlay the next image and fade out. - - * **Boxes grow** - The next image appears with a gray grid overlay that shrinks and disappears. - -* **Transition speed** -Number of seconds spent transitioning to the next image. The default -transition speed is one second. - -* **Randomize photos** -**No** (default) means photos are displayed in the same order as they appear in the gallery. **Yes** means the images are randomized. The randomization order stays the same with autoplay loops and navigation. - -### Controls tab - -This tab lets you select which controls you want to display. - -The following figure shows the control icons in the control bar that you can see in the Beaver Builder editor, with the icon labels underneath the figure. Any of the icons can be displayed or hidden. - -*Figure 2: Control bar icons displayed in the Beaver Builder editor* - -![Control bar icons displayed in the Beaver Builder editor, see legend below figure](/img/layouts--modules--slideshow--2.png) - -1 Navigation arrows -2 Thumbs button -3 Caption button -4 Fullscreen button -5 Social button -6 Play button -7 (shown in the front end but not in the Beaver Builder editor preview: Photo count control) - -There are six sections on this tab: an unnamed top section, **Control bar**, **Control bar buttons**, **Control bar overlay**, **Thumbs**, and **Social**. - -#### Unnamed top section - -* **Navigation arrows** -Choose whether or not to display larger arrows that appear on each side of the slides, shown in Figure 1. If the image is wide enough, they are overlaid on the image. -The actual color of the arrows depends on whether you set **Light** or **Dark** as the **Skin color** on the **General** tab. These arrows may appear inside or outside of the image, depending on image width and the **Crop** setting on the **General** tab. - -:::info -The navigation arrows in the control bar are controlled in the **Control bar** section. -::: - -#### Control Bar section -This section lets you choose the type of control bar and where to display it. - -* **Nav type** - * If you don't want to display any control bar, choose **None**. - If set to **None**, then the other **Controls** tab sections described below are hidden. - * The **Buttons** choice displays the control bar in the layout shown in Figure 3, depending on the control buttons selected for display. - - *Figure 3: Control bar Buttons layout displayed in the front end* - - ![Control bar Buttons layout displayed in the front end, see legend below figure](/img/layouts--modules--slideshow--3.jpg) - 1 Thumbs button - 2 Caption button - 3 Social button - 4 Navigation arrows - 5 Play button - 6 Photo count - 7 Fullscreen button - - * The **Thumbs** choice displays thumbnails of the gallery images, which can be clicked to navigate to a different slide. - By default, the size of the thumbnail images is **50px**, but you can change that in the **Thumbs size** field in the **Thumbs** section. - - *Figure 4: Control bar Thumbs layout displayed in the front end* - - ![Control bar Thumbs layout displayed in the front end, see legend below figure](/img/layouts--modules--slideshow--4.jpg) - 1 Caption button - 2 Social button - 3 Navigation arrows (do not appear unless there are two many thumbnail images to display in the width available) - 4 Thumbnail images - 5 Photo count - 6 Fullscreen button - -* **Nav position** -By default, the control bar is displayed below the slides. To move it above the slides, set it to **Top**. -**Tip:** You can also display the control bar in an overly at the top or bottom of the slide. See the [Control bar overlay section](#control-bar-overlay-section). - -#### Control Bar Buttons section - -You can show or hide any of the icons in the control bar. See Figures 3 and 4 for identification of the button icons. - -* **Navigation arrows** (only visible when **NavType** is set to **Buttons**) -**Yes** provides the ability to move the slides forward and backward manually. -* **Play button** -**Yes** provides the ability to begin automated playback of the slider. -**Note:** The Play/Pause icon is only visible in the control bar when it is -set to **Yes** and the **Nav Style** setting in the **Control Bar** section is **Buttons.** -* **Fullscreen button** -If set to **Yes**, this button is displayed and the slideshow expands to fullscreen when clicked. -* **Photo count button** -If set to **Yes**, the photo count is displayed as current photo position / -total photos. -* **Thumbs button** (only visible when **NavType** is set to **Buttons**) -**Yes** displays this icon, and clicking the icon opens thumbnails of all the images in the gallery, as shown in this screenshot. By default, the size of the thumbnail images is a square **50px**, but you can change that in the **Thumbs size** field in the **Thumbs** section. - -*Figure 5: Control bar Buttons layout when Thumbs button is clicked* -![Control bar Buttons layout when Thumbs button is clicked](/img/slideshow-module-3.png) -* **Caption button** -**Yes** displays the Information icon, shown in this screenshot, and clicking the icon displays the image's caption from the Media Library in an overlay over the slide. - -*Figure 6: Control bar when Caption button is clicked* - -![When Caption button is clicked, caption displays in an overlay](/img/slideshow-module-4.png) -* **Social button** -**Yes** displays a Heart icon, shown in this screenshot, and clicking the icon displays whatever social buttons you have enabled in the **Social** section on this tab. - -*Figure 7: Control bar Buttons layout when Social button is clicked* -![When Social button is clicked, social icons displays in an overlay](/img/slideshow-module-5.png) - -#### Control Bar Overlay section - -This section has an **Overlay enabled** field, which by default is set to -**No**, meaning the control bar is displayed below or above the slides. If -set to **Yes**, the control bar is placed in a narrow semitransparent band -along the bottom or top of the slides themselves. In this case, there -are two additional settings: Overlay Hide and Overlay Hide Delay. If set to -**No**, the control bar overlay is always visible. If set to **Yes**, the -control bar overlay disappears after the number of seconds that you specify. - -#### Thumbs section - -* **Thumbs size** -Sets the size of the thumbnails in pixels. The thumbnails are cropped squares, both in **Buttons** and **Thumbs** control bar layouts. - -#### Social section -This section only appears when **Social button** is set to **Yes** in the **Control bar buttons** section. It controls which social icons appear when the Social icon is clicked. - -The choices: - -* **Facebook button** -* **Twitter button** -* **Pinterest button** - -### Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. - -## Related modules - -Other modules that display a set of images one at a time with automatic -transitions or navigation controls or both: - - * Content slider module -Displays individual images in a set in the background, with the option of a -foreground content overlay on the image. Images displayed in the background to -fill the space often get cropped and the focus of the image usually changes as -screen sizes decreases, so this module is best used when the focus is on the -content overlay and the background image is used for effect. - - * Posts Carousel and Posts Slider modules -These module display a set of posts or pages one at a time with the option to -display a featured or fallback image. Use these modules when you want to -display information about a set of pages or posts. diff --git a/beaver-builder/layouts/modules/slideshow.mdx b/beaver-builder/layouts/modules/slideshow.mdx new file mode 100644 index 00000000..66f4f0d1 --- /dev/null +++ b/beaver-builder/layouts/modules/slideshow.mdx @@ -0,0 +1,395 @@ +--- +title: Slideshow +sidebar_label: Slideshow +icon: "images" +description: "Use Slideshow to display multiple photos in a full-featured slideshow with transitions, navigation controls, and optional thumbnails." +--- + + +Use Slideshow to display multiple photos in a full-featured slideshow with transitions, navigation controls, and optional thumbnails. + +## Usage + +Use Slideshow to display multiple photos in a slideshow view sourced from the WordPress Media Library or a SmugMug RSS feed. The module supports a range of transitions, automatic playback with adjustable speed, optional Ken Burns motion, and a configurable control bar with navigation arrows, play, fullscreen, photo count, captions, thumbnails, and social sharing buttons. + +Use Slideshow on photography pages, portfolios, event recaps, hero sections, and any layout that needs an interactive multi-photo viewer with built-in navigation. It fits projects that need a richer presentation than a static gallery without adding a separate slider plugin. + +## Module Settings + +The Slideshow module settings control where photos come from, how they display, how playback behaves, and which navigation and control bar elements appear. + +### General Tab + +The General tab sets the photo source, display sizing, and click behavior for slides. + +
    +Source Default: Media Library + + +Selects where the slideshow pulls images from. + +- **Media Library:** Uses photos selected from the WordPress Media Library. +- **SmugMug:** Uses photos from a SmugMug gallery RSS feed URL. + +
    +Media Library Settings + + +
    +Photos Supports: Field Connections + + +The photos shown in the slideshow when **Source** is set to **Media Library**. Selects multiple images from the WordPress Media Library. +
    +
    + +
    +SmugMug Settings + + +
    +Feed URL Supports: Field Connections + + +The SmugMug gallery RSS feed URL used when **Source** is set to **SmugMug**. The RSS feed URL is available through the get a link function in the SmugMug gallery. +
    +
    +
    + +
    +Display + + +The Display section controls slideshow sizing, color scheme, image cropping, and right-click protection. + +
    +Display Settings + + +
    +Height Default: 500; Supports: Responsive + + +The height of the slideshow in pixels. +
    + +
    +Skin Color Default: Light + + +Sets the color scheme used for control buttons and overlays. + +- **Light:** Pairs with lighter themes and images by displaying buttons in a darker color scheme. +- **Dark:** Pairs with darker themes and images by displaying buttons in a lighter color scheme. + +
    + +
    +Crop Default: No + + +Controls how images fit the slideshow area. + +- **No:** Fits images to the specified height and keeps the width proportional. +- **Yes:** Fills the full content area at the specified height and crops the left and right edges to fit. + +
    + +
    +Disable Right-Click Default: Yes + + +Blocks the browser right-click menu on slideshow images to discourage casual image saving. +
    +
    +
    + +
    +Click Action + + +The Click Action section configures what happens when a visitor clicks a slide. + +
    +Click Action Settings + + +
    +Type Default: None + + +Selects whether clicking a slide does nothing or follows a link. + +- **None:** Clicks on the slide perform no action. +- **Link:** Clicks on the slide follow the URL set in **Link URL**. + +
    +Link settings + +Link settings control the URL, link target, nofollow behavior, download behavior, and other link attributes where available. + +
    +
    +
    +
    + +### Playback Tab + +The Playback tab controls auto-play behavior, transition style, and timing. + +
    +Auto Play Default: Yes + + +Starts the slideshow automatically on page load. Set to **No** to require visitor interaction before slides advance. +
    + +
    +Speed Default: 3 + + +The number of seconds each slide stays visible before transitioning to the next slide. +
    + +
    +Transition Default: Fade + + +Selects the animation used between slides. + +- **None:** Switches slides instantly with no animation. +- **Fade:** Cross-fades between slides. +- **Ken Burns:** Applies a slow pan-and-zoom motion to each slide. +- **Slide Horizontal:** Slides photos in from the side. +- **Slide Vertical:** Slides photos in from the top or bottom. +- **Blinds:** Reveals the next slide using a vertical blinds effect. +- **Bars:** Reveals the next slide with sequential bars. +- **Random Bars:** Reveals the next slide with bars in a random order. +- **Boxes:** Reveals the next slide with sequential boxes. +- **Random Boxes:** Reveals the next slide with boxes in a random order. +- **Boxes Grow:** Reveals the next slide with growing boxes. + +
    + +
    +Transition Speed Default: 1 + + +The duration of the transition animation in seconds. +
    + +
    +Randomize Photos Default: No + + +Shuffles the photo order on each page load when set to **Yes**. +
    + +### Controls Tab + +The Controls tab configures the navigation arrows that overlay slides and the control bar shown beneath or over the slideshow. + +
    +Navigation Arrows Default: Yes + + +Shows large navigation arrows that overlay the slideshow images so visitors can move freely between slides. These are separate from the smaller arrows in the control bar. +
    + +
    +Control Bar + + +The Control Bar section sets the navigation type and the position of the control bar. + +
    +Control Bar Settings + + +
    +Nav Type Default: None + + +Selects the style of navigation displayed in the control bar. + +- **None:** Hides the control bar. +- **Buttons:** Shows a control bar with configurable buttons such as arrows, play, fullscreen, photo count, thumbs, caption, and social sharing. +- **Thumbs:** Shows a control bar with thumbnail navigation for jumping directly to specific slides. + +
    +Nav Position + + +
    +Nav Position Default: Bottom + + +Places the control bar at the **Bottom** or **Top** of the slideshow when **Nav Type** is set to **Buttons** or **Thumbs**. +
    +
    +
    +
    +
    + +
    +Control Bar Buttons + + +This section is available when **Nav Type** is set to **Buttons** or **Thumbs**, and controls which buttons appear in the control bar. + +
    +Control Bar Buttons + + +
    +Navigation Arrows Default: Yes + + +Shows previous and next arrow buttons in the control bar. +
    + +
    +Play Button Default: Yes + + +Shows a play and pause toggle button in the control bar. +
    + +
    +Fullscreen Button Default: Yes + + +Shows a button that expands the slideshow to fullscreen. +
    + +
    +Photo Count Default: Yes + + +Shows the current slide number and total photo count in the control bar. +
    + +
    +Thumbs Button Default: Yes + + +Shows a button that toggles a thumbnail strip when **Nav Type** is set to **Buttons**. +
    + +
    +Caption Button Default: Yes + + +Shows a button that toggles caption visibility for slides that have captions. +
    + +
    +Social Button Default: Yes + + +Shows a button that opens social sharing options for the current slide. +
    +
    +
    + +
    +Control Bar Overlay + + +This section is available when **Nav Type** is set to **Buttons** or **Thumbs**, and controls whether the control bar overlays the slides and how it auto-hides. + +
    +Control Bar Overlay + + +
    +Overlay Enabled Default: No + + +Displays the control bar in an overlay at the bottom or top of the slides instead of below or above them. + +
    +Overlay Hide + + +
    +Overlay Hide Default: No + + +Hides the control bar overlay after the delay specified in **Overlay Hide Delay** when set to **Yes**. The overlay reappears on mouseover. +
    +
    + +
    +Overlay Hide Delay + + +
    +Overlay Hide Delay Default: 3 + + +The number of seconds before the control bar overlay hides when **Overlay Hide** is set to **Yes**. +
    +
    +
    +
    +
    + +
    +Thumbs + + +This section is available when **Nav Type** is set to **Buttons** or **Thumbs**, and sets the size of slideshow thumbnails. + +
    +Thumbs + + +
    +Thumbs Size Default: 50 + + +The size of the thumbnail images in pixels. +
    +
    +
    + +
    +Social + + +This section is available when **Nav Type** is set to **Buttons** or **Thumbs**, and controls which social sharing buttons appear when the social button is opened. + +
    +Social + + +
    +Facebook Button Default: Yes + + +Shows a Facebook share button in the social sharing menu. +
    + +
    +Twitter Button Default: Yes + + +Shows a Twitter share button in the social sharing menu. +
    + +
    +Pinterest Button Default: Yes + + +Shows a Pinterest share button in the social sharing menu. +
    +
    +
    + +
    +Advanced tab + +The Advanced tab contains common Slideshow module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    diff --git a/beaver-builder/layouts/modules/social-buttons.md b/beaver-builder/layouts/modules/social-buttons.md deleted file mode 100644 index 89d1757b..00000000 --- a/beaver-builder/layouts/modules/social-buttons.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -id: social-buttons -title: Social Buttons -sidebar_label: Social Buttons -description: The Social Buttons module is a legacy module that displays social icons. There are a number of social icon plugins that can replace this module. ---- - -:::info -The Social Buttons module is no longer displayed in the content -panel by default in the Beaver Builder editor. We recommend a plugin such as -[Scriptless Social Sharing](https://wordpress.org/plugins/scriptless-social-sharing/) to display social icons in content layouts. If you're using the Social Buttons module in a layout, it will continue to work. If you want to add the Social Buttons module to a layout, go to **Settings > Beaver Builder > Modules** and select the **Social buttons** checkbox to enable it in the -Modules list in the editor. -::: - -Use the Social Buttons module to let visitors share, like, or post content to -their own social network pages and automatically inserts a link to the current -page or any other URL you specify, such as the home page for your site. - -The Social Buttons module includes Facebook, Twitter, and Google+, and you can -choose which to display. Note that the social buttons use the branding of each -social site. - -![](/img/social-module-1.png) diff --git a/beaver-builder/layouts/modules/social-buttons.mdx b/beaver-builder/layouts/modules/social-buttons.mdx new file mode 100644 index 00000000..4f97eb28 --- /dev/null +++ b/beaver-builder/layouts/modules/social-buttons.mdx @@ -0,0 +1,86 @@ +--- +title: Social Buttons Module +sidebar_label: Social Buttons +icon: "share-2" +tag: "Deprecated" +description: "Use the Social Buttons module to add social sharing buttons for Facebook, Twitter, and Google+ to encourage visitors to share your content." +--- + + +Use the Social Buttons module to add social sharing buttons for Facebook, Twitter, and Google+ to encourage visitors to share your content. + +:::danger + +The Social Buttons module has been deprecated since 2018, starting with version 2.1 of Beaver Builder, and is no longer recommended for use. Its code has not been updated in several years and remains available only for backwards compatibility. For better performance, compatibility, and ongoing support, we strongly recommend using a dedicated social sharing plugin instead. +::: + +## Usage + +Use the Social Buttons module to add social media sharing buttons to your layout. Visitors can share your content on Facebook, Twitter, and Google+. You can configure the buttons to share the current page URL or a custom URL. + +For more social networks or advanced sharing features, use a dedicated social sharing plugin embedded through the [HTML](/beaver-builder/layouts/modules/html) module, or create individual social buttons with the [Button Group](/beaver-builder/layouts/modules/button-group) module. + +## Module Settings + +The Social Buttons module settings control which social buttons display and what URL they share. + +### General tab + +The General tab configures which social buttons appear and the URL they share. + +
    +Target URL Default: Current Page + + +Determines which URL the social buttons share. + +- **Current Page:** Shares the URL of the page where the module is placed. +- **Custom:** Shares a specific URL you provide. + +
    +Custom URL + + +
    +Custom URL + + +The specific URL to share when **Target URL** is set to **Custom**. +
    +
    +
    + +
    +Alignment Default: left + + +Controls the horizontal alignment of the social buttons within their container. +
    + +
    +Show Facebook Default: yes + + +Shows or hides the Facebook share button. +
    + +
    +Show Twitter Default: yes + + +Shows or hides the Twitter share button. +
    + +
    +Show Google+ Default: yes + + +Shows or hides the Google+ share button. +
    + +
    +Advanced tab + +The Advanced tab contains common Social Buttons module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    diff --git a/beaver-builder/layouts/modules/star-rating.md b/beaver-builder/layouts/modules/star-rating.md deleted file mode 100644 index 97bafd22..00000000 --- a/beaver-builder/layouts/modules/star-rating.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: star-rating -title: Star Rating -sidebar_label: Star Rating -description: The Star Rating module makes it simple to showcase feedback, reviews, and ratings directly on your site. ---- - -The Star Rating module makes it simple to showcase feedback, reviews, and ratings directly on your site. - -![Star Rating module](/img/beaver-builder/modules--star-rating--1.webp) - -## Usage - -Easily display feedback and highlight quality across your site with customizable star ratings. Adjust the number of stars, style, size, and color to match your design, creating a seamless way to showcase satisfaction and credibility. Common use cases include: - -- Displaying customer ratings within testimonial sections. -- Showcasing product or service ratings on sales pages. -- Adding star ratings to pricing tables for comparison. -- Highlighting feedback in review or case study layouts. -- Enhancing landing pages with visual trust indicators. - -## Settings - -The Star Rating module consists of two primary settings tabs: General, and Style, along with the customary Advanced tab. - -### General - -The General tab lets you control the total number of stars, set the rating, and choose the star icon. - -- **Total Stars** - Enter a numeric value to define the total number of stars to display. -- **Start Rating** - Enter a numeric value to set the star rating, which determines the displayed rating. This value cannot exceed the Total Stars setting. -- **Star Icon** - Choose the star rating icon you want to use. You can select from any icons available in your installed and enabled icon library sets, such as Font Awesome. - -### Style - -The Style tab allows you to customize the star rating, including fill and background colors, alignment, size, and spacing. It is divided into two sections: Colors, where you control the fill, background, and border settings, and Layout, where you adjust alignment, size, and spacing. - -- **Colors** - - - **Star Fill**: Sets the color of the filled stars that represent the actual rating value. - - **Star Background**: Sets the color of the unfilled stars, representing the remaining stars up to the total number set. - - **Star Border**: Sets the border color of the star icons, applied to both the filled stars representing the rating and the unfilled stars representing the total number. - -- **Layout** - - - **Star Alignment**: Choose the alignment of the stars (left, center, or right). - - **Star Size**: Set the size of the star rating icons. - - **Star Spacing**: Adjust the space between each star rating icon. - - **Star Stroke**: Set the border stroke for the star icons. - -## Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/star-rating.mdx b/beaver-builder/layouts/modules/star-rating.mdx new file mode 100644 index 00000000..d9ae8042 --- /dev/null +++ b/beaver-builder/layouts/modules/star-rating.mdx @@ -0,0 +1,133 @@ +--- +title: Star Rating +sidebar_label: Star Rating +icon: "star" +description: "Use Star Rating to display a configurable star rating with custom totals, fill levels, icons, colors, and sizing." +--- + + +Use Star Rating to display a configurable star rating with custom totals, fill levels, icons, colors, and sizing. + +## Usage + +Use Star Rating to display a visual rating made up of stars, with control over the total number of stars, the current rating value, and the icon used. The module renders both filled and unfilled portions of the rating using CSS, and supports fractional values so partial stars represent ratings such as 3.5 or 4.2 accurately. + +Use Star Rating on review pages, product showcases, testimonial layouts, case studies, and any context where a numeric score benefits from a visual representation. Pairing the **Total Stars** and **Star Rating** fields with Field Connections lets you drive the rating from custom field values stored on the post or another dynamic source. + +## Module Settings + +The Star Rating module settings control the rating value, the total number of stars, the icon used, and the colors, alignment, size, spacing, and stroke width applied to the stars. + +### General Tab + +The General tab sets the rating value, the total number of stars, and the icon used to render each star. + +
    +Total Stars Default: 5; Supports: Field Connections + + +The total number of stars displayed in the rating. Accepts whole numbers between 1 and 10. +
    + +
    +Star Rating Default: 0; Supports: Field Connections + + +The current rating value. Accepts decimal values between 0 and 5 in 0.1 increments to support partial stars. +
    + +
    +Star Icon Supports: Field Connections + + +The icon used to render each star. When left empty, the module falls back to the default star character. Selecting an icon replaces the default with the chosen icon for both the filled and unfilled portions of the rating. +
    + +### Style Tab + +The Style tab controls the colors, alignment, size, spacing, and stroke width applied to the stars. + +
    +Colors + + +The Colors section controls the fill, background, and border colors used to render each star. + +
    +Colors + + +
    +Star Fill Default: #fd0; Supports: Responsive, Field Connections + + +The color used for the filled portion of each star, representing the rating value. +
    + +
    +Star Background Default: #fff; Supports: Responsive, Field Connections + + +The color used for the unfilled portion of each star. +
    + +
    +Star Border Default: #000; Supports: Responsive, Field Connections + + +The outline color applied to each star. +
    +
    +
    + +
    +Layout + + +The Layout section controls how the stars are positioned and sized within the module. + +
    +Layout + + +
    +Star Alignment Default: Auto; Supports: Responsive + + +The horizontal alignment of the stars within the module wrapper. + +- **Left:** Aligns the stars to the left edge of the wrapper. +- **Center:** Centers the stars within the wrapper. +- **Right:** Aligns the stars to the right edge of the wrapper. + +
    + +
    +Star Size Default: 30; Supports: Responsive + + +The size of each star in pixels. +
    + +
    +Star Spacing Default: 5; Supports: Responsive + + +The horizontal space between stars in pixels. +
    + +
    +Star Stroke Default: 1; Supports: Responsive + + +The width of the star outline in pixels, drawn using the **Star Border** color. +
    +
    +
    + +
    +Advanced tab + +The Advanced tab contains common Star Rating module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    diff --git a/beaver-builder/layouts/modules/subscribe-form.mdx b/beaver-builder/layouts/modules/subscribe-form.mdx new file mode 100644 index 00000000..e3903d84 --- /dev/null +++ b/beaver-builder/layouts/modules/subscribe-form.mdx @@ -0,0 +1,1844 @@ +--- +title: Subscribe Form +sidebar_label: Subscribe Form +icon: "mail-plus" +description: "Use Subscribe Form to add a name and email opt-in form that sends new subscribers to a connected email marketing service." +--- + + +Use Subscribe Form to add a name and email opt-in form that sends new subscribers to a connected email marketing service. + +## Usage + +Use Subscribe Form to add a lightweight opt-in form that captures a name and email address and sends the subscriber to a connected email marketing service. The module submits over AJAX, supports an optional terms and conditions checkbox, can be protected with Google reCAPTCHA, and either shows a confirmation message or redirects to a thank-you page after a successful signup. + +Use Subscribe Form on landing pages, sidebars, footers, and anywhere a list-building call to action fits. It works well for newsletter signups, lead magnets, and product launch waitlists where the goal is to add subscribers to an existing email service rather than collect detailed inquiries. + +## Module Settings + +The Subscribe Form module settings control the connected email marketing service, the form structure and fields, the success behavior, the appearance of labels, inputs, and the submit button, and optional reCAPTCHA protection. + +### General Tab + +The General tab connects the form to an email marketing service, configures the visible fields, and sets what happens after a successful signup. + +
    +Service Default: Choose a service... + + +Selects the email marketing service that receives new subscribers. Choosing a service reveals the connection fields and post-connection settings for that provider. The available options are: + +- Email Address (sends submissions to a WordPress email address rather than a third-party service) +- ActiveCampaign +- AWeber +- Brevo (formerly SendinBlue) +- Campaign Monitor +- Campayn +- Constant Contact +- Constant Contact (deprecated) +- ConvertKit +- Drip +- Enormail +- GetResponse +- GoDaddy Email Marketing +- Groundhogg +- Hatchbuck +- iContact +- iContact Pro +- Keap (formerly InfusionSoft) +- Mad Mimi +- MailChimp +- MailerLite +- Mailjet +- MailPoet +- Mailrelay +- Mautic +- Ontraport +- Sendy + +See the [Services guide](#services-guide) below for the connection and post-connection settings for each service. +
    + +
    +Structure + + +The Structure section controls the form layout, whether labels are visible, which fields appear, and whether the form requires terms acceptance before submission. + +
    +Form Fields + + +
    +Layout Default: Stacked + + +Sets how form fields are arranged. + +- **Stacked:** Stacks the name field, email field, and submit button on separate lines. Field labels can be shown above each input. +- **Inline:** Places the fields and submit button on a single line. Selecting **Inline** automatically hides field labels. + +
    + +
    +Field Labels Default: Show + + +Shows or hides the labels rendered above each input. This field is only available when **Layout** is set to **Stacked**. Setting **Field Labels** to **Show** reveals the **Labels** group in the Style tab. +
    + +
    +Name Field Default: Show + + +Shows or hides the name input. + +
    +Name Field Text + + +
    +Name Field Text Default: Name + + +The text used for the name field label and placeholder. This field appears when **Name Field** is set to **Show**. +
    +
    +
    + +
    +Email Field Text Default: Email Address + + +The text used for the email field label and placeholder. +
    + +
    +Terms and Conditions Checkbox Default: Hide + + +Shows or hides a required acceptance checkbox below the form fields. + +
    +Checkbox Text + + +
    +Checkbox Text Default: I Accept the Terms and Conditions + + +The text displayed next to the checkbox. +
    +
    + +
    +Terms and Conditions + + +
    +Terms and Conditions Supports: Field Connections + + +The Terms and Conditions custom text uses the WordPress Classic Editor WYSIWYG, which lets you format text, add links, and include basic HTML. This content is displayed above the checkbox. +
    +
    +
    +
    +
    + +
    +Success + + +The Success section sets the notification subject line and configures the action that runs after a successful signup. + +
    +Success Settings + + +
    +Notification Subject + + +The subject line used for any notification email sent by the connected service. When left empty, the module falls back to **Subscribe Form Signup**. +
    + +
    +Success Action Default: Show Message + + +Determines what happens after a successful signup. + +- **Show Message:** Replaces the form with a custom confirmation message. +- **Redirect:** Sends the subscriber to another URL after they sign up. + +
    +Success Message + + +
    +Success Message Default: Thanks for subscribing! Please check your email for further instructions.; Supports: Field Connections + + +The confirmation message displayed after a successful signup when **Success Action** is set to **Show Message**. Uses the WordPress Classic Editor WYSIWYG. +
    +
    + +
    +Success URL + + +
    +Success URL Supports: Field Connections + + +The destination used after a successful signup when **Success Action** is set to **Redirect**. + +
    +Link settings + +Link settings control the URL, link target, nofollow behavior, download behavior, and other link attributes where available. + +
    +
    +
    +
    +
    +
    + +### Style Tab + +The Style tab controls the appearance of labels, inputs, and the submit button. + +
    +Labels + + +This group is available when **Field Labels** is set to **Show** in the General tab. + +
    +Labels + + +
    +Padding Supports: Responsive + + +The inner spacing around each field label. +
    + +
    +Color Supports: Field Connections + + +The text color of form labels. +
    + +
    +Typography Supports: Responsive + + +The font settings for form labels. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    +
    +
    + +
    +Inputs + + +The Inputs section controls the appearance of the name and email inputs. + +
    +Inputs + + +
    +Gap + + +The vertical spacing between each form field. +
    + +
    +Padding Supports: Responsive + + +The inner spacing of the name and email inputs. +
    + +
    +Color Supports: Field Connections + + +The text color of the name and email inputs. +
    + +
    +Hover Color Supports: Field Connections + + +The text color used when the name and email inputs are hovered or focused. +
    + +
    +Typography Supports: Responsive + + +The font settings for the name and email inputs. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    + +
    +Background Color Supports: Field Connections + + +The background color of the name and email inputs. +
    + +
    +Background Hover Color Supports: Field Connections + + +The background color used when the name and email inputs are hovered or focused. +
    + +
    +Border settings + +Border settings control border style, width, color, radius, and related responsive border controls where available. + +
    + +
    +Border Hover Color Supports: Field Connections + + +The border color used when the name and email inputs are hovered or focused. +
    +
    +
    + +
    +Button + + +The Button section controls the appearance of the submit button. + +
    +Button settings + + +
    +Text Default: Subscribe! + + +The label displayed on the submit button. +
    + +
    +Icon Supports: Field Connections + + +Adds an optional icon to the submit button. + +
    +DuoTone Primary Color + + +
    +DuoTone Primary Color Supports: Field Connections + + +For Font Awesome DuoTone icons only: the primary color applied to the icon. +
    +
    + +
    +DuoTone Secondary Color + + +
    +DuoTone Secondary Color Supports: Field Connections + + +For Font Awesome DuoTone icons only: the secondary color applied to the icon. +
    +
    + +
    +Icon Position + + +
    +Icon Position Default: Before Text + + +Places the icon before or after the button text when an icon is selected. +
    +
    + +
    +Icon Visibility + + +
    +Icon Visibility Default: Always Visible + + +Keeps the icon visible or fades it in on hover when an icon is selected. + +- **Always Visible:** Displays the icon at all times. +- **Fade In On Hover:** Fades the icon in when the button is hovered. + +
    +
    +
    + +
    +Padding Supports: Responsive + + +The inner spacing of the submit button. +
    + +
    +Text Color Supports: Field Connections + + +The text color of the submit button. +
    + +
    +Text Hover Color Supports: Field Connections + + +The text color of the submit button on hover and focus. +
    + +
    +Typography Supports: Responsive + + +The font settings for the submit button text. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    + +
    +Background Color Supports: Field Connections + + +The default background color of the submit button. +
    + +
    +Background Hover Color Supports: Field Connections + + +The background color of the submit button on hover and focus. +
    + +
    +Background Style Default: Flat + + +Selects a **Flat** or **Gradient** background for the submit button. + +- **Flat:** Renders a solid background color. +- **Gradient:** Renders a gradient between the background color and a darker shade. + +
    + +
    +Background Animation Default: Disabled + + +Enables or disables the transition between the normal and hover background states. +
    + +
    +Border Supports: Responsive + + +The border style, width, radius, and color of the submit button. +
    + +
    +Border Hover Color Supports: Field Connections + + +The border color of the submit button on hover and focus. +
    +
    +
    + +### Captcha Tab + +The Captcha tab configures Google reCAPTCHA for spam protection. + +:::note + +Set up your reCAPTCHA keys in the [Google Admin Console](https://www.google.com/recaptcha/admin). Each reCAPTCHA validation type requires its own unique site key and secret key pair. + +For more information, see the [reCAPTCHA v3 documentation](https://developers.google.com/recaptcha/docs/v3). +::: + +
    +reCAPTCHA Field Default: Hide + + +Shows or hides the Google reCAPTCHA field. Enabling it requires valid site and secret keys. + +
    +Validate Type + + +
    +Validate Type Default: {`"I'm not a robot" checkbox (V2)`} + + +Selects the reCAPTCHA challenge mode. + +- **"I'm not a robot" checkbox (V2):** Shows the standard reCAPTCHA checkbox widget. +- **Invisible (V2):** Validates submissions in the background using the v2 invisible flow. +- **Invisible (V3):** Validates submissions in the background using v3 scoring. + +
    +Action + + +
    +Action + + +An optional action name passed to Google for v3 verification when **Validate Type** is set to **Invisible (V3)**. Use letters, numbers, and underscores only. +
    +
    +
    +
    + +
    +Site Key + + +
    +Site Key + + +The public site key from the Google reCAPTCHA Admin Console. +
    +
    + +
    +Secret Key + + +
    +Secret Key + + +The private secret key from the Google reCAPTCHA Admin Console. +
    +
    + +
    +Theme + + +
    +Theme Default: Light + + +The color scheme used for visible reCAPTCHA widgets. + +- **Light:** Renders the widget on a light background. +- **Dark:** Renders the widget on a dark background. + +
    +
    +
    + +
    +Advanced tab + +The Advanced tab contains common Subscribe Form module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    + +## Services guide + +Each service connects in the same way. After you choose a value in the **Service** field, the module displays an **Account Name** field, the credentials needed by the selected provider, and a **Connect** button: + +1. Enter an **Account Name** to identify the connection in your saved accounts list. The name can be anything you choose. +2. Fill in the credentials shown for the selected service. +3. Click **Connect** to save the account. +4. Once connected, choose the saved account in the **Account** field and configure any remaining service-specific settings. + +The sections below list the connection and post-connection settings for each service. Email Address appears first because it is not a third-party integration. The remaining services are listed alphabetically. + +
    +Email Address + + +Sends the subscriber's name and email to a WordPress email address rather than to a third-party email marketing service. There are no post-connection settings. + +
    +Connection settings + + +
    +Email Address + + +The email address that receives the form submission. +
    +
    +
    + +
    +ActiveCampaign + + +Adds subscribers to an ActiveCampaign list or form, with optional tagging. + +
    +Connection settings + + +
    +API URL + + +Your ActiveCampaign API URL, found in your ActiveCampaign account under **My Settings > Developer > API**. +
    + +
    +API Key + + +Your ActiveCampaign API key, found in your ActiveCampaign account under **My Settings > Developer > API**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved ActiveCampaign account used for this form. +
    + +
    +Type + + +Whether to add the subscriber to a **List** or to a **Form**. Selecting a value reveals the matching selector below. +
    + +
    +List + + +The ActiveCampaign list that receives the subscriber. Available when **Type** is set to **List**. +
    + +
    +Form + + +The ActiveCampaign form to associate with the submission. Available when **Type** is set to **Form**. +
    + +
    +Tags + + +One or more tags to apply to the subscriber. +
    +
    +
    + +
    +AWeber + + +Adds subscribers to an AWeber list, with optional tagging. AWeber connects through OAuth: the connection field provides a link that opens AWeber's authorization page, where you generate the code to paste back into the field. + +
    +Connection settings + + +
    +Authorization Code + + +The authorization code returned by AWeber after you authorize Beaver Builder to access your account. Use the **Register Now** link displayed with the field to begin the AWeber authorization flow, then paste the code into this field. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved AWeber account used for this form. +
    + +
    +List + + +The AWeber list that receives the subscriber. +
    + +
    +Tags + + +A comma-separated list of tags to apply to the subscriber. +
    +
    +
    + +
    +Brevo (formerly SendinBlue) + + +Adds subscribers to a Brevo list. The service ID remains `sendinblue` for backwards compatibility. + +
    +Connection settings + + +
    +API Key + + +Your Brevo API key, found in your Brevo account under **SMTP & API > API Keys**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Brevo account used for this form. +
    + +
    +List + + +The Brevo list that receives the subscriber. +
    +
    +
    + +
    +Campaign Monitor + + +Adds subscribers to a Campaign Monitor list under a selected client. + +
    +Connection settings + + +
    +API Key + + +Your Campaign Monitor API key, found in your Campaign Monitor account under **Account Settings > API Key**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Campaign Monitor account used for this form. +
    + +
    +Client + + +The Campaign Monitor client that owns the target list. +
    + +
    +List + + +The list under the selected client that receives the subscriber. +
    +
    +
    + +
    +Campayn + + +Adds subscribers to a Campayn list. + +
    +Connection settings + + +
    +Host + + +The host you chose when you signed up for your Campayn account, for example `demo.campayn.com`. Enter it without the leading `http://`. +
    + +
    +API Key + + +Your Campayn API key, found in your Campayn account under **Settings > API Key**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Campayn account used for this form. +
    + +
    +List + + +The Campayn list that receives the subscriber. +
    +
    +
    + +
    +Constant Contact + + +Adds subscribers to a Constant Contact list. Connection requires a developer application registered in the Constant Contact API portal so you can generate the OAuth tokens used by the form. + +
    +Connection settings + + +
    +Client ID + + +The Client ID from your Constant Contact API application. +
    + +
    +Client Secret + + +The Client Secret from your Constant Contact API application. +
    + +
    +Access Token + + +The Access Token generated for your Constant Contact API application. +
    + +
    +Refresh Token + + +The Refresh Token generated for your Constant Contact API application. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Constant Contact account used for this form. +
    + +
    +List + + +The Constant Contact list that receives the subscriber. +
    +
    +
    + +
    +Constant Contact (deprecated) + + +Adds subscribers to a Constant Contact list using the legacy v2 API. + +:::warning + +This service is deprecated. Use the **Constant Contact** service for new forms. +::: + +:::note + +You must already have registered a Developer Account with Constant Contact and obtained an API key and access token. Creating new v2 API Keys is no longer supported by Constant Contact. If you do not already have a v2 API key, please use the other Constant Contact option that supports the v3 API. +::: + +
    +Connection settings + + +
    +API Key + + +Your Constant Contact v2 API key. +
    + +
    +Access Token + + +Your Constant Contact v2 access token. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Constant Contact (v2) account used for this form. +
    + +
    +List + + +The Constant Contact list that receives the subscriber. +
    +
    +
    + +
    +ConvertKit + + +Adds subscribers to a ConvertKit form, with optional custom field mapping. + +
    +Connection settings + + +
    +API Key + + +Your ConvertKit API key, found in your ConvertKit account under **Account > Account Settings > API Key**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved ConvertKit account used for this form. +
    + +
    +List + + +The ConvertKit form that receives the subscriber. +
    + +
    +Custom Fields + + +One or more ConvertKit custom fields to populate from the submission. +
    +
    +
    + +
    +Drip + + +Adds subscribers to a Drip account, with optional tags, campaign enrollment, and workflow enrollment. + +
    +Connection settings + + +
    +API Token + + +Your Drip API token. +
    + +
    +Account ID + + +Your Drip Account ID, found in your Drip account under **Settings > Site Setup**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Drip account used for this form. +
    + +
    +Campaign + + +The Drip campaign to enroll the subscriber in. +
    + +
    +Tags + + +A comma-separated list of tags to apply to the subscriber. +
    + +
    +Workflow + + +The Drip workflow to enroll the subscriber in after they are added. +
    +
    +
    + +
    +Enormail + + +Adds subscribers to an Enormail list. + +
    +Connection settings + + +
    +API Key + + +Your Enormail API key, found in your Enormail account settings. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Enormail account used for this form. +
    + +
    +List + + +The Enormail list that receives the subscriber. +
    +
    +
    + +
    +GetResponse + + +Adds subscribers to a GetResponse list, with an optional autoresponder cycle day. + +
    +Connection settings + + +
    +API Key + + +Your GetResponse API key, found in your GetResponse account under **My Account > API & OAuth**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved GetResponse account used for this form. +
    + +
    +List + + +The GetResponse list that receives the subscriber. +
    + +
    +Cycle Day + + +The autoresponder cycle day to assign to the subscriber. This should match the cycle day configured for the selected list's autoresponder. +
    +
    +
    + +
    +GoDaddy Email Marketing + + +Adds subscribers to a GoDaddy Email Marketing signup form. + +
    +Connection settings + + +
    +API Username + + +The username associated with your GoDaddy Email Marketing account. +
    + +
    +API Key + + +The API key from your GoDaddy Email Marketing account. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved GoDaddy Email Marketing account used for this form. +
    + +
    +Form + + +The GoDaddy Email Marketing signup form that receives the subscriber. +
    +
    +
    + +
    +Groundhogg + + +Adds subscribers to your Groundhogg installation and applies one or more tags. Groundhogg runs inside WordPress, so no API credentials are required, but the [Groundhogg plugin](https://wordpress.org/plugins/groundhogg/) must be installed and active. If the plugin is not active, the connection panel shows an installation notice instead of the connection fields. + +
    +Connection settings + + +
    +Plugin requirement + + +No credentials are needed. Click **Connect** after the Groundhogg plugin is installed and active. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Groundhogg connection used for this form. +
    + +
    +Apply Tag + + +One or more Groundhogg tags to apply to the subscriber. +
    +
    +
    + +
    +Hatchbuck + + +Adds subscribers to Hatchbuck and applies a tag. + +
    +Connection settings + + +
    +API Key + + +Your Hatchbuck API key, found in your Hatchbuck account under **Account Settings > Web API**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Hatchbuck account used for this form. +
    + +
    +Tag + + +The Hatchbuck tag to apply to the subscriber. +
    +
    +
    + +
    +iContact + + +Adds subscribers to an iContact list. + +
    +Connection settings + + +
    +Username + + +Your iContact username. +
    + +
    +App ID + + +Your iContact app ID. +
    + +
    +App Password + + +Your iContact app password. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved iContact account used for this form. +
    + +
    +List + + +The iContact list that receives the subscriber. +
    +
    +
    + +
    +iContact Pro + + +Adds subscribers to an iContact Pro list. Pro accounts require additional company and profile identifiers. + +
    +Connection settings + + +
    +Username + + +Your iContact Pro username. +
    + +
    +App ID + + +Your iContact Pro app ID. +
    + +
    +App Password + + +Your iContact Pro app password. +
    + +
    +Company ID + + +Your iContact Pro company ID. +
    + +
    +Profile ID + + +Your iContact Pro profile ID. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved iContact Pro account used for this form. +
    + +
    +List + + +The iContact Pro list that receives the subscriber. +
    +
    +
    + +
    +Keap (formerly InfusionSoft) + + +Adds subscribers to Keap and tags them. The service ID remains `infusionsoft` for backwards compatibility. + +
    +Connection settings + + +
    +App ID + + +Your Keap App ID. The App ID is the subdomain in your account URL. For example, if your account URL is `myaccount.infusionsoft.com`, the App ID is `myaccount`. +
    + +
    +API Key + + +Your Keap API key, found in your Keap account under **Admin > Settings > Application > API > Encrypted Key**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Keap account used for this form. +
    + +
    +Select Tag + + +The Keap tag to apply to the subscriber. +
    +
    +
    + +
    +Mad Mimi + + +Adds subscribers to a Mad Mimi list. + +
    +Connection settings + + +
    +Email Address + + +The email address associated with your Mad Mimi account. +
    + +
    +API Key + + +Your Mad Mimi API key, found in your Mad Mimi account under **Account > Settings & Billing > API**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Mad Mimi account used for this form. +
    + +
    +List + + +The Mad Mimi list that receives the subscriber. +
    +
    +
    + +
    +MailChimp + + +Adds subscribers to a MailChimp audience, with optional tags and interest groups. + +
    +Connection settings + + +
    +API Key + + +Your MailChimp API key, found in your MailChimp account under **Account > Extras > API Keys**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved MailChimp account used for this form. +
    + +
    +List + + +The MailChimp audience that receives the subscriber. +
    + +
    +Tags + + +A comma-separated list of tags to apply to the subscriber. +
    + +
    +Groups + + +One or more MailChimp interest groups to assign to the subscriber. +
    +
    +
    + +
    +MailerLite + + +Adds subscribers to a MailerLite group. + +
    +Connection settings + + +
    +API Key + + +Your MailerLite API key, found in your MailerLite account under **Integrations > Developer API**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved MailerLite account used for this form. +
    + +
    +Group + + +The MailerLite group that receives the subscriber. +
    +
    +
    + +
    +Mailjet + + +Adds subscribers to a Mailjet contact list. + +
    +Connection settings + + +
    +API Key + + +Your Mailjet API key, found in your Mailjet account under **Account Settings > Rest API > Master API Key & Sub API Key Management**. +
    + +
    +Secret Key + + +Your Mailjet secret key, found alongside the API key in **Account Settings > Rest API > Master API Key & Sub API Key Management**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Mailjet account used for this form. +
    + +
    +List + + +The Mailjet contact list that receives the subscriber. +
    +
    +
    + +
    +MailPoet + + +Adds subscribers to a MailPoet list. MailPoet runs inside WordPress, so no API credentials are required, but the MailPoet plugin must be installed and active. + +
    +Connection settings + + +
    +Plugin requirement + + +No credentials are needed. Click **Connect** after the MailPoet plugin is installed and active. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved MailPoet connection used for this form. +
    + +
    +List + + +The MailPoet list that receives the subscriber. +
    +
    +
    + +
    +Mailrelay + + +Adds subscribers to one or more Mailrelay groups. + +
    +Connection settings + + +
    +Host + + +The host you chose when you signed up for your Mailrelay account, for example `demo.ip-zone.com`. Enter it without the leading `http://`. +
    + +
    +API Key + + +Your Mailrelay API key, found in your Mailrelay account under **Menu > Settings > API access**. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Mailrelay account used for this form. +
    + +
    +Group + + +One or more Mailrelay groups that receive the subscriber. +
    +
    +
    + +
    +Mautic + + +Adds subscribers to a Mautic segment by authenticating against your self-hosted Mautic installation. + +
    +Connection settings + + +
    +Installation URL + + +The URL where your Mautic application is installed, for example `http://mautic.mywebsite.com`. +
    + +
    +Mautic Username + + +A Mautic username with full system access. As a best practice, create a dedicated user for each external site. +
    + +
    +Mautic Password + + +The password for the Mautic user. Use a long passphrase. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Mautic account used for this form. +
    + +
    +List + + +The Mautic segment that receives the subscriber. +
    +
    +
    + +
    +Ontraport + + +Adds subscribers to an Ontraport campaign. + +
    +Connection settings + + +
    +APP ID + + +Your Ontraport APP ID, found in your Ontraport account. +
    + +
    +API Key + + +Your Ontraport API key, found in your Ontraport account. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Ontraport account used for this form. +
    + +
    +Campaign + + +The Ontraport campaign that the subscriber is added to. +
    +
    +
    + +
    +Sendy + + +Adds subscribers to a list in your self-hosted Sendy installation. Sendy is unusual in that the list ID is part of the connection rather than a post-connection setting, so each Sendy account corresponds to a single list. + +
    +Connection settings + + +
    +Installation URL + + +The URL where your Sendy application is installed, for example `http://mywebsite.com/sendy`. +
    + +
    +API Key + + +Your Sendy API key, found in your Sendy application under **Settings**. +
    + +
    +List ID + + +The ID of the Sendy list that receives the subscriber. The list ID is shown under **View all lists** in the **ID** column. +
    +
    + +
    +Settings after connecting + + +
    +Account + + +The saved Sendy account used for this form. Because the list is part of the connection, no additional fields appear after connecting. +
    +
    +
    diff --git a/beaver-builder/layouts/modules/subscribe-form/configure-subscribe-form-module-for-mailchimp-double-opt-in.md b/beaver-builder/layouts/modules/subscribe-form/configure-subscribe-form-module-for-mailchimp-double-opt-in.md deleted file mode 100644 index b7c17b8a..00000000 --- a/beaver-builder/layouts/modules/subscribe-form/configure-subscribe-form-module-for-mailchimp-double-opt-in.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: configure-subscribe-form-module-for-mailchimp-double-opt-in -title: Configure the Subscribe Form module for MailChimp double opt-in -sidebar_label: Configure MailChimp double opt-in -description: Use a filter to configure the Beaver Builder Subscribe Form module to use MailChimp double opt-in. ---- - -MailChimp changed their default subscriber setting to single opt-in – in other words, a subscriber submits a subscription form connected to the MailChimp API and is automatically subscribed. Double opt-in is when the subscriber submits the form and receives an email asking for subscription verification. - -If you're using the Beaver Builder Subscribe Form module, you can enable double opt-in with a Beaver Builder filter. See the [filter examples article for the MailChimp opt-in filter code](/beaver-builder/developer/tutorials-guides/common-beaver-builder-plugin-filter-examples.md/#enable-double-opt-in-for-mailchimp-integrations). diff --git a/beaver-builder/layouts/modules/subscribe-form/subscribe-form.md b/beaver-builder/layouts/modules/subscribe-form/subscribe-form.md deleted file mode 100644 index 56986885..00000000 --- a/beaver-builder/layouts/modules/subscribe-form/subscribe-form.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -id: subscribe-form -title: Subscribe Form -sidebar_label: Subscribe Form -description: The Subscribe Form module displays a form for visitors to sign up, with back-end connections to many email services or just a simple email notification. ---- - -Use the Subscribe Form module to provide a form for visitors to subscribe to an email list or to collect email addresses for your own use. See the list of supported email subscription services at the end of this article. - -The Subscribe Form module displays a simple form with five parts: - -- Name (can be displayed or hidden; if displayed it's a required field) -- Email address -- An optional **Terms & Conditions** checkbox, for which you can customize the terms and the checkbox label. -- Subscribe button -- An optional Google reCaptcha checkbox to reduce the incidence of junk submissions. - -## Example in use - -Here's an example of the Subscribe Form module as used in the Sign Up content -template included with the Beaver Builder plugin. An example of the **Terms -and Conditions** checkbox has been added to the template. If you enable this -option, users must select the checkbox to submit the form -successfully. If they don't, they receive the message "You must accept the -Terms and Conditions." - -![](/img/subscribe-module-1.png) - -This template consists of a single row with two columns. In the left column, there's a Photo module for the envelope image, and in the right column there's -a Text Editor module for the text and then the Subscribe form beneath that. In -the template, the fields and the button are stacked, but you can also display them -inline, which means the fields and the button are laid out horizontally for a more -full-width presentation, for example in a ribbon top bar banner. - -## Notifications and confirmations - -Email notifications depend on the service and your account settings there. For -example, if you connect a MailChimp account, after the subscriber clicks -**Submit**, MailChimp takes over and sends a notification email. The list owner doesn't get notified of the -subscription unless that notification is configured in the Mail Chimp account. - -On the other hand, if you choose **Email Address** as the service, you have to -supply an email address that the subscription information will forward to. In -this case, you receive a notification with the subject line in the Subscribe -Form Signup field, but the subscriber doesn't get a notification by default. -That's something you'd have to configure in the email account that you're -forwarding to, such as setting up an autoresponder. - -You can choose whether the person who submits the form gets confirmation on -screen, and if so, whether clicking the button sends that person to another -URL or displays the confirmation message in place of the form. You can also -style the button label (the default label is **Send** ), add a button icon, -change the button color, and so on. - -## Supported services - -The Subscribe Form module supports a connection to the following services: - -- ActiveCampaign -- AWeber -- Campaign Monitor -- Campayn -- Constant Contact -- ConvertKit -- Drip -- Email Address - This choice sends the subscriber name and email to an email address of your - choosing. You must then handle it in that email account--for example, set up - an autoresponse to the subscriber, set up an email filter to channel the - subscribe emails into a special folder, add them to your contact list, and so - on. -- Enormail -- GetResponse -- Godaddy Email Marketing -- Groundhogg - **Note**: You must have the Groundhogg plugin installed for Groundhogg to appear in the list in the Subscribe Form module. -- Hatchbuck -- iContact -- iContact Pro -- Infusionsoft -- Mad Mimi -- MailChimp -- MailerLite -- Mailjet -- MailPoet - **Note**: You must have the MailPoet plugin installed for MailPoet to appear in the list in the Subscribe Form module. MailPoet shows all of your lists for you to choose from. -- Mailrelay -- Mautic -- Ontraport -- SendinBlue -- Sendy - -## Settings - -### General tab - -:::tip **Tip** -If you're mocking up a website but don't have a subscription service enabled yet, choose **Email address** in the **Service** field. That way you can keep the form in the layout and connect the service later. -::: - -| Section | Field | Description | -| ------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| | **Service** | The mail service you want to use, or choose **Email address** if you just want to get notifications rather than use a subscription service. | -| | **Account** | Depending on which service you select, you'll get the appropriate fields to connect to your service account. If you chose **Email address** for your account, provide the email address where you want to receive notifications of subscribers. | -| **Structure** | **Layout** | Choose **Stacked** (vertical layout) or **Inline** (horizontal layout). | -| | **Name field** | (Default is **Show**.) Show or hide on the form. | -| | **Name field text** | (Default is "Name.") Modify if you want to customize the field's placeholder text. | -| | **Email field text** | (Default is "Email Address.") Modify if you want to customize the field's placeholder text. | -| | **Terms and Conditions checkbox** | (Default is **Hide**.) If set to **Show**, new settings appear to customize the text label and to enter the terms and conditions. If you enable this setting, users are required to accept them for form submission to be successful. | -| **Success** | **Notification subject** | The subject of the notification email that the subscriber receives. The default subject is "Subscribe Form Signup." | -| | **Success action** | **Show message** means the confirmation message is displayed in place of the Subscribe Form. **Redirect** lets you provide a URL to a different page where you can provide your own message. | -| | **Message** | (Optional) Enter a custom message for the **Show message** confirmation. Note that the text you provide here doesn't appear in the email notification. | - -### Button tab - -| Section | Field | Description | -| ---------------------------------------------------------------------------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| | **Button text** | (Optional) Enter custom text for the Subscribe button. | -| **Button icon** | **Button icon** | (Optional) Select an icon for the Subscribe button. | -| **Button style** | **Button padding** | (Optional) Specify the number of pixels of space between the button edge and the button text. | -| **Button text** | **Button text color** | (Optional) Choose the color of the button. Note: If you're using the Beaver Builder Theme, the default button and button hover colors come from **Customize > General > Buttons**, but you override the default colors with this setting. | -| | **Button text hover color** | (Optional) Enter a hover color. | -| | **Button typography** | The [standard typography section](basics/typography.md) to style the button text. | -| **Button background** | **Button background color** | Set the fill color for the button in the resting state. | -| | **Button background hover color** | Set the button's fill color on hover. If this setting is left blank, the **Background color** setting applies to hover also. | -| | **Button background style** | **Flat**: consistent fill color. | -| **Gradient**: gradient of the background color, lighter on top and darker on the bottom. | -| | **Button background animation** | **Disabled** by default. If set to **Enabled**, there's a 0.2-second linear transition from resting state to hover state. | -| **Button border** | **Button border** | (Optional) The [standard border settings](basics/border.md). | - -### Captcha tab - -See [this article](/beaver-builder/layouts/modules/contact-form/add-a-google-recaptcha-checkbox-to-a-form.md) for instructions on how to implement Google reCaptcha. - -### Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. - -## Accessibility - -The Subscribe Form module's rendered HTML output contains a number of labels and classes to help screen readers understand the form. Here's an example. - -```html -
    -``` diff --git a/beaver-builder/layouts/modules/tabs.mdx b/beaver-builder/layouts/modules/tabs.mdx new file mode 100644 index 00000000..96d4f93e --- /dev/null +++ b/beaver-builder/layouts/modules/tabs.mdx @@ -0,0 +1,417 @@ +--- +title: Tabs +sidebar_label: Tabs +icon: "folder-closed" +description: "Use Tabs to display a collection of tabbed content built from manual items or post-based content." +--- + + +Use Tabs to display a collection of tabbed content built from manual items or post-based content. + +## Usage + +Use Tabs to display a collection of content panels that visitors switch between using a row of labels. Build tabs manually with custom content, or generate them dynamically from posts, pages, or custom post types. The module supports both horizontal and vertical layouts and provides a separate behavior for how tabs collapse on mobile. + +This module is useful for product details, feature comparisons, documentation sections, pricing breakdowns, and other layouts that group related content into compact, switchable panels. + +## Module Settings + +The Tabs module settings control where tab items come from, how labels and content render, and how the tabs look on the front end. + +### Items Tab + +The Items tab defines the tab source and the content shown inside each tab panel. + +
    +Content Source Default: Custom Content + + +Selects whether tab items come from WordPress posts or manual entries created inside the module. + +- **Post:** Builds tab items from queried WordPress posts, pages, or custom post types. +- **Custom Content:** Builds tab items from manual items added directly in the module. + +
    +Post Settings + + +
    +Post + + +The Post section configures the query used when **Content Source** is set to **Post**. + +
    +Post Query + + +
    +Post Type Default: Post + + +Selects one or more post types to query for tab items. +
    + +
    +Posts Per Page Default: 5 + + +Sets how many queried posts appear as tab items. +
    + +
    +Ordering settings + +Ordering settings control how queried posts or items are sorted, such as by date, title, menu order, or custom ordering options where available. + +
    + +
    +Filtering settings + +Filtering settings control which posts, terms, authors, or content types are included or excluded from the module output. + +
    +
    +
    +
    + +
    +Display Settings + + +
    +Display + + +The Display section controls post output for tab content. This section is available when **Content Source** is set to **Post**. + +
    +Display + + +
    +Content Type (Post Only) Default: Post Content + + +Selects whether post-based items render full post content or post excerpts. + +- **Post Content:** Displays the full post content inside each tab panel. +- **Post Excerpt:** Displays the post excerpt and reveals excerpt display settings. + +
    +Excerpt Settings + + +
    +Excerpt Length (Post Excerpt Only) + + +Sets the number of words shown in each post excerpt. +
    + +
    +Excerpt More Text (Post Excerpt Only) Default: ... + + +Sets the text appended after each excerpt. +
    + +
    +More Link (Post Excerpt Only) Default: Hide + + +Shows or hides a link below each post excerpt. + +- **Show:** Displays a link below the excerpt and reveals **More Link Text**. +- **Hide:** Removes the excerpt link. + +
    +More Link Text + + +
    +More Link Text (Show Only) Default: Read More + + +Sets the label used for the post excerpt link when **More Link** is set to **Show**. +
    +
    +
    +
    +
    +
    +
    +
    + +
    +Custom Content Settings + + +
    +Custom Content + + +The Custom Content section manages manual tab items created inside the module. + +
    +Tab Items + + +
    +Item + + +Adds one or more tab items and stores the label and content settings for each item. + +
    +Item Settings + + +
    +Label Supports: Field Connections + + +Sets the label text displayed for the tab. +
    + +
    +Type Default: Custom Content + + +Selects whether the item uses custom editor content or a saved Beaver Builder asset. + +- **Saved Row:** Loads a saved row into the tab panel. +- **Saved Column:** Loads a saved column into the tab panel. +- **Saved Module:** Loads a saved module into the tab panel. +- **Saved Template:** Loads a saved template into the tab panel. +- **Custom Content:** Uses editor content added directly in the tab item. + +
    +Select Row + + +
    +Select Row (Saved Row Only) + + +Lists all saved rows you have created. Select one to use that saved row as the tab panel content when **Type** is set to **Saved Row**. +
    +
    + +
    +Select Column + + +
    +Select Column (Saved Column Only) + + +Lists all saved columns you have created. Select one to use that saved column as the tab panel content when **Type** is set to **Saved Column**. +
    +
    + +
    +Select Modules + + +
    +Select Modules (Saved Module Only) + + +Lists all saved modules you have created. Select one to use that saved module as the tab panel content when **Type** is set to **Saved Module**. +
    +
    + +
    +Select Template + + +
    +Select Template (Saved Template Only) + + +Lists all templates you have created. Select one to use that template as the tab panel content when **Type** is set to **Saved Template**. +
    +
    + +
    +Content + + +
    +Content (Custom Content Only) Supports: Field Connections + + +Adds custom content using the WordPress Classic Editor when **Type** is set to **Custom Content**. +
    +
    +
    +
    +
    +
    +
    +
    +
    + +### Style Tab + +The Style tab controls layout, colors, borders, label appearance, and content styling for the tabs. + +
    +Layout Default: Horizontal + + +Sets the orientation of the tab labels in relation to the panels. + +- **Horizontal:** Places the labels in a row above the tab panels. +- **Vertical:** Places the labels in a column to the side of the tab panels. + +
    + +
    +Background Color Supports: Field Connections + + +Sets the background color of the active tab label and the tab panels. +
    + +
    +Border Color Default: e5e5e5; Supports: Field Connections + + +Sets the border color used around tab labels and the tab panels. +
    + +
    +Border Width + + +Sets the border width in `px` for tab labels and the tab panels. +
    + +
    +Active Tab Default: 1 + + +Sets which tab is open when the module loads. If the value exceeds the number of tabs, the first tab is used. Set to `0` or leave blank to load with no active tab. +
    + +
    +Tab(s) Status on Mobile Default: Keep Active Tab Open + + +Controls how tabs behave when the module collapses to a stacked layout on mobile. + +- **Keep Active Tab Open:** Keeps the active tab open when the layout collapses on mobile. +- **Close All Tabs:** Closes all tabs when the layout collapses on mobile. + +
    + +
    +Label + + +The Label section controls the appearance of tab labels. + +
    +Label Settings + + +
    +Inactive Label Text Color Supports: Field Connections + + +Sets the text color of inactive tab labels. +
    + +
    +Inactive Label Background Color Supports: Field Connections + + +Sets the background color of inactive tab labels. +
    + +
    +Active Label Text Color Supports: Field Connections + + +Sets the text color of the active tab label. +
    + +
    +Active Label Background Color Supports: Field Connections + + +Sets the background color of the active tab label. +
    + +
    +Padding Supports: Responsive, Link Values + + +Sets the inner spacing of tab labels. +
    + +
    +Typography Supports: Responsive + + +The font settings for tab labels. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    +
    +
    + +
    +Content + + +The Content section controls the appearance of tab panels. + +
    +Content Settings + + +
    +Text Color (Custom Content Only) Supports: Field Connections + + +Sets the text color for custom content shown inside tab panels. This field appears when **Content Source** is set to **Custom Content**. +
    + +
    +Padding Supports: Responsive, Link Values + + +Sets the inner spacing of tab panels. +
    + +
    +Typography (Custom Content Only) Supports: Responsive + + +The font settings for custom content shown inside tab panels. This field appears when **Content Source** is set to **Custom Content**. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    +
    +
    + +
    +Advanced tab + +The Advanced tab contains common Tabs module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    diff --git a/beaver-builder/layouts/modules/tabs/index.md b/beaver-builder/layouts/modules/tabs/index.md deleted file mode 100644 index e4b14319..00000000 --- a/beaver-builder/layouts/modules/tabs/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: index -title: Tabs -sidebar_label: Tabs ---- - -The Tabs module displays horizontal or vertical tabbed content, ideal for inserting sets of content into a small space. - -![Tabs module](/img/beaver-builder/modules--tabs--1.jpg) - -## Usage - -The Accordion module is ideal when you have a list of items with detailed information that you want to keep easily accessible without cluttering up the main page. Below are some examples of useful applications for the Accordion module: - -* FAQs -* Q&A -* Feature Lists for products or services - -
    - -
    - -## In this Section - -import DocCardList from '@theme/DocCardList'; - - \ No newline at end of file diff --git a/beaver-builder/layouts/modules/tabs/link-specific-item.md b/beaver-builder/layouts/modules/tabs/link-specific-item.md deleted file mode 100644 index fdf5f6cc..00000000 --- a/beaver-builder/layouts/modules/tabs/link-specific-item.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: link-specific-item -title: Link to a Specific Tab Item -sidebar_label: Link to a Specific Item ---- - -In this article, you will learn how to create a link that navigates to a specific item in an Tab module. - -## Adding an `ID` - -To begin, first assign an `ID` to the Tab module, which can be accomplished by following the instructions below: - -1. Open the Tab module settings and click the [Advanced tab](../../advanced-tab/index.md). - -2. Scroll to the `ID` setting, and set a unique `ID` name for the module. - See the [Advanced tab](../../advanced-tab/html-element.md#id) article for more information about `ID` selectors. - -3. Save changes. - -## Index Values - -Every item in the Tab module is given a unique index value that starts at `0`. The index value of the initial Tab item is `0`, the second item is assigned an index value of `1`, the third item has an index value of `2`, and so on. By using these index values in an HTML link, you can generate a link to a specific Tab item and set it as the active item. - -The below HTML code example demonstrates how the index values are allocated to each Tab item. In this instance, the Tab module has been given a unique ID name of `my-tab` and consists of three Tab items. - -```html -
    -
    -
    -
    -
    -
    -
    -
    -
    -``` - -## Linking to a Specific Item - -The link structure will differ based on whether the Tab module is on the same page as your link. To create the link, you can use either the Button or HTML modules in your layout. - -### Same Page - -When the link is on the same page as the Tab module, you can use a hash character (`#`) followed by an `ID` name and the item's index value separated by a hyphen. For instance, using our example `ID` name of `my-tab`, the link would be structured as follows: - -```html title='Button module link option' -#my-tab-1 -``` - -```html title='HTML module link' -My Tab link -``` - -### Different Page - -To create a link to the Tab module from a different page on your website, use the complete URL of the target page along with the hash symbol (`#`) followed by the `ID` and index value. For instance, if you want to add the link to your homepage, and the Tab module is located on a page named Sample Page, the link should appear like this: - -```html title='Button module link option' -https://my-website.com/sample-page#my-tab-1 -``` - -```html title='HTML module link' -My Tab link -``` diff --git a/beaver-builder/layouts/modules/tabs/settings/index.md b/beaver-builder/layouts/modules/tabs/settings/index.md deleted file mode 100644 index d56268b3..00000000 --- a/beaver-builder/layouts/modules/tabs/settings/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: index -title: Tabs Module Settings -sidebar_label: Tabs Module Settings ---- - -The Tabs module consists of two primary setting tabs: Items and Style, along with the customary Advanced tab. These setting tabs offer you the flexibility to personalize various aspects of the tab items to suit your preferences. - -![Tabs module settings](/img/beaver-builder/modules--tabs--settings--1.jpg) - -import DocCardList from '@theme/DocCardList'; - - - -## Advanced tab - -The Advanced tab includes all the standard settings for margins, visibility, animations, and advanced HTML configurations. - -See the [Advanced tab](../../../advanced-tab/index.md) section for more information. \ No newline at end of file diff --git a/beaver-builder/layouts/modules/tabs/settings/items.md b/beaver-builder/layouts/modules/tabs/settings/items.md deleted file mode 100644 index f0805686..00000000 --- a/beaver-builder/layouts/modules/tabs/settings/items.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -id: items -title: Items tab -sidebar_label: Items tab ---- - -In the Items tab, you have the option to select the content source and manage tab items by adding, editing, or removing them. - -## Content Source - -The content source allows you to determine what content is displayed. You can choose between posts and custom content. - -### Post - -The Post content source option allows you to automatically populate the Tabs module with pages, posts, or custom post types. - -:::info -The post title becomes the item label of the Tabs item. -::: - -:::caution - -- Posts with long titles can cause the Tab module layout to be distorted. -- The Featured Image and Post info (author, date, categories, or tags) are not displayed. - ::: - -- **Post Type** - Select the post type you wish to populate the Tabs module with. You can choose pages, posts, or a custom post type, such as WooCommerce Products or a custom post type that you created yourself. - -- **Posts Per Page** - Determines how many tabs items are created. Each item contains one page, post, or custom post type. The default is 5. - -- **Order** - Choose between descending or ascending. - -- **Order By** - The choices are: Author, Comment count, Date, Date last modified, ID, Menu order, Meta value (alphabetic or numeric), Random, Title, Selection order. - - See the [Order By](/beaver-builder/layouts/modules/posts/posts.md#order-by) section in the Post module for more information. - -- **Filter By** - The Filter section allows you to include or exclude a set of posts, pages or custom post types by title, and taxonomy. - - See the [Filter](/beaver-builder/layouts/modules/posts/posts.md#filter) section in the Post module article for more information regarding the filter options. - -### Custom Content - -The Custom Content source option allows you to add your own content using the WordPress classic editor or populate the tab item with content from a saved row, column, module, or template. - -#### Edit items - -When you first add an Tabs module to your layout, a blank item will be created for you to edit. To edit an item, click the **Edit Items** link. - -![Edit tab items](/img/beaver-builder/modules--tabs--2.jpg) - -- **Label** - Name your tab item. - -- **Content Type** - The choices are: Saved Row, Saved Column, Saved Module, Saved Template, and Custom Content. The Saved content drop down menu automatically lists all previously saved rows, columns, modules, or templates when you select Saved content. - - The Custom Content option allows you to add your own content using the WordPress classic editor. - - :::caution - Shortcodes used too frequently on the same page or post may impact performance. - ::: - -- **Content** - Use the WordPress classic editor to add text to your tab item. You can also add images using the **Add Media** button. - -#### Add items - -To add more tab items, click the **Add Item** button. - -## Display - -The Display section is available when **Post** is selected as a **Content Source** and contains the following options: - -- **Content Type** - _(Available when [Post](#post) is selected as a Content Source)_ - - - **Post Content** - Show the full content of each post. - - **Post Excerpt** - Show the post excerpt. - -- **More Link** - _(Available when **Post Excerpt** is selected as the **Content Type**)_ - - Show or hide the Read more link after the post content. If set to Show, you can also customize the default Read more text. - -- **More Link Text** - _(Available when **Post Excerpt** is selected as the **Content Type**)_ - - Customize the default Read more... text. diff --git a/beaver-builder/layouts/modules/tabs/settings/style.md b/beaver-builder/layouts/modules/tabs/settings/style.md deleted file mode 100644 index 9a368007..00000000 --- a/beaver-builder/layouts/modules/tabs/settings/style.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -id: style -title: Style tab -sidebar_label: Style tab -description: The Tabs module displays horizontal or vertical tabbed content, ideal for inserting sets of content into a small space. ---- - -In the Style tab, you can change the color of the tab items, such as the text and tab background color. - -### Layout - -- **Layout** - You can choose a horizontal layout or you can choose a vertical layout. - - ![Horizontal or vertical tab layouts](/img/beaver-builder/modules--tabs--3.jpg) - - :::info - As the screen width shrinks, the tabs turn into an accordion layout. - ::: - -- **Background Color** - Set the background color for the tab. - -- **Border Color** - Set the border color. - -- **Border Width** - Set the border width in pixels. - -- **Active Tab** - Set which tab should be active. The value should not exceed the total number of tab items. - -- **Tab(s) Status on Mobile** - Control how the tabs display on mobile devices. You can choose between **Keep Active Tab Open**, and **Close All Tabs**. - -### Label - -- **Inactive Label Text Color** - Set the text color for the inactive tab(s). - -- **Inactive Label Background Color** - Set the background color for the inactive tab(s). - -- **Active Label Color** - Set the text color for the active tab. - -- **Active Label Background Color** - Set the background color for the active tab. - -- **Padding** - Set a specific padding value in pixels for the tab label. Click the **Link Value** icon to automatically make all four padding values the same. - -- **Typography** - Set the font size, family, line-height and more for the tab label. See the [Typography](basics/typography.md) article for more information. - -### Content - -- **Text Color** - _(Available when **Custom Content** is selected as a **Content Source**)_ - - Set the text color of the tab content. - -- **Padding** - Set a specific padding value in pixels for the tab content. Click the **Link Value** icon to automatically make all four padding values the same. - -- **Typography** - _(Available when **Custom Content** is selected as a **Content Source**)_ - - Set the font size, family, line-height and more for the tab content. See the [Typography](basics/typography.md) article for more information. - -## Advanced - -There are all the usual [Advanced tab](/beaver-builder/layouts/advanced-tab/index.md) settings for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/testimonials.md b/beaver-builder/layouts/modules/testimonials.md deleted file mode 100644 index 39b85dee..00000000 --- a/beaver-builder/layouts/modules/testimonials.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: testimonials -title: Testimonials -sidebar_label: Testimonials -description: The Testimonials module is a basic slider that offers an animiated way to display testimonials or any other combination of heading, text, and media. ---- - -Use the Testimonials module to add a basic slider with testimonials to your -layouts, or any other set of text and images that you want to display one by -one with either autoplay or navigation. - -If the Testimonials module is the only module in a row, select **Wide** so it -takes up the entire row. If you are using the Testimonials module with other -modules in the same row, set the layout to **Compact**. - -You can add as many testimonials as you like and customize a variety of -options, such as autoplay, animation effects, and navigation choices. Each -individual testimonial has a Text Editor box, so you can add anything that a -WordPress editing box accepts, such as headings, text, and images. - -Note that although it's called a Testimonials module, there's nothing to stop -you from using it for other purposes, because it's basically a slider for any -headings, text or media. For example, you could use this module on an About -Us page, where you want to introduce each of your team members. And not just -people – you could set up something like a portfolio of your creations, in -which each image has a description that's too long for a caption. Or, you -could have a selection of your favorite quotations, displayed one by one. - -This module has the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/testimonials.mdx b/beaver-builder/layouts/modules/testimonials.mdx new file mode 100644 index 00000000..0a9060b2 --- /dev/null +++ b/beaver-builder/layouts/modules/testimonials.mdx @@ -0,0 +1,303 @@ +--- +title: Testimonials +icon: "message-square-quote" +description: "Use Testimonials to display an animated slider of customer quotes with configurable autoplay, transitions, and styling." +--- + + +Use Testimonials to display an animated slider of customer quotes with configurable autoplay, transitions, and styling. + +## Usage + +Use Testimonials to display an animated slider of customer quotes that rotates automatically or on user interaction. The module renders each entry as a styled blockquote and uses bxSlider to handle the slide and fade transitions, autoplay, and navigation controls. + +Use Testimonials on home pages, landing pages, sales pages, and About pages where social proof needs to occupy a fixed area without taking up the full vertical space of multiple stacked quotes. The compact layout fits multi-column rows for grouped testimonials, and the wide layout suits single-column sections that need a prominent featured quote. + +## Module Settings + +The Testimonials module settings control the testimonial entries shown in the slider, the slider playback and transition behavior, and the layout, heading, text, and navigation styling. + +### Items Tab + +The Items tab is where you build and manage the list of testimonials displayed in the slider. + +
    +Add Testimonials + + +Manages the list of testimonials in the slider. Click **Add Testimonial** to add a new testimonial to the slider, or click **Edit** on an existing testimonial to open its settings. + +Each row in the list also includes **Move**, **Duplicate**, and **Delete** action icons: + +- **Move:** Drag and drop the testimonial row to change the order in which testimonials appear in the slider. +- **Duplicate:** Creates a copy of the testimonial, including its content, and adds it to the end of the list. +- **Delete:** Removes the testimonial from the slider. + +:::note + +The **Move** and **Delete** actions only appear once the slider contains more than one testimonial. +::: + +Each testimonial has its own General tab, described in [Individual testimonial settings](#individual-testimonial-settings). + +:::note + +Deleting a testimonial cannot be undone after you click **Publish**. +::: +
    + +### Slider Tab + +The Slider tab controls how testimonials advance, including playback, timing, and transition direction. + +
    +Auto Play Default: Yes + + +Determines whether the slider advances automatically. + +- **No:** Keeps the slider on the current entry until the visitor uses the navigation. +- **Yes:** Cycles through testimonials automatically using the configured **Delay**. + +
    + +
    +Show Play/Pause Default: No + + +Shows or hides a play and pause control for the slider. + +- **No:** Hides the play and pause control. +- **Yes:** Displays a play and pause control that lets visitors stop and resume autoplay. + +
    + +
    +Delay Default: 4 + + +The number of seconds each testimonial stays visible before the slider advances. The Delay value should be greater than the Transition Speed. +
    + +
    +Transition Default: Slide + + +The animation used when moving between testimonials. + +- **Slide:** Slides the next testimonial in horizontally. +- **Fade:** Crossfades between the current and next testimonial. + +
    + +
    +Transition Speed Default: 0.5 + + +The number of seconds the transition animation runs. The Transition Speed value should be less than the Delay. +
    + +
    +Transition Direction Default: Right To Left + + +The direction of the slide transition. + +- **Right To Left:** Brings the next testimonial in from the right. +- **Left To Right:** Brings the next testimonial in from the left. + +
    + +
    +Loop Default: Yes + + +Sets whether the slider loops continuously after reaching the last testimonial. + +- **Yes:** Returns to the first testimonial after the last one. +- **No:** Stops on the last testimonial. + +
    + +### Style Tab + +The Style tab controls the layout and the appearance of the heading, text, and slider navigation. + +
    +Layout Default: Wide + + +Selects the slider layout. Wide is for single-column rows, and compact is for multi-column rows. + +- **Wide:** Displays a single testimonial across the full width of the column and reveals the **Dots** group. +- **Compact:** Displays a smaller testimonial layout suited to multi-column rows and reveals the **Heading** and **Arrows** groups. + +
    + +
    +Heading + + +This group is available when **Layout** is set to **Compact**. + +
    +Heading + + +
    +Heading Default: Testimonials + + +The heading text displayed above the compact testimonials slider. +
    + +
    +Color Supports: Responsive, Field Connections + + +The color of the heading text. +
    + +
    +Typography Supports: Responsive + + +The font settings for the heading text. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    +
    +
    + +
    +Text + + +The Text section controls the appearance of the testimonial content. + +
    +Text + + +
    +Text Color Supports: Responsive, Field Connections + + +The color of the testimonial text. +
    + +
    +Text Typography Supports: Responsive + + +The font settings for the testimonial text. + +
    +Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
    +
    +
    +
    + +
    +Arrows + + +This group is available when **Layout** is set to **Compact**. + +
    +Arrows + + +
    +Show Arrows Default: Yes + + +Shows or hides the previous and next navigation arrows. + +- **No:** Hides the navigation arrows. +- **Yes:** Displays the navigation arrows and reveals **Arrow Color**. + +
    +Arrow Color + + +
    +Arrow Color Default: #999999; Supports: Responsive, Field Connections + + +The color of the navigation arrows. This field appears when **Show Arrows** is set to **Yes**. +
    +
    +
    +
    +
    + +
    +Dots + + +This group is available when **Layout** is set to **Wide**. + +
    +Dots + + +
    +Show Dots Default: Yes + + +Shows or hides the pagination dots beneath the slider. + +- **No:** Hides the pagination dots. +- **Yes:** Displays the pagination dots and reveals **Dot Color**. + +
    +Dot Color + + +
    +Dot Color Default: #999999; Supports: Field Connections + + +The color of the pagination dots. This field appears when **Show Dots** is set to **Yes**. +
    +
    +
    +
    +
    + +### Individual testimonial settings + +Each testimonial in the slider has its own settings, accessible by clicking **Edit** on any testimonial in the Items tab. + +#### General tab + +The General tab holds the testimonial's content. + +
    +Testimonial + + +The testimonial content for the entry, edited in the WordPress Classic Editor WYSIWYG. Use it to add the quote text along with attribution, formatting, links, or basic HTML. +
    + +
    +Advanced tab + +The Advanced tab contains common Testimonials module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    + +:::note + +The Advanced tab is global, so it is not available for individual testimonial items in the Testimonials module. As a result, the ID setting applies to the parent node div, not to each testimonial. +::: diff --git a/beaver-builder/layouts/modules/text.md b/beaver-builder/layouts/modules/text.md deleted file mode 100644 index 06d49c7a..00000000 --- a/beaver-builder/layouts/modules/text.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: text -title: Text Editor -sidebar_label: Text Editor module -description: The Text Editor module displays an editor derived from the classic WordPress editor to enter formatted text, headings, and images. ---- - -The Text Editor module uses an instance of the classic WordPress editor, with [some differences in the toolbar](/beaver-builder/troubleshooting/miscellaneous/classic-wordpress-and-beaver-builder-text-editor-toolbars-dont-match.md). - -You can add headings images, and make simple changes to text formatting directly in this editor. - -:::tip **Tip** -If you want more control over the vertical or columnar spacing and stacking of headings, images, and text, use separate [Heading](/beaver-builder/layouts/modules/heading.md) and [Photo](/beaver-builder/layouts/modules/photo/photo.md) modules. If you want text to wrap around an image, then add the image to the Text Editor module. -::: - -You can style your text using either the toolbar on this text editor or the **Style** tab. If you want to style specific parts of the text, use the toolbar above the editor. You can expose the second row of the toolbar by clicking the rightmost icon in the first row: - -![](/img/how-to-tips-change-font-color.png) - -## Style tab - -The **Style** tab has a variety of settings that apply to all of the text in the module, such as text color and a [Typography section](basics/typography.md), which gives you many choices not available in the text editor, starting with font family. - -## Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. diff --git a/beaver-builder/layouts/modules/video.mdx b/beaver-builder/layouts/modules/video.mdx new file mode 100644 index 00000000..8e2c3cb3 --- /dev/null +++ b/beaver-builder/layouts/modules/video.mdx @@ -0,0 +1,240 @@ +--- +title: Video +sidebar_label: Video +icon: "clapperboard" +description: "Use Video to render a self-hosted media library video or an embedded video from providers like YouTube and Vimeo." +--- + + +Use Video to render a self-hosted media library video or an embedded video from providers like YouTube and Vimeo. + +## Usage + +Use Video to render a self-hosted video from the WordPress media library or an embedded video from a provider such as YouTube or Vimeo. The module outputs a responsive player with optional poster image, autoplay, looping, lightbox playback, sticky-on-scroll behavior, and Schema.org `VideoObject` structured data for SEO. + +Use Video for product demonstrations, tutorials, testimonials, hero backgrounds, and any layout where video is the primary content. Choose the **Media Library** type when you need full control over native player controls, and the **Embed** type when a provider should handle delivery and playback. + +## Module Settings + +The Video module settings control the video source, playback behavior, lightbox display, sticky scroll behavior, and structured data markup. + +### General Tab + +The General tab configures the video source, poster image, playback options, and native player controls. + +
    +Video Type Default: Media Library + + +Selects the source of the video content. + +- **Media Library:** Plays a video file uploaded to the WordPress media library using the native WordPress player. +- **Embed:** Renders an oEmbed URL or custom embed markup from a provider such as YouTube or Vimeo. + +
    +Media Library Settings + + +
    +Main Video (MP4) Supports: Field Connections + + +The primary video file. Supports mp4, m4v, webm, ogv, and wmv formats. This format is supported by most modern browsers. +
    + +
    +Fallback Video (WebM) Supports: Field Connections + + +An optional WebM file used as a fallback. This format is required to support browsers such as Firefox and Opera. +
    + +
    +Auto Play Default: No + + +Starts playback automatically when the page loads. Most browsers require muted playback for autoplay to succeed. +
    + +
    +Loop Default: No + + +Restarts playback from the beginning each time the video reaches the end. +
    + +
    +Video Controls + + +The Video Controls section toggles the visibility of individual native player controls. + +
    +Video Controls + + +
    +Play/Pause Default: Show + + +Shows or hides the play and pause button. +
    + +
    +Timer Default: Show + + +Shows or hides the current playback time indicator. +
    + +
    +Time Rail Default: Show + + +Shows or hides the progress bar and scrubber. +
    + +
    +Duration Default: Show + + +Shows or hides the total video duration display. +
    + +
    +Volume Default: Show + + +Shows or hides the volume control. +
    + +
    +Fullscreen Default: Show + + +Shows or hides the fullscreen toggle button. +
    +
    +
    +
    + +
    +Embed Settings + + +
    +Embed Code Supports: Field Connections + + +A URL from a supported oEmbed provider such as YouTube or Vimeo, or custom embed markup using ` -

    -
  • -``` - -### Advanced tab - -There are all the usual [**Advanced** tab settings](/beaver-builder/layouts/advanced-tab/index.md) for margins, visibility, animations, and advanced HTML settings. - -### Related modules - -* You can also play a video in a lightbox using a Button module. -For a description of the differences, see the article about [opening a video in a lightbox](/beaver-builder/layouts/modules/video/open-a-video-in-a-lightbox.md). -* You can embed the code for videos using an HTML module. -However, if you want the structured metadata in the output, you'll have to provide your own code. Use the example above for how to structure this information around your video iframe. diff --git a/beaver-builder/layouts/modules/widgets.md b/beaver-builder/layouts/modules/widgets.md deleted file mode 100644 index 8cfd853d..00000000 --- a/beaver-builder/layouts/modules/widgets.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: widgets -title: WordPress Widgets -sidebar_label: WordPress Widgets -description: Beaver Builder has transformed all the standard WordPress widgets into modules, allowing you to effortlessly utilize them anywhere within your layout. ---- - -You can easily include almost any WordPress widget from the **WordPress Admin Dashboard > Appearance > Widgets** section in your Beaver Builder layout as a content module. Additionally, if you have WooCommerce installed, the WooCommerce widgets will also be visible in the list of available widgets. - -:::info -When accessing the **Content Panel > Modules > WordPress Widgets**, you may notice that certain widgets like Audio, Custom HTML, Gallery, Image, Text, and Video are not included. This deliberate exclusion is because Beaver Builder provides module equivalents that offer advanced functionality. As a result, these specific widgets are not necessary within your Beaver Builder layouts. - -Nevertheless, you can still make use of these WordPress widgets in theme sidebars or widgetized areas that utilize native WordPress widgets. -::: - -## Adding Widgets - -In the Content panel, click in the **Group** field and choose **WordPress -widgets**. Drag a widget into your layout. - -## Third-party Widgets - -When adding third-party widgets into your Beaver Builder layout, you may encounter limited or non-functional behavior. This is because most third-party widgets are designed to function within the WordPress admin dashboard (back-end) and are primarily intended for use at **Appearance > Widgets**. In contrast, Beaver Builder functions on the front end of your website. - -Technically speaking, these third-party widgets utilize the [`admin_enqueue_script()`](https://developer.wordpress.org/reference/hooks/admin_enqueue_scripts/) function to load their scripts (JavaScript) and styles (CSS) into the WordPress Admin dashboard. - -To make these widgets function properly within your Beaver Builder layouts, you can include custom code in your child theme's *functions.php* file. This code will ensure that the widgets are enqueued and loaded on the front end as well. Below is an example snippet that demonstrates how to enqueue scripts and styles when the builder is active on your pages or posts: - -```php -add_action( 'wp_enqueue_scripts', function() { - if ( FLBuilderModel::is_builder_active() ) { - wp_enqueue_script( // Add URL to widgets script here ); - wp_enqueue_style( // Add URL to widgets styles here ); - } -}); -``` - -:::info -If you are unsure about the URL for your widget assets, we recommend reaching out to the respective plugin developer for assistance. -::: \ No newline at end of file diff --git a/beaver-builder/layouts/modules/widgets.mdx b/beaver-builder/layouts/modules/widgets.mdx new file mode 100644 index 00000000..cb5cd9b4 --- /dev/null +++ b/beaver-builder/layouts/modules/widgets.mdx @@ -0,0 +1,131 @@ +--- +title: WordPress Widgets +sidebar_label: Widgets +icon: "wordpress" +tag: "Deprecated" +description: "Use WordPress widgets inside Beaver Builder layouts for plugin-specific features not covered by native modules." +--- + + +Use WordPress widgets inside Beaver Builder layouts for plugin-specific features not covered by native modules. + +:::warning + +On newer installations, the WordPress Widgets module is disabled by default. You can enable it at any time in [Beaver Builder module settings](MISSINGLINK). +::: + +## Usage + +Any registered WordPress widget is automatically available as a module in the Beaver Builder editor. You'll find them listed in the WordPress Widgets group of the content panel. Drag and drop any widget module into your Beaver Builder layout without the need for a widgetized area. + +## Access Widgets + +:::note + +WordPress replaced traditional widgets with blocks starting in WordPress 5.8. For the best experience, use native Beaver Builder modules or third-party modules instead of legacy widgets. +::: + + +
    +Launch Builder + + +Launch Beaver Builder on your page or post. +
    +
    +Open the Content Panel + + +Click the + button in the top-right corner to open the Content Panel. +
    +
    +Go to the Modules tab + + +Select the Modules tab (if not already selected), then scroll down to the WordPress Widgets subgroup. +
    +
    +Drag and drop + + +Drag the desired widget module into your layout and configure its settings in the panel that appears. +
    + + +## Widget Module Settings + +Each Widget module includes a General settings tab, along with the standard Advanced tab. + +### General Tab + +The General tab displays the native settings for the specific widget you’ve added. Each widget includes its own built-in configuration form, the options shown here will vary from widget to widget. + +:::tip + +Refer to the widget plugin’s documentation for details on how to configure the widget and for an explanation of each available setting. +::: + +
    +Advanced tab + +The Advanced tab contains common Widget module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    + +## Available Widgets + +The available widgets depend on your theme and installed plugins. Common widgets include: + +- Recent Posts +- Categories +- Tag Cloud +- Custom HTML +- Navigation Menu +- Search +- Calendar +- RSS + +## Excluded widgets + +Beaver Builder excludes several core WordPress widgets because they overlap with existing Beaver Builder modules or do not work reliably in the builder context. These widgets remain available in native theme sidebars and widgetized areas. + + +
    +Excluded core classes + + +The following widget classes are excluded by default: + +- Audio +- Image +- Video +- Gallery +- Text +- Custom HTML + +
    + +
    +WPML-specific exclusion + + +When WPML is active, Beaver Builder also excludes the WPML language switcher because it must run inside a registered sidebar. +
    + + +## Third-party widget compatibility + +Third-party widgets are built primarily for the WordPress admin widget screen and may not fully initialize in front-end builder rendering. The most common issue is scripts or styles that only load in admin contexts. + +If a third-party widget does not render correctly in the builder, enqueue its required assets on the front end while Beaver Builder is active: + +```php title="functions.php" +add_action( 'wp_enqueue_scripts', function() { + if ( FLBuilderModel::is_builder_active() ) { + wp_enqueue_script( 'my-widget-script-handle' ); + wp_enqueue_style( 'my-widget-style-handle' ); + } +} ); +``` + +If you do not know which asset handles to enqueue, check the widget plugin's documentation or contact that plugin's developer. diff --git a/beaver-builder/layouts/modules/woocommerce.md b/beaver-builder/layouts/modules/woocommerce.md deleted file mode 100644 index 6779e8b3..00000000 --- a/beaver-builder/layouts/modules/woocommerce.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -id: woocommerce -title: WooCommerce -sidebar_label: WooCommerce -description: If you have the WooCommerce plugin installed, you can use the Beaver Builder WooCommerce module to display products in your layouts. ---- - -Use the WooCommerce module to insert WooCommerce content into any page. - -:::info -You must have the WooCommerce plugin installed and activated for -this module to appear. -::: - -Here are some ways you can use the WooCommerce module to display products on -regular pages. Note that the WooCommerce module comes with the [Beaver Builder](https://www.wpbeaverbuilder.com) plugin – you don't need to have Beaver Themer installed to implement these ideas. - -## Display a single product - -Suppose you want to display a featured product each month that you select, as -shown in this screenshot: - -![](/img/woocommerce-module-1.jpg) - -The product is identified by its ID number in the -WooCommerce module, and in the screenshot there's a Heading module above it to -identify the product. - -The display is what you'd see on an archive page, not on a true product page. -There's the title of the product, the price, and an **Add to Cart** button -displayed under the featured image. Clicking this item takes you to the -product page. - -**To display a single product:** - - 1. Add a WooCommerce module to the layout. - 2. In the **Layout** field choose **Single product**, then enter the product ID. Mouse over the question mark in the **Product ID** field for how to find the product ID. - -## Display a single product page - -You can display the same details that you'd see in a true product page, as -shown in the following screenshot. - -![](/img/woocommerce-module-2.jpg) - -The single product page display is identical to what you'd see on an actual -single product page, but you can embed it anywhere in a layout on another -page. - -**To display a single product page:** - - * In the **Layout** field choose **Single product page**, then enter the product ID. Mouse over the question mark in the **Product ID** field for how to find the product ID. - -## Display multiple products, all or a subset - -You can display all of your products, or display a subset of products based on -various sources, described below. The module displays the products themselves, -and in most cases you'll want to add a Heading to describe the set of products -you're displaying. For example, in the screenshot below the WooCommerce module -displays the products with basic product information, and there's a Heading -module above the WooCommerce module that says "Our products." - -![](/img/woocommerce-module-3.jpg) - -To display multiple products (all or a subset), drag a WooCommerce module into -your page layout and in the **Layout** field choose **Multiple products**. - -**To display the entire set of products:** - - * In the **Products source** field, choose **Products IDs**, then leave the **Product IDs** field blank. - -**To display a custom list of products:** - - * In the **Products source** field, choose **Products IDs**, then in the **Product IDs** add a list of product IDs, separated by commas. - -**To display the products in a particular category (or combined categories):** - - * In the **Products source** field, choose **Product category**, then add the category's slug. You can display products from more than one category by entering multiple category slugs separated by commas, but note that the products will still be grouped into a single display, not broken out by category. - -**Tip:** If you want to display multiple categories of products, use a -WooCommerce module for each category, and use a Heading module to name each -category. - -**Other displays of multiple products:** - -You can display multiple products in any of the following ways: - - * Recent - * Featured - * Sale - * Best selling - * Top rated - -:::info -These categories are determined by WooCommerce and cannot be -individualized. If you want to display a different set of items, follow the -procedure above for inserting a custom list of IDs for multiple products. -::: - - 1. Drag a WooCommerce module into your page layout. - 2. In the **Layout** field, choose **Multiple Products**. - 3. In the **Products source** field, choose how the products will be selected. - * To display all products, choose **Products IDs** for **Products Source**, then leave the **Product IDs** field blank. - * To display a custom list of products, choose **Products IDs** for **Products Source**, then in the **Product IDs** field, add the list of Product IDs you want to display, separated by commas. - -## Display price and the Add to Cart button for a single product - -In the WooCommerce API, the product price and **Add to Cart** button are -displayed as a unit, and you can display this part of an individual product -without showing the rest of the product, as shown in the following screenshot, -in which there's a Heading module that says "Our price," then a WooCommerce -module with **Layout** designated **"Add to Cart" button**. - -![](/img/woocommerce-module-4.png) - -## Display categories - -You can display your entire set of product categories, or you can display all the subcategories of one parent category that you identify by its ID number. - -:::note **Notes** -* If you display more than one category, choose how to sort them in the **Sort product category by** field. -You can sort by name, category ID, category slug, or menu order. -* The behavior when you click a category in the display is the same as -for standard WooCommerce pages. If you click a top-level category, you'll get a display of the subcategories, if there are any. If you click a top-level category with no subcategories, you'll see a display of products within the category. -::: - -**To display the entire set of top-level categories:** - -This is equivalent to what you see on the standard WooCommerce Shop page when -you have selected **Categories** as the Shop page display preference in your -WooCommerce settings. - - * In the **Layout** field, choose **Categories**, then leave the both the **Product category IDs to include** and **Parent category ID** fields blank. - -**To display only top-level categories:** - -* In the **Layout** field, choose **Categories**, then in the **Parent category ID** field, enter **0**. - -**To display all the subcategories of a category:** - -If you have a hierarchical system of categories, you can display all the child categories of a parent category that you specify. - - * In the **Layout** field, choose **Categories**, then in the **Parent category ID** field add the ID for the parent category. Mouse over the question mark in the **Parent category ID** field for how to find the category ID. - Leave the **Product category IDs to include** field blank. Leave **Autoselect parent** set to **No**. - -:::info -WooCommerce doesn't handle the display of subsubcategories well -without a plugin or custom coding. However, by using Beaver Builder's WooCommerce module, it's possible to display a subcategory's subategories by entering the ID of the subcategory in the **Parent category ID** field. -::: - -**To display categories by autoselecting the parent category:** - -The **Autoselect parent** field is used specifically for Beaver Themer layouts on Product Category pages so that each category page displays the correct categories for that page. If this setting is **Yes**, leave the **Product category IDs to include** and **Parent category ID** fields blank. - -## Display the cart - -You can use the WooCommerce module to display what you'd normally see on the -Cart page. In the **Layout** field, choose **Cart** and you'll see something -like the screenshot example below. - -![](/img/woocommerce-module-5.png) - -## Display the Checkout content area - -You can use the WooCommerce module to display what you'd normally see on the -Checkout page. In the **Layout** field, choose **Checkout**. - -## Display order tracking - -You can display the normal WooCommerce order tracking, such as in this -screenshot, with fields for the customer to enter Order ID and billing email. - -![](/img/woocommerce-module-6.png) - -## Display the My Account area - -You can display what the customer normally sees on the **My Account** page. - -## More WooCommerce options - -### WooCommerce shortcodes - -Besides the options available in the WooCommerce module, you can use any -WooCommerce shortcodes in an HTML module. See the WooCommerce documentation -for a list of [shortcodes](https://docs.woothemes.com/document/woocommerce-shortcodes/). - -### WooCommerce widgets - -When you have WooCommerce installed, all of the WooCommerce widgets appear in -the **WordPress Widgets** group in the Content panel. diff --git a/beaver-builder/layouts/modules/woocommerce.mdx b/beaver-builder/layouts/modules/woocommerce.mdx new file mode 100644 index 00000000..c3fb25d1 --- /dev/null +++ b/beaver-builder/layouts/modules/woocommerce.mdx @@ -0,0 +1,271 @@ +--- +title: WooCommerce +sidebar_label: WooCommerce +icon: "shopping-cart" +description: "Use WooCommerce to display products, categories, and core WooCommerce pages from your store inside a Beaver Builder layout." +--- + + +Use WooCommerce to display products, categories, and core WooCommerce pages from your store inside a Beaver Builder layout. + +:::info + +The WooCommerce module requires the WooCommerce plugin to be active. +::: + +## Usage + +Use WooCommerce to embed products, product categories, and core WooCommerce pages into a Beaver Builder layout without writing shortcodes. The module renders a single product, a full product page, multiple products, an "Add to Cart" button, product categories, the cart, the checkout, the order tracking form, or the My Account page based on the selected layout. + +Use this module on storefront landing pages, custom shop layouts, promotional sections, or templates that need to surface specific products or category groupings. It is most useful when you want to mix WooCommerce output with other Beaver Builder content on the same page and control which products or categories appear without leaving the builder. + +:::note + +The module is a wrapper around WooCommerce's own shortcodes. Each layout option maps to a [WooCommerce shortcode](https://woocommerce.com/document/woocommerce-shortcodes/), so the rendered output and behavior are controlled by WooCommerce, not Beaver Builder. +::: + +## Module Settings + +The WooCommerce module settings control which layout is rendered and which products or categories the layout pulls from your store. + +### General Tab + +The General tab selects the layout type and configures the source product, category, or product collection used for that layout. + +
    +Layout Default: Choose... + + +Selects which WooCommerce output the module renders. The available source fields below change based on the selected layout. + +- **Single Product:** Renders a single product by ID. +- **Product Page:** Renders the full WooCommerce product page for a single product by ID. +- **Multiple Products:** Renders a grid of products built from the **Multiple Products** section. +- **"Add to Cart" Button:** Renders the Add to Cart button for a single product by ID. +- **Categories:** Renders product categories using the category settings below. +- **Cart:** Renders the WooCommerce cart page. +- **Checkout:** Renders the WooCommerce checkout page. +- **Order Tracking:** Renders the WooCommerce order tracking form. +- **My Account:** Renders the WooCommerce My Account page. + +
    +Single Product + + +
    +Product ID + + +The unique product ID used to render the single product. Find the ID in the WooCommerce **Products** area by hovering over a product row. +
    +
    + +
    +Product Page + + +
    +Product ID + + +The unique product ID used to render the full product page. Find the ID in the WooCommerce **Products** area by hovering over a product row. +
    +
    + +
    +Multiple Products + + +
    +Multiple Products + + +The Multiple Products section configures the query used when **Layout** is set to **Multiple Products**. See [Multiple Products section](#multiple-products-section) below. +
    +
    + +
    +&quot;Add to Cart&quot; Button + + +
    +Product ID + + +The unique product ID used to render the Add to Cart button. Find the ID in the WooCommerce **Products** area by hovering over a product row. +
    +
    + +
    +Categories + + +
    +Autoselect Parent Default: No + + +Controls whether the module automatically uses the current page's parent category as the source. When set to **No**, the **Parent Category ID** field becomes available so you can specify a parent category manually. + +- **Yes:** Uses the parent category of the current page. +- **No:** Uses the **Parent Category ID** value below. + +
    +Parent Category ID + + +
    +Parent Category ID Default: 0 + + +The unique parent category ID used when **Autoselect Parent** is set to **No**. Find the ID by hovering over a category in the WooCommerce **Products → Categories** area and reading the number in the URL. +
    +
    +
    + +
    +Product Category IDs to include + + +A comma-separated list of product category IDs to include. Leave blank to include all product categories. +
    + +
    +Sort Product Category By Default: Name + + +Sets the field used to sort the displayed categories. + +- **Name:** Sorts by category name. +- **Category ID:** Sorts by the numeric category ID. +- **Category Slug:** Sorts by the category slug. +- **Menu Order:** Sorts by the menu order assigned to each category. + +
    + +
    +Product Category Sort Direction Default: Ascending + + +Sets the sort direction applied to the **Sort Product Category By** value. + +- **Ascending:** Sorts categories in ascending order. +- **Descending:** Sorts categories in descending order. + +
    + +
    +Columns Default: 4 + + +The number of columns used to lay out the category grid. Options are **1**, **2**, **3**, and **4**. +
    +
    +
    + +#### Multiple Products section + +The Multiple Products section appears when **Layout** is set to **Multiple Products** and configures how products are queried and displayed. + +
    +Products Source Default: Products IDs + + +Selects how products are retrieved. The fields revealed below depend on the selected source. + +- **Products IDs:** Builds the grid from a comma-separated list of product IDs. +- **Product Category:** Builds the grid from one or more product category slugs. +- **Product Tags:** Builds the grid from one or more product tag slugs. +- **Recent Products:** Lists the most recent products. +- **Featured Products:** Lists products marked as featured. +- **Sale Products:** Lists products currently on sale. +- **Best Selling Products:** Lists best-selling products. +- **Top Rated Products:** Lists products with the highest ratings. + +
    +Products IDs + + +
    +Product IDs + + +A comma-separated list of product IDs used to build the grid when **Products Source** is set to **Products IDs**. Find each ID in the WooCommerce **Products** area by hovering over a product row. +
    +
    + +
    +Product Category + + +
    +Category Slug + + +A comma-separated list of product category slugs used to build the grid when **Products Source** is set to **Product Category**. Find slugs in the WooCommerce **Products → Categories** area. +
    +
    + +
    +Product Tags + + +
    +Tags Slug + + +A comma-separated list of product tag slugs used to build the grid when **Products Source** is set to **Product Tags**. Find slugs in the WooCommerce **Products → Tags** area. +
    +
    + +
    +Number of Products + + +
    +Number of Products Default: 12 + + +The maximum number of products to display. Available when **Products Source** is set to **Product Category**, **Product Tags**, **Recent Products**, **Featured Products**, **Sale Products**, **Best Selling Products**, or **Top Rated Products**. +
    +
    +
    + +
    +Columns Default: 4 + + +The number of columns used to lay out the product grid. Options are **1**, **2**, **3**, **4**, **5**, and **6**. +
    + +
    +Sort By Default: Default + + +Sets the field used to sort the products. Not available when **Products Source** is set to **Best Selling Products**. + +- **Default:** Uses the WooCommerce menu order. +- **Popularity:** Sorts by popularity. +- **Rating:** Sorts by average rating. +- **Date:** Sorts by publish date. +- **Price:** Sorts by price. +- **Product ID:** Sorts by the numeric product ID. + +
    + +
    +Sort Direction Default: Ascending + + +Sets the sort direction applied to the **Sort By** value. Not available when **Products Source** is set to **Best Selling Products**. + +- **Ascending:** Sorts products in ascending order. +- **Descending:** Sorts products in descending order. + +
    + +
    +Advanced tab + +The Advanced tab contains common WooCommerce module's settings for spacing, visibility, animation, custom CSS, and other advanced module controls. + +
    diff --git a/beaver-builder/layouts/modules/wordpress-patterns.md b/beaver-builder/layouts/modules/wordpress-patterns.md deleted file mode 100644 index 8655f9b4..00000000 --- a/beaver-builder/layouts/modules/wordpress-patterns.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: wordpress-patterns -title: WordPress Patterns -sidebar_label: WordPress Patterns -description: Learn how to use WordPress Patterns in Beaver Builder layouts. ---- - -You can use [WordPress Patterns](https://wordpress.org/support/article/reusable-blocks/) (Reusable Blocks) in Beaver Builder layouts. If a Pattern is updated in WordPress, it's also updated in any Beaver Builder layout where it's used. - -## Access WordPress Patterns - -1. Launch Beaver Builder on your page or post. - -2. Open the **Content Panel** and select the **WordPress Patterns subgroup**. - -3. Drag the pattern that you want to use into your layout. - -4. Click the **Done** button and Save your changes. - -:::info - -The WordPress Patterns subgroup becomes available in the Content Panel after you have created and saved WordPress Patterns. - -::: - -![Access WordPress Patterns from the Content Panel](/img/beaver-builder/modules--wordpress-patterns--1.jpg) diff --git a/beaver-builder/layouts/modules/wordpress-patterns.mdx b/beaver-builder/layouts/modules/wordpress-patterns.mdx new file mode 100644 index 00000000..2e871d80 --- /dev/null +++ b/beaver-builder/layouts/modules/wordpress-patterns.mdx @@ -0,0 +1,42 @@ +--- +title: WordPress Patterns +sidebar_label: WordPress Patterns +icon: "wordpress" +description: "Drag saved WordPress Patterns directly into Beaver Builder layouts and keep them in sync with the source content." +--- + + +Drag saved WordPress Patterns directly into Beaver Builder layouts and keep them in sync with the source content. + +## Usage + +WordPress Patterns (formerly Reusable Blocks) are saved blocks created in the WordPress block editor. Beaver Builder reads every published `wp_block` post and surfaces each one as its own draggable item in the Content Panel, so existing patterns can be dropped into a row, column, or layout without leaving the builder. + +When the underlying pattern is edited in WordPress, every Beaver Builder layout that uses it reflects the change. This makes WordPress Patterns useful for content that needs to be authored once and reused, such as shared callouts, banners, footers, and marketing blocks. + +:::note + +Beaver Builder does not add a single "WordPress Pattern" module to the Content Panel. Instead, each saved pattern is registered individually under the **WordPress Patterns** subgroup using its post title. +::: + +## Add a WordPress Pattern to a layout + +1. Launch Beaver Builder on your page or post. +2. Open the **Content Panel** and select the **WordPress Patterns** subgroup. +3. Drag the pattern you want to use into your layout. +4. Click **Done** and save your changes. + +:::note + +The **WordPress Patterns** subgroup appears in the Content Panel only after at least one pattern has been created and saved in the WordPress block editor. If no patterns exist yet, the subgroup is not registered. +::: + +## How patterns stay in sync + +Beaver Builder renders the selected pattern's saved block markup at the position where it is dropped, and re-reads the source `wp_block` post each time the layout renders. Editing the pattern in **Appearance > Editor > Patterns** (or **Pages > Patterns** depending on the WordPress version) updates every layout that references it, with no need to re-open the layout in Beaver Builder. + +Patterns are listed in the Content Panel ordered by menu order, then alphabetically by title. New or renamed patterns appear automatically the next time the builder is opened. + +## Manage patterns + +Patterns are managed in the WordPress block editor, not in Beaver Builder. To create, rename, or delete a pattern, use the standard WordPress workflow for the `wp_block` post type. Beaver Builder picks up the changes the next time the Content Panel is loaded. From c362930ff274a4e03b5a995a628a6334b02ff7c2 Mon Sep 17 00:00:00 2001 From: Danny Date: Wed, 27 May 2026 14:01:40 +0100 Subject: [PATCH 05/24] Add versioning --- .../beaver-themer-conditional-logic.md | 225 ++++ ...add-custom-attributes-to-themer-layouts.md | 42 + .../developer/add-themer-support.md | 110 ++ .../developer/conditional-logic-apis.md | 628 +++++++++++ .../customize-field-connections-themer.md | 173 +++ .../developer/customize-themer-modules.md | 33 + ...ide-node-when-field-connection-is-empty.md | 104 ++ .../developer/hooks-reference-themer.md | 7 + .../developer/wp-cli-for-beaver-themer.md | 88 ++ .../field-connections/conditionals.md | 73 ++ .../field-connections/examples/combining.md | 105 ++ .../field-connections/examples/conditional.md | 132 +++ .../field-connections/examples/expressions.md | 235 +++++ .../field-connections/examples/index.md | 12 + .../field-connections/expressions.md | 227 ++++ .../field-connections/getting-started.md | 79 ++ .../version-1.5/field-connections/index.md | 101 ++ .../version-1.5/field-connections/syntax.md | 111 ++ .../field-connections/third-party.md | 45 + .../wordpress-custom-fields.md | 102 ++ .../field-connections/wordpress-data.md | 605 +++++++++++ .../i-installed-beaver-themer-now-what.md | 101 ++ .../version-1.5/getting-started/install.md | 35 + ...ordpress-content-and-theme-areas-themer.md | 31 + .../getting-started/requirements.md | 25 + .../getting-started/supported-themes.md | 42 + .../what-can-i-do-with-beaver-themer.md | 83 ++ .../acf/field-types/button-group.md | 38 + .../integrations/acf/field-types/checkbox.md | 43 + .../acf/field-types/color-picker.md | 43 + .../acf/field-types/date-picker.md | 29 + .../acf/field-types/date-time-picker.md | 29 + .../integrations/acf/field-types/email.md | 29 + .../integrations/acf/field-types/file.md | 80 ++ .../acf/field-types/flexible-content.md | 160 +++ .../integrations/acf/field-types/gallery.md | 15 + .../acf/field-types/google-map.md | 43 + .../integrations/acf/field-types/group.md | 66 ++ .../integrations/acf/field-types/image.md | 35 + .../integrations/acf/field-types/index.md | 16 + .../integrations/acf/field-types/number.md | 29 + .../integrations/acf/field-types/oembed.md | 29 + .../integrations/acf/field-types/page-link.md | 29 + .../integrations/acf/field-types/password.md | 29 + .../acf/field-types/post-object.md | 113 ++ .../acf/field-types/radio-button.md | 35 + .../acf/field-types/relationship.md | 42 + .../integrations/acf/field-types/repeater.md | 260 +++++ .../integrations/acf/field-types/select.md | 43 + .../acf/field-types/smart-slider.md | 29 + .../integrations/acf/field-types/taxonomy.md | 43 + .../integrations/acf/field-types/text-area.md | 29 + .../integrations/acf/field-types/text.md | 29 + .../acf/field-types/time-picker.md | 29 + .../acf/field-types/true-false.md | 35 + .../integrations/acf/field-types/url.md | 29 + .../integrations/acf/field-types/user.md | 53 + .../integrations/acf/field-types/wysiwyg.md | 29 + .../integrations/acf/getting-started.md | 167 +++ .../version-1.5/integrations/acf/index.md | 70 ++ .../integrations/acf/options-page.md | 40 + .../beaver-themer-layouts-for-bigcommerce.md | 25 + ...to-display-a-single-bigcommerce-product.md | 70 ++ ...n-archive-themer-layout-for-bigcommerce.md | 76 ++ .../bigcommerce/field-connections.md | 101 ++ .../products-posts-module-for-bigcommerce.md | 95 ++ .../beaver-themer-and-the-edd-plugin.md | 27 + ...er-layout-for-edd-download-items-themer.md | 54 + ...ive-themer-layout-for-edd-download-sets.md | 63 ++ .../field-connections.md | 64 ++ .../integrations/tec/archive-layout.md | 53 + .../integrations/tec/field-connections.md | 314 ++++++ .../integrations/tec/getting-started.md | 42 + .../version-1.5/integrations/tec/index.md | 22 + .../tec/modules/event-calendar.md | 16 + .../integrations/tec/modules/event-cost.md | 26 + .../tec/modules/event-countdown.md | 30 + .../tec/modules/event-date-time.md | 26 + .../tec/modules/event-description.md | 16 + .../integrations/tec/modules/event-details.md | 18 + .../tec/modules/event-export-links.md | 27 + .../integrations/tec/modules/event-map.md | 22 + .../tec/modules/event-navigation.md | 31 + .../integrations/tec/modules/event-notices.md | 25 + .../tec/modules/event-organizer.md | 22 + .../integrations/tec/modules/event-posts.md | 11 + .../tec/modules/event-related-events.md | 26 + .../integrations/tec/modules/event-tickets.md | 34 + .../integrations/tec/modules/event-title.md | 42 + .../integrations/tec/modules/event-venue.md | 22 + .../integrations/tec/modules/event-website.md | 26 + .../integrations/tec/modules/index.md | 14 + .../integrations/tec/singular-layout.md | 58 + ...for-woocommerce-singular-themer-layouts.md | 46 + ...rce-singular-and-archive-themer-layouts.md | 25 + ...-singular-themer-layout-for-woocommerce.md | 64 ++ ...n-archive-themer-layout-for-woocommerce.md | 65 ++ .../woocommerce/field-connections.md | 181 ++++ .../integrations/woocommerce/index.md | 26 + ...for-woocommerce-singular-themer-layouts.md | 23 + ...for-woocommerce-singular-themer-layouts.md | 27 + ...for-woocommerce-singular-themer-layouts.md | 31 + ...for-woocommerce-singular-themer-layouts.md | 23 + ...for-woocommerce-singular-themer-layouts.md | 26 + ...for-woocommerce-singular-themer-layouts.md | 21 + ...for-woocommerce-singular-themer-layouts.md | 20 + ...for-woocommerce-singular-themer-layouts.md | 17 + ...-for-woocommerce-archive-themer-layouts.md | 44 + ...for-woocommerce-singular-themer-layouts.md | 13 + ...for-woocommerce-singular-themer-layouts.md | 23 + .../version-1.5/introduction/about-release.md | 57 + .../version-1.5/introduction/faq.md | 80 ++ .../version-1.5/introduction/index.md | 27 + .../404-layout-type/themer-404-layout-type.md | 25 + .../create-a-card-layout-for-posts-themer.md | 119 +++ ...-layout-for-custom-post-type-categories.md | 24 + ...chive-layout-archive-description-module.md | 35 + ...mer-archive-layout-archive-title-module.md | 18 + ...st-columns-gallery-list-masonry-modules.md | 22 + .../themer-archive-layout-type.md | 131 +++ ...-create-an-author-archive-themer-layout.md | 107 ++ .../themer-footer-layout-type.md | 190 ++++ .../themer-header-layout-type.md | 226 ++++ .../tutorial-create-a-header-layout-themer.md | 141 +++ .../version-1.5/layout-types-modules/index.md | 80 ++ ...dd-yoast-breadcrumbs-with-beaver-themer.md | 31 + .../themer-part-layout-type.md | 35 + ...ut-to-the-wordpress-page-template-field.md | 49 + ...-singular-layout-attached-images-module.md | 17 + ...hemer-singular-layout-author-bio-module.md | 29 + .../themer-singular-layout-comments-module.md | 21 + ...r-singular-layout-featured-image-module.md | 17 + ...mer-singular-layout-post-content-module.md | 15 + ...themer-singular-layout-post-info-module.md | 80 ++ ...-singular-layout-post-navigation-module.md | 59 ++ ...hemer-singular-layout-post-title-module.md | 18 + .../themer-singular-layout-type.md | 106 ++ ...he-posts-module-to-create-related-posts.md | 120 +++ .../locations/themer-locations-reference.md | 37 + .../full-width-layout-types.md | 38 + ...-this-post-has-a-themer-layout-assigned.md | 22 + .../themer-layouts-menu-missing.md | 19 + ...post-preview-but-not-actual-post-themer.md | 39 + ...y-does-my-themer-layout-say-unsupported.md | 16 + .../version-1.5-sidebars.json | 338 ++++++ beaver-themer_versions.json | 3 + sidebarBeaverBuilder.js | 194 +--- src/css/custom.css | 4 +- .../version-2.10/account/affiliate-program.md | 52 + .../version-2.10/account/billing-info.md | 67 ++ .../version-2.10/account/domain-manager.md | 100 ++ versioned_docs/version-2.10/account/index.md | 50 + .../account/license/activations.md | 37 + .../version-2.10/account/license/cancel.md | 47 + .../version-2.10/account/license/downgrade.md | 37 + .../version-2.10/account/license/expiry.md | 33 + .../version-2.10/account/license/index.md | 57 + .../version-2.10/account/license/renew.md | 55 + .../account/license/suspension.md | 31 + .../version-2.10/account/license/transfer.md | 9 + .../version-2.10/account/license/types.md | 48 + .../version-2.10/account/license/upgrade.md | 47 + .../account/license/view-activate.md | 35 + .../version-2.10/account/request-invoice.md | 9 + .../account/suggest-new-features.md | 10 + .../account/update-email-password.md | 42 + .../version-2.10/advanced/adding-pdf.md | 30 + .../version-2.10/advanced/convert-content.md | 103 ++ .../version-2.10/advanced/css-gradients.md | 58 + .../advanced/custom-image-sizes.md | 69 ++ .../advanced/diy-website-builder-platform.md | 27 + versioned_docs/version-2.10/advanced/index.md | 13 + .../version-2.10/advanced/migration.md | 38 + .../version-2.10/advanced/performance.md | 135 +++ .../advanced/smooth-scrolling-tweaks.md | 180 ++++ versioned_docs/version-2.10/basics/border.md | 67 ++ .../version-2.10/basics/color-picker.md | 249 +++++ .../version-2.10/basics/custom-code.md | 135 +++ .../basics/display-only-bb-content.md | 23 + .../version-2.10/basics/duplicate-layout.md | 61 ++ versioned_docs/version-2.10/basics/index.md | 11 + .../version-2.10/basics/inline-editing.md | 84 ++ .../basics/multi-layer-backgrounds.md | 148 +++ .../basics/restore-previous-version.md | 44 + .../basics/show-hide-page-title.md | 59 ++ .../version-2.10/basics/smooth-scrolling.md | 115 ++ .../version-2.10/basics/typography.md | 138 +++ .../version-2.10/basics/undo-redo.md | 82 ++ .../version-2.10/developer/acf-blocks.md | 173 +++ .../developer/conditionally-hidden-content.md | 39 + .../developer/container-modules.md | 130 +++ .../custom-modules/01-create-a-plugin.md | 39 + .../02-add-a-module-to-your-plugin.md | 63 ++ .../03-define-module-settings.md | 82 ++ .../04-module-settings-css-javascript.md | 34 + .../custom-modules/05-module-html.md | 35 + .../developer/custom-modules/06-module-css.md | 70 ++ .../custom-modules/07-module-javascript.md | 57 + .../08-module-property-reference.md | 83 ++ .../09-module-method-reference.md | 120 +++ .../10-setting-fields-reference.md | 994 ++++++++++++++++++ .../11-responsive-fields-reference.md | 49 + .../12-repeater-fields-reference.md | 31 + .../13-sanitize-field-values.md | 31 + .../custom-modules/14-create-custom-fields.md | 109 ++ .../developer/custom-modules/15-helpers.md | 134 +++ .../16-live-preview-reference.md | 211 ++++ .../17-partial-refresh-reference.md | 120 +++ .../custom-modules/18-override-modules.md | 55 + .../custom-modules/19-localization.md | 11 + .../custom-modules/20-module-aliases.md | 64 ++ .../developer/custom-modules/index.md | 39 + ...m-attributes-to-rows-columns-or-modules.md | 76 ++ ...a-video-lightbox-for-an-amazon-s3-video.md | 46 + .../developer/how-to-tips/data-storage.md | 17 + ...e-minification-and-caching-with-wpdebug.md | 40 + .../disable-schema-markup-beaver-builder.md | 11 + .../display-subset-typography-controls.md | 11 + .../html-css-and-javascript-reference.md | 42 + .../load-css-and-javascript-inline.md | 19 + .../load-google-fonts-locally-gdpr.md | 46 + .../how-to-tips/map-module-filter-google.md | 16 + ...avascript-from-loading-on-archive-pages.md | 22 + .../how-to-tips/render-layouts-with-php.md | 36 + .../version-2.10/developer/iframe-ui.md | 194 ++++ .../version-2.10/developer/module-blocks.md | 29 + .../developer/module-deprecations.md | 124 +++ .../add-a-custom-shape-layer.md | 190 ++++ .../add-icons-to-your-custom-modules.md | 54 + ...hange-how-css-and-javascript-are-loaded.md | 19 + ...n-beaver-builder-plugin-filter-examples.md | 604 +++++++++++ ...-module-to-compare-images-with-a-slider.md | 248 +++++ ...r-to-customize-the-display-of-post-data.md | 82 ++ .../customize-keyboard-shortcuts.md | 203 ++++ .../customize-row-resizing-behavior.md | 102 ++ .../customize-settings-forms.md | 44 + .../install-beaver-builder-via-composer.md | 78 ++ .../remove-rename-tools-menu-items.md | 50 + .../tutorials-guides/wp-cli-plugin-theme.md | 123 +++ .../version-2.10/getting-started/install.md | 58 + .../getting-started/launch-builder.md | 59 ++ .../getting-started/system-requirements.md | 65 ++ .../what-can-i-do-with-beaver-builder.md | 203 ++++ .../version-2.10/integrations/font-awesome.md | 92 ++ .../version-2.10/integrations/index.md | 26 + .../version-2.10/integrations/popup-maker.md | 37 + .../integrations/query-monitor.md | 25 + .../version-2.10/integrations/rankmath.md | 31 + .../version-2.10/integrations/woocommerce.md | 57 + .../version-2.10/integrations/yoast.md | 31 + .../introduction/about-release.md | 132 +++ .../introduction/accessibility.md | 177 ++++ .../version-2.10/introduction/faq.md | 210 ++++ .../version-2.10/introduction/gdpr.md | 58 + .../version-2.10/introduction/index.md | 40 + .../introduction/releases-versioning.md | 127 +++ .../introduction/support-policy.md | 31 + .../version-2.10/introduction/translations.md | 47 + .../layouts/advanced-tab/animation.md | 62 ++ .../layouts/advanced-tab/copy-paste.md | 57 + .../layouts/advanced-tab/css-js.md | 92 ++ .../layouts/advanced-tab/html-element.md | 263 +++++ .../layouts/advanced-tab/index.md | 28 + .../layouts/advanced-tab/spacing.md | 55 + .../layouts/advanced-tab/visibility.md | 98 ++ .../column-layouts-overview-10400ffc.png | Bin 0 -> 41563 bytes .../column-layouts-overview-675008fe.png | Bin 0 -> 161504 bytes .../columns/column-layouts-overview.md | 99 ++ .../layouts/columns/duplicate-a-column.md | 20 + .../layouts/columns/edit-a-column.md | 99 ++ .../layouts/columns/insert-columns.md | 30 + .../layouts/columns/move-a-column.md | 41 + .../columns/resize-or-reset-column-width.md | 61 ++ .../version-2.10/layouts/columns/stacking.md | 81 ++ .../columns/tips-for-working-with-columns.md | 77 ++ .../modules/accordion/css-customization.md | 82 ++ .../layouts/modules/accordion/index.md | 27 + .../modules/accordion/link-specific-item.md | 64 ++ .../modules/accordion/settings/index.md | 19 + .../modules/accordion/settings/items.md | 119 +++ .../modules/accordion/settings/style.md | 65 ++ .../version-2.10/layouts/modules/audio.md | 98 ++ .../layouts/modules/bigcommerce-products.md | 32 + .../version-2.10/layouts/modules/box/index.md | 93 ++ .../layouts/modules/box/settings/children.md | 71 ++ .../layouts/modules/box/settings/container.md | 204 ++++ .../layouts/modules/box/settings/index.md | 19 + .../modules/box/using-align-options.md | 13 + .../layouts/modules/button-group.md | 173 +++ .../layouts/modules/button/button.md | 172 +++ .../button/make-a-button-transparent.md | 26 + .../modules/callout-and-call-to-action.md | 284 +++++ ...d-a-google-recaptcha-checkbox-to-a-form.md | 73 ++ .../modules/contact-form/contact-form.md | 117 +++ .../layouts/modules/content-slider.md | 80 ++ .../version-2.10/layouts/modules/countdown.md | 91 ++ .../layouts/modules/gallery/gallery.md | 108 ++ ...open-a-gallery-lightbox-on-button-click.md | 75 ++ .../version-2.10/layouts/modules/heading.md | 73 ++ .../version-2.10/layouts/modules/html.md | 44 + .../layouts/modules/icon-and-icon-group.md | 79 ++ .../version-2.10/layouts/modules/index.md | 130 +++ .../version-2.10/layouts/modules/list.md | 218 ++++ .../layouts/modules/login-form.md | 98 ++ .../layouts/modules/loop/index.md | 74 ++ .../layouts/modules/loop/settings.md | 194 ++++ .../version-2.10/layouts/modules/map.md | 28 + ...-menu-item-that-links-to-a-page-section.md | 58 + .../version-2.10/layouts/modules/menu/menu.md | 325 ++++++ .../layouts/modules/module-blocks.md | 26 + .../layouts/modules/north-commerce.md | 79 ++ .../layouts/modules/number-counter.md | 94 ++ .../add-hover-effects-to-the-photo-module.md | 181 ++++ .../display-full-captions-under-photos.md | 26 + .../layouts/modules/photo/photo.md | 58 + ...-between-images-in-posts-module-gallery.md | 22 + .../layouts/modules/posts/posts-carousel.md | 86 ++ ...ousel-and-posts-slider-modules-examples.md | 136 +++ .../layouts/modules/posts/posts-slider.md | 95 ++ .../layouts/modules/posts/posts.md | 691 ++++++++++++ .../layouts/modules/pricing-table.md | 231 ++++ .../search/limit-post-types-search-module.md | 33 + .../layouts/modules/search/search.md | 169 +++ .../version-2.10/layouts/modules/separator.md | 28 + .../version-2.10/layouts/modules/sidebar.md | 19 + .../version-2.10/layouts/modules/slideshow.md | 257 +++++ .../layouts/modules/social-buttons.md | 23 + .../layouts/modules/star-rating.md | 53 + ...form-module-for-mailchimp-double-opt-in.md | 10 + .../modules/subscribe-form/subscribe-form.md | 193 ++++ .../layouts/modules/tabs/index.md | 27 + .../modules/tabs/link-specific-item.md | 64 ++ .../layouts/modules/tabs/settings/index.md | 19 + .../layouts/modules/tabs/settings/items.md | 93 ++ .../layouts/modules/tabs/settings/style.md | 73 ++ .../layouts/modules/testimonials.md | 29 + .../version-2.10/layouts/modules/text.md | 26 + .../video/open-a-video-in-a-lightbox.md | 24 + .../layouts/modules/video/video.md | 123 +++ .../version-2.10/layouts/modules/widgets.md | 40 + .../layouts/modules/woocommerce.md | 190 ++++ .../layouts/modules/wordpress-patterns.md | 26 + ...modules-to-index-archive-and-post-pages.md | 142 +++ ...rdpress-handles-blog-posts-and-archives.md | 100 ++ ...-archives-versus-beaver-builder-layouts.md | 33 + ...-blogs-and-custom-post-types-start-here.md | 23 + ...-beaver-builder-to-lay-out-post-content.md | 110 ++ .../post-layouts/wordpress-archive-types.md | 80 ++ .../assets/responsive-columns-163bfe78.png | Bin 0 -> 167046 bytes .../layouts/responsive-design/breakpoints.md | 88 ++ .../layouts/responsive-design/disable.md | 20 + .../layouts/responsive-design/editor.md | 78 ++ .../layouts/responsive-design/index.md | 65 ++ .../responsive-design/responsive-columns.md | 23 + .../layouts/responsive-design/toggle.md | 128 +++ .../layouts/reusable-content/components.md | 145 +++ .../layouts/reusable-content/globals.md | 141 +++ .../layouts/reusable-content/index.md | 49 + .../layouts/reusable-content/templates.md | 141 +++ .../rows/add-prebuilt-rows-to-your-content.md | 21 + ...ackground-image-on-table-or-mobile-view.md | 32 + .../layouts/rows/customize-the-row-height.md | 16 + .../rows/full-width-and-fixed-width.md | 67 ++ .../full-width-rows-on-third-party-themes.md | 36 + ...-a-ken-burns-effect-in-a-row-background.md | 24 + ...for-using-background-colors-and-effects.md | 124 +++ .../row-effects/parallax-row-backgrounds.md | 33 + .../rows/row-effects/row-shape-overlays.md | 180 ++++ .../row-effects/video-backgrounds-in-rows.md | 92 ++ ...set-global-site-wide-default-row-widths.md | 53 + .../rows/set-width-for-rows-and-content.md | 63 ++ .../layouts/rows/work-with-rows.md | 150 +++ .../version-2.10/layouts/templates/index.md | 75 ++ .../layouts/templates/prebuilt-templates.md | 55 + .../layouts/templates/saved-templates.md | 148 +++ .../layouts/templates/template-site.md | 53 + .../templates/theme-template-authors.md | 153 +++ .../version-2.10/settings/advanced.md | 251 +++++ .../version-2.10/settings/blocks.md | 43 + .../version-2.10/settings/branding.md | 117 +++ .../version-2.10/settings/export-import.md | 77 ++ .../version-2.10/settings/help-button.md | 34 + versioned_docs/version-2.10/settings/icons.md | 118 +++ .../settings/import-export-settings.md | 44 + versioned_docs/version-2.10/settings/index.md | 53 + .../version-2.10/settings/layouts-menu.md | 32 + .../version-2.10/settings/license.md | 38 + .../version-2.10/settings/modules.md | 38 + .../version-2.10/settings/post-types.md | 43 + .../settings/template-exporter.md | 23 + .../version-2.10/settings/templates.md | 60 ++ versioned_docs/version-2.10/settings/tools.md | 241 +++++ .../version-2.10/settings/user-access.md | 157 +++ .../version-2.10/settings/version-control.md | 31 + .../version-2.10/settings/welcome.md | 34 + .../version-2.10/shortcode/find-id-slug.md | 47 + .../version-2.10/shortcode/index.md | 46 + .../version-2.10/shortcode/syntax.md | 60 ++ .../version-2.10/shortcode/using-css.md | 64 ++ .../version-2.10/shortcode/using-php-files.md | 185 ++++ .../version-2.10/shortcode/using-shortcode.md | 76 ++ .../403-forbidden-or-blocked-error.md | 46 + .../404-error-when-trying-to-open-editor.md | 25 + ...3-errors-when-loading-background-images.md | 34 + .../destination-folder-already-exists.md | 17 + .../common-issues/dreamhost.md | 13 + .../common-issues/error-settings-not-saved.md | 117 +++ .../error-when-trying-to-install-update.md | 20 + .../exceeds-php-max-input-vars.md | 51 + .../http-error-when-uploading-images.md | 19 + .../i-am-getting-a-blank-screen.md | 14 + ...-because-it-is-unzipped-when-i-download.md | 26 + ...d-a-site-but-my-image-urls-didnt-change.md | 22 + .../im-getting-a-permission-denied-error.md | 16 + ...rease-the-wordpress-allowed-memory-size.md | 34 + .../internal-server-500-error.md | 19 + .../common-issues/require-once.md | 17 + ...-uploadmaxfilesize-directive-in-php-ini.md | 23 + .../common-issues/title-bar-incorrect.md | 18 + .../use-smtp-to-send-form-notifications.md | 9 + .../common-issues/zlib-output-compression.md | 11 + .../debugging/cache-clearing-tool.md | 35 + .../enable-beaver-builder-debug-mode.md | 44 + .../debugging/issue-fixer-clear-the-cache.md | 21 + .../known-beaver-builder-incompatibilities.md | 237 +++++ .../debugging/plugin-conflicts.md | 31 + .../troubleshooting/debugging/safe-mode.md | 73 ++ .../debugging/theme-conflict.md | 103 ++ ...background-color-or-image-doesnt-appear.md | 24 + ...s-not-open-for-editing-on-nginx-servers.md | 54 + ...-beaver-builder-menu-in-the-admin-panel.md | 28 + .../cant-open-page-in-beaver-builder.md | 42 + ...builder-text-editor-toolbars-dont-match.md | 82 ++ ...ws-beaver-builder-customizer-and-beyond.md | 73 ++ .../miscellaneous/font-awesome-icons.md | 71 ++ ...r-builder-renders-the-title-of-an-image.md | 57 + .../i-cant-drag-and-drop-modules.md | 16 + .../miscellaneous/limit-on-adding-rows.md | 17 + ...criber-popup-form-breaks-beaver-builder.md | 18 + .../my-custom-column-width-keeps-changing.md | 16 + ...dont-appear-on-siteground-staging-sites.md | 43 + .../reduce-disable-undo-redo-manager.md | 59 ++ ...ibe-form-mailchimp-merge-fields-invalid.md | 19 + .../uploaded-icon-set-is-blank.md | 12 + ...seeing-an-eye-icon-in-my-module-toolbar.md | 13 + .../wordpress-admin-bar-is-hidden.md | 18 + ...ver-builder-not-working-after-upgrading.md | 79 ++ .../manually-reinstall-beaver-builder.md | 46 + .../not-getting-beaver-builder-updates.md | 64 ++ ...or-deactivate-the-beaver-builder-plugin.md | 52 + .../version-2.10/user-interface/cloud.md | 59 ++ .../user-interface/content-panel.md | 83 ++ .../user-interface/global-settings.md | 193 ++++ .../user-interface/global-styles.md | 143 +++ .../version-2.10/user-interface/index.md | 29 + .../user-interface/layout-css-js.md | 31 + .../user-interface/link-values.md | 20 + .../user-interface/outline-panel.md | 91 ++ .../version-2.10/user-interface/overlay.md | 82 ++ .../user-interface/settings-window.md | 54 + .../tools-menu-styles.module.css | 13 + .../version-2.10/user-interface/tools-menu.md | 189 ++++ .../version-2.10/user-interface/top-bar.md | 139 +++ versioned_sidebars/version-2.10-sidebars.json | 679 ++++++++++++ 464 files changed, 35696 insertions(+), 166 deletions(-) create mode 100644 beaver-themer_versioned_docs/version-1.5/conditional-logic/beaver-themer-conditional-logic.md create mode 100644 beaver-themer_versioned_docs/version-1.5/developer/add-custom-attributes-to-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/developer/add-themer-support.md create mode 100644 beaver-themer_versioned_docs/version-1.5/developer/conditional-logic-apis.md create mode 100644 beaver-themer_versioned_docs/version-1.5/developer/customize-field-connections-themer.md create mode 100644 beaver-themer_versioned_docs/version-1.5/developer/customize-themer-modules.md create mode 100644 beaver-themer_versioned_docs/version-1.5/developer/hide-node-when-field-connection-is-empty.md create mode 100644 beaver-themer_versioned_docs/version-1.5/developer/hooks-reference-themer.md create mode 100644 beaver-themer_versioned_docs/version-1.5/developer/wp-cli-for-beaver-themer.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/conditionals.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/examples/combining.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/examples/conditional.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/examples/expressions.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/examples/index.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/expressions.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/getting-started.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/index.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/syntax.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/third-party.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/wordpress-custom-fields.md create mode 100644 beaver-themer_versioned_docs/version-1.5/field-connections/wordpress-data.md create mode 100644 beaver-themer_versioned_docs/version-1.5/getting-started/i-installed-beaver-themer-now-what.md create mode 100644 beaver-themer_versioned_docs/version-1.5/getting-started/install.md create mode 100644 beaver-themer_versioned_docs/version-1.5/getting-started/primer-on-wordpress-content-and-theme-areas-themer.md create mode 100644 beaver-themer_versioned_docs/version-1.5/getting-started/requirements.md create mode 100644 beaver-themer_versioned_docs/version-1.5/getting-started/supported-themes.md create mode 100644 beaver-themer_versioned_docs/version-1.5/getting-started/what-can-i-do-with-beaver-themer.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/button-group.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/checkbox.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/color-picker.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/date-picker.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/date-time-picker.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/email.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/file.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/flexible-content.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/gallery.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/google-map.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/group.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/image.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/index.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/number.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/oembed.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/page-link.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/password.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/post-object.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/radio-button.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/relationship.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/repeater.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/select.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/smart-slider.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/taxonomy.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/text-area.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/text.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/time-picker.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/true-false.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/url.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/user.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/field-types/wysiwyg.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/getting-started.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/index.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/acf/options-page.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/bigcommerce/beaver-themer-layouts-for-bigcommerce.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/bigcommerce/create-a-themer-layout-to-display-a-single-bigcommerce-product.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/bigcommerce/create-an-archive-themer-layout-for-bigcommerce.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/bigcommerce/field-connections.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/bigcommerce/products-posts-module-for-bigcommerce.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/easy-digital-downloads/beaver-themer-and-the-edd-plugin.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/easy-digital-downloads/create-a-singular-themer-layout-for-edd-download-items-themer.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/easy-digital-downloads/create-an-archive-themer-layout-for-edd-download-sets.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/easy-digital-downloads/field-connections.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/archive-layout.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/field-connections.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/getting-started.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/index.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-calendar.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-cost.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-countdown.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-date-time.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-description.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-details.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-export-links.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-map.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-navigation.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-notices.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-organizer.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-posts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-related-events.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-tickets.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-title.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-venue.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/event-website.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/modules/index.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/tec/singular-layout.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/add-to-cart-button-module-for-woocommerce-singular-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/breadcrumb-module-for-woocommerce-singular-and-archive-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/create-a-singular-themer-layout-for-woocommerce.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/create-an-archive-themer-layout-for-woocommerce.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/field-connections.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/index.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/product-description-module-for-woocommerce-singular-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/product-images-module-for-woocommerce-singular-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/product-meta-module-for-woocommerce-singular-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/product-price-module-for-woocommerce-singular-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/product-rating-module-for-woocommerce-singular-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/product-tabs-module-for-woocommerce-singular-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/product-title-module-for-woocommerce-singular-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/product-upsells-module-for-woocommerce-singular-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/products-module-for-woocommerce-archive-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/related-products-module-for-woocommerce-singular-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/integrations/woocommerce/woo-notices-module-for-woocommerce-singular-themer-layouts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/introduction/about-release.md create mode 100644 beaver-themer_versioned_docs/version-1.5/introduction/faq.md create mode 100644 beaver-themer_versioned_docs/version-1.5/introduction/index.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/404-layout-type/themer-404-layout-type.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/archive-layout-type/create-a-card-layout-for-posts-themer.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/archive-layout-type/example-themer-archive-layout-for-custom-post-type-categories.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/archive-layout-type/themer-archive-layout-archive-description-module.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/archive-layout-type/themer-archive-layout-archive-title-module.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/archive-layout-type/themer-archive-layout-post-columns-gallery-list-masonry-modules.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/archive-layout-type/themer-archive-layout-type.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/archive-layout-type/tutorial-create-an-author-archive-themer-layout.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/footer-layout-type/themer-footer-layout-type.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/header-layout-type/themer-header-layout-type.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/header-layout-type/tutorial-create-a-header-layout-themer.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/index.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/part-layout-type/add-yoast-breadcrumbs-with-beaver-themer.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/part-layout-type/themer-part-layout-type.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/singular-layout-type/add-a-singular-themer-layout-to-the-wordpress-page-template-field.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/singular-layout-type/themer-singular-layout-attached-images-module.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/singular-layout-type/themer-singular-layout-author-bio-module.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/singular-layout-type/themer-singular-layout-comments-module.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/singular-layout-type/themer-singular-layout-featured-image-module.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/singular-layout-type/themer-singular-layout-post-content-module.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/singular-layout-type/themer-singular-layout-post-info-module.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/singular-layout-type/themer-singular-layout-post-navigation-module.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/singular-layout-type/themer-singular-layout-post-title-module.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/singular-layout-type/themer-singular-layout-type.md create mode 100644 beaver-themer_versioned_docs/version-1.5/layout-types-modules/singular-layout-type/use-the-posts-module-to-create-related-posts.md create mode 100644 beaver-themer_versioned_docs/version-1.5/locations/themer-locations-reference.md create mode 100644 beaver-themer_versioned_docs/version-1.5/troubleshooting/full-width-layout-types.md create mode 100644 beaver-themer_versioned_docs/version-1.5/troubleshooting/message-this-post-has-a-themer-layout-assigned.md create mode 100644 beaver-themer_versioned_docs/version-1.5/troubleshooting/themer-layouts-menu-missing.md create mode 100644 beaver-themer_versioned_docs/version-1.5/troubleshooting/troubleshooting-singular-layout-appears-in-post-preview-but-not-actual-post-themer.md create mode 100644 beaver-themer_versioned_docs/version-1.5/troubleshooting/why-does-my-themer-layout-say-unsupported.md create mode 100644 beaver-themer_versioned_sidebars/version-1.5-sidebars.json create mode 100644 beaver-themer_versions.json create mode 100644 versioned_docs/version-2.10/account/affiliate-program.md create mode 100644 versioned_docs/version-2.10/account/billing-info.md create mode 100644 versioned_docs/version-2.10/account/domain-manager.md create mode 100644 versioned_docs/version-2.10/account/index.md create mode 100644 versioned_docs/version-2.10/account/license/activations.md create mode 100644 versioned_docs/version-2.10/account/license/cancel.md create mode 100644 versioned_docs/version-2.10/account/license/downgrade.md create mode 100644 versioned_docs/version-2.10/account/license/expiry.md create mode 100644 versioned_docs/version-2.10/account/license/index.md create mode 100644 versioned_docs/version-2.10/account/license/renew.md create mode 100644 versioned_docs/version-2.10/account/license/suspension.md create mode 100644 versioned_docs/version-2.10/account/license/transfer.md create mode 100644 versioned_docs/version-2.10/account/license/types.md create mode 100644 versioned_docs/version-2.10/account/license/upgrade.md create mode 100644 versioned_docs/version-2.10/account/license/view-activate.md create mode 100644 versioned_docs/version-2.10/account/request-invoice.md create mode 100644 versioned_docs/version-2.10/account/suggest-new-features.md create mode 100644 versioned_docs/version-2.10/account/update-email-password.md create mode 100644 versioned_docs/version-2.10/advanced/adding-pdf.md create mode 100644 versioned_docs/version-2.10/advanced/convert-content.md create mode 100644 versioned_docs/version-2.10/advanced/css-gradients.md create mode 100644 versioned_docs/version-2.10/advanced/custom-image-sizes.md create mode 100644 versioned_docs/version-2.10/advanced/diy-website-builder-platform.md create mode 100644 versioned_docs/version-2.10/advanced/index.md create mode 100644 versioned_docs/version-2.10/advanced/migration.md create mode 100644 versioned_docs/version-2.10/advanced/performance.md create mode 100644 versioned_docs/version-2.10/advanced/smooth-scrolling-tweaks.md create mode 100644 versioned_docs/version-2.10/basics/border.md create mode 100644 versioned_docs/version-2.10/basics/color-picker.md create mode 100644 versioned_docs/version-2.10/basics/custom-code.md create mode 100644 versioned_docs/version-2.10/basics/display-only-bb-content.md create mode 100644 versioned_docs/version-2.10/basics/duplicate-layout.md create mode 100644 versioned_docs/version-2.10/basics/index.md create mode 100644 versioned_docs/version-2.10/basics/inline-editing.md create mode 100644 versioned_docs/version-2.10/basics/multi-layer-backgrounds.md create mode 100644 versioned_docs/version-2.10/basics/restore-previous-version.md create mode 100644 versioned_docs/version-2.10/basics/show-hide-page-title.md create mode 100644 versioned_docs/version-2.10/basics/smooth-scrolling.md create mode 100644 versioned_docs/version-2.10/basics/typography.md create mode 100644 versioned_docs/version-2.10/basics/undo-redo.md create mode 100644 versioned_docs/version-2.10/developer/acf-blocks.md create mode 100644 versioned_docs/version-2.10/developer/conditionally-hidden-content.md create mode 100644 versioned_docs/version-2.10/developer/container-modules.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/01-create-a-plugin.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/02-add-a-module-to-your-plugin.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/03-define-module-settings.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/04-module-settings-css-javascript.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/05-module-html.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/06-module-css.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/07-module-javascript.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/08-module-property-reference.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/09-module-method-reference.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/10-setting-fields-reference.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/11-responsive-fields-reference.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/12-repeater-fields-reference.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/13-sanitize-field-values.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/14-create-custom-fields.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/15-helpers.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/16-live-preview-reference.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/17-partial-refresh-reference.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/18-override-modules.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/19-localization.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/20-module-aliases.md create mode 100644 versioned_docs/version-2.10/developer/custom-modules/index.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/add-custom-attributes-to-rows-columns-or-modules.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/create-a-video-lightbox-for-an-amazon-s3-video.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/data-storage.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/disable-minification-and-caching-with-wpdebug.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/disable-schema-markup-beaver-builder.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/display-subset-typography-controls.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/html-css-and-javascript-reference.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/load-css-and-javascript-inline.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/load-google-fonts-locally-gdpr.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/map-module-filter-google.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/prevent-css-and-javascript-from-loading-on-archive-pages.md create mode 100644 versioned_docs/version-2.10/developer/how-to-tips/render-layouts-with-php.md create mode 100644 versioned_docs/version-2.10/developer/iframe-ui.md create mode 100644 versioned_docs/version-2.10/developer/module-blocks.md create mode 100644 versioned_docs/version-2.10/developer/module-deprecations.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/add-a-custom-shape-layer.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/add-icons-to-your-custom-modules.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/change-how-css-and-javascript-are-loaded.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/common-beaver-builder-plugin-filter-examples.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/create-a-custom-module-to-compare-images-with-a-slider.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/create-a-filter-to-customize-the-display-of-post-data.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/customize-keyboard-shortcuts.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/customize-row-resizing-behavior.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/customize-settings-forms.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/install-beaver-builder-via-composer.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/remove-rename-tools-menu-items.md create mode 100644 versioned_docs/version-2.10/developer/tutorials-guides/wp-cli-plugin-theme.md create mode 100644 versioned_docs/version-2.10/getting-started/install.md create mode 100644 versioned_docs/version-2.10/getting-started/launch-builder.md create mode 100644 versioned_docs/version-2.10/getting-started/system-requirements.md create mode 100644 versioned_docs/version-2.10/getting-started/what-can-i-do-with-beaver-builder.md create mode 100644 versioned_docs/version-2.10/integrations/font-awesome.md create mode 100644 versioned_docs/version-2.10/integrations/index.md create mode 100644 versioned_docs/version-2.10/integrations/popup-maker.md create mode 100644 versioned_docs/version-2.10/integrations/query-monitor.md create mode 100644 versioned_docs/version-2.10/integrations/rankmath.md create mode 100644 versioned_docs/version-2.10/integrations/woocommerce.md create mode 100644 versioned_docs/version-2.10/integrations/yoast.md create mode 100644 versioned_docs/version-2.10/introduction/about-release.md create mode 100644 versioned_docs/version-2.10/introduction/accessibility.md create mode 100644 versioned_docs/version-2.10/introduction/faq.md create mode 100644 versioned_docs/version-2.10/introduction/gdpr.md create mode 100644 versioned_docs/version-2.10/introduction/index.md create mode 100644 versioned_docs/version-2.10/introduction/releases-versioning.md create mode 100644 versioned_docs/version-2.10/introduction/support-policy.md create mode 100644 versioned_docs/version-2.10/introduction/translations.md create mode 100644 versioned_docs/version-2.10/layouts/advanced-tab/animation.md create mode 100644 versioned_docs/version-2.10/layouts/advanced-tab/copy-paste.md create mode 100644 versioned_docs/version-2.10/layouts/advanced-tab/css-js.md create mode 100644 versioned_docs/version-2.10/layouts/advanced-tab/html-element.md create mode 100644 versioned_docs/version-2.10/layouts/advanced-tab/index.md create mode 100644 versioned_docs/version-2.10/layouts/advanced-tab/spacing.md create mode 100644 versioned_docs/version-2.10/layouts/advanced-tab/visibility.md create mode 100644 versioned_docs/version-2.10/layouts/columns/assets/column-layouts-overview-10400ffc.png create mode 100644 versioned_docs/version-2.10/layouts/columns/assets/column-layouts-overview-675008fe.png create mode 100644 versioned_docs/version-2.10/layouts/columns/column-layouts-overview.md create mode 100644 versioned_docs/version-2.10/layouts/columns/duplicate-a-column.md create mode 100644 versioned_docs/version-2.10/layouts/columns/edit-a-column.md create mode 100644 versioned_docs/version-2.10/layouts/columns/insert-columns.md create mode 100644 versioned_docs/version-2.10/layouts/columns/move-a-column.md create mode 100644 versioned_docs/version-2.10/layouts/columns/resize-or-reset-column-width.md create mode 100644 versioned_docs/version-2.10/layouts/columns/stacking.md create mode 100644 versioned_docs/version-2.10/layouts/columns/tips-for-working-with-columns.md create mode 100644 versioned_docs/version-2.10/layouts/modules/accordion/css-customization.md create mode 100644 versioned_docs/version-2.10/layouts/modules/accordion/index.md create mode 100644 versioned_docs/version-2.10/layouts/modules/accordion/link-specific-item.md create mode 100644 versioned_docs/version-2.10/layouts/modules/accordion/settings/index.md create mode 100644 versioned_docs/version-2.10/layouts/modules/accordion/settings/items.md create mode 100644 versioned_docs/version-2.10/layouts/modules/accordion/settings/style.md create mode 100644 versioned_docs/version-2.10/layouts/modules/audio.md create mode 100644 versioned_docs/version-2.10/layouts/modules/bigcommerce-products.md create mode 100644 versioned_docs/version-2.10/layouts/modules/box/index.md create mode 100644 versioned_docs/version-2.10/layouts/modules/box/settings/children.md create mode 100644 versioned_docs/version-2.10/layouts/modules/box/settings/container.md create mode 100644 versioned_docs/version-2.10/layouts/modules/box/settings/index.md create mode 100644 versioned_docs/version-2.10/layouts/modules/box/using-align-options.md create mode 100644 versioned_docs/version-2.10/layouts/modules/button-group.md create mode 100644 versioned_docs/version-2.10/layouts/modules/button/button.md create mode 100644 versioned_docs/version-2.10/layouts/modules/button/make-a-button-transparent.md create mode 100644 versioned_docs/version-2.10/layouts/modules/callout-and-call-to-action.md create mode 100644 versioned_docs/version-2.10/layouts/modules/contact-form/add-a-google-recaptcha-checkbox-to-a-form.md create mode 100644 versioned_docs/version-2.10/layouts/modules/contact-form/contact-form.md create mode 100644 versioned_docs/version-2.10/layouts/modules/content-slider.md create mode 100644 versioned_docs/version-2.10/layouts/modules/countdown.md create mode 100644 versioned_docs/version-2.10/layouts/modules/gallery/gallery.md create mode 100644 versioned_docs/version-2.10/layouts/modules/gallery/open-a-gallery-lightbox-on-button-click.md create mode 100644 versioned_docs/version-2.10/layouts/modules/heading.md create mode 100644 versioned_docs/version-2.10/layouts/modules/html.md create mode 100644 versioned_docs/version-2.10/layouts/modules/icon-and-icon-group.md create mode 100644 versioned_docs/version-2.10/layouts/modules/index.md create mode 100644 versioned_docs/version-2.10/layouts/modules/list.md create mode 100644 versioned_docs/version-2.10/layouts/modules/login-form.md create mode 100644 versioned_docs/version-2.10/layouts/modules/loop/index.md create mode 100644 versioned_docs/version-2.10/layouts/modules/loop/settings.md create mode 100644 versioned_docs/version-2.10/layouts/modules/map.md create mode 100644 versioned_docs/version-2.10/layouts/modules/menu/add-a-menu-item-that-links-to-a-page-section.md create mode 100644 versioned_docs/version-2.10/layouts/modules/menu/menu.md create mode 100644 versioned_docs/version-2.10/layouts/modules/module-blocks.md create mode 100644 versioned_docs/version-2.10/layouts/modules/north-commerce.md create mode 100644 versioned_docs/version-2.10/layouts/modules/number-counter.md create mode 100644 versioned_docs/version-2.10/layouts/modules/photo/add-hover-effects-to-the-photo-module.md create mode 100644 versioned_docs/version-2.10/layouts/modules/photo/display-full-captions-under-photos.md create mode 100644 versioned_docs/version-2.10/layouts/modules/photo/photo.md create mode 100644 versioned_docs/version-2.10/layouts/modules/posts/increase-space-between-images-in-posts-module-gallery.md create mode 100644 versioned_docs/version-2.10/layouts/modules/posts/posts-carousel.md create mode 100644 versioned_docs/version-2.10/layouts/modules/posts/posts-posts-carousel-and-posts-slider-modules-examples.md create mode 100644 versioned_docs/version-2.10/layouts/modules/posts/posts-slider.md create mode 100644 versioned_docs/version-2.10/layouts/modules/posts/posts.md create mode 100644 versioned_docs/version-2.10/layouts/modules/pricing-table.md create mode 100644 versioned_docs/version-2.10/layouts/modules/search/limit-post-types-search-module.md create mode 100644 versioned_docs/version-2.10/layouts/modules/search/search.md create mode 100644 versioned_docs/version-2.10/layouts/modules/separator.md create mode 100644 versioned_docs/version-2.10/layouts/modules/sidebar.md create mode 100644 versioned_docs/version-2.10/layouts/modules/slideshow.md create mode 100644 versioned_docs/version-2.10/layouts/modules/social-buttons.md create mode 100644 versioned_docs/version-2.10/layouts/modules/star-rating.md create mode 100644 versioned_docs/version-2.10/layouts/modules/subscribe-form/configure-subscribe-form-module-for-mailchimp-double-opt-in.md create mode 100644 versioned_docs/version-2.10/layouts/modules/subscribe-form/subscribe-form.md create mode 100644 versioned_docs/version-2.10/layouts/modules/tabs/index.md create mode 100644 versioned_docs/version-2.10/layouts/modules/tabs/link-specific-item.md create mode 100644 versioned_docs/version-2.10/layouts/modules/tabs/settings/index.md create mode 100644 versioned_docs/version-2.10/layouts/modules/tabs/settings/items.md create mode 100644 versioned_docs/version-2.10/layouts/modules/tabs/settings/style.md create mode 100644 versioned_docs/version-2.10/layouts/modules/testimonials.md create mode 100644 versioned_docs/version-2.10/layouts/modules/text.md create mode 100644 versioned_docs/version-2.10/layouts/modules/video/open-a-video-in-a-lightbox.md create mode 100644 versioned_docs/version-2.10/layouts/modules/video/video.md create mode 100644 versioned_docs/version-2.10/layouts/modules/widgets.md create mode 100644 versioned_docs/version-2.10/layouts/modules/woocommerce.md create mode 100644 versioned_docs/version-2.10/layouts/modules/wordpress-patterns.md create mode 100644 versioned_docs/version-2.10/layouts/post-layouts/add-rows-and-modules-to-index-archive-and-post-pages.md create mode 100644 versioned_docs/version-2.10/layouts/post-layouts/basics-how-wordpress-handles-blog-posts-and-archives.md create mode 100644 versioned_docs/version-2.10/layouts/post-layouts/generated-wordpress-archives-versus-beaver-builder-layouts.md create mode 100644 versioned_docs/version-2.10/layouts/post-layouts/how-beaver-builder-works-with-blogs-and-custom-post-types-start-here.md create mode 100644 versioned_docs/version-2.10/layouts/post-layouts/use-beaver-builder-to-lay-out-post-content.md create mode 100644 versioned_docs/version-2.10/layouts/post-layouts/wordpress-archive-types.md create mode 100644 versioned_docs/version-2.10/layouts/responsive-design/assets/responsive-columns-163bfe78.png create mode 100644 versioned_docs/version-2.10/layouts/responsive-design/breakpoints.md create mode 100644 versioned_docs/version-2.10/layouts/responsive-design/disable.md create mode 100644 versioned_docs/version-2.10/layouts/responsive-design/editor.md create mode 100644 versioned_docs/version-2.10/layouts/responsive-design/index.md create mode 100644 versioned_docs/version-2.10/layouts/responsive-design/responsive-columns.md create mode 100644 versioned_docs/version-2.10/layouts/responsive-design/toggle.md create mode 100644 versioned_docs/version-2.10/layouts/reusable-content/components.md create mode 100644 versioned_docs/version-2.10/layouts/reusable-content/globals.md create mode 100644 versioned_docs/version-2.10/layouts/reusable-content/index.md create mode 100644 versioned_docs/version-2.10/layouts/reusable-content/templates.md create mode 100644 versioned_docs/version-2.10/layouts/rows/add-prebuilt-rows-to-your-content.md create mode 100644 versioned_docs/version-2.10/layouts/rows/change-row-background-image-on-table-or-mobile-view.md create mode 100644 versioned_docs/version-2.10/layouts/rows/customize-the-row-height.md create mode 100644 versioned_docs/version-2.10/layouts/rows/full-width-and-fixed-width.md create mode 100644 versioned_docs/version-2.10/layouts/rows/full-width-rows-on-third-party-themes.md create mode 100644 versioned_docs/version-2.10/layouts/rows/row-effects/create-a-ken-burns-effect-in-a-row-background.md create mode 100644 versioned_docs/version-2.10/layouts/rows/row-effects/ideas-for-using-background-colors-and-effects.md create mode 100644 versioned_docs/version-2.10/layouts/rows/row-effects/parallax-row-backgrounds.md create mode 100644 versioned_docs/version-2.10/layouts/rows/row-effects/row-shape-overlays.md create mode 100644 versioned_docs/version-2.10/layouts/rows/row-effects/video-backgrounds-in-rows.md create mode 100644 versioned_docs/version-2.10/layouts/rows/set-global-site-wide-default-row-widths.md create mode 100644 versioned_docs/version-2.10/layouts/rows/set-width-for-rows-and-content.md create mode 100644 versioned_docs/version-2.10/layouts/rows/work-with-rows.md create mode 100644 versioned_docs/version-2.10/layouts/templates/index.md create mode 100644 versioned_docs/version-2.10/layouts/templates/prebuilt-templates.md create mode 100644 versioned_docs/version-2.10/layouts/templates/saved-templates.md create mode 100644 versioned_docs/version-2.10/layouts/templates/template-site.md create mode 100644 versioned_docs/version-2.10/layouts/templates/theme-template-authors.md create mode 100644 versioned_docs/version-2.10/settings/advanced.md create mode 100644 versioned_docs/version-2.10/settings/blocks.md create mode 100644 versioned_docs/version-2.10/settings/branding.md create mode 100644 versioned_docs/version-2.10/settings/export-import.md create mode 100644 versioned_docs/version-2.10/settings/help-button.md create mode 100644 versioned_docs/version-2.10/settings/icons.md create mode 100644 versioned_docs/version-2.10/settings/import-export-settings.md create mode 100644 versioned_docs/version-2.10/settings/index.md create mode 100644 versioned_docs/version-2.10/settings/layouts-menu.md create mode 100644 versioned_docs/version-2.10/settings/license.md create mode 100644 versioned_docs/version-2.10/settings/modules.md create mode 100644 versioned_docs/version-2.10/settings/post-types.md create mode 100644 versioned_docs/version-2.10/settings/template-exporter.md create mode 100644 versioned_docs/version-2.10/settings/templates.md create mode 100644 versioned_docs/version-2.10/settings/tools.md create mode 100644 versioned_docs/version-2.10/settings/user-access.md create mode 100644 versioned_docs/version-2.10/settings/version-control.md create mode 100644 versioned_docs/version-2.10/settings/welcome.md create mode 100644 versioned_docs/version-2.10/shortcode/find-id-slug.md create mode 100644 versioned_docs/version-2.10/shortcode/index.md create mode 100644 versioned_docs/version-2.10/shortcode/syntax.md create mode 100644 versioned_docs/version-2.10/shortcode/using-css.md create mode 100644 versioned_docs/version-2.10/shortcode/using-php-files.md create mode 100644 versioned_docs/version-2.10/shortcode/using-shortcode.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/403-forbidden-or-blocked-error.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/404-error-when-trying-to-open-editor.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/cloudflare-and-403-errors-when-loading-background-images.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/destination-folder-already-exists.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/dreamhost.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/error-settings-not-saved.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/error-when-trying-to-install-update.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/exceeds-php-max-input-vars.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/http-error-when-uploading-images.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/i-am-getting-a-blank-screen.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/i-cant-upload-the-installer-zip-file-because-it-is-unzipped-when-i-download.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/i-migrated-a-site-but-my-image-urls-didnt-change.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/im-getting-a-permission-denied-error.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/increase-the-wordpress-allowed-memory-size.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/internal-server-500-error.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/require-once.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/the-uploaded-file-exceeds-the-uploadmaxfilesize-directive-in-php-ini.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/title-bar-incorrect.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/use-smtp-to-send-form-notifications.md create mode 100644 versioned_docs/version-2.10/troubleshooting/common-issues/zlib-output-compression.md create mode 100644 versioned_docs/version-2.10/troubleshooting/debugging/cache-clearing-tool.md create mode 100644 versioned_docs/version-2.10/troubleshooting/debugging/enable-beaver-builder-debug-mode.md create mode 100644 versioned_docs/version-2.10/troubleshooting/debugging/issue-fixer-clear-the-cache.md create mode 100644 versioned_docs/version-2.10/troubleshooting/debugging/known-beaver-builder-incompatibilities.md create mode 100644 versioned_docs/version-2.10/troubleshooting/debugging/plugin-conflicts.md create mode 100644 versioned_docs/version-2.10/troubleshooting/debugging/safe-mode.md create mode 100644 versioned_docs/version-2.10/troubleshooting/debugging/theme-conflict.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/background-color-or-image-doesnt-appear.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/beaver-builder-does-not-open-for-editing-on-nginx-servers.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/cant-find-the-beaver-builder-menu-in-the-admin-panel.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/cant-open-page-in-beaver-builder.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/classic-wordpress-and-beaver-builder-text-editor-toolbars-dont-match.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/device-previews-beaver-builder-customizer-and-beyond.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/font-awesome-icons.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/how-beaver-builder-renders-the-title-of-an-image.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/i-cant-drag-and-drop-modules.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/limit-on-adding-rows.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/mailchimp-subscriber-popup-form-breaks-beaver-builder.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/my-custom-column-width-keeps-changing.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/new-slideshow-images-dont-appear-on-siteground-staging-sites.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/reduce-disable-undo-redo-manager.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/subscribe-form-mailchimp-merge-fields-invalid.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/uploaded-icon-set-is-blank.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/why-am-i-seeing-an-eye-icon-in-my-module-toolbar.md create mode 100644 versioned_docs/version-2.10/troubleshooting/miscellaneous/wordpress-admin-bar-is-hidden.md create mode 100644 versioned_docs/version-2.10/troubleshooting/updates-license/beaver-builder-not-working-after-upgrading.md create mode 100644 versioned_docs/version-2.10/troubleshooting/updates-license/manually-reinstall-beaver-builder.md create mode 100644 versioned_docs/version-2.10/troubleshooting/updates-license/not-getting-beaver-builder-updates.md create mode 100644 versioned_docs/version-2.10/troubleshooting/updates-license/uninstall-or-deactivate-the-beaver-builder-plugin.md create mode 100644 versioned_docs/version-2.10/user-interface/cloud.md create mode 100644 versioned_docs/version-2.10/user-interface/content-panel.md create mode 100644 versioned_docs/version-2.10/user-interface/global-settings.md create mode 100644 versioned_docs/version-2.10/user-interface/global-styles.md create mode 100644 versioned_docs/version-2.10/user-interface/index.md create mode 100644 versioned_docs/version-2.10/user-interface/layout-css-js.md create mode 100644 versioned_docs/version-2.10/user-interface/link-values.md create mode 100644 versioned_docs/version-2.10/user-interface/outline-panel.md create mode 100644 versioned_docs/version-2.10/user-interface/overlay.md create mode 100644 versioned_docs/version-2.10/user-interface/settings-window.md create mode 100644 versioned_docs/version-2.10/user-interface/tools-menu-styles.module.css create mode 100644 versioned_docs/version-2.10/user-interface/tools-menu.md create mode 100644 versioned_docs/version-2.10/user-interface/top-bar.md create mode 100644 versioned_sidebars/version-2.10-sidebars.json diff --git a/beaver-themer_versioned_docs/version-1.5/conditional-logic/beaver-themer-conditional-logic.md b/beaver-themer_versioned_docs/version-1.5/conditional-logic/beaver-themer-conditional-logic.md new file mode 100644 index 00000000..91ccc11d --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/conditional-logic/beaver-themer-conditional-logic.md @@ -0,0 +1,225 @@ +--- +id: beaver-themer-conditional-logic +title: Beaver Themer conditional logic +sidebar_label: Beaver Themer conditional logic +description: Conditional logic lets you create rules that determine when to display a Themer layout or a Beaver Builder row, column, or module. +--- + +Beaver Themer's conditional logic feature gives you the power to fine-tune when Themer layouts or parts of Beaver Builder layouts are displayed. + +## The conditional logic if-then statement + +The basic logic is an if-then statement, but with Beaver conditional logic, you only specify the if-expression. The form of the statement is always: + +_If {my expression is true} then display this item_ + +The if-expression can contain both rules and rule groups. Rules in the same group use AND logic, while rules groups use OR logic. See the examples in the following section and more details further below. + +## Where you can apply conditional logic + +You can apply conditional logic in two different locations: + +- In the **Rules** section of the Beaver Themer editing panel: + ![](/img/conditional-logic-themer-edit-panel_800.png) + This screenshot shows the editing panel for a Part layout. In addition to the **Position** and the **Location** of the part, there's a **Rules** section where you can set up a complex conditional logic rule. See the first example in the next section. +- In the **Display** setting on the **Advanced** tab of any row, column, or module in a Beaver Builder layout: + ![](/img/conditional-logic-module_800.png) + +:::info +The **Display** setting is always available in Beaver Builder layouts, but the **Conditional Logic** choice only appears when Beaver Themer is installed. +::: + +There are a huge number of ways that you can use conditional logic, but here are a couple of examples, followed by more details about the rules and lists of choices and comparison operators for the if-expressions. + +## Conditional logic examples + +### Display a Themer layout only when users are Editors + +Suppose you want to display a banner at the top of the page with special instructions to editors when they are logged in, showing how to open a page for editing in Beaver Builder, as in this screenshot: + +![](/img/conditional-logic-themer-editing-banner_800.png) + +This is easy to accomplish with a Part-type Themer layout and conditional logic, following the steps here. + +1. Create a Part-type Themer layout. +2. In the editor panel for the Themer layout, set **Position** to **Before header**. +3. Set **Location** to **Page > All pages**. +4. In the **Rules** section, create a rule for **User Role** **equals** **Editor**, as shown in the following screenshot. + ![](/img/conditional-logic-themer-banner-setup_800.png) +5. Click **Update** to save the edits. + +In other words, this banner will display above the header whenever the user is logged into the site with the role of Editor. + +### Display a button only when a specific ACF custom field has a value + +Suppose you have created an Advanced Custom Fields (ACF) field for posts so that you can display the company title below the Author's name in the post title row. But company title is not a required field, and you want to display the row or column containing it only when the company title field has a value. For example, here's a screenshot of a post that has the company title in a column group below the author name: + +![](/img/beaver-themer-conditional-logic-74fe4598.jpg) + +And here's the same page when the ACF field is blank: + +![](/img/beaver-themer-conditional-logic-2f30569a.jpg) + +While the difference is subtle, the column group containing the custom field for company title is no longer displayed, and the rest of the text has recentered vertically. The need to hide a row is much more obvious in the following case, where the lack of the custom field value would leave an empty blue band. + +![](/img/beaver-themer-conditional-logic-9cd20ed7.png) + +The solution is to set a normal field connection to the custom field in the module and then add conditional logic to the row or column containing it to display the row or column only when the custom field value exists. Here's how. + +:::info +With this procedure, if you have any other content in the row or column in addition to the custom field, it will also be hidden when the custom field has no value. Plan your rows, columns, and modules so you'll be showing and hiding what you want. +::: + +**To hide a row or column containing an ACF custom field that doesn't have a value:** + +1. Create a module to display your ACF custom field. + For example, add a Heading module, and in the **Heading** field, add a field connection to the ACF field. +2. Open the settings for the row or column containing that module and go to the **Advanced** tab. +3. Go to the **Visibility** section, and in the **Display** field, choose **Conditional logic**, then click **Open Conditional logic settings.** +4. Click **Choose**, scroll down to the **Advanced Custom Fields** section, and choose **ACF post field**. +5. In the second column, enter the field name of your custom field. +6. In the third column, scroll down and choose **is set**. + This means that this row or column will display when this custom field has a value. +7. Click **Save**. + +## Conditional logic details + +### Rules and rule groups + +You can add one or more rules to form a rule group. You can add as many rule groups as you want. Rules operate with AND logic. Rule groups operate with OR logic. + +For example, you could have two rule groups with two rules each for the following conditions: + +> Display this module if a particular ACF custom field isn't empty AND the post category is "news" +> OR +> Display this module if a particular ACF custom field isn't empty AND the post category is "events" + +#### Bulk Options + +Bulk options are available for the conditional logic for nodes (rows, columns, modules) and allow you to quickly duplicate or delete rules, saving valuable time. This is especially useful when you need to create a similar rule with only minor differences; you can duplicate an existing rule and then modify the condition to your preference, rather than creating a new rule from scratch. + +:::tip + +Bulk options become available only when you have more than one rule and are limited to individual rule groups, meaning you can only duplicate or delete rules within the same group. You cannot apply bulk actions across different rule groups. + +::: + +### Comparison operators + +You can set rules for various aspects of posts, archives, authors, users, and ACF custom fields. The items you choose for the rule determine which comparison operators are available. For example, **Post title**, **Post excerpt**, **Post featured image** have some or all of the following comparison operators: + +- **is set** or **exists**, **is not set** or **doesn't exist** + Used to show or hide rows, columns, or modules if the value is set (such as a featured image) or exists (such as a custom field) +- **equals** or **does not equal**, **starts with**, **ends with**, **contains**, **doesn't contain** + Used to evaluate text values for a particular item. + +### Conditional logic for Themer layouts + +The conditional logic selections that appear in Themer layouts depend on the type of layout. In most cases, you can select not only logged-in vs. logged-out and user status, but also user properties such as user role, user capability, or even a specific username, as shown in the following screenshot. + +![](/img/beaver-themer-conditional-logic-60a0bbc2.png) + +In Singular-type Themer layouts, you can also set conditions that control whether layouts appear depending on the value or status of items in the post, as shown in this screenshot. + +![](/img/beaver-themer-conditional-logic-fc83f077.png) + +In Archive-type layouts, you can set conditions based on the archive properties of title, description, or meta, as shown in the following screenshot. + +![](/img/beaver-themer-conditional-logic-8d1c438d.png) + +### Visibility setting for rows, columns, and modules + +In a standard Beaver Builder layout without Beaver Themer activated, there's a **Display** field on the **Advanced** tab where you can choose to display the module **Never**, only to logged-out users, or only to logged-in users, as shown in this screenshot. The default display choice is **Always**. + +![](/img/beaver-themer-conditional-logic-ab689e66.png) + +With Beaver Themer installed, in either a standard Beaver Builder layout or a Themer layout, the Display field has an additional **Conditional Logic** choice, as you can see in this screenshot. + +![](/img/beaver-themer-conditional-logic-dbd8a972.png) + +The rules you set there determine the conditions under which the row, column, or module is visible. + +:::info +You can use conditional logic in any Beaver Builder layout, but conditional logic is only available when Beaver Themer is installed. +::: + +### Conditional logic categories + +Rows, columns, and modules have the following conditional logic selections for rules. + +#### Posts + +- Post +- Post parent +- Post type +- Post title +- Post excerpt +- Post content +- Post featured image +- Post comments number +- Post template +- Post taxonomy term +- Post status +- Post custom field + +#### Archive + +- Archive +- Archive title +- Archive description +- Archive taxonomy term +- Archive term meta + +#### Author + +- Author +- Author bio +- Author meta +- Author login status + +#### User + +- User +- User bio +- User meta +- User login status +- User role +- User capability +- User registered + +#### Browser + +- Cookie + You can base the visibility on a particular key in your cookie. +- Referer + **Referer** means the page that contains a link that the user follows to get to the page containing the conditional logic, such as a link from the layout or a menu link. [Here's some more information about HTTP Referers.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer) + **Note:** This misspelling of `referer` is built into WordPress. +- URL variable + +### 3rd party integrations + +The following conditional rules appear when the following third-party plugins are installed. + +#### WooCommerce + +- Customer products purchased +- Customer first ordered +- Customer last ordered +- Customer total orders +- Customer total products +- Customer total spent +- Customer billing address +- Customer shipping address +- Cart +- Cart products +- Cart total + +#### Advanced Custom Fields + +These choices refer to the source or destination of the ACF field on your site. For more information, see [the article about ACF field connections](../integrations/acf/index.md). + +- ACF Archive field +- ACF Post field +- ACF Post Author field +- ACF User field +- ACF Option field diff --git a/beaver-themer_versioned_docs/version-1.5/developer/add-custom-attributes-to-themer-layouts.md b/beaver-themer_versioned_docs/version-1.5/developer/add-custom-attributes-to-themer-layouts.md new file mode 100644 index 00000000..5d0d3e10 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/developer/add-custom-attributes-to-themer-layouts.md @@ -0,0 +1,42 @@ +--- +id: add-custom-attributes-to-themer-layouts +title: Add custom attributes to Beaver Themer layouts +sidebar_label: Add custom attributes to Beaver Themer layouts +--- + +You can easily add custom attributes when you need them for your Beaver Themer layouts. +The code example below uses the `fl_render_content_by_id_attrs` filter to add the attribute(s) to your Beaver Themer layout whose ID you have specified in the code. This example will add an attribute of `role` with a value of `banner`. This is useful for [Header Layout Types](/beaver-themer/layout-types-modules/header-layout-type/themer-header-layout-type.md). + +The code example below uses an ID of `2168` this is the ID of your Beaver Themer layout. To get the ID, copy the post number from the URL in your browser’s address bar, as shown in this screenshot. + +![](/img/how-to-tips-get-slug-id-shortcode-2.jpg) + +Substitute your own attribute name and value and your Themer layout ID in the code and place the code in +the _functions.php_ file of your child theme. + +```php +add_filter( 'fl_render_content_by_id_attrs', function( $attrs, $post_id ) { + + if ( '2168' === $post_id ) { + $attrs['role'] = 'banner'; + } + + return $attrs; + +}, 10, 2 ); +``` + +This example demonstrates how to use the filter to add multiple attributes to a Themer layout. + +```php +add_filter( 'fl_render_content_by_id_attrs', function( $attrs, $post_id ) { + + if ( '2168' === $post_id ) { + $attrs['role'] = 'banner'; + $attrs['data-foo'] = 'bar'; + } + + return $attrs; + +}, 10, 2 ); +``` \ No newline at end of file diff --git a/beaver-themer_versioned_docs/version-1.5/developer/add-themer-support.md b/beaver-themer_versioned_docs/version-1.5/developer/add-themer-support.md new file mode 100644 index 00000000..74263f38 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/developer/add-themer-support.md @@ -0,0 +1,110 @@ +--- +id: add-themer-support +title: Add Themer Support +sidebar_label: Add Themer Support +--- + +Most themes support Archive, Singular, and 404 layout types out of the box. However, to support the Header, Footer, and Part layout types, the theme must allow its header, footer, and parts to be removed using hooks. + +See the [list of themes that are currently supported](/beaver-themer/developer/add-themer-support). If your theme isn't currently supported, you can add support for headers, footers, and parts by following the instructions below. + +## Add Header & Footer Support + +There are other ways than using hooks to remove the theme's headers and footers, but using hooks is the easiest and cleanest. For example, in Genesis you can remove the header with the following code. + +```php +remove_action( 'genesis_header', 'genesis_do_header' ); +``` + +If your theme's header and footer can be removed with hooks, the first step to providing support for Beaver Themer is by declaring it on the `after_setup_theme` action in your _functions.php_ file: + +```php +add_action( 'after_setup_theme', 'my_theme_header_footer_support' ); + +function my_theme_header_footer_support() { + add_theme_support( 'fl-theme-builder-headers' ); + add_theme_support( 'fl-theme-builder-footers' ); +} +``` + +The next step varies from theme to theme, but the general idea is to check to see if a header or footer exists for the current page. If it does, remove the theme's default header or footer and add an action to render the header or footer built by Beaver Themer. Here's what the code looks like to do that for Genesis: + +```php +add_action( 'wp', 'my_theme_header_footer_render' ); + +function my_theme_header_footer_render() { + // Get the header ID. + $header_ids = FLThemeBuilderLayoutData::get_current_page_header_ids(); + + // If we have a header, remove the theme header and hook in Beaver Themer' + if ( ! empty( $header_ids ) ) { + remove_action( 'genesis_header', 'genesis_do_header' ); + add_action( 'genesis_header', 'FLThemeBuilderLayoutRenderer::render_header' ); + } + + // Get the footer ID. + $footer_ids = FLThemeBuilderLayoutData::get_current_page_footer_ids(); + + // If we have a footer, remove the theme footer and hook in Beaver Themer. + if ( ! empty( $footer_ids ) ) { + remove_action( 'genesis_footer', 'genesis_do_footer' ); + add_action( 'genesis_footer', 'FLThemeBuilderLayoutRenderer::render_footer' ); + } +} +``` + +:::tip + +If you're interested in an object-oriented approach to theme support, check out how we implemented Genesis support in the _extensions/themes/class-fl-theme-builder-support-genesis.php_ file. + +::: + +## Add Parts Support + +Theme parts are references to actions in your theme that a layout can be hooked into. For example, if your theme has a `before_header` action, you can register that so Part layout types can be rendered there. + +Adding support for part layout types is basically the same as adding support for headers and footers layout types. In fact, you can declare support for headers, footers, and parts at the same time: + +```php +add_action( 'after_setup_theme', 'my_theme_header_footer_support' ); + +function my_theme_header_footer_support() { + add_theme_support( 'fl-theme-builder-headers' ); + add_theme_support( 'fl-theme-builder-footers' ); + add_theme_support( 'fl-theme-builder-parts' ); +} +``` + +After you've declared support for parts, you can use the `fl_theme_builder_part_hooks` filter to register your parts. The function for your filter should return an array of arrays for each group of parts, as shown below. Within the hooks array, set your actions to the array key, and set the human-readable label to the array value. + +Here's an example of what that would look like for Genesis: + +```php +add_filter( 'fl_theme_builder_part_hooks', 'my_theme_register_part_hooks' ); + +function my_theme_register_part_hooks() { + return array( + array( + 'label' => 'Header', + 'hooks' => array( + 'genesis_before_header' => 'Before Header', + 'genesis_after_header' => 'After Header', + ) + ), + array( + 'label' => 'Content', + 'hooks' => array( + 'genesis_before_content' => 'Before Content', + 'genesis_after_content' => 'After Content', + ) + ), + array( + 'label' => 'Footer', + 'hooks' => array( + 'genesis_before_footer' => 'Before Footer', + 'genesis_after_footer' => 'After Footer', + ) + ) + ); +} +``` diff --git a/beaver-themer_versioned_docs/version-1.5/developer/conditional-logic-apis.md b/beaver-themer_versioned_docs/version-1.5/developer/conditional-logic-apis.md new file mode 100644 index 00000000..034649e9 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/developer/conditional-logic-apis.md @@ -0,0 +1,628 @@ +--- +id: conditional-logic-apis +title: Conditional Logic APIs +sidebar_label: Conditional Logic APIs +--- + +This document covers APIs for writing custom rules for the Beaver Themer conditional logic feature in third-party plugins. + +:::info + +- Add these rules via a plugin as `bb_logic_init` is fired during the `plugins_loaded` WordPress action, which occurs before the theme is loaded. + +- Beaver Themer’s conditional logic feature does not currently support dynamic rules that are specific to each unique visitor of your website, such as cookies and geotargeting. Caching prevents those rules from working, because a single cached copy of the page is returned and cannot be modified using conditional logic. In the future, we will be working on making dynamic rules possible with caching. + +::: + +## What is a rule? + +A rule is a set of data edited by a simple form and evaluated into a true or false boolean value to decide if a particular action should happen or not. For example, in Beaver Builder we use conditional logic to decide if a piece of content should render. In Beaver Themer we use conditional logic to decide if entire layouts should render. The following screenshot shows an example of a conditional rule form in the Beaver Themer UI. + +![](/img/conditional-logic-apis-50280878.png) + +## Add a Custom Rule + +There are two steps to adding a custom rule: + +- Frontend rule registration in JavaScript +- Server-side rule processing in PHP. + +You can follow along by [downloading the example plugin here](https://www.wpbeaverbuilder.com/downloads/beaver-themer-example-rules.zip). + +### 1. Frontend Rule Registration + +1. Create a new JavaScript file in your plugin. + In this example, a file called _rules.js_ in the example plugin is created and enqueued on the `bb_logic_enqueue_scripts` action, as follows. + +```php +add_action( 'bb_logic_enqueue_scripts', function() { + wp_enqueue_script( + 'bb-logic-example-rules', + BB_LOGIC_EXAMPLE_URL . 'js/rules.js', + array( 'bb-logic-core' ), + '1.0', + true + ); +} ); +``` + +2. Add a new rule type in your _rules.js_ file using the `BBLogic.api.addRuleType` function. + The following example shows a rule created to match the number of posts the current user has authored. See the section below on the Frontend API for more information about using the functions in the API object `BBLogic` for creating new rule types. + +```javascript +// Frontend rule registration step2 +var addRuleType = BBLogic.api.addRuleType; +var __ = BBLogic.i18n.__; + +addRuleType("bb-logic-example/user-post-count", { + label: __("User Post Count"), + category: "user", + form: { + operator: { + type: "operator", + operators: [ + "equals", + "does_not_equal", + "is_less_than", + "is_greater_than", + ], + }, + count: { + type: "number", + defaultValue: "0", + }, + }, +}); +``` + +### 2. Server-side rule processing + +1. Create a new PHP file in your plugin. In this example, a file called _rules.php_ in the example plugin is included on the `bb_logic_init` action. + +```php +add_action( 'bb_logic_init', function() { + require_once BB_LOGIC_EXAMPLE_DIR . 'includes/rules.php'; +} ); +``` + +2. Register a callback function for processing your rule using `BB_Logic_Rules::register`. + See the section below on the backend API for more information about using the `BB_Logic_Rules` methods for processing rules. + +```php +BB_Logic_Rules::register( array( + 'bb-logic-example/user-post-count' => 'bb_logic_example_user_post_count', +) ); + +function bb_logic_example_user_post_count( $rule ) { + $user = wp_get_current_user(); + return BB_Logic_Rules::evaluate_rule( array( + 'value' => count_user_posts( $user->ID ), + 'operator' => $rule->operator, + 'compare' => $rule->count, + ) ); +} +``` + +That’s it! You’ve successfully created your first rule. + +## Frontend API + +To make it easy to work with the rules API, there's an object on the global window object called `BBLogic`. That object provides the following functions for your convenience. + +### BBLogic.api + +This API object contains the following functions for working with rules and rule categories. This is the main object you'll use to create new rule types. + +#### addRuleType( id, props ) + +Adds a new rule to the conditional logic form. It accepts two arguments: a rule ID and a `props` configuration object. + +**id** string +A unique value assigned to each rule. The value should follow the format of _namespace_ / _rule_ , where namespace is the name of your plugin, theme, or other identifying information. For example, if my company name was Acme Co. and my rule was for movies, my rule I would be `acme-co/movies`. + +**props** object +The required properties that must be defined on the `props` object for a rule to be added. + +- **label** string + The human-readable label for each rule that is shown in the conditional logic form. + +- **category** string + The ID of a registered rule category. See the `addRuleTypeCategory` function for information about adding custom rule categories. + +- **form** object | function + Specifies the conditional logic form field config for a rule. Each property on the `form` object must be the key for a field as well as an object for the field’s config. This is similar to but much simpler than Beaver Builder’s module form API, written in JavaScript. See the Form Field API section below for details about each type of field that you can register. + +Examples of `addRuleType()`: + +```js +// Example of BBLogic.api.addRuleType() +BBLogic.api.addRuleType("my-plugin/my-rule", { + label: BBLogic.i18n.__("My Rule"), + category: "my-category", + form: { + operator: { + type: "operator", + operators: ["equals", "does_not_equal"], + }, + compare: { + type: "text", + }, + }, +}); +``` + +The `form` property may also be a function that returns a form config object, as described above. That function receives an object with the current form’s data, which is useful for modifying your form config based on user input, as in the following example. + +```php +// Example of BBLogic.api.addRuleType() +BBLogic.api.addRuleType( 'my-plugin/my-rule', { + label: BBLogic.i18n.__( 'My Rule' ), + category: 'my-category', + form: function( props ) { + var operator = props.rule.operator + return { + operator: { + type: 'operator', + operators: [ + 'equals', + 'does_not_equal', + 'is_set', + 'is_not_set', + ], + }, + compare: { + type: 'text', + visible: 'is_set' !== operator || 'is_not_set' !== operator, + }, + } + }, +} ) +``` + +The `form` property can also be populated by using the `getFormPreset` function. That function lets you utilize common form configurations without having to define them yourself. See the `getFormPreset` function for more info on how that works. + +```php +// Example of BBLogic.api.addRuleType() +BBLogic.api.addRuleType( 'my-plugin/my-rule', { + label: BBLogic.i18n.__( 'My Rule' ), + category: 'my-category', + form: BBLogic.api.getFormPreset( 'string' ), +} ) +``` + +#### removeRuleType( id ) + +Removes a registered rule type with the provided ID. This must be called after the rule has been added. Calling it before will have no effect. + +**id** string +The ID of the rule to remove. + +Example of `removeRuleType()`: + +```php +BBLogic.api.removeRuleType( 'my-plugin/my-rule' ) +``` + +#### addRuleTypeCategory( id, props ) + +The `addRuleTypeCategory` function allows you to add a new rule category to the conditional logic form. It accepts two arguments, a rule category `id` and a `props` configuration object. + +**id** string +A value assigned to that must be unique and cannot be defined for another category. + +**props** object +The required properties that must be defined on the `props` object for a category. + +- **label** string + The human-readable label for each category that is shown in the conditional logic form. + +Example of `addRuleTypeCategory()`: + +```php +// Example of BBLogic.api.addRuleTypeCategory() +BBLogic.api.addRuleTypeCategory( 'my-category', { + label: BBLogic.i18n.__( 'My Category' ) +} ) +``` + +#### getFormPreset( id ) + +Defines the form value of the `props` object for the `addRuleType` function. This function lets you utilize common form configurations without having to define them yourself. + +**id** string +The ID for the form preset. The following form presets are currently available as `id` values. + +- **address** \- for matching the various parts of an address +- **date** \- for matching complex date rules such as on, over, before or after +- **key-value** \- for matching key/value pairs +- **number** \- for matching a specific number +- **string** \- for matching a specific string + +Example of `getFormPreset()`: + +```php +BBLogic.api.getFormPreset( 'string' ) +``` + +### BBLogic.i18n + +The i18n object contains methods for making your rules available for translation. + +#### `__( string )` + +Makes a string available for translation. + +**string** string +The string to make available for translation. + +Example of `BBLogic.i18n`: + +```php +BBLogic.i18n.__( 'My Label' ) +``` + +## Form Field API + +The form field API provides a basic set of fields that you can register for your rule forms when calling `BBLogic.api.addRuleType`. + +### date + +A text input that displays a date picker when focused. + +```js +// A text input that displays a date picker when focused. +my_date: { + type: 'date', +}, +``` + +### datetime + +A text input that displays a date and time picker when focused. + +```js +// A text input that displays a date and time picker when focused. +my_datetime: { + type: 'datetime', +}, +``` + +### number + +An input for entering a number. + +```js +// An input for entering a number. +my_number: { + type: 'number', + defaultValue: 0, + placeholder: '0', +}, +``` + +### operator + +A select input for picking one of the provided core operators for your rules. + +Instead of using the `operator` field, you can create a select field with custom operators. However, the `operator` field provides common operators that can be used with the `evaluate_rule` method on the server side, saving you the hassle of having to write that logic yourself. + +Here’s the complete list of operators. Include only the ones needed for your rule. + +```js +// Complete list of operators. +my_operator: { + type: 'operator', + operators: [ + 'equals', + 'does not equal', + 'is less than', + 'is less than or equal to', + 'is greater than', + 'is greater than or equal to', + 'starts with', + 'ends with', + 'contains', + 'does not contain', + 'include', + 'includes', + 'do not include', + 'does not include', + 'is set', + 'is not set', + 'is empty', + 'is not empty', + 'on', + 'is on', + 'not on', + 'is not on', + 'before', + 'is before', + 'on or before', + 'is on or before', + 'after', + 'is after', + 'on or after', + 'is on or after', + 'within', + 'is within', + 'not within', + 'is not within', + 'between', + 'is between', + 'not between', + 'is not between', + 'in the past', + 'over', + ], +}, +``` + +### select + +A select input for picking one of the provided values. + +```js +// A select input for picking one of the provided values. +my_select: { + type: 'select', + options: [ + { + label: 'Option 1', + value: '1', + }, + { + label: 'Option 2', + value: '2', + }, + ] +}, +``` + +In addition to providing an array of predefined options, you can also specify a REST API route that will request the options from the server. This is useful when you need dynamically generated options such as the taxonomies available on a site. See the REST API Routes section for more information about the core routes that are available. + +```js +// Example of specifying a REST API route that will +// dynamically generate form options from the server. +my_select: { + type: 'select', + route: 'bb-logic/v1/wordpress/taxonomies', +}, +``` + +You can also use a function to define your form and modify the route based on user input. For example, you can change the route form terms based on the selected taxonomy, as in the following example. + +```js +// Example of modifying the REST API route based on user input. +form: function( props ) { + var taxonomy = props.rule.taxonomy + return { + operator: { + type: 'operator', + operators: [ + 'equals', + 'does_not_equal', + ], + }, + taxonomy: { + type: 'select', + route: 'bb-logic/v1/wordpress/taxonomies', + }, + term: { + type: 'select', + route: taxonomy ? 'bb-logic/v1/wordpress/terms?taxonomy=' + taxonomy : null, + visible: taxonomy, + }, + } +}, +``` + +### suggest + +A text input that shows a list of suggestions based on the text that was entered. Suggestions are populated using a REST API route as shown in the following example. + +```js +// A text input that shows a list of suggestions based on the text that was entered. +username: { + type: 'suggest', + placeholder: 'Username', + route: 'bb-logic/v1/wordpress/users?suggest={search}', +}, +``` + +:::info +The `{search}` string will be replaced with the user’s current search string. +::: + +### text + +An input for entering text. + +```js +// An input for entering text. +my_text: { + type: 'text', + defaultValue: 'My Text', + placeholder: 'My Text', +}, + +``` + +### time + +A text input that displays a time picker when focused. + +```js +// A text input that displays a time picker when focused. +my_time: { + type: 'time', +}, +``` + +## Form Field Visibility + +Using the **visible** property on a field’s configuration object lets you determine if a field should be visible to the user or not. This is useful when you have rules that require an additional field that should only be visible when other fields have a specific value. For example, below we are showing that the `compare` field is only visible when the operator field does not equal `is_set`. + +```js +// Example showing that the compare field is only visible when +// the operator field does not equal is_set. +form: function( props ) { + var operator = props.rule.operator + return { + key: { + type: 'text', + placeholder: 'Key', + }, + operator: { + type: 'operator', + operators: [ + 'equals', + 'does_not_equal', + 'is_set', + ], + }, + compare: { + type: 'text', + placeholder: 'Value', + visible: 'is_set' !== operator, + }, + } +} +``` + +## Backend API + +While the frontend APIs deal with registering rules, the backend APIs primarily deal with processing rules. + +### BB_Logic_Rules::register( $rules ) + +This method registers an array of rule callback functions that will be called to evaluate each instance of a rule. + +The callback function receives a rule object (shown below) that contains all of the data from the rule form that was registered on the frontend. You must use that data to decide whether a rule callback function should return true or false. That is typically done with the `evaluate_rule` method, but it doesn’t have to be. You can use any custom logic you want with the provided rule data to decide whether a callback function should return true or false for a rule. + +**$rules** array +An array of rule callback functions to register. The key is the rule ID and the value is the callback function. + +Example of `BB_Logic_Rules::register()`: + +```js +// Example of BB_Logic_Rules::register() +BB_Logic_Rules::register( array( + 'my-plugin/my-rule' => 'my_plugin_rule_callback', +) ); + +function my_plugin_rule_callback( $rule ) { + return BB_Logic_Rules::evaluate_rule( array( + 'value' => 'my-value', + 'operator' => $rule->operator, + 'compare' => $rule->compare, + ) ); +} +``` + +### BB_Logic_Rules::evaluate_rule( $data ) + +Helper method that helps to decide whether a rule is true or false. This method is not required to evaluate a rule. Any custom logic that returns true or false based on rule data will do. However, this method provides logic for common operations such as equals, does not equal, greater than or less than, and it can save you the hassle of having to write that logic yourself. + +**$data** array +An array of rule data that will be evaluated as either true or false. + +- **value** mixed + A value to test other data (such as compare) against. +- **operator** string + A registered core operator string from the operator field such as equals, does_not_equal, starts_with or ends_with. +- **compare** mixed (optional) + Used to compare against the provided value. This is only required for operators that use a compare value such as `equals` or `does_not_equal`. Operators such as `is_set` or `is_empty` do not require a compare value. +- **isset** boolean (optional) + Used for the `is_set` and `is_not_set` operators to check if a value is set or not. +- **start** integer (optional) + Used as the start value for `within`, `not_within`, `between` or `not_between` operators to check if an integer is within a range or not. +- **end** integer (optional) + Used as the end value for `within`, `not_within`, `between` or `not_between` operators to check if an integer is within a range or not. + +Example of `BB_Logic_Rules::evaluate_rule`: + +```js +// Example of BB_Logic_Rules::evaluate_rule to help decide whether a rule is true or false +BB_Logic_Rules::evaluate_rule( array( + 'value' => 'my-value', + 'operator' => $rule->operator, + 'compare' => $rule->compare, + 'isset' => isset( $my_var ), + 'start' => strtotime( $my_date ), + 'end' => strtotime( $my_date ), +) ); +``` + +## REST API Routes + +The core REST API Routes are available for populating your fields with data for the user to choose from. If one of these routes doesn’t fit your needs, you can create a custom route for your fields. + +**Archives** +Returns an array of `select` options for selecting a type of archive. + +```js +bb - logic / v1 / wordpress / archives; +``` + +**Capabilities** +Returns an array of `select` options for selecting a user capability. + +```js +bb - logic / v1 / wordpress / capabilities; +``` + +**Posts** +Returns an array of `select` options for selecting a post. + +```js +bb-logic/v1/wordpress/posts?post_type= +``` + +**Post Stati** +Returns an array of `select` options for selecting a post status. + +```js +bb - logic / v1 / wordpress / post - stati; +``` + +**Post Templates** +Returns an array of `select` options for selecting a post template. + +```js +bb - logic / v1 / wordpress / post - templates; +``` + +**Post Types** +Returns an array of `select` options for selecting a post type. + +```js +bb - logic / v1 / wordpress / post - types; +``` + +**Roles** +Returns an array of `select` options for selecting a user role. + +```js +bb - logic / v1 / wordpress / roles; +``` + +**Taxonomies** +Returns an array of `select` options for selecting a taxonomy. + +```js +bb - logic / v1 / wordpress / taxonomies; +``` + +**Terms** +Returns an array of `select` options for selecting a taxonomy term. + +```js +bb-logic/v1/wordpress/terms?taxonomy= +``` + +**User** +Returns an array of `suggest` options for selecting a username. + +``` +bb-logic/v1/wordpress/users?suggest= +``` diff --git a/beaver-themer_versioned_docs/version-1.5/developer/customize-field-connections-themer.md b/beaver-themer_versioned_docs/version-1.5/developer/customize-field-connections-themer.md new file mode 100644 index 00000000..067da3b4 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/developer/customize-field-connections-themer.md @@ -0,0 +1,173 @@ +--- +id: customize-field-connections-themer +title: Customize field connections +sidebar_label: Customize field connections +--- + +There are several ways to customize field connections: + +* Add custom connections to the field connections menu +* Create a custom settings form for field connections +* Add a new group to organize field connections displayed in the connections menu +* Add support for field connections to your module fields + +## Add New Connections + +You can use the APIs to add custom connections to the field connections menu in order to connect any kind of data you want. + +There are three main methods for adding new connections: + +* `FLPageData::add_post_property( $key, $config )` +Adds a connection related to posts. + +* `FLPageData::add_archive_property( $key, $config )` +Adds a connection related to archives. + +* `FLPageData::add_site_property( $key, $config )` +Adds a connection related to the site. + +Use these methods to add your connections within the `fl_page_data_add_properties` action. Each method accepts a key for your connection and a config array. + +:::caution +Be sure to namespace the key for your connection in order to avoid possible collisions with other custom connections. For example, if your connection is called Post Title, the key should be `my_namespace_post_title`, where *my_namespace* is your custom namespace. +::: + +The following code example shows the method `FLPageData::add_post_property()` used within the `fl_page_data_add_properties` action. + +```php +add_action( 'fl_page_data_add_properties', function() { + + FLPageData::add_post_property( 'my_connection', array( + 'label' => 'My Connection', + 'group' => 'general', + 'type' => 'string', + 'getter' => 'my_connection_getter', + ) ); +} ); + +function my_connection_getter() { + return 'My text'; +} +``` + +The config array accepts the following properties: + +**label (required)** + The label for your connection that will show in the menu. + +**group (required)** + The group you want your connection to appear in. Currently, the following groups are built in (array key values in parentheses): + +* General (`general`) +* Archives (`archives`) +* Posts (`posts`) +* Comments (`comments`) +* Author (`author`) +* User (`user`) +* Site (`site`) +* Advanced (`advanced`) +* Advanced Custom Fields (`acf`) +* BigCommerce (`bigcommerce`) +* Easy Digital Downloads (`edd`) +* The Events Calendar (`the-events-calendar`) +* WooCommerce (`woocommerce`) + +See the section below to [add custom groups](customize-field-connections-themer.md/#adding-custom-groups). + +**type (required)** +The type of connection. Use this when you connect a field to indicate what type of connections are available. For example, when you add a text field to a settings form, you can indicate that all of the string and HTML-based connections are available. + +You can set the type to anything you want. However, we recommend that you stick with the built-in connection types if you want your connections to appear in built-in modules. Currently, the following connection types are built in: + +* color +* string +* html +* photo +* multiple-photos +* url +* custom_field + +**getter (required)** +A reference to a function or class method that is used to retrieve the data for your connection. + +## Add a Settings Form + +Creating custom forms for field connections is very similar to [creating custom modules](/beaver-builder/developer/custom-modules). There are three main methods for adding settings, the choice of which depends on the type of connection: + +* `FLPageData::add_post_property_settings_fields( $key, $config )` +Adds settings to a post connection. + +* `FLPageData::add_archive_property_settings_fields( $key, $config )` +Adds settings to a archive connection. + +* `FLPageData::add_site_property_settings_fields( $key, $config )` +Adds settings to a site connection. + +Each method accepts a key for your form and a config array. + +:::caution +Be sure to namespace the key for your form in order to avoid possible collisions with other forms. For example, if your form is for the post title, the key should be `my_namespace_post_title_form`, where *my_namespace* is your custom namespace. +::: + +The following code example shows the use of the method that adds settings to a post connection. + +```php +FLPageData::add_post_property_settings_fields( 'my_connection', array( + 'css' => 'https://www.mysite.com/path-to-settings.css', + 'js' => 'https://www.mysite.com/path-to-settings.js', + 'my_setting' => array( + 'type' => 'text', + 'label' => 'My Setting' + ) +) ); +``` + +The config array for adding settings should have field config as discussed in the [custom module documentation](/beaver-builder/developer/custom-modules). It can also have a `css` and `js` property for defining CSS and JavaScript files that should be loaded along with your settings. + +See also the Beaver Builder Plugin article about [customizing settings forms](/beaver-builder/developer/tutorials-guides/customize-settings-forms). + +## Adding Custom Groups + +You can add a group to the list of field connections. In the following screenshot, **Posts**, **Author**, and **User** are groups that organize the field connections. + +![](/img/beaver-themer/developer--field-connection-api--1.jpg) + +To add a new group, use the `FLPageData::add_group( $key, $config )` method, as shown in the following example: + +```php +FLPageData::add_group( 'my_group', array( + 'label' => 'My Group' +) ); +``` + +## Connect Module Fields + +You can add support for field connections to your module fields by defining what kind of connections they should support. Use the `connections` property in the field config. The following code example shows how you would add support for all connections registered as strings: + +```php +'text' => array( + 'type' => 'text', + 'label' => 'My Text Field', + 'connections' => array( 'string' ) +) +``` + +You can support multiple connection types: + +```php +'text' => array( + 'type' => 'text', + 'label' => 'My Text Field', + 'connections' => array( 'string', 'html', 'url' ) +) +``` + +See the type section above for the list of built-in field types. + +You can simply declare support for connections in your field config, and the rest is taken care of. In your module's _frontend.php_ file, you can access all of your settings on the `$settings` object, just as you normally would, whether they are connected or not. For example, if your setting key is `text`, you would still access it like this: + +```php +text; +``` diff --git a/beaver-themer_versioned_docs/version-1.5/developer/customize-themer-modules.md b/beaver-themer_versioned_docs/version-1.5/developer/customize-themer-modules.md new file mode 100644 index 00000000..dceb0b33 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/developer/customize-themer-modules.md @@ -0,0 +1,33 @@ +--- +id: customize-themer-modules +title: Customize Themer modules +sidebar_label: Customize Themer modules +--- + +Beaver Themer includes a set of modules designed specifically for Themer layouts, such as the Post Navigation module used in Singular layout types. You can modify or extend the functionality of these Themer-specific modules by overriding them. + +The process is the same as [overriding regular Beaver Builder modules](/beaver-builder/developer/custom-modules/override-modules). Simply create a `/fl-builder` directory in your child theme, then add a `/modules` directory inside it. From there, copy the module folder you want to override from the Beaver Themer plugin `/bb-theme-builder/modules/` into the `/modules` directory, as shown in the example below: + +```bash +/bb-theme-child +├── /fl-builder +│ └── /modules +│ └── /fl-post-navigation +├── functions.php +└── style.css +``` + +:::info + +Beaver Themer includes a mix of regular modules and a special type of module called module aliases. Unfortunately, module aliases cannot be overridden. You can use the list below to identify which modules are aliases: + +- Archive Title +- Attached Images +- Featured Image +- Post Gallery +- Post Columns +- Post List +- Post Masonry +- Post Title + +::: diff --git a/beaver-themer_versioned_docs/version-1.5/developer/hide-node-when-field-connection-is-empty.md b/beaver-themer_versioned_docs/version-1.5/developer/hide-node-when-field-connection-is-empty.md new file mode 100644 index 00000000..d7165a88 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/developer/hide-node-when-field-connection-is-empty.md @@ -0,0 +1,104 @@ +--- +id: hide-node-when-field-connection-is-empty +title: Hide Node when a Field Connection is Empty +sidebar_label: Hide Node when Field Connection is Empty +--- + +There may be times when you don't want entire rows or modules to show up when a field connection is empty. + +:::tip + +If you don't need to hide entire rows or modules, you can use conditional shortcodes instead of PHP code to [display field connections only when they return content](/beaver-themer/field-connections/conditionals/). + +::: + +You can use the following code to hide rows or modules that have empty field connections. Add it to your child theme's _functions.php_ file. + +:::info + +This code is just a starting point and will not work in every situation. Use your knowledge of PHP to extend this code, using the `$node` variable to choose which rows, columns or modules are hidden based on a number of circumstances such as `$node->type` or `$node->settings`. + +::: + +```php +add_filter( 'fl_builder_is_node_visible', function ( $is_visible, $node ) { + if ( isset( $node->settings->connections ) ) { + foreach ( $node->settings->connections as $key => $connection ) { + if ( ! empty( $connection ) && empty( $node->settings->$key ) ) { + return false; + } + } + } + return $is_visible; +}, 10, 2 ); +``` + +## Hide Row + +The example below removes a row if row has a [class](/beaver-builder/layouts/advanced-tab/html-element#class) of `my-target-row`. + +```php +add_filter( 'fl_builder_is_node_visible', function ( $is_visible, $node ) { + if ( 'row' === $node->type ) { + if ( ! empty( $node->settings->class ) && false !== strpos( $node->settings->class, 'my-target-row' ) ) { + return false; + } + } + return $is_visible; +}, 10, 2 ); +``` + +## Hide Column + +The example below removes a column if column has a [class](/beaver-builder/layouts/advanced-tab/html-element#class) of `my-target-column`. + +```php +add_filter( 'fl_builder_is_node_visible', function ( $is_visible, $node ) { + if ( 'column' === $node->type ) { + if ( ! empty( $node->settings->class ) && false !== strpos( $node->settings->class, 'my-target-column' ) ) { + return false; + } + } + return $is_visible; +}, 10, 2 ); +``` + +## Hide Module + +The example below removes a module if module has a [class](/beaver-builder/layouts/advanced-tab/html-element#class) of `my-target-module`. + +```php +add_filter( 'fl_builder_is_node_visible', function ( $is_visible, $node ) { + if ("module" === $node->type) { + if ( !empty($node->settings->class) && false !== strpos($node->settings->class, "my-target-module") ) { + return false; + } + } + return $is_visible; +}, 10, 2 ); +``` + +## Hide on Specific Pages + +To hide a specific row on a certain page—when the row has a class of `my-target-row` and the page `ID` is 123—use the following approach. This can be easily refactored to target other types of WordPress pages, such as archives or the front page, by leveraging [WordPress conditional tags](https://developer.wordpress.org/themes/basics/conditional-tags/). + +```php +add_filter( 'fl_builder_is_node_visible', function ( $is_visible, $node ) { + if ( 'row' === $node->type ) { + if ( ! empty( $node->settings->class ) && false !== strpos( $node->settings->class, 'my-target-row' ) && is_page( 123 ) ) { + return false; + } + } + return $is_visible; +}, 10, 2 ); +``` + +You can also target different elements like columns or modules by replacing the `$node->type`: + +- `if ( 'column' === $node->type ) {` for Column +- `if ( 'module' === $node->type ) {` for Module. + +**Customization Tips:** + +- Replace `is_page(123)` with any other WordPress conditional to adapt the behavior to archives, the front page, category pages, etc. +- Adjust `my-target-row` to match the actual class you’re targeting in your Advanced tab settings. diff --git a/beaver-themer_versioned_docs/version-1.5/developer/hooks-reference-themer.md b/beaver-themer_versioned_docs/version-1.5/developer/hooks-reference-themer.md new file mode 100644 index 00000000..330c1eb8 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/developer/hooks-reference-themer.md @@ -0,0 +1,7 @@ +--- +id: hooks-reference-themer +title: Themer hooks reference +sidebar_label: Themer hooks reference +--- + +The list of Beaver Themer hooks is autogenerated from the code at . diff --git a/beaver-themer_versioned_docs/version-1.5/developer/wp-cli-for-beaver-themer.md b/beaver-themer_versioned_docs/version-1.5/developer/wp-cli-for-beaver-themer.md new file mode 100644 index 00000000..bc27e235 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/developer/wp-cli-for-beaver-themer.md @@ -0,0 +1,88 @@ +--- +id: wp-cli-for-beaver-themer +title: WP-CLI for Beaver Themer +sidebar_label: WP-CLI for Beaver Themer +--- + +[WP-CLI](https://wp-cli.org/) is a set of command-line tools for managing WordPress installations. You can update plugins, configure multisite installs and much more, without using a web browser. + +After you've installed WP-CLI, you can enter the following command to get a list of all Beaver Builder commands: + +`wp beaver` + +The on-screen information will tell you what commands are available and the syntax of each command, with options and examples. + +Currently, the following commands are available for Beaver Themer. To see a description of the Beaver Builder Plugin and Theme commands, see [this article](/beaver-builder/developer/tutorials-guides/wp-cli-plugin-theme). + +## List all Themer layouts + +The following command lists all of the Themer layouts with the following values: + +* ID of the Themer layout +* Name of the Themer layout +* Status of the Themer layout (Publish or Draft) +* Type of Themer layout (part, footer, etc.) +* Hook where the Part will appear, if the Themer layout is of type Part. +* Locations to which the Themer layout applies + + ``` + wp beaver themer list + ``` + ![](/img/wp-cli-for-beaver-themer-178c944c.png) + +You can also use this command to list the values that can be used for the `--hooks` option to specify the location of a Part type, as described in the section below on setting the type for the Themer layout. + +## Change status for a Themer layout to Published or Draft + +Changes the Themer layout status to either **Published** or **Draft** with the following commands. + +``` +wp beaver themer set-status --id=123 --status=publish +``` +``` +wp beaver themer set-status --id=456 --status=draft +``` + +Setting a Themer layout to Draft status effectively disables the Themer layout from being applied. + +## Set type for Themer layout + +The following command sets the Themer layout type to Archive: + +``` +wp beaver themer set-type --id=123 --type=archive +``` + +The following command sets the Themer layout type to Part, using the `-hook` argument to determine the Part location, in this case before the content area: + +``` +wp beaver themer set-type --id=456 --type=part --hook=fl_before_content +``` + +To get a list of `--hook` values for -`-type=part`, use the following command: + +``` +wp beaver themer list-hooks +``` + +## Add a location to the Themer layout + +Set the location of the Themer layout: + +``` +wp beaver themer add-location --id=123 --location=general:single +``` + +Add location `general:site` to Themer layout with ID 456 as the first element of the array: + +``` +wp beaver themer add-location --id=456 --location=general:single --position=0 +``` + +## Delete location from Themer layout + +Remove a specified location from a Themer layout. Use the `wp beaver themer list` command to find the value for the location you want to remove. + +``` +wp beaver themer del-location --id=123 --location=general:single +``` diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/conditionals.md b/beaver-themer_versioned_docs/version-1.5/field-connections/conditionals.md new file mode 100644 index 00000000..728c097c --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/conditionals.md @@ -0,0 +1,73 @@ +--- +id: conditionals +title: Conditionals +sidebar_label: Conditionals +--- + +The Field Connections shortcode syntax supports conditionals, allowing you to display dynamic content based on the evaluation of statements as `TRUE` or `FALSE`. This functionality is available for all Beaver Themer field connection shortcodes, including Advanced Custom Fields (ACF), BigCommerce, Easy Digital Downloads, The Events Calendar, and WooCommerce. + +## Statements + +The conditional shortcode syntax supports three statements: `if`, `if not`, and `else`. + +### If `[wpbb-if]` + +The `[wpbb-if]` statement enables you to display custom content if the statement evaluates to `TRUE`. + +```markup +[wpbb-if some-field-connection] + + If True, show this! + +[/wpbb-if] +``` + +### Else `[wpbb-else]` + +The `[wpbb-else]` statement extends the `[wpbb-if]` statement to display custom content when the `[wpbb-if]` statement evaluates to `FALSE`. + +```markup +[wpbb-if some-field-connection] + + If True, show this! + +[wpbb-else] + + If False, show this instead! + +[/wpbb-if] +``` + +### If Not `[wpbb-if !]` + +The `[wpbb-if !]` statement allows you to display custom content when the statement evaluates to `FALSE`. The exclamation mark `!` functions as the logical operator `NOT`. + +```markup +[wpbb-if !some-field-connection] + + If False, show this! + +[/wpbb-if] +``` + +## Limitation + +Nested `if` statements are not supported. Meaning you can't place an `if` statement inside another, as shown in the example below. If you need more complex conditional logic, we recommend creating a custom shortcode instead. + +```markup +[wpbb-if some-field-connection] + + If True, show this! + + [wpbb-if some-field-connection] + + If also True, show this! + + [/wpbb-if] + +[wpbb-else] + + If False, show this instead! + +[/wpbb-if] +``` diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/examples/combining.md b/beaver-themer_versioned_docs/version-1.5/field-connections/examples/combining.md new file mode 100644 index 00000000..f3cd70f1 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/examples/combining.md @@ -0,0 +1,105 @@ +--- +id: combining +title: Combining Shortcode Examples +sidebar_label: Combining Shortcodes +toc_min_heading_level: 2 +toc_max_heading_level: 2 +description: The following examples demonstrate how you can combine field connections. You can also use HTML and CSS to give you greater control over the markup and style the field connection output. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +This article offers various examples demonstrating how to effectively combine field connections to grant you greater freedom and flexibility over the output. This includes the ability to wrap the field connection within HTML tags and apply custom CSS classes. + +## Post Title with Custom HTML & CSS + +To display a post title into your layout, the easiest approach involves utilizing a Heading module with the [Post Title](../wordpress-data.md#post-title) field connection. + +In the following code example, we have made use of the [Post Title](../wordpress-data.md#post-title) and [Post URL](../wordpress-data.md#post-url) field connections, alongside custom HTML markup and CSS, to generate the Post Title with a personalized HTML structure and CSS classes. + +```markup +

    + + + [wpbb post:title] + + +

    +``` + +### Output + +```markup +

    + + + Hello World + + +

    +``` + +## Featured image using custom HTML and CSS + +It's possible to use multiple field connections to output the featured image. As a result, you have more control over the HTML structure and can use your own CSS classes. + +```markup +[wpbb post:featured_image display='alt'] +``` + +### Output + +```markup +My Post's Featured Image +``` + +## Post Title & Post Author + +In this particular example, the [Post Title](../wordpress-data.md#post-title) and [Author Name](../wordpress-data.md#author-name) field connections are used, with the word "by" inserted between them. This allows for displaying both the post title and author within a single heading tag. + +```markup +

    [wpbb post:title] by [wpbb post:author_name type='display' link='no']

    +``` + +### Output + +> Hello World by Beaver Builder + +## Categories or Tag Name as CSS Class + +In this example, the [Post Term List](../wordpress-data.md#post-terms-list) field connection is used to implement the category slug as a CSS class name. This proves beneficial for customizing individual categories, like assigning unique colors or adding category-specific icons. + +```markup +

    + + [wpbb post:title] + +

    +``` + +### Output + +```markup +

    + + Some Movie Title + +

    +``` + +## Featured Image as Background Image + +In this example, the [Featured Image](../wordpress-data.md#featured-image) field connection is applied as an inline CSS value for the CSS `background-image` property. This allows you to set the post's featured image as a background image, which can be conveniently overlaid with additional content, like the post title. This provides a great example of how to use field connections as inline CSS values. + +:::info +Some custom CSS is required to make this display the featured image correctly. The CSS code is not included in this example. +::: + +```markup + +``` diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/examples/conditional.md b/beaver-themer_versioned_docs/version-1.5/field-connections/examples/conditional.md new file mode 100644 index 00000000..035511c5 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/examples/conditional.md @@ -0,0 +1,132 @@ +--- +id: conditional +title: Conditional Shortcode Examples +sidebar_label: Conditional Shortcodes +description: The examples in this article demonstrates how to use conditional field connections for standard WordPress fields, custom WordPress fields and Advanced Custom Fields. +--- + +The examples in this article demonstrates how to use conditional field connections for standard WordPress fields, custom WordPress fields and Advanced Custom Fields. + +## If `[wpbb-if]` + +Below are some examples that showcase the practical use of the `[wpbb-if]` shortcode: + +### Check for the existence of a featured image. + +In this example, we are verifying whether a post contains a featured image or not. When the statement evaluates to `TRUE`, the post's featured image will be displayed. However, if the statement evaluates to `FALSE`, no image will be shown for the post. + +```markup +[wpbb-if post:featured_image] + +
    + + [wpbb post:featured_image size="large" display="tag" linked="yes"] + +
    + +[/wpbb-if] +``` + +### Display content based on User Role + +In this example, the [User Logged In](../wordpress-data.md#user-logged-in) field connection is utilized to show content for any user assigned to the administrator role. + +:::tip +You can replace the administrator role with any other WordPress user role. +::: + +```markup +[wpbb-if site:logged_in role='administrator'] + +

    This text will only be visible to users assigned to the administrator role.

    + +[/wpbb-if] +``` + +### Display tags for posts that have tags + +In this example, the [Post Term List](../wordpress-data.md#post-terms-list) field connection is utilized to display all tags assigned to a post. If a post has no tags, then no tags will be shown. + +```markup +[wpbb-if post:terms_list taxonomy='post_tag'] + +

    Tagged in: [wpbb post:terms_list taxonomy='post_tag' html_list='no' display='name' separator=', ' limit='' linked='yes']

    + +[/wpbb-if] +``` + +## Else `[wpbb-else]` + +Below are some examples that showcase the practical use of the Else `[wpbb-else]` shortcode: + +### Fallback Featured Image + +This example demonstrates the use of the `[wpbb-else]` statement to verify the presence of a featured image in a post. When the statement is `TRUE`, the post's featured image will be shown. If the statement is `FALSE`, the fallback image will be displayed instead. + +```markup +[wpbb-if post:featured_image] + +
    + + [wpbb post:featured_image size="large" display="tag" linked="yes"] + +
    + +[wpbb-else] + +
    + + Fallback Image + +
    + +[/wpbb-if] +``` + +### Show Content if Field is Empty + +This example demonstrates the use of the `[wpbb-else]` statement to verify whether a post's Advanced Custom Field (ACF) field is empty or not. When the statement is `TRUE`, the post's ACF field value will be shown. If the statement is `FALSE`, the fallback content will be displayed instead. + +```markup +[wpbb-if post:acf type='text' name='ACF_FIELD_NAME'] + +

    [wpbb post:acf type='text' name='ACF_FIELD_NAME']

    + +[wpbb-else] + +

    This post's ACF field is empty!

    + +[/wpbb-if] +``` + +## If Not `[wbpp-if !]` + +Below are some examples that showcase the practical use of the If Not `[wpbb-if !]` shortcode: + +### Test for Absence of Featured Image + +This example tests for the absence of a featured image. + +```markup +[wpbb-if !post:featured_image] + +
    + + + +
    + +[/wpbb-if] +``` + +### Test for Absence of Field Value + +This example tests for the absence of a post's Advanced Custom Field (ACF) field value. If the statement evaluates to `TRUE`, the text *"This post's FIELD_NAME has no value."* will be displayed. This is a great way to locate posts that are missing a value for a specific field. + +```markup +[wpbb-if !post:acf type='image' name='acfimg'] + +

    This post's FIELD_NAME has no value.

    + +[/wpbb-if] +``` \ No newline at end of file diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/examples/expressions.md b/beaver-themer_versioned_docs/version-1.5/field-connections/examples/expressions.md new file mode 100644 index 00000000..4b9debdd --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/examples/expressions.md @@ -0,0 +1,235 @@ +--- +id: expressions +title: Expression Examples +sidebar_label: Expression Examples +--- + +This article provides examples of practical uses for expressions in your field connections, demonstrating how to effectively incorporate them with WordPress data, WordPress custom fields, and Advanced Custom Fields. + +## Equals + +Below are some examples that showcase the practical use of the `equals` operator: + +### Show Content Based on Author Name + +In this example, we're using the `equals` operator to check whether the authors name has a specific value in this case **Beaver Builder**. If the statement is `TRUE`, the content inside the shortcode will display. If the statement is `FALSE` meaning the authors name isn't **Beaver Builder**, but something else, then no content will return. + +```markup +[wpbb-if post:author_name exp='equals' value='Beaver Builder'] + +

    This content will only display if the author name is Beaver Builder.

    + +[/wpbb-if] +``` + +### Style elements based on Post Type + +In this example, the [Post Type](../wordpress-data.md#post-type) field connection is utilized to style elements based on the post type. In this example, we are styling the post title differently based on the post type when a Post module is set up to showcase multiple post types within the same module. + +```markup +[wpbb-if post:post_type display='slug' exp='equals' value='post'] + +

    [wpbb post:title]

    + +[wpbb-else] + +

    [wpbb post:title]

    + +[/wpbb-if] +``` + +:::tip + +You can replace `value='post'` with the slug of your chosen post type or custom post type. For instance, `value='movies'`. + +::: + +### Style Specific Taxonomy + +In this example, we're using the equals operator to check whether the post has a specific taxonomy term assigned to it called **New**. If the statement is `TRUE`, the **New** tag will be styled with a red background and white text. If the statement is `FALSE` meaning the post doesn't have the taxonomy term assigned, then no styling will return. + +This is a great way to style specific taxonomy terms differently than others. + +**Tag Name:** New + +```markup +[wpbb-if post:terms_list taxonomy='post_tag' exp='equals' value='New'] + + New + +[/wpbb-if] +``` + +#### Output + +> New + +### Hide End Date for All Day Events + +In this example, we're using the `equals` expression to check whether the event's end date is the same day as the start date. If the statement is `true`, only the start date displays. If the statement is `false` meaning the start date and end date do not match, both the start date and end date display. + +```markup +[wpbb-if post:the_events_calendar_start_date exp='equals' value='[wpbb post:the_events_calendar_end_date']'] + +

    Date: [wpbb post:the_events_calendar_start_date format='']

    + +[wpbb-else] + +

    Date: [wpbb post:the_events_calendar_start_date format=''] - [wpbb post:the_events_calendar_end_date format='']

    + +[/wpbb-if] +``` + +## Not Equals + +Below are some examples that showcase the practical use of the `notequals` operator: + +### Display Categories, Hide Uncategorized + +This example utilizes the "terms_list" field connection to display all categories assigned to a post. By using the `notequals` operator, it checks for the existence of the **"uncategorized"** category and, if `TRUE`, excludes it from displaying. + +This is a great way to hide specific taxonomy terms from displaying, such as **Uncategorized**. + +```markup +[wpbb-if post:terms_list taxonomy='category' exp='notequals' value='uncategorized'] + + [wpbb post:terms_list taxonomy='category' html_list='no' display='name' separator=', ' limit='' linked='yes'] + +[/wpbb-if] +``` + +## Contains + +Below are some examples that showcase the practical use of the `contains` operator: + +### Display Extra Content Based on Post Title + +In this example, we're using the `contains` operator to check whether the post title contains a specific value in this case **What's New**. + +If the statement is `TRUE`, meaning any post that has a title containing the words **What's New**, such as **What's New in Beaver Builder 2.8**, a Font Awesome icon will prefix the post title. If the statement is `FALSE` meaning the post title doesn't contain **What's New**, then no Font Awesome icon will display. + +```markup +[wpbb-if post:title exp='contains' value='What’s New'] + +

    [wpbb post:title]

    + +[wpbb-else] + +

    [wpbb post:title]

    + +[/wpbb-if] +``` + +#### Output + +> What's New in Beaver Builder 2.8 + +## Greater + +Below are some examples that showcase the practical use of the `greater` operator: + +### Test for Value of ACF Number Field using Greater + +The following example uses the ACF number field along with the `greater` operator and a comparison value of `500`. If the field value is greater than **500** then the statement is `TRUE` and will return the **TRUE** markup in the example. + +**Field Value:** 501 + +```markup +[wpbb-if post:acf type='number' name='FIELD_NAME' exp='greater' value='500'] + + TRUE: The ACF Number field FIELD_NAME value is greater than 500.
    + The number field value is [wpbb post:acf type='number' name='FIELD_NAME'] + +[wpbb-else] + + FALSE: The ACF Number field FIELD_NAME value isn't greater than 500. .
    + The number field value is [wpbb post:acf type='number' name='FIELD_NAME']. + +[/wpbb-if] +``` + +#### Output + +> TRUE: The ACF Number field FIELD_NAME value is greater than 500. +> The number field value is 501. + +## Greater Equals + +### Test for Value of ACF Number Field using Greater Equals + +The following example uses the ACF number field along with the `greaterequals` operator with a comparison value of `100`. If the field value is equal to or greater than 100 then the statement is `TRUE` and will return the **TRUE** markup from the example. + +**Field Value:** 100 + +```markup +[wpbb-if post:acf type='number' name='FIELD_NAME' exp='greaterequals' value='100'] + + TRUE: The ACF Number field FIELD_NAME value is equal to or greater than 100.
    + The number field value is [wpbb post:acf type='number' name='FIELD_NAME'] + +[wpbb-else] + + FALSE: The ACF Number field FIELD_NAME value is less than 100.
    + The number field value is [wpbb post:acf type='number' name='FIELD_NAME']. + +[/wpbb-if] +``` + +#### Output + +> TRUE: The ACF Number field FIELD_NAME value equal to or greater than 100. +> The number field value is 100. + +## Less + +### Test for Value of ACF Number Field using Less + +The following example uses the ACF number field along with the `less` operator with a comparison value of `100`. If the field value is less than 100 then the statement is `TRUE` and will return the **TRUE** markup in the example. + +**Field Value:** 50 + +```markup +[wpbb-if post:acf type='number' name='FIELD_NAME' exp='less' value='100'] + + TRUE: The ACF Number field FIELD_NAME value is less than 100.
    + The number field value is [wpbb post:acf type='number' name='FIELD_NAME'] + +[wpbb-else] + + FALSE: The ACF Number field FIELD_NAME value isn't less than 100. .
    + The number field value is [wpbb post:acf type='number' name='FIELD_NAME']. + +[/wpbb-if] +``` + +#### Output + +> TRUE: The ACF Number field FIELD_NAME value is less than 100. +> The number field value is 50. + +## Less Equals + +### Test for value of ACF number field + +The following example uses the ACF number field along with the `lessequals` operator with a comparison value of `100`. If the field value is equal to or less than 100 then the statement is `TRUE` and will return the **TRUE** markup in the example. + +**Field Value:** 90 + +```markup +[wpbb-if post:acf type='number' name='FIELD_NAME' exp='lessequals' value='100'] + + TRUE: The ACF Number field FIELD_NAME value is equal to or less than 100.
    + The number field value is [wpbb post:acf type='number' name='FIELD_NAME'] + +[wpbb-else] + + FALSE: The ACF FIELD_NAME field isn't equal to or less than 100. .
    + The number field value is [wpbb post:acf type='number' name='FIELD_NAME']. + +[/wpbb-if] +``` + +#### Output + +> True: The ACF number_value field is equal to or less than 100. +> The number field value is 90. diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/examples/index.md b/beaver-themer_versioned_docs/version-1.5/field-connections/examples/index.md new file mode 100644 index 00000000..1fdd4dc8 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/examples/index.md @@ -0,0 +1,12 @@ +--- +id: index +title: Shortcode Examples +sidebar_label: Shortcode Examples +description: The examples in this article demonstrates how to use conditional field connections for standard WordPress fields, custom WordPress fields and Advanced Custom Fields. +--- + +The purpose of this section is to provide examples of how to use field connections, including conditionals, expressions, default values, and combining multiple field connections with HTML. + +import DocCardList from '@theme/DocCardList'; + + diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/expressions.md b/beaver-themer_versioned_docs/version-1.5/field-connections/expressions.md new file mode 100644 index 00000000..49f7654b --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/expressions.md @@ -0,0 +1,227 @@ +--- +id: expressions +title: Expressions +sidebar_label: Expressions +--- + +Expressions enhance the capabilities of conditional field connection shortcodes, allowing you to showcase content depending on the value retrieved from the field. For instance, you can create an expression where if the field's value is **less** than `2`, it will display the text *"This field has a value less than 2"*. If the value is **greater** than `2`, it will show the text *"This field has a value greater than 2"*. + +By utilizing expressions, you gain the ability to dynamically manage the content displayed, tailoring it based on the specific field values. This approach offers a more versatile and adaptable way to present your content, making it responsive to different scenarios. + +## Syntax + +The syntax for expressions involves an [Operator](#operators) and a [Comparison Value](#comparison-value), both added as parameters to the conditional field connection shortcode. The `exp=` parameter is used to specify the operator, while the `value=` parameter is used to indicate the comparison value. + +```markup +[wpbb-if some-field-connection exp='' value=''] + + Display this text when the value test is True. + +[wpbb-else] + + Display this text when the value test is False. + +[/wpbb-if] +``` + +## Operators + +Expression operators offer the ability to execute logical operations on comparison values, enabling you to display content based on the field's returned value. + +When dealing with **Strings** (Text), you have the option to utilize the following operators: + +* `equals` +* `notequals` +* `contains` + +When working with **Integers** (Numbers), you have access to the following operators: + +* `equals` +* `notequals` +* `contains` +* `greater` +* `greaterequals` +* `less` +* `lessequals` + +### Equals + +The **Equals** operator (`exp='equals'`) compares the exact text or number provided as the comparison value and verifies if it is identical to the value obtained from the field. + +**Field Value:** Beaver Builder + +```markup +[wpbb-if post:author_name type='display' link='no' exp='equals' value='Beaver Builder'] + + TRUE: The author's name is Beaver Builder! + +[wpbb-else] + + FALSE: The author's name is not Beaver Builder! + +[/wpbb-if] +``` + +**Output:** + +> TRUE: The author's name is Beaver Builder! + +### Not Equals + +The **Not Equals** operator (`exp='notequals'`) compares the exact text or number provided as the comparison value and verifies if it is **not equal** to the value obtained from the field. + +**Field Value:** Justin Busa + +```markup +[wpbb-if post:author_name type='display' link='no' exp='notequals' value='Beaver Builder'] + + TRUE: The author's name is not Beaver Builder! + +[wpbb-else] + + FALSE: The author's name is not Beaver Builder! + +[/wpbb-if] +``` + +**Output:** + +> FALSE: The author's name is not Beaver Builder! + +### Contains + +The **Contains** operator (`exp='contains'`) verifies if the comparison value includes similar characters or numbers. For example, if a field has a value of **Hello World** and the comparison value you're testing for is **ello** this will be `TRUE`. + +**Post Title:** Hello World + +```markup +[wpbb-if post:title exp='contains' value='ello'] + + TRUE: The post title is Hello World. + +[wpbb-else] + + FALSE: The post title is not Hello World. + +[/wpbb-if] +``` + +**Output:** + +> TRUE: The post title is Hello World. + +### Greater + +The **Greater** operator (`exp='greater'`) verifies if the comparison value is greater than the value obtained from the field. + +**Field Value:** 1001 + +```markup +[wpbb-if post:custom_field key='my-number-field' exp='greater' value='1000'] + + TRUE: my-number-field is greater than comparison value "1000". + +[wpbb-else] + + FALSE: my-number-field is not greater than comparison value "1000". + +[/wpbb-if] +``` + +**Output:** + +> True: my-number-field is greater than test value "1000". + +### Greater Equals + +The **Greater Equals** operator (`exp='greaterequals'`) verifies if the comparison value is greater than or equal to the value obtained from the field. + +**Field Value:** 1000 + +```markup +[wpbb-if post:custom_field key='my-number-field' exp='greaterequals' value='1000'] + + TRUE: my-number-field is greater than or equals comparison value "1000". + +[wpbb-else] + + FALSE: my-number-field isn't greater than or equals comparison value "1000". + +[/wpbb-if] +``` + +**Output:** + +> TRUE: my-number-field is greater than or equals comparison value "1000". + +### Less + +The **Less** operator (`exp='less'`) verifies if the comparison value is less than the value obtained from the field. + +**Field Value:** 999 + +```markup +[wpbb-if post:custom_field key='my-number-field' exp='less' value='1000'] + + TRUE: my-number-field is less than comparison value "1000". + +[wpbb-else] + + FALSE: my-number-field is not less than comparison value "1000". + +[/wpbb-if] +``` + +**Output:** + +> TRUE: my-number-field is less than comparison value "1000". + +### Less Equals + +The **Less Equals** operator (`exp='lessequals'`) verifies if the comparison value is less than or equal to the value obtained from the field. + +**Field Value:** 1000 + +```markup +[wpbb-if post:custom_field key='my-number-field' exp='lessequals' value='1000'] + + TRUE: my-number-field is less than or equals than test value "1000". + +[wpbb-else] + + FALSE: isn't less than or equals test value "1000" + +[/wpbb-if] +``` + +**Output:** + +> TRUE: my-number-field is less than or equals to the comparison value "1000". + +## Comparison Value + +The comparison value represents the value you wish to test against the value of your field. It can be either a string (text) or an integer (number). The `value=""` parameter is used to specify this comparison value. + +:::caution +The `value=''` attribute **is case-sensitive**. +::: + +:::warning warning +When performing a comparison value test, it is essential to ensure that the fields being evaluated contain a value. If a field is empty, the comparison value test will always yield a `FALSE` result. + +For instance, if you are testing whether a field `equals` the string "abc" and the field happens to be empty, both an `equals` and a `notequals` test will produce a `FALSE` outcome. To guarantee that the field has a value, the most effective approach is to make it a required field. +::: + +### Dates + +You can perform a comparison value test for a date value as long as it is using the data format `YYYYMMDD`. This allows the value to be compared as an integer (number). + +### Numbers + +When using operators such as `greater`, `greaterequals`, `less`, or `lessequals`, both the Number field value and the value specified in the comparison value parameter are converted to integers before comparison. However, for `equals` and `notequals`, the comparison is made using the exact strings as they are. + +For instance, if you are testing whether **377.78** is `lessequals` **377.77**, the result is `TRUE` because both values are converted to **377** before the comparison occurs, making them equal. Conversely, if you test whether **377.77** `equals` **377.78**, the result is `FALSE` because the two strings are compared as they are without any conversions. + +### URLs + +When conducting **URL** tests, any trailing slash is disregarded in both the field value and the comparison value. For instance, whether the URL is provided as `https://my-website.com` or `https://my-website.com/`, the result will be `TRUE` as the trailing slash is ignored in the comparison. diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/getting-started.md b/beaver-themer_versioned_docs/version-1.5/field-connections/getting-started.md new file mode 100644 index 00000000..fa08dc3e --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/getting-started.md @@ -0,0 +1,79 @@ +--- +id: getting-started +title: Getting Started +sidebar_label: Getting Started +--- + +This article serves as a comprehensive guide to help you get started with field connections. We will walk you through the process of adding, editing, and deleting field connections, as well as explain the distinctions between "connect" and "insert" functions and field connection limitations. + +## Access Field Connections + +To gain access to field connections, ensure Beaver Themer is installed on your website. After the plugin installation, you will see the field connection toggle denoted by a plus (+) icon positioned on the right-hand side of specific row, column, and module options, as depicted in the screenshot below. This toggle provides access to the field connection menu, allowing you to explore the various available field connections. + +:::caution +Please be aware that any row, column, or module option lacking a plus (+) icon does not support field connections. +::: + +![Access Field Connections](/img/beaver-themer/field-connections--getting-started--1.png) + +## Field Connection Menu + +When you click the field connection toggle, it activates the field connection menu, which presents a comprehensive list of available field connections tailored specifically for the layout you are currently editing. Additionally, the inclusion of a search feature further streamlines the process, enabling you to quickly find the exact field connection you want to use without having to scroll through a long list. + +![Field Connection Menu](/img/beaver-themer/field-connections--getting-started--2.png) + +## Add Field Connection + +To add a field connection, mouse over the connection you want to use and click either **Connect** or **Insert**. If the field connection has parameters (options), a window of settings for that field connection may pop up. Configure the settings and click **Save**. + +![Add Field Connections](/img/beaver-themer/field-connections--getting-started--3.png) + +## Connect vs Insert + +Connect and Insert both apply the field connection to the chosen option. However, they do have subtle differences in their function. + +### Connect + +When you choose to "Connect," the field connection is applied directly to the option, and it effectively locks the option to the field connection. This means that no additional content can be added to the option, and it remains linked exclusively to the field connection. + +![Connect Field Connections](/img/beaver-themer/field-connections--getting-started--4.png) + +### Insert + +When you opt for "Insert," the field connection is applied to the option as a field connection shortcode. This approach allows you to incorporate additional content, such as plain text, HTML, or other shortcodes, both before and after the field connection within the option. + +![Insert Field Connections](/img/beaver-themer/field-connections--getting-started--5.png) + +## Field Connection Parameters (Options) + +Some field connections, such as Post Date or Post Excerpt, have parameters (options) that you can configure. For example, you can choose the date format for the Post Date field connection or the number of words for the Post Excerpt field connection. + +These parameters (options) are available when you first apply the field connection to the option, and they can be edited later. + +![Field Connection Parameters](/img/beaver-themer/field-connections--getting-started--6.png) + +## Edit/Modify Field Connections + +Field connections applied to row, column, and module options can be edited or modified. The process, however, varies slightly depending on how you initially applied the field connection to the option. + +- **Connect** + If you selected the **Connect** option while adding your field connection, you can easily modify it by hovering your mouse over the connection and clicking the Wrench icon. This will provide you with access to the field connection options once again, allowing you to reconfigure it. + + However, keep in mind that if you want to switch to a different field connection, you will need to delete the current field connection first before making the switch. + + ![Delete Field Connections](/img/beaver-themer/field-connections--getting-started--7.png) + + :::info + If the field connection has no parameters (options), the Wrench icon will not appear. + ::: + +- **Insert** + When adding your field connection using the **Insert** option, the process to modify it differs slightly. Knowing the field connection parameters (options) enables you to add them to the shortcode, replacing the existing ones. However, if you're not familiar with the parameters, you'll have to remove the field connection shortcode from the option and then add the field connection again. + +## Delete Field Connections + +When a field connection is applied to a row, column, or module option using **Connect**, it can be deleted by hovering your mouse over the connection and clicking the () X icon. This will remove the field connection from the option, allowing you to add a new one. + +![Delete Field Connections](/img/beaver-themer/field-connections--getting-started--8.png) + +When a field connection is applied to a row, column, or module option using **Insert**, it can be deleted by removing the field connection shortcode from the option. This will remove the field connection from the option, allowing you to add a new one. diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/index.md b/beaver-themer_versioned_docs/version-1.5/field-connections/index.md new file mode 100644 index 00000000..defe9dad --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/index.md @@ -0,0 +1,101 @@ +--- +id: index +title: Field Connections +sidebar_label: Field Connections +--- + +Field connections enable you to seamlessly retrieve data from your website's WordPress database and effortlessly integrate it into designated row, column, and module options, presenting the data beautifully within your Beaver Themer layouts. + +The versatility of these connections allows data extraction from a multitude of sources, including WordPress data, WordPress custom fields, and popular plugins like Advanced Custom Fields, Big Commerce, Easy Digital Downloads, The Events Calendar, and WooCommerce. + +Furthermore, field connections extend their support to [shortcodes](syntax.md), granting you the flexibility to apply them not only within row, column, or module options but also throughout your entire layout wherever text can be inserted. This includes HTML modules or the custom layout option for the Post module. + +```mermaid +flowchart LR + A(WordPress) --> F(Field Connection) + B(Advanced Custom Fields) --> F(Field Connection) + C(WooCommerce) --> F(Field Connection) + F(Field Connection) --> G(Template/Layout) + + style A fill:#21759b,stroke:#21759b,stroke-width:0px,color:#ffffff + style B fill:#00e4bc,stroke:#00e4bc,stroke-width:0px,color:#ffffff + style C fill:#96588a,stroke:#96588a,stroke-width:0px,color:#ffffff + style F fill:#ffffff,stroke:#373737,stroke-width:1px,color:#373737 + style G fill:#e2e8f0,stroke:#e2e8f0,stroke-width:0px,color:#373737 +``` + +*Note: The above diagram showcases WordPress, Advanced Custom Fields and WooCommerce as data sources, but field connections can also be used with other supported plugin, such as BigCommerce, Easy Digital Downloads, and The Events Calendar.* + +## Why use Field Connections? + +Field Connections allow you to streamline your workflow by eliminating the need to create separate layouts for individual posts or pages. Instead, you can create one singular layout, assign this to all posts on your website and use field connections to dynamically display the correct data for each post or page. + +## Data Sources & Natively Supported Plugins + +Field Connections natively support the following data sources and plugins. + +* [WordPress Data](wordpress-data.md) +* [WordPress Custom Fields](wordpress-custom-fields.md) +* [Advanced Custom Fields](../integrations/acf/index.md) +* [BigCommerce](../integrations/bigcommerce/field-connections.md) +* [Easy Digital Downloads](../integrations/easy-digital-downloads/field-connections.md) +* [The Events Calendar](../integrations/tec/field-connections.md) +* [WooCommerce](../integrations/woocommerce/field-connections.md) + +[Toolset](third-party.md#toolset) custom fields are fully compatible and function in a manner similar to WordPress custom fields. However, to utilize Toolset custom fields effectively, it is necessary to prefix your field's name (key) with `wpcf-`. + +Additionally, third-party plugins like Pods, and Meta Box have integrated their own field connections, ensuring smooth compatibility with Beaver Themer. + +* [Meta Box](third-party.md#meta-box) +* [Pods](third-party.md#pods) + +## Data Types + +When applying field connections to options, ensuring the data type aligns with the intended option is crucial. This ensures that the option you are connecting can accurately output the data. + +For example, when using a field connection that outputs an image, like the Featured Image field connection, it should be applied to an option that can display images, such as the option found in the Photo module. If you attempt to apply the Featured Image field connection to a text option, like those present in the Header and Text modules, the connection can still be made. But, you will only be able to output details about the image, such as URL, Title, Caption, Description, or Alt Text, as these details can be presented as text. + +```mermaid +flowchart LR + F(Featured Image Field Connection) --> P[Photo Module] + F(Featured Image Field Connection) --> H[Heading Module] + + P(Photo Module) --> OP(Photo Option) --> O1(Output: Display Image) + + H(Heading Module) --> OP1(Heading Option) + OP1(Heading Option) --> O2(Output: Image Alt Text) + OP1(Heading Option) --> O3(Output: Image Caption Text) + OP1(Heading Option) --> O4(Output: Image URL) + + style F fill:#ffffff,stroke:#373737,stroke-width:1px,color:#373737 + style H fill:#2563eb,stroke:#2563eb,stroke-width:0px,color:#ffffff + style P fill:#2563eb,stroke:#2563eb,stroke-width:0px,color:#ffffff + style OP fill:#334155,stroke:#334155,stroke-width:0px,color:#ffffff + style OP1 fill:#334155,stroke:#334155,stroke-width:0px,color:#ffffff + style O1 fill:#475569,stroke:#475569,stroke-width:0px,color:#ffffff + style O2 fill:#475569,stroke:#475569,stroke-width:0px,color:#ffffff + style O3 fill:#475569,stroke:#475569,stroke-width:0px,color:#ffffff + style O4 fill:#475569,stroke:#475569,stroke-width:0px,color:#ffffff +``` + +## Theme Data + +Due to variations in how each theme manages customizer settings, it is not possible to utilize field connections for outputting theme data from the WordPress Customizer settings. + +:::tip +An alternative is to utilize the Advanced Custom Fields (ACF) Options Page feature, which allows you to create an additional admin page in your WordPress Dashboard. Any fields you include on the Options Page become global, meaning the data can be accessed and used throughout your entire website. + +See the [ACF Options Page](integrations/acf/options-page.md) article for more information. +::: + +## WordPress Multisite Support + +Field Connection are supported in [WordPress Multisite Network](https://wordpress.org/support/article/create-a-network/) installations. However, it is important to be aware that these field connections cannot be used to retrieve data between sub-sites. + +For instance, if you have a WordPress Multisite network with three sub-sites - Site A, Site B, and Site C - using field connections, you cannot retrieve data from Site A and display it on Site B or Site C. The data retrieval is limited to within each individual sub-site and cannot be extended across the network. + +## In this Section + +import DocCardList from '@theme/DocCardList'; + + diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/syntax.md b/beaver-themer_versioned_docs/version-1.5/field-connections/syntax.md new file mode 100644 index 00000000..ea711cfd --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/syntax.md @@ -0,0 +1,111 @@ +--- +id: syntax +title: Field Connection Shortcode Syntax +sidebar_label: Shortcode Syntax +--- + + +The Field Connection shortcode offers a straightforward way to showcase data from custom fields in your layouts. This reference illustrates the syntax for the field connection shortcode. + +:::tip +To make things even easier, you can generate the shortcode automatically by using an [HTML module](/beaver-builder/layouts/modules/html) and the Field Connection [Insert](getting-started.md#connect-vs-insert) function. +::: + +## Syntax + +The Field Connections shortcode syntax varies based on the data type, the location where it is applied, and whether it supports [parameters](#parameters). Below are two examples that demonstrate how the syntax can vary depending on the data's location. + +```markup title="Post Title" +[wpbb post:title] +``` + +```markup title="Archive Title" +[wpbb archive:title] +``` + +## Conditional Shortcodes + +The Field Connections shortcode syntax supports conditionals, allowing you to display dynamic content based on the evaluation of statements as `TRUE` or `FALSE`. + +```markup +[wpbb-if some-field-connection] + + If True, show this! + +[/wpbb-if] +``` + +See the [Conditionals](conditionals.md) article for more information. + +## Parameters + +The Field Connection shortcode syntax provides support for a range of parameters, enabling you to perform various actions, such as modifying the output, displaying content based on the field's returned value, or setting a default value. + +### Modifiers + +The modifier parameter is available for field connections that have option support. These options grant you the ability to configure the field connection output according to your preferences. After configuring the options, they are incorporated into the shortcode syntax as modifier parameters. The value you selected for each individual option is then utilized as the corresponding value for the modifier parameter. + +The two examples below demonstrate how the modifier parameters can differ for each field connection. + +* **Example: Post Date** + The post date field connection comes with a parameter named `format`, which allows you to modify the date format returned using PHP `date()`. + + ```markup title="Post Date" + [wpbb post:date format='F Y, J'] + ``` + +* **Example: Featured Image** + The featured image field connection offers parameters like `size`, `display`, `align`, and `linked`, allowing you to adjust the output accordingly. + + ```markup title="Featured Image" + [wpbb post:featured_image size='large' display='tag' align='default' linked='no'] + ``` + +### Expressions + +Expressions extend the functionality of the conditional field connection shortcode through two parameters: `exp` (operator) and `value` (comparison value). This allows you to display content based on the value returned by the field. + +```markup +[wpbb-if some-field-connection exp='' value=''] + + Display this text when the value test is True. + +[wpbb-else] + + Display this text when the value test is False. + +[/wpbb-if] +``` + +See the [Expressions](expressions.md) article for more information. + +### Defaults + +Field Connection shortcodes support default modifier parameters that enable the addition of a default value to a Field Connection shortcode. These two default modifiers have slightly different functions, depending on the default value you’re adding. + +:::warning Warning +The parameters `default=''` and `wpbb_default=''` are incompatible with [Conditional](conditionals.md) shortcodes, as they enforce the statement to be consistently `TRUE`. +::: + +#### `default=''` + +The `default=''` parameter is optional and specifies a default value that is returned if the field has no value. The default value can include plain text, or HTML markup. + +```markup +[wpbb post:custom_field key='name' default='John Doe'] +``` + +* **Example: Default Featured Image** + In this example, the default value is a URL to a default image (default.jpg). If the post has no featured image, the default image is displayed. + + ```markup + + ``` + +#### `wpbb_default=''` + +The `wpbb_default=''` parameter is optional and used instead of `default=''` when the default value is sourced from a custom field. + +```markup title="wpbb_default Example" +[wpbb post:custom_field key='FIELD_NAME' wpbb_default="wpbb post:custom_field key='FIELD_NAME'"] +``` diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/third-party.md b/beaver-themer_versioned_docs/version-1.5/field-connections/third-party.md new file mode 100644 index 00000000..38f61722 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/third-party.md @@ -0,0 +1,45 @@ +--- +id: third-party +title: Third-party Custom Fields +sidebar_label: Third-party +description: This article gives a brief introduction to using field connections with fields created in third-party plugins that are not inherently supported by Beaver Themer. +--- + +This article gives a brief introduction to using field connections with fields created in third-party plugins that are not inherently supported by Beaver Themer. + +:::caution +If you encounter any issues with field connections related to Toolset, Pods, or Meta Box, we advise reaching out to their respective support teams for assistance. +::: + +## Meta Box + +By utilizing the [Meta Box - Beaver Themer Integrator](https://metabox.io/plugins/meta-box-beaver-themer-integrator/) plugin, you can seamlessly integrate custom fields generated with Meta Box. This integration enables you to effortlessly select and display custom fields, created using the Meta Box plugin, through a dropdown menu in Beaver Themer. + +Below is an example of a Meta Box field connection shortcode. It's important to be aware that the shortcode syntax may differ based on the type of field you aim to display and the layout type to which you are applying it. + +```markup +[wpbb post:meta_box field='FIELD_NAME'] +``` + +## Pods + +By installing the [Pods Beaver Themer Add-On](https://wordpress.org/plugins/pods-beaver-builder-themer-add-on/), you gain the ability to effortlessly select Pods fields in Beaver Themer field connections through a dropdown menu. This dropdown menu corresponds to the currently displayed item, whether it's a Custom Post Type or Taxonomy. + +Below is an example of a Pods field connection shortcode. It's important to be aware that the shortcode syntax may differ based on the type of field you aim to display and the layout type to which you are applying it. + +```markup +[wpbb post:pods_display field='FIELD_NAME'] +``` + +## Toolset + +Toolset fields are compatible with Beaver Themer and function almost identically to [WordPress Custom fields](wordpress-custom-fields.md). The only difference is that you should prefix your field's name (key) with `wpcf-`. + +1. In the field connection panel list, select **Post Custom Field**. +2. In the **Field Key** field, enter the name of your Toolset custom field, prefixed with `wpcf-`. + +For example, if your Toolset custom field is named `my_tc_field`, in Themer, it should be specified as `wpcf-my_tc_field`. + +```markup +[wpbb post:custom_field key='wpcf-my_tc_field'] +``` \ No newline at end of file diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/wordpress-custom-fields.md b/beaver-themer_versioned_docs/version-1.5/field-connections/wordpress-custom-fields.md new file mode 100644 index 00000000..30ed80c3 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/wordpress-custom-fields.md @@ -0,0 +1,102 @@ +--- +id: wordpress-custom-fields +title: WordPress Custom Fields +sidebar_label: WordPress Custom Fields +--- + +[WordPress Custom Fields](https://wordpress.org/support/article/custom-fields/) is a feature in WordPress which allows you to add additional information to your pages, posts, and custom post types. You do this by adding a `key` which is the custom field name and a value which is the information you want to display on your page or post. You can then use Beaver Themer field connections to display this data into your layout. + +## Enable WordPress Custom Fields + +By default, Custom fields are hidden. You can make the custom fields panel visible on your post edit screen in two ways depending on whether you're using the default WordPress editor (Gutenberg) or the [Classic Editor plugin](https://wordpress.org/plugins/classic-editor/). + +:::info +When the Advanced Custom Fields plugin is installed and active on your website, the functionality of WordPress custom fields is deactivated. To utilize WordPress custom fields, you need to disable the Advanced Custom Fields plugin. +::: +### Block Editor (Gutenberg) + +To enable WordPress custom fields while utilizing the Block editor, follow these steps: + +1. On the **WordPress Edit Screen** for pages or posts and access the **Options** panel by clicking the () vertical ellipsis icon. +2. Choose **Preferences** from the dropdown menu. +3. In the popup window, select the **Panel** option. +4. Toggle the **Custom Fields** option to enable and finalize the process by clicking the **Enable & Reload** button. + +![Access custom fields using WordPress default editor](/img/beaver-themer/field-connections--wp-custom-fields--1.jpg) + +### Classic Editor Plugin + +To enable WordPress custom fields while using the Classic Editor plugin, follow these steps: + +1. On the **WordPress Edit Screen** for pages or posts, access the **Screen Options** panel located in the upper right corner. +2. Mark the checkbox for **Custom Fields**. +3. The **Custom Fields** panel will now become visible beneath the Classic Editor. + +![Access custom fields using WordPress classic editor](/img/beaver-themer/field-connections--wp-custom-fields--2.jpg) + +## Add a WordPress Custom Field + +To add a WordPress custom field: + +1. Input the name (key) for your custom field and provide a value for the field. +2. Apply the changes by clicking **Publish**. + +:::info +If you have previously added WordPress custom fields, you'll notice a dropdown menu that presents a list of all existing custom fields. To add a new custom field, click on the **Enter New** button. +::: + +![Add a WordPress Custom Field](/img/beaver-themer/field-connections--wp-custom-fields--3.jpg) + +## Apply WordPress Custom Field + +A WordPress custom field can be assigned to a row, column, or module option using the following steps: + +1. Access the specific row, column, or module to which you intend to apply the WordPress custom field. +2. Click the [Field Connection toggle](getting-started.md#access-field-connections) and within the [Field Connection menu](getting-started.md#field-connection-menu), choose **Post Custom Field**. +3. Select either [Connect](getting-started.md#connect) or [Insert](getting-started.md#insert) to apply the WordPress custom field onto the chosen option. + +![Apply a WordPress Custom Field](/img/beaver-themer/field-connections--wp-custom-fields--4.jpg) + +## WordPress Custom Field Shortcode + +You also have the option to display WordPress custom fields within your layouts using the Field Connection shortcode. This can be accomplished by choosing **Post Custom Field** from the [Field Connection Menu](getting-started.md#field-connection-menu) and then inputting the field name (key). + +```markup +[wpbb post:custom_field key='FIELD_NAME'] +``` + +### Conditionals & Expressions Support + +WordPress custom fields also have support for [conditionals](conditionals.md) and [expressions](expressions.md). + +#### Conditionals + +The following code provides a simple example of the syntax used for applying conditionals with your WordPress custom field connection shortcodes. + +```html +[wpbb-if post:custom_field key='FIELD_NAME'] + +

    Show this if TRUE.

    + +[wpbb-else] + +

    Show this if FALSE.

    + +[/wpbb-if] +``` + +Check out the [Conditional](conditionals.md) article to delve deeper into understanding how conditionals work. Also, take a look at the [Conditional Examples](examples/conditional.md) article for more instances that showcase how conditionals can be applied. + +#### Expressions + +The following code provides a simple example of the syntax used for applying expressions with your WordPress custom field connection shortcodes. + +```html +[wpbb-if post:custom_field key='FIELD_NAME' exp='equal' value='Beaver Builder'] + +

    This content will only display if the field's value is Beaver Builder.

    + +[/wpbb-if] +``` + +Check out the [Expressions](expressions.md) article to delve deeper into understanding how expressions work. Also, take a look at the [Expression Examples](examples/expressions.md) article for more instances that showcase how expressions can be applied. diff --git a/beaver-themer_versioned_docs/version-1.5/field-connections/wordpress-data.md b/beaver-themer_versioned_docs/version-1.5/field-connections/wordpress-data.md new file mode 100644 index 00000000..2be6bb98 --- /dev/null +++ b/beaver-themer_versioned_docs/version-1.5/field-connections/wordpress-data.md @@ -0,0 +1,605 @@ +--- +id: wordpress-data +title: WordPress Data +sidebar_label: WordPress Data +--- + +In this article, you'll find a comprehensive list of available WordPress data field connection shortcodes. These shortcodes enable you to retrieve various types of data, including the title of your page or post, page or post content, publishing date, archive title, and more. + +:::info + +You can locate Field Connection shortcodes for our third-party integrations by following the links provided below. + +- [Advanced Custom Fields (ACF)](../integrations/acf/index.md) +- [BigCommerce](../integrations/bigcommerce/field-connections.md) +- [Easy Digital Downloads](../integrations/easy-digital-downloads/field-connections.md) +- [The Events Calendar](../integrations/tec/field-connections.md) +- [WooCommerce](../integrations/woocommerce/field-connections.md) + +::: + +:::tip +WordPress data field connection shortcodes also support conditionals and expressions. Learn more by visiting the following links: + +- [Conditionals](conditionals.md) +- [Expressions](expressions.md) +- [Conditional Examples](examples/conditional.md) +- [Expression Examples](examples/expressions.md) + +::: + +## Archive + +### Archive Title + +Outputs an archive's title. + +```markup +[wpbb archive:title] +``` + +### Archive Description + +Outputs an archive's description. + +```markup +[wpbb archive:description] +``` + +### Archive Count + +Outputs an archive's count. Example: _(Showing 1-5 of 25.)_ + +```markup +[wpbb archive:show_count] +``` + +### Archive Page Count + +Outputs an archive page count. Example: _(Page 1 of 3.)_ + +```markup +[wpbb archive:show_page_count] +``` + +### Archive Term Meta + +Outputs an archive’s meta term, such as the value of a custom field assigned to a taxonomy (a post category or tag or a custom taxonomy). + +```markup +[wpbb archive:term_meta key=''] +``` + +## Author + +### Author Name + +Outputs the authors name. + +```markup +[wpbb post:author_name] +``` + +- Options + + - **Type** - Choices are display (default), first name, last name, first last, last first, nickname, and username. + - **Link** - Enable/Disable a link to the author's archive or to the website in the author's user profile. + +- Example + + ```markup + [wpbb post:author_name type='first' link='yes' link_type='website'] + ``` + +### Author Bio + +Outputs the author's bio (**WordPress Dashboard > Users > Profile > Biographical Info**). + +```markup +[wpbb post:author_bio] +``` + +### Author URL + +Outputs the author's website or archive e.g. `https://my-website.com/author/name/`. + +```markup +[wpbb post:author_url type='archive'] +``` + +- Options + + - **Type** - Post Archive or Profile Website. + +:::tip **Tip** +You can wrap the field connection shortcode with `` tags to make a link. + +```markup +Author Website +``` + +::: + +### Author Picture + +Outputs the authors profile picture. + +```markup +[wpbb post:author_profile_picture link='no' link_type='archive' size='100'] +``` + +- Options + + - **Type** - Choices are display (default), first name, last name, first last, last first, nickname, and username. + - **Link** - Enable/Disable a link to the author's archive or to the website in the author's user profile. + +- Example + + ```markup + [wpbb post:author_name type='first' link='yes' link_type='website'] + ``` + +### Author Picture URL + +Outputs the authors profile picture URL. + +```markup +[wpbb post:author_profile_picture_url size='100'] +``` + +- Options + + - **Size** - Set the pixel size of the image e.g. 100px. + +### Author Meta + +Outputs the author’s meta term, such as the value of a custom field assigned to the user profile page. + +```markup +[wpbb post:author_meta key=''] +``` + +## Comments + +### Comments Number + +Outputs a post's comment number. Example: 21 Comments. + +```markup +[wpbb post:comments_number link='yes' none_text='No Comments' one_text='1 Comment' more_text='% Comments'] +``` + +- Options + + - **Link** - Enable/Disable link. + - **No Comments Text** - Set the text for when there are no comments. Default is "No Comments". + - **One Comment Text** - Set the text for when there is one comment. Default is "1 Comment". + - **Comments Text** - Set the text for when there are multiple comments. Default is "% Comments". + +### Comments URL + +Outputs a post's comment URL. Example: `https://my-website.com/hello-world/#respond` + +```markup +[wpbb post:comments_url] +``` + +## Post/Page + +The Post/Page field connections work for all public post types this includes custom post types. + +### Post Title + +Outputs the post's title. + +```markup +[wpbb post:title] +``` + +### Post ID + +Outputs the post's ID. + +```markup +[wpbb post:id] +``` + +### Post Excerpt + +Outputs the post excerpt. + +```markup +[wpbb post:excerpt length='55' more=''] +``` + +- Options + + - **Length** - Accepts a number (number of words). Default is 55. + - **More** - Accepts text to appear after the excerpt + +- Example + + ```markup + [wpbb post:excerpt length='100' more='Continue Reading'] + ``` + +### Post Content + +Outputs the post's content. + +```markup +[wpbb post:content] +``` + +### Post Custom Field + +Outputs [WordPress custom fields](https://wordpress.org/support/article/custom-fields/) added to the page, post or custom post type. + +```markup +[wpbb post:custom_field key=''] +``` + +- Options + + - **Key** - Your custom field key/name + +- Example + + ```markup + [wpbb post:custom_field key='my_field_name'] + ``` + + - **Format** - Accepts date formats, such as `F j, Y` if the field value is a date. + + - Example + + ```markup + [wpbb post:custom_field key='my_field_name' format='F j, Y'] + ``` + + - Output + + ```markup + December 25, 2025 + ``` + +### Post Link + +Outputs the post's Link. + +```markup +[wpbb post:link text='title'] +``` + +- Options + + - **Link Text** - Choice of Post Title or Custom. + +- Example + + ```markup + [wpbb post:link text='custom' custom_text='Read More...'] + ``` + +### Post URL + +Outputs the post's URL. Example: `https://my-website.com/hello-world/`. + +```markup +[wpbb post:url] +``` + +### Post Slug + +Outputs the post's slug. Example: `hello-world`. + +```markup +[wpbb post:slug] +``` + +### Post Type + +Outputs the post types name, singular name, or slug. Example: `post`. + +```markup +[wpbb post:post_type display='slug'] +``` + +**Options** + +- **Display** - Choices are Slug, Singular Same, Name, or No Posts Found. + +:::tip + +This field connection comes in handy when you're utilizing a Post module that's set up to showcase various post types and you wish to apply distinct styling to individual elements based on the post type. + +See the [Expression Examples](examples/expressions.md#style-elements-based-on-post-type) article for more details. + +::: + +### Post Date + +See the [PHP date() document](https://secure.php.net/manual/en/function.date.php) for a list of date formats or use the Insert functionality in the Beaver Builder UI to choose from a list of date formats when you insert this field connection. + +```markup +[wpbb post:date format=''] +``` + +- Options + + - **Format** - Accepts date formats + +- Example + + ```markup + [wpbb post:date format='F j, Y'] + ``` + + - Output + + ```markup + December 25, 2021 + ``` + +### Post Modified Date + +See the [PHP date() document](https://secure.php.net/manual/en/function.date.php) for a list of date formats or use the Insert functionality in the Beaver Builder UI to choose from a list of date formats when you insert this field connection. + +```markup +[wpbb post:modified_date format=''] +``` + +- Options + + - **Format** - Accepts date formats. + +- Example + + ```markup + [wpbb post:modified_date format='F j, Y'] + ``` + +### Post Featured Image + +Outputs the post's [featured image](https://wordpress.org/support/article/settings-sidebar/#featured-image). + +```markup +[wpbb post:featured_image size='thumbnail' display='tag' align='left' linked='yes'] +``` + +- Options + + - **Size** - Thumbnail, Medium, Large, Full Size and any custom sizes you have. + - **Display** - Image Tag ([``](https://www.w3schools.com/tags/tag_img.asp)), URL, Title, Caption, Description or Alt. + - **Align** - default, left, center, right. + - **Linked** - Enable or disable the link on the featured image. + +- Example + + ```markup + [wpbb post:featured_image size='medium' display='tag' align='center' linked='yes'] + ``` + +### Post Attached Image + +Outputs any [images attached to the post](https://wordpress.org/support/article/using-image-and-file-attachments/#attachment-to-a-post). + +:::info +This field connection only appears in modules that have a gallery field setting, such as the Gallery or Slideshow modules. +::: + +```markup +[wpbb post:attached_images] +``` + +### Post Terms List + +Outputs the post's terms assigned to the post type you are editing. + +```markup +[wpbb post:terms_list taxonomy='category' html_list='no' display='name' separator=', ' limit= linked='yes'] +``` + +**Options** + +- **Taxonomy** (`taxonomy=''`) + Displays the taxonomy terms assigned to the post type your Themer layout applies to. + Examples: For standard posts, the terms are Categories and Tags. For WooCommerce Products, the terms are Product Categories and Product Tags. + +- **Layout** (`html_list=''`) + Choose how the terms are displayed from Separator, Unordered List (`