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. diff --git a/beaver-builder/getting-started/system-requirements.md b/beaver-builder/getting-started/system-requirements.md index 525b1602..f6e94f16 100644 --- a/beaver-builder/getting-started/system-requirements.md +++ b/beaver-builder/getting-started/system-requirements.md @@ -8,7 +8,7 @@ This article covers the recommended system requirements for installing and using ## WordPress -- Beaver Builder is compatible with WordPress version 6.6 or higher. +- Beaver Builder is compatible with WordPress version 6.8 or higher. - The WordPress REST API must be enabled: Beaver Builder relies on the REST API for key features. You can verify it’s active by visiting `/wp-json/` on your site (e.g., `https://yourwebsite.com/wp-json/`). We recommend a [WP memory limit](https://wordpress.org/support/article/editing-wp-config-php/#increasing-memory-allocated-to-php) of at least 128 MB, with 256 MB or more preferred for optimal performance. diff --git a/beaver-builder/introduction/about-release.md b/beaver-builder/introduction/about-release.md index 66974842..5fb07a99 100644 --- a/beaver-builder/introduction/about-release.md +++ b/beaver-builder/introduction/about-release.md @@ -6,127 +6,72 @@ toc_min_heading_level: 2 toc_max_heading_level: 2 --- -Beaver Builder 2.10 includes the following new features and improvements. +Beaver Builder 2.11 includes the following new features and improvements. ## :rocket: New Features The following features have been added: -### Beaver Builder Cloud +### Popup Module -Powered by Assistant Pro, Beaver Builder Cloud offers cloud storage and template sharing, making it easy to manage creative assets directly within Beaver Builder, without the need to install the Assistant plugin. +Popup is a new module that allows you to create dialogs, popovers, and flyouts that appear over page content, making it ideal for newsletter opt-ins, promotions, confirmations, videos, and other content that should appear at the right moment. -See the [Beaver Builder Cloud](../user-interface/cloud.md) article for more information. +See the [Popup Module](../layouts/modules/popup.mdx) article for more information. -### Components +### Maintenance Mode -A new Reusable Content type has been added called Components, which allow you to strike a balance between consistency and flexibility. Unlike templates, which are fully independent, or globals, which update universally, Components let you define which options stay fixed and which can be customized per instance. +Maintenance Mode is a new settings tab that allows you to temporarily show visitors a selected Beaver Builder layout while you update, launch, or work on your site. You can choose which roles bypass maintenance mode, schedule it for a specific time window, and return a 503 Service Unavailable status to help preserve search rankings. -See the [Components](../layouts/reusable-content/components.md) article for more information. +See the [Maintenance Mode](../settings/maintenance.md) article for more information. -### Star Rating Module +### Custom Attributes -Star Rating is a new module that allows you to easily display ratings, making it ideal for building testimonial sections and other content that benefits from visual feedback. +Custom Attributes is a new Advanced tab section that allows you to add HTML attributes to any row, column, or module. You can add attributes to the wrapper element, or, for modules, target an inner element with a CSS selector. This gives you more control over markup for accessibility, tracking, styling, JavaScript integrations, and other custom use cases. -See the [Star Rating Module](../layouts/modules/star-rating.md) article for more information. +See the [Custom Attributes](../layouts/advanced-tab/custom-attributes.md) article for more information. -### Pre-built Box Module Templates +### [Post Type] Settings tab -We’ve added over 60 pre-built layout templates powered by the Box module, including callouts, team member profiles, testimonials, hero sections, and more. You’ll also find Bento Grid layouts that showcase different ways to design grid-based sections with the Box module. These layouts not only give you ready-to-use designs but also serve as hands-on examples to help you learn and create your own Bento Grid layouts. +[Post Type] Setting is a new tab in the Layout Settings (formerly Layout CSS & JavaScript) panel that provides a convenient way to modify your page, post, product, or custom post type data without leaving the builder. It lets you edit key WordPress fields for the item you are currently building, with changes saved directly to the WordPress post rather than to Beaver Builder layout data. -### Version Control +The tab name changes to match the type of content you are editing. For example, it appears as Page Settings for pages, Post Settings for posts, Product Settings for WooCommerce products, and so on. -Version Control is now available, giving you the ability to quickly install any of the last 10 releases of Beaver Builder, Beaver Themer, or the Beaver Builder Theme (BB Theme) without manually downloading files. Designed primarily for troubleshooting and development, it lets you roll back or switch between recent releases directly from your settings panel, making it simple to test, troubleshoot, and manage versions. +### WordPress Font Library Support -See the [Version Control](../settings/version-control.md) article for more information. +Beaver Builder now supports the WordPress Font Library, allowing fonts installed or uploaded through WordPress to be used in Beaver Builder typography settings. Once a font is added to the Font Library, it becomes available in modules that include typography settings. -## :boom: Improvements - -The following improvements have been made: - -### Accessibility - -We’ve introduced a wide range of accessibility enhancements to improve usability and ensure compliance with modern standards. These updates focus on better keyboard navigation, proper use of ARIA attributes and roles, improved focus management, and more semantic HTML markup across modules. Any markup changes noted here have been implemented using the Deprecation API, ensuring they only affect new modules added to your layouts. The following list highlights the key accessibility improvements included in this release. - -
Accessibility Enhancements & Improvements - -- **Accordion Module** - Updated HTML tags for new modules, increased the focus ring size, and changed the key event listener from `keypress` to `keydown`. Ensured proper ARIA attributes are applied. Replaced the `.fl-menu-mobile-toggle` class with the generic `.fl-content-ui-button` class so these buttons are excluded from Global Styles button styling. Implemented support for closing tabs with the Escape key and ensured event handlers only target interactive buttons. All items now close when focus moves outside the accordion. - -- **Content Slider Module** - Improved accessibility by ensuring the focus ring is visible for links, adding support for reduced-motion preferences, preventing autoplay on focus in or out, and including ARIA labels and roles. Enhanced keyboard navigation with focus on slider dot navigation, updated HTML to use list and button tags, and made several other refinements. - -- **Gallery Module** - Deprecated `div` tags in favor of list tags and added ARIA roles for any remaining `div` elements. - -- **Menu Module** - Introduced multiple accessibility enhancements, including improved keyboard navigation, the use of appropriate ARIA attributes and roles, and adjustments to markup and sub-menu icon sizing. - -- **Photo Module** - Updated markup to use `figcaption` for captions, following accessibility best practices. - -- **Posts Module** - Improved accessibility by replacing the `div` container tag with an unordered list. Added a new option in the post container field. - -- **Post Slider & Post Carousel** - Enhanced accessibility by using list tags for slides, button tags for navigation and pagination, proper ARIA attributes, and ensuring visible focus on all controls. +### `post_id` Parameter -- **All Posts Modules** - Ensured redundant links are hidden from screen readers and excluded from keyboard navigation. +A new `post_id` parameter has been added to field connections, allowing you to pull content from a specific post instead of the current page, post, or loop item. This makes it possible to display data from another post anywhere in your layout, such as a featured post’s title, image, excerpt, or other connected field. -- **Tabs Module** - Replaced links and `div` elements with button tags for interactive elements, using the module deprecation API so changes only affect new modules. Ensured proper ARIA attributes are applied. +See the [Post ID](/beaver-themer/field-connections/syntax#post-id) section for more information. -- **Testimonials Module** - Changed the HTML structure from `div` to `blockquote`, applied through the module deprecation API so it only affects new modules. Added support for the reduced-motion preference and introduced an option to display play/pause buttons. - -- **Row Shapes** - Added generic titles and descriptions to row shapes to improve accessibility. - -- **Modules Displaying Excerpts** - Updated the default “Read More” text to provide clearer context, following accessibility recommendations. - -
- -### Modules - -The following improvements have been added for the modules listed below. +## :boom: Improvements -- **Box Module** - We’ve added a new global setting that applies row spacing to top-level boxes for Grid & Spacing. This setting is enabled by default on new sites, but remains disabled for sites updating from version 2.9 to 2.10 to maintain backward compatibility. +The following improvements have been made: -- **Button Module** - Added responsive support for more fields, including custom width, text color, background color, and border color. +### Accessibility -- **Menu Module** - Introduced a new width option for the flyout menu. +- Links that open in a new tab now include screen-reader text. +- Global Styles adds outline styling controls for interactive elements. +- Accordion module HTML structure improved through module deprecation for backward compatibility. +- Accordion buttons now have unique accessible names. +- Search module gets proper accessibility attributes. +- Search module adds a new reveal layout. +- Content Slider, Post Slider, and Post Carousel remove end navigation when looping is disabled and add aria-hidden where needed. +- Number Counter wraps number prefix/suffix in spans through module deprecation for backward compatibility. ### User Interface (UI) -The following improvements have been added for the Beaver Builder user interface. - -- **Content Panel** - Reworked the pre-built rows and modules panels to show categories instead of a dropdown. - -- **Saved Tab** - Added the ability to collapse the sections in the Saved panel. - -- **Nodes** _(rows, columns, & modules)_ - Added a "Save As" action to the settings dropdown on overlays. Added a "Type" select in the "Save As" form to include Template, Global, and Component. - -- **Outline Panel** - Added [copy and paste options to the context menu](/beaver-builder/user-interface/outline-panel.md#context-menu-right-click) in the Outline Panel. - -### WordPress Admin - -- Updated the WP Admin list table to display **Global** or **Component** labels. -- Refined user access settings to allow editing of per-page component settings without granting access to the component itself. -- Added a new user access option to enable or [disable cloud access based on user role](/beaver-builder/settings/user-access.md#cloud-access). +- Overlays now show parent container overlays similar to rows when enough space is available. +- Overlays now render in the body instead of layout markup to avoid styling conflicts with the coming 3.0 design panel. +- Outline Panel adds Save As to the context menu. +- Outline Panel adds direct export for Globals/Components from the context menu. +- [Applying a Template](../layouts/templates/index.md#apply-a-template-to-a-page-or-post) to a page or post now supports Prepend. +- The settings panel has been updated with a cleaner, more modern design to make it easier to navigate and use. ### Other Changes -- **Performance** - Improved the time it takes for settings to initially render when first opened. - -- **Subscribe Module** - Added support for ConvertKit custom fields +- Font Awesome 7 Support +- Font Awesome Pro Style Support +- Icon Field Connection Support 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. 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 +
+ +
+``` + +
diff --git a/beaver-builder/layouts/modules/accordion.mdx b/beaver-builder/layouts/modules/accordion.mdx new file mode 100644 index 00000000..4de1d99c --- /dev/null +++ b/beaver-builder/layouts/modules/accordion.mdx @@ -0,0 +1,589 @@ +--- +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 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. diff --git a/beaver-builder/layouts/modules/acf-block.mdx b/beaver-builder/layouts/modules/acf-block.mdx new file mode 100644 index 00000000..73cb875b --- /dev/null +++ b/beaver-builder/layouts/modules/acf-block.mdx @@ -0,0 +1,43 @@ +--- +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 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. diff --git a/beaver-builder/layouts/modules/audio.mdx b/beaver-builder/layouts/modules/audio.mdx new file mode 100644 index 00000000..e20eb674 --- /dev/null +++ b/beaver-builder/layouts/modules/audio.mdx @@ -0,0 +1,193 @@ +--- +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 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. + +## 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.mdx b/beaver-builder/layouts/modules/bigcommerce.mdx new file mode 100644 index 00000000..82817c6b --- /dev/null +++ b/beaver-builder/layouts/modules/bigcommerce.mdx @@ -0,0 +1,98 @@ +--- +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 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. diff --git a/beaver-builder/layouts/modules/box.mdx b/beaver-builder/layouts/modules/box.mdx new file mode 100644 index 00000000..cb9f2c43 --- /dev/null +++ b/beaver-builder/layouts/modules/box.mdx @@ -0,0 +1,671 @@ +--- +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 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. diff --git a/beaver-builder/layouts/modules/button-group.mdx b/beaver-builder/layouts/modules/button-group.mdx new file mode 100644 index 00000000..ae4eed43 --- /dev/null +++ b/beaver-builder/layouts/modules/button-group.mdx @@ -0,0 +1,301 @@ +--- +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 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. + +:::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..3affa76a --- /dev/null +++ b/beaver-builder/layouts/modules/button.mdx @@ -0,0 +1,372 @@ +--- +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 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. diff --git a/beaver-builder/layouts/modules/callout.mdx b/beaver-builder/layouts/modules/callout.mdx new file mode 100644 index 00000000..c1729bbd --- /dev/null +++ b/beaver-builder/layouts/modules/callout.mdx @@ -0,0 +1,773 @@ +--- +title: Callout +sidebar_label: Callout +icon: "phone-outgoing" +description: "Combine a heading, descriptive text, an optional image or icon, and a call-to-action link or button into a single attention-grabbing block." +--- + + +Combine a heading, descriptive text, an optional image or icon, and a call-to-action link or button into a single attention-grabbing block. + +## Usage + +The Callout module bundles a heading, descriptive text, an optional photo or icon, and a call-to-action link or button into one cohesive unit. It is purpose-built for drawing attention to key messages and driving visitors toward a specific next step without requiring you to assemble and align separate heading, text, image, and button modules. + +A common use case is displaying a row of feature callouts — each with an icon, a short heading, supporting text, and a link to a relevant page. Because all of those elements live inside a single module, they stay grouped and stack correctly at smaller screen sizes without any extra configuration. + +The link you set on the **Link** tab applies simultaneously to the heading, the photo or icon, and any button or link text. This makes it straightforward to create linked cards without wiring up multiple separate links. + +## Module Settings + +The Callout module is organized into four tabs — **General**, **Style**, **Image**, and **Link** — plus the standard **Advanced** tab. + +### General Tab + +The General tab contains the core content for the callout: the heading and the body text. + +
+Heading Supports: Field Connections + + +The main heading text displayed at the top of the callout. Supports inline editing directly on the canvas. +
+ +
+Heading Tag Default: h3 + + +Sets the HTML element used for the heading. Options: `h1`, `h2`, `h3`, `h4`, `h5`, `h6`. + +Choose a tag that reflects the heading's position in the page content hierarchy. Use the **Heading Typography** settings on the Style tab to control visual appearance independently of the tag level. +
+ +
+Text Supports: Field Connections + + +The body text displayed below the heading. Uses a rich text editor that supports basic formatting including bold, italic, and inline links. +
+ +### Style Tab + +The Style tab controls the callout's background, border, layout alignment, padding, and the color and typography of both the heading and the body text. + +
+Background Color Supports: Field Connections + + +Sets the background color for the entire callout container. Supports full alpha transparency. +
+ +
+Border settings + +Border settings control border style, width, color, radius, and related responsive border controls where available. + +
+ +
+Alignment Default: Left; Supports: Responsive + + +Controls the horizontal alignment of all elements within the callout — heading, text, image or icon, and button. + +- **Left:** Aligns all elements to the left edge. +- **Center:** Centers all elements. +- **Right:** Aligns all elements to the right edge. + +
+ +
+Padding Supports: Responsive + + +Sets the spacing between the callout container's edge and its inner content. +
+ +
+Heading + + +Style settings for the callout heading. + +
+Heading style settings + + +
+Heading Color Supports: Field Connections + + +Sets the text color of the heading, including the state when the heading is used as a link. +
+ +
+Heading Typography Supports: Responsive + + +Font settings for the callout heading. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +
+Text + + +Style settings for the body text and any text-type call-to-action link. + +
+Text style settings + + +
+Text Color Supports: Field Connections + + +Sets the color of the body text. Also applies to link text when **CTA Type** is set to **Link**. +
+ +
+Text Typography Supports: Responsive + + +Font settings for the body text and link text. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +### Image Tab + +The Image tab lets you add an optional visual element to the callout — either a photo from the media library or an icon from the icon picker. + +
+Image Type Default: Photo + + +Determines the type of visual element displayed in the callout. + +- **None:** No image or icon is shown. +- **Photo:** Displays an image selected from the WordPress media library. +- **Icon:** Displays an icon selected from the icon picker. + +
+Photo settings + + +
+Photo + + +Settings for selecting and positioning the photo. + +
+Photo source and position + + +
+Photo Supports: Field Connections + + +Select an image from the WordPress media library. +
+ +
+Position Default: Above Heading + + +Controls where the photo appears relative to the callout content. + +- **Above Heading:** Photo sits above the heading and text. +- **Below Heading:** Photo appears between the heading and the body text. +- **Left of Text and Heading:** Photo is placed to the left of both the heading and text as a column. +- **Right of Text and Heading:** Photo is placed to the right of both the heading and text as a column. + +
+
+
+ +
+Photo Style + + +Styling options for the photo's shape, size, alignment, and border. + +
+Photo style settings + + +
+Crop + + +Crops the photo into a predefined shape. Options: **None**, **Landscape**, **Panorama**, **Portrait**, **Square**, **Circle**. +
+ +
+Width Supports: Responsive + + +Sets a maximum width for the photo. Accepts values in `px`, `vw`, or `%`. When left blank, the image width is determined by the size selected in the **Photo** field. +
+ +
+Align Supports: Responsive + + +Aligns the photo within its column space. When the photo is positioned left or right, this aligns the photo within that column. + +- **Left:** Aligns the photo to the left. +- **Center:** Centers the photo. +- **Right:** Aligns the photo to the right. + +
+ +
+Border Supports: Responsive + + +Applies a border to the photo element including radius, which rounds the photo corners or creates a circle effect when combined with a square crop. +
+
+
+
+ +
+Icon settings + + +
+Icon + + +Settings for selecting and positioning the icon. + +
+Icon source and position + + +
+Icon + + +Select an icon using the icon picker. +
+ +
+Screen Reader Text + + +A text label read by screen readers but not displayed visually. Use this to provide an accessible description when the icon conveys meaning without accompanying visible text. +
+ +
+Position Default: Left of Heading + + +Controls where the icon appears relative to the callout content. + +- **Above Heading:** Icon sits above the heading. +- **Below Heading:** Icon appears between the heading and body text. +- **Left of Heading:** Icon is inline to the left of the heading text only; the body text and button flow below both. +- **Right of Heading:** Icon is inline to the right of the heading text only. +- **Left of Text and Heading:** Icon is placed to the left of both the heading and text as a side column. +- **Right of Text and Heading:** Icon is placed to the right of both the heading and text as a side column. + +
+
+
+ +
+Icon Colors + + +Color settings for the icon and its optional background. + +
+Icon color settings + + +
+DuoTone Primary Color (DuoTone Icons Only) Supports: Field Connections + + +Sets the primary (foreground) color for DuoTone icon styles. +
+ +
+DuoTone Secondary Color (DuoTone Icons Only) Supports: Field Connections + + +Sets the secondary color for DuoTone icon styles. +
+ +
+Color Supports: Field Connections + + +Sets the default icon color. When not specified, the theme's default accent color is used. +
+ +
+Hover Color Supports: Field Connections + + +Sets the icon color when a visitor hovers over the callout. When not specified, the default accent color is used. +
+ +
+Background Color Supports: Field Connections + + +Adds a circular background shape behind the icon. When no color is set, no background is shown. +
+ +
+Background Hover Color Supports: Field Connections + + +Sets the background color on hover. When not specified, the **Background Color** value is used. +
+ +
+Gradient Default: No + + +Applies a gradient effect to the icon background. + +- **No:** No gradient is applied. +- **Yes:** Enables the gradient on the icon background. + +
+
+
+ +
+Icon Structure + + +Controls the size of the icon. + +
+Icon size settings + + +
+Size Default: 30px; Supports: Responsive + + +Sets the icon's font size. Accepts values in `px`, `em`, or `rem` units. +
+
+
+
+
+ +### Link Tab + +The Link tab configures the module-level link and the call-to-action element displayed in the callout. + +
+Link Supports: Field Connections + + +Sets the URL the callout links to. This link is applied to the heading, the photo or icon, and any call-to-action button or link text defined below. + +
+Link settings + +Link settings control the URL, link target, nofollow behavior, download behavior, and other link attributes where available. + +
+
+ +
+Call to Action + + +Configures the call-to-action element shown below the body text. + +
+CTA settings + + +
+Type Default: None + + +Selects the style of call-to-action displayed. + +- **None:** No call-to-action is shown. Any link set in the **Link** section above still applies to the heading and image. +- **Link:** Displays the CTA as styled hyperlink text. +- **Button:** Displays the CTA as a styled button. + +
+Link CTA settings + + +
+Text Default: Read More; Supports: Field Connections + + +The label displayed on the link. +
+ +
+Link Color Supports: Field Connections + + +Sets the default text color for the CTA link. +
+ +
+Link Hover Color Supports: Field Connections + + +Sets the text color when the CTA link is hovered or focused. +
+ +
+Link Typography Supports: Responsive + + +Font settings for the CTA link text. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+ +
+Button CTA settings + + +
+Text Default: Read More; Supports: Field Connections + + +The label displayed on the button. +
+ +
+Button Icon + + +Adds an optional icon to the button. Select an icon from the icon picker to display alongside the button text. + +
+Button icon settings + + +
+Button Icon Position Default: Before Text + + +Controls whether the icon appears before or after the button text. + +- **Before Text:** Icon is shown to the left of the label. +- **After Text:** Icon is shown to the right of the label. + +
+ +
+Button Icon Visibility Default: Always Visible + + +Controls when the icon is visible. + +- **Always Visible:** Icon is shown at all times. +- **Fade In On Hover:** Icon is revealed only when the button is hovered. + +
+ +
+DuoTone Primary Color (DuoTone Icons Only) Supports: Field Connections + + +Sets the primary color for DuoTone button icon styles. +
+ +
+DuoTone Secondary Color (DuoTone Icons Only) Supports: Field Connections + + +Sets the secondary color for DuoTone button icon styles. +
+
+
+ +
+Button Width Default: Auto + + +Sets whether the button sizes to its content or expands to fill the full container width. + +- **Auto:** Button width is determined by its content. +- **Full Width:** Button stretches to fill the full width of the callout. + +
+Auto width settings + + +
+Button Align Supports: Responsive + + +Aligns the button horizontally within the callout. Available when **Button Width** is set to **Auto**. +
+
+
+ +
+Button Padding Supports: Responsive + + +Sets internal spacing around the button text and icon. +
+ +
+Button Text Color Supports: Field Connections + + +Sets the default color of the button text. +
+ +
+Button Text Hover Color Supports: Field Connections + + +Sets the text color when the button is hovered or focused. +
+ +
+Button Typography Supports: Responsive + + +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 Style Default: Flat + + +Selects the background rendering mode for the button. + +- **Flat:** Solid background color. +- **Auto Gradient:** Automatically generates a gradient from the button background color. +- **Advanced Gradient:** Uses gradient pickers for full gradient control. + +
+Flat background settings + + +
+Button Background Color Supports: Field Connections + + +Sets the button's background color. +
+ +
+Button Background Hover Color Supports: Field Connections + + +Sets the background color on hover. +
+ +
+Button Background Animation Default: Disabled + + +Animates the background color transition on hover. + +- **Disabled:** No animation. +- **Enabled:** Background color animates on hover. + +
+
+ +
+Auto gradient settings + + +
+Button Background Color Supports: Field Connections + + +Sets the button's background color used to generate the gradient. +
+ +
+Button Background Hover Color Supports: Field Connections + + +Sets the background color on hover used to generate the hover gradient. +
+
+ +
+Advanced gradient settings + + +
+Background Gradient + + +Configures the button background gradient. +
+ +
+Background Hover Gradient + + +Configures the button background hover gradient. +
+
+
+ +
+Button Border + + +Applies a border to the button. + +
+Button border settings + + +
+Button Border Supports: Responsive + + +Configure the button border style, width, color, and radius. +
+ +
+Button Border Hover Color Supports: Field Connections + + +Sets the border color when the button is hovered or focused. +
+
+
+
+
+
+
+ +## 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. + +## CSS Customization + +Use custom CSS to style the Callout module beyond the available settings. + +:::tip + +The examples below target the `.fl-module-callout` parent class, which applies styles to all Callout modules on your site. + +To style a specific Callout module, assign it a custom class on the **Advanced** tab and replace `.fl-module-callout` with your custom class name. + +```css +.my-custom-class .fl-callout-title { + color: #333333; +} +``` +::: + + +
+Callout Heading + + +Style the callout heading text. + +```css +.fl-module-callout .fl-callout-title { + font-size: 24px; + font-weight: 700; + color: #222222; +} +``` +
+ +
+Callout Body Text + + +Style the callout's body text content. + +```css +.fl-module-callout .fl-callout-text { + font-size: 16px; + line-height: 1.6; + color: #555555; +} +``` +
+ +
+Callout Photo + + +Add styles to the callout photo, such as a drop shadow or hover effect. + +```css +/* Add a drop shadow to the photo */ +.fl-module-callout .fl-photo-img { + box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15); +} + +/* Scale the photo on hover */ +.fl-module-callout .fl-callout-photo:hover .fl-photo-img { + transform: scale(1.03); + transition: transform 0.3s ease; +} +``` +
+ +
+CTA Link Text + + +Style the call-to-action link text when **CTA Type** is set to **Link**. + +```css +.fl-module-callout .fl-callout-cta-link { + font-weight: 600; + text-decoration: underline; +} + +.fl-module-callout .fl-callout-cta-link:hover { + text-decoration: none; +} +``` +
diff --git a/beaver-builder/layouts/modules/contact-form.mdx b/beaver-builder/layouts/modules/contact-form.mdx new file mode 100644 index 00000000..a8d56e84 --- /dev/null +++ b/beaver-builder/layouts/modules/contact-form.mdx @@ -0,0 +1,579 @@ +--- +title: Contact Form +sidebar_label: Contact Form +icon: "mail" +description: "Use Contact Form to add a simple email form with configurable fields, spam protection, and post-submit actions." +--- + + +Use Contact Form to add a simple email form with configurable fields, spam protection, and post-submit actions. + +## Usage + +Use Contact Form to add a simple AJAX-powered email form with optional name, subject, email, phone, and message fields. It sends submissions through WordPress `wp_mail()`, supports a required terms and conditions checkbox, and can protect submissions with Google reCAPTCHA. After a successful submission, it can show a confirmation message or redirect visitors to another URL. + +Use Contact Form on contact pages, landing pages, service pages, and other layouts that need a lightweight inquiry form without a separate form plugin. It fits straightforward single-step contact workflows where field requirements, submission handling, and styling stay simple. + +## Module Settings + +The Contact Form module settings control where submissions go, which fields appear, how the form looks, and how the form handles spam protection and successful submissions. + +### General Tab + +The General tab sets the recipient address, visible form fields, and post-submit behavior. + +
+Send To Email Supports: Field Connections + + +The email address that receives form submissions. When left empty, the module sends notifications to the WordPress admin email. +
+ +
+Fields + + +The Fields section controls which contact form fields appear, the text used for their labels and placeholders, how labels display, and whether the form requires terms acceptance before submission. + +
+Form Fields + + +
+Name Field Default: Show + + +Shows or hides the name input. + +
+Name Field Placeholder + + +
+Name Field Placeholder Default: Your name + + +The text used for the name field label, placeholder, or both, depending on **Show labels/placeholders**. +
+
+
+ +
+Subject Field Default: Hide + + +Shows or hides the subject input. + +
+Subject Field Placeholder + + +
+Subject Field Placeholder Default: Subject + + +The text used for the subject field label, placeholder, or both, depending on **Show labels/placeholders**. This field appears when **Subject Field** is set to **Show**. +
+
+ +
+Email Subject + + +
+Email Subject Default: Contact Form Submission; Supports: Field Connections + + +The subject line used for notification emails when **Subject Field** is set to **Hide**. Supports shortcodes. +
+
+
+ +
+Email Field Default: Show + + +Shows or hides the email input. + +
+Email Field Placeholder + + +
+Email Field Placeholder Default: Your email + + +The text used for the email field label, placeholder, or both, depending on **Show labels/placeholders**. This field appears when **Email Field** is set to **Show**. +
+
+
+ +
+Phone Field Default: Hide + + +Shows or hides the phone input. + +
+Phone Field Placeholder + + +
+Phone Field Placeholder Default: Your phone + + +The text used for the phone field label, placeholder, or both, depending on **Show labels/placeholders**. This field appears when **Phone Field** is set to **Show**. +
+
+
+ +
+Your Message Placeholder Default: Your message + + +The text used for the message field label, placeholder, or both, depending on **Show labels/placeholders**. +
+ +
+Show labels/placeholders Default: Show Both + + +Controls whether fields show placeholders only, labels only, or both. Selecting **Show Labels Only** or **Show Both** reveals the **Labels** group in the Style tab. +
+ +
+Terms and Conditions Checkbox Default: Hide + + +Shows or hides a required acceptance checkbox. + +
+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 configures the action that runs after a successful submission. + +
+Success Settings + + +
+Success Action + + +Determines whether submission shows the built-in confirmation text, displays a custom message, or redirects to another URL. Options are **None**, **Show Message**, and **Redirect**. + +
+Success Message + + +
+Success Message Default: Thanks for your message! We'll be in touch soon.; Supports: Field Connections + + +The confirmation message displayed after a successful submission when **Success Action** is set to **Show Message**. +
+
+ +
+Success URL + + +
+Success URL Supports: Field Connections + + +The destination URL used after a successful submission when **Success Action** is set to **Redirect**. +
+
+
+
+
+ +### Style Tab + +The Style tab controls the appearance of labels, inputs, and the submit button. + +
+Labels + + +This group is available when **Show labels/placeholders** is set to **Show Labels Only** or **Show Both** in the General tab. + +
+Labels + + +
+Padding Supports: Responsive, Link Values + + +The inner spacing around each text label. +
+ +
+Color Supports: Field Connections + + +The text color of form labels. +
+ +
+Typography Supports: Responsive + + +The font settings for form labels. +
+
+
+ +
+Inputs + + +The Inputs section controls the appearance of text inputs and the message textarea. + +
+Inputs + + +
+Padding Supports: Responsive, Link Values + + +The inner spacing of text inputs and the message textarea. +
+ +
+Color + + +The text and placeholder color of text inputs and the message textarea. +
+ +
+Typography Supports: Responsive + + +The font settings for text inputs and the message textarea. +
+ +
+Background Color Supports: Field Connections + + +The background color of text inputs and the message textarea. +
+ +
+Background Hover Color Supports: Field Connections + + +The background color used when text inputs and the message textarea are hovered. +
+ +
+Border + + +The border style, width, radius, and color for text inputs and the message textarea. +
+ +
+Border Hover + + +The border style used when text inputs and the message textarea are hovered or focused. +
+
+
+ +
+Button + + +The Button section controls the appearance of the submit button. + +
+Button settings + + +
+Text Default: Send + + +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 Default: #5b5b5b; Supports: Field Connections + + +For Font Awesome DuoTone icons only: the primary color applied to the icon. +
+
+ +
+DuoTone Secondary Color + + +
+DuoTone Secondary Color Default: #757575; 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. +
+
+
+ +
+Width Default: Auto + + +Sets the button width to **Auto** or **Full Width**. + +
+Align + + +
+Align Default: Left; Supports: Responsive + + +The horizontal alignment of the button within its wrapper when **Width** is set to **Auto**. +
+
+
+ +
+Padding Supports: Responsive, Link Values + + +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. +
+ +
+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. +
+ +
+Background Animation Default: Disabled + + +Enables or disables the transition between 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)**, **Invisible (V2)**, and **Invisible (V3)**. Checkbox and invisible flows use different Google API key pairs. + +
+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. +
+
+
+ +## 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. + +## Feature Guides + +### Set up reCAPTCHA + +Use this workflow when the form needs Google reCAPTCHA protection. + +1. Open the **Captcha** tab and set **reCAPTCHA Field** to **Show**. +2. Choose **Validate Type** based on the submission flow: **"I'm not a robot" checkbox (V2)**, **Invisible (V2)**, or **Invisible (V3)**. +3. Register the site in the Google reCAPTCHA Admin Console using the same validation type selected in the module. +4. Use a different key pair for each validation type when the site uses both v2 and v3 forms. +5. Paste the public key into **Site Key** and the private key into **Secret Key**. +6. Set **Theme** to **Light** or **Dark** for visible widgets. +7. If **Validate Type** is **Invisible (V3)**, add an **Action** value that matches the verification flow for that form. +8. Publish the page and submit the form from the front end. +9. If verification fails, recheck the selected validation type, hostname, and key pair. diff --git a/beaver-builder/layouts/modules/content-slider.mdx b/beaver-builder/layouts/modules/content-slider.mdx new file mode 100644 index 00000000..07f0acf8 --- /dev/null +++ b/beaver-builder/layouts/modules/content-slider.mdx @@ -0,0 +1,780 @@ +--- +title: Content Slider +sidebar_label: Content Slider +icon: "gallery-horizontal" +description: "Use Content Slider to display multiple slides with background images, video, or color, combined with optional headings, text, and call-to-action buttons." +--- + + +Use Content Slider to display multiple slides with background images, video, or color, combined with optional headings, text, and call-to-action buttons. + +## Usage + +Use Content Slider to build a multi-slide presentation where each slide displays a background image, video, or solid color, combined with a heading, body text, and an optional call-to-action link or button. Slides cycle automatically on a configurable delay or respond to user navigation through arrows or dot controls. + +This module works well for hero sections, promotional banners, featured content rotators, and any layout where a sequence of visually distinct messages shares a single fixed space on the page. + +## Module Settings + +The Content Slider module settings control what each slide displays, how the slider cycles between slides, and the global dimensions and colors applied across all slides. + +### Slides Tab + +The Slides tab manages individual slides and their content, background, style, link, and mobile settings. + +
+Slides + + +The Slides section manages each slide displayed by the module. + +
+Slide Settings + + +
+Slide + + +Adds one or more slides to the module. Each slide has its own General, Style, Link, and Mobile settings. + +
+General tab + + +
+Slide Label + + +A label used to identify the slide in the Slides tab list. Not displayed on the front end. +
+ +
+Background + + +The Background section configures the visual background of the slide. + +
+Background Settings + + +
+Type Default: Photo + + +Selects the background type for the slide. + +- **Photo:** Uses an uploaded image as the slide background and reveals the Background Photo and Overlay Color fields. +- **Video:** Uses embedded video code as the slide background. Content overlay settings are not available when this type is selected. +- **Color:** Uses a solid or transparent fill as the slide background and reveals the Background Color field. +- **None:** Renders the slide with no background. + +
+Photo Settings + + +
+Background Photo + + +Sets the background image for the slide. +
+ +
+Overlay Color Supports: Field Connections + + +Adds a color overlay on top of the background photo. Supports alpha transparency. +
+
+ +
+Video Settings + + +
+Background Video Code + + +Paste the embed code for the video displayed as the slide background. Content overlay settings are not available when **Type** is set to **Video**. +
+
+ +
+Color Settings + + +
+Background Color Supports: Field Connections + + +Sets the background fill color for the slide. Supports alpha transparency. +
+
+
+
+
+ +
+Content + + +The Content section configures the overlay content displayed over the slide background. Not available when **Background Type** is set to **Video**. + +
+Content Settings + + +
+Type (Content) Default: None + + +Selects the content layout displayed over the slide background. + +- **Text:** Displays a heading and body text over the background. +- **Text & Photo:** Displays a heading, body text, and an uploaded photo. +- **Text & Video:** Displays a heading, body text, and an embedded video. +- **None:** Adds no content overlay to the slide. + +
+Text Content + + +
+Heading + + +Sets the heading text for the slide. Available when **Type** is set to **Text**, **Text & Photo**, or **Text & Video**. +
+ +
+Content + + +Sets the body text for the slide using the WordPress Classic Editor. Available when **Type** is set to **Text**, **Text & Photo**, or **Text & Video**. +
+
+ +
+Photo (Text & Photo Only) + + +
+Photo + + +Sets the foreground photo displayed alongside the slide text when **Type** is set to **Text & Photo**. +
+
+ +
+Video (Text & Video Only) + + +
+Video Embed Code + + +Paste the embed code for the foreground video displayed alongside the slide text when **Type** is set to **Text & Video**. +
+
+
+
+
+
+ +
+Style tab + + +
+Position Default: Left + + +Sets the horizontal alignment of the content overlay within the slide. + +- **Left:** Aligns the content area to the left side of the slide. +- **Center:** Centers the content area within the slide. +- **Right:** Aligns the content area to the right side of the slide. + +
+ +
+Width Default: 50 + + +Sets the percentage width of the content area within the slide. +
+ +
+Background Color Supports: Field Connections + + +Sets the color of the overlay behind the slide text content. Applies to the content area independently of the slide background. +
+ +
+Background Height Default: Auto + + +Controls whether the text background overlay matches the content height or stretches to the full slide height. + +- **Auto:** The overlay fits the height of the text content. +- **100%:** The overlay extends the full height of the slide. + +
+ +
+Margins Supports: Link Values + + +Sets the outer margins around the slide content area. +
+ +
+Padding Supports: Link Values + + +Sets the inner padding within the slide content area. +
+ +
+Heading Tag Default: h2 + + +Sets the HTML element used for the slide heading. + +- **h1** through **h6:** Renders the heading with the selected HTML heading tag. + +
+ +
+Color (Heading) Default: #ffffff; Supports: Field Connections + + +Sets the color of the slide heading text. +
+ +
+Typography (Heading) Supports: Responsive + + +The font settings for the slide heading. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+ +
+Color (Text) Default: #ffffff; Supports: Field Connections + + +Sets the color of the slide body text. +
+ +
+Typography (Text) Supports: Responsive + + +The font settings for the slide body text. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+ +
+Link tab + + +
+Link + + +Sets the link applied to the entire slide. When a call-to-action type is selected, this link is also used for the CTA text or button. + +This field also includes Link Attributes for opening the link in a new tab, adding `nofollow`, and forcing downloads. + +
+Link Attributes + + +
+Open in New Tab + + +Opens the link in a new browser tab or window instead of the current page. Helpful for external links or downloads, so visitors do not lose their place on the site. + +Uses `target="_blank"` in the link code. +
+ +
+No Follow + + +Tells search engines not to pass ranking authority through the link. Commonly used for sponsored links, affiliate links, or links that should not affect search rankings. + +Uses `rel="nofollow"` in the link code. +
+ +
+Force Download + + +Prompts the browser to download the linked file instead of opening it. Useful for PDFs, ZIP files, and other downloadable files. + +If supported by the browser and file type, the link uses the `download` attribute. +
+
+
+ +
+Type (CTA) Default: None + + +Selects the call-to-action element displayed on the slide. + +- **None:** No call-to-action element is shown. +- **Link:** Displays the CTA as a text link using the slide link. +- **Button:** Displays the CTA as a styled button and reveals button styling settings. + +
+CTA Text + + +
+Text + + +Sets the label for the call-to-action link or button. Available when **Type** is set to **Link** or **Button**. +
+
+ +
+Button Settings + + +
+Button Icon Supports: Field Connections + + +Sets an icon displayed on the CTA button. When an icon is selected, reveals the icon position and visibility settings. + +
+Button Icon Settings + + +
+DuoTone Primary Color (DuoTone Icons Only) Supports: Field Connections + + +Sets the primary color for DuoTone Font Awesome icons on the button. +
+ +
+DuoTone Secondary Color (DuoTone Icons Only) Supports: Field Connections + + +Sets the secondary color for DuoTone Font Awesome icons on the button. +
+ +
+Button Icon Position Default: Before Text + + +Sets whether the icon appears before or after the button label. + +- **Before Text:** Displays the icon to the left of the button label. +- **After Text:** Displays the icon to the right of the button label. + +
+ +
+Button Icon Visibility Default: Always Visible + + +Controls when the button icon is visible. + +- **Always Visible:** Displays the icon at all times. +- **Fade In On Hover:** Shows the icon only when the button is hovered. + +
+
+
+ +
+Button Padding Supports: Responsive, Link Values + + +Sets the inner padding of the CTA button. +
+ +
+Button Text Color Supports: Field Connections + + +Sets the button label color. +
+ +
+Button Text Hover Color Supports: Field Connections + + +Sets the button label color on hover and focus. +
+ +
+Button Typography Supports: Responsive + + +The font settings for the CTA 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 Style Default: Flat + + +Selects the background fill method for the CTA button. + +- **Flat:** Uses a solid background color and reveals the background animation setting. +- **Auto Gradient:** Generates an automatic gradient from the background color. +- **Advanced Gradient:** Uses a custom gradient builder for the button background and hover state. Hides the solid color fields. + +
+Flat Settings + + +
+Button Background Color Supports: Field Connections + + +Sets the solid background color of the CTA button. +
+ +
+Button Background Hover Color Supports: Field Connections + + +Sets the button background color on hover and focus. +
+ +
+Button Background Animation Default: Disabled + + +Animates the background color transition on hover when set to **Enabled**. + +- **Enabled:** Applies a CSS transition to the background color on hover. +- **Disabled:** Changes the background color immediately on hover without animation. + +
+
+ +
+Auto Gradient Settings + + +
+Button Background Color Supports: Field Connections + + +Sets the base color used to generate the automatic gradient. +
+ +
+Button Background Hover Color Supports: Field Connections + + +Sets the hover color used to generate the automatic gradient on hover. +
+
+ +
+Advanced Gradient Settings + + +
+Background Gradient + + +Defines the custom gradient applied to the CTA button background. +
+ +
+Background Hover Gradient + + +Defines the custom gradient applied to the CTA button background on hover. +
+
+
+ +
+Button Border Supports: Responsive + + +Configures the border style, width, color, radius, and shadow for the CTA button. +
+ +
+Button Border Hover Color Supports: Field Connections + + +Sets the button border color on hover and focus. +
+
+
+
+ +
+Mobile tab + + +
+Type (Mobile Photo) Default: Use Main Photo + + +Selects the photo shown on mobile devices. + +- **Use Main Photo:** Displays the same background photo used on desktop. +- **Choose Another Photo:** Reveals the Photo field to select a different image for mobile. +- **No Photo:** Removes the background photo on mobile devices. + +
+Mobile Photo + + +
+Photo (Choose Another Photo Only) + + +Sets an alternative background photo displayed on mobile devices when **Type** is set to **Choose Another Photo**. +
+
+
+ +
+Content Background Color Default: #333333; Supports: Field Connections + + +Sets the background color of the content area on mobile devices. +
+ +
+Title Color Default: #ffffff; Supports: Field Connections + + +Sets the slide heading color on mobile devices. +
+ +
+Text Color Default: #ffffff; Supports: Field Connections + + +Sets the slide body text color on mobile devices. +
+
+
+
+
+ +### Slider Tab + +The Slider tab controls automatic playback, slide order, transition style, and navigation controls. + +
+Auto Play Default: Yes + + +Enables or disables automatic slide cycling. + +- **Yes:** Slides advance automatically and reveals the **Show Play/Pause** setting. +- **No:** Slides only advance through user interaction. + +
+Play/Pause Settings + + +
+Show Play/Pause Default: No + + +Shows or hides a play/pause control on the slider when **Auto Play** is enabled. + +- **Yes:** Displays a play/pause button on the slider. +- **No:** Hides the play/pause button. + +
+
+
+ +
+Shuffle Default: No + + +Randomizes the slide order on each page load. + +- **Yes:** Plays slides in a random order. +- **No:** Plays slides in the order they are defined. + +
+ +
+Pause On Hover Default: Yes + + +Pauses automatic slide cycling when the cursor is over the slider. + +- **Yes:** Pauses the slider while the cursor is over it. +- **No:** Continues cycling regardless of cursor position. + +
+ +
+Loop Default: Yes + + +Controls whether the slider returns to the first slide after the last. + +- **Yes:** Cycles continuously from the last slide back to the first. +- **No:** Stops at the last slide. + +
+ +
+Delay Default: 5 + + +Sets how long each slide remains visible before advancing, in seconds. The delay should be greater than the transition speed. +
+ +
+Transition Default: Slide + + +Sets the animation used when moving between slides. + +- **Slide:** Moves horizontally from one slide to the next. +- **Fade:** Fades between slides. + +
+ +
+Transition Speed Default: 0.5 + + +Sets the duration of the slide transition animation, in seconds. The transition speed should be less than the delay. +
+ +
+Show Arrows Default: No + + +Shows or hides previous and next navigation arrows on the slider. Enabling arrows also reveals the Arrows section in the Style tab. + +- **Yes:** Displays navigation arrows and reveals arrow style settings in the Style tab. +- **No:** Hides navigation arrows. + +
+ +
+Show Dots Default: Yes + + +Shows or hides dot navigation indicators below the slider. + +- **Yes:** Displays a dot indicator for each slide. +- **No:** Hides the dot indicators. + +
+ +### Style Tab + +The Style tab controls the slider dimensions, global text and overlay colors shared across all slides, and arrow navigation appearance. + +
+Height Default: 400 + + +Sets the minimum height of the slider in pixels. Slide content expands the height automatically when it exceeds this value. +
+ +
+Max Content Width Default: 1100 + + +Sets the maximum width of the content area within each slide in pixels. +
+ +
+Text Color Default: #ffffff; Supports: Field Connections + + +Sets a text color shared across all slides. Individual slides also set their own text color defaults. +
+ +
+Text Background Color Supports: Field Connections + + +Sets a background color applied to the overlay behind text content across all slides. Supports alpha transparency. +
+ +
+Arrows + + +The Arrows section controls the appearance of slider navigation arrows. This section is available when **Show Arrows** is set to **Yes** in the Slider tab. + +
+Arrow Settings + + +
+Arrows Background Color Supports: Field Connections + + +Sets the background color of the arrow navigation buttons. Supports alpha transparency. +
+ +
+Arrows Background Style Default: Circle + + +Sets the shape of the arrow navigation button background. + +- **Circle:** Renders the arrow background as a circle. +- **Square:** Renders the arrow background as a square. + +
+ +
+Arrows Color Supports: Field Connections + + +Sets the color of the arrow icons. +
+
+
+ +## 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. diff --git a/beaver-builder/layouts/modules/countdown.mdx b/beaver-builder/layouts/modules/countdown.mdx new file mode 100644 index 00000000..550c02e3 --- /dev/null +++ b/beaver-builder/layouts/modules/countdown.mdx @@ -0,0 +1,317 @@ +--- +title: Countdown +sidebar_label: Countdown +icon: "timer" +description: "Use the Countdown module to display a live timer that counts down to a target date and time." +--- + + +Use the Countdown module to display a live timer that counts down to a target date and time. + +## Usage + +The Countdown module outputs a live timer that ticks down to a specific date and time. Each time unit — days, hours, minutes, and seconds — displays as a labeled number block. Choosing the **Numbers + Circles** layout wraps each unit in an animated SVG circle that fills as the unit's time progresses. + +Use the Countdown module to build urgency for limited-time offers, event registrations, product launches, or sale deadlines. The optional redirect setting automatically sends visitors to a new URL once the countdown reaches zero, so the page responds to the event end without manual updates. + +## Module Settings + +The Countdown module settings control the target date and time, redirect behavior, and visual styling of the timer. + +### General tab + +The General tab sets the target date, time, time zone, and optional post-countdown redirect. + +
+Date Supports: Field Connections + + +Sets the target date the countdown counts down to. +
+ +
+Time + + +The Time section sets the time of day and time zone for the countdown target. + +
+Time settings + + +
+Time Default: 01:00; Supports: Field Connections + + +Sets the time of day for the countdown target. +
+ +
+Time Zone Default: UTC + + +Sets the time zone used to interpret the target date and time. +
+
+
+ +
+Redirect Default: Disabled + + +Controls whether the page redirects after the countdown reaches zero. + +- **Disabled:** No redirect occurs after the countdown ends. +- **Once After Countdown End:** Redirects the visitor once when the countdown reaches zero. +- **Always After Countdown End:** Redirects on every visit after the countdown has ended. + +
+URL + + +
+URL Supports: Field Connections + + +The destination URL used when **Redirect** is set to **Once After Countdown End** or **Always After Countdown End**. + +
+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 countdown layout, alignment, number and text appearance, and layout-specific visual options. + +
+Layout Default: Numbers + + +Selects whether the countdown displays numbers only or numbers with animated SVG circle progress indicators. + +- **Numbers:** Displays each time unit as a labeled number block. +- **Numbers + Circles:** Wraps each time unit in an animated SVG circle that fills as the unit progresses. + +
+Numbers Settings + + +
+Backgrounds + + +The Backgrounds section controls the background color and corner rounding of each number block. Available when **Layout** is set to **Numbers**. + +
+Backgrounds + + +
+Number Background Color Supports: Field Connections + + +Sets the background color applied behind each countdown number block. +
+ +
+Number Border Radius Default: 0 + + +Sets the corner rounding of each number block in `px`. +
+
+
+ +
+Separator + + +The Separator section controls whether visual separators appear between time units. Available when **Layout** is set to **Numbers**. + +
+Separator settings + + +
+Show Time Separators Default: No + + +Shows or hides separators between countdown time units. + +
+Separator options + + +
+Separator Type Default: Line + + +Sets the style of the separator displayed between time units when **Show Time Separators** is set to **Yes**. + +- **Colon:** Displays a colon character between time units. +- **Line:** Displays a vertical line between time units. + +
+Colon settings + + +
+Separator Size (Colon Only) Default: 15 + + +Sets the font size of the colon separator in `px`. Available when **Separator Type** is set to **Colon**. +
+
+
+ +
+Separator Color Supports: Field Connections + + +Sets the color of the separators between time units. +
+
+
+
+
+
+ +
+Numbers + Circles Settings + + +
+Circle Styles + + +The Circle Styles section controls the appearance of the SVG circle indicators. Available when **Layout** is set to **Numbers + Circles**. + +
+Circle Styles + + +
+Circle Foreground Color Default: f7951e; Supports: Field Connections + + +Sets the stroke color of the animated foreground arc on each circle. +
+ +
+Circle Background Color Default: eaeaea; Supports: Field Connections + + +Sets the stroke color of the static background track on each circle. +
+ +
+Circle Size Default: 200 + + +Sets the diameter of each circle indicator in `px`. +
+ +
+Circle Stroke Size Default: 10 + + +Sets the stroke width of both the foreground arc and background track in `px`. +
+
+
+
+
+ +
+Alignment Default: center; Supports: Responsive + + +Sets the horizontal alignment of the countdown timer. +
+ +
+Numbers and Text + + +The Numbers and Text section controls the color, typography, and spacing of countdown numbers and time unit labels. + +
+Numbers and Text + + +
+Number Color Supports: Field Connections + + +Sets the color of the countdown numbers. +
+ +
+Number Typography Supports: Responsive + + +The font settings for the countdown numbers. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+ +
+Text Color Supports: Field Connections + + +Sets the color of the time unit labels beneath each number. +
+ +
+Text Typography Supports: Responsive + + +The font settings for the time unit labels. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+ +
+Horizontal Padding (Numbers Only) Default: 10 + + +Sets the left and right padding inside each number block in `px`. Available when **Layout** is set to **Numbers**. +
+ +
+Vertical Padding (Numbers Only) Default: 10 + + +Sets the top and bottom padding inside each number block in `px`. Available when **Layout** is set to **Numbers**. +
+ +
+Number Spacing Default: 10 + + +Sets the horizontal margin between each countdown unit in `px`. +
+
+
+ +## 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. diff --git a/beaver-builder/layouts/modules/cta.mdx b/beaver-builder/layouts/modules/cta.mdx new file mode 100644 index 00000000..458d4ec4 --- /dev/null +++ b/beaver-builder/layouts/modules/cta.mdx @@ -0,0 +1,415 @@ +--- +title: Call to Action +sidebar_label: Call to Action +icon: "megaphone" +description: "Use Call to Action to display a heading, body text, and a styled button together as a single structured prompt for site visitors." +--- + + +Use Call to Action to display a heading, body text, and a styled button together as a single structured prompt for site visitors. + +## Usage + +The Call to Action module renders a heading, supporting text, and a button in a single self-contained unit. The heading and text are positioned alongside or above the button depending on the selected layout, and all three elements share a common background and padding container. The embedded button supports the same icon, color, gradient, and border settings as the standalone Button module. + +Use Call to Action for promotional banners, section endings, and landing page prompts where a headline and short message need to appear directly next to or above a primary action button. It suits layouts where the heading, text, and button share a background color or border and should move together as one unit. + +## Module Settings + +The Call to Action module settings control the heading and body text content, module layout and visual styling, and the embedded button behavior. + +### General Tab + +The General tab sets the heading text, heading tag, and body text for the module. + +
+Heading Default: Ready to find out more?; Supports: Field Connections + + +The main heading displayed at the top of the module. +
+ +
+Heading Tag Default: h3 + + +Sets the HTML tag used to render the heading. + +- **h1:** Renders the heading as an `

` element. +- **h2:** Renders the heading as an `

` element. +- **h3:** Renders the heading as an `

` element. +- **h4:** Renders the heading as an `

` element. +- **h5:** Renders the heading as an `

` element. +- **h6:** Renders the heading as an `
` element. + +
+ +
+Text Default: Drop us a line today for a free quote!; Supports: Field Connections + + +The body text displayed below the heading. Supports formatted text using the WordPress editor. +
+ +### Style Tab + +The Style tab controls the module layout, background, border, spacing, and the color and typography settings for the heading and body text. + +
+Layout Default: Inline + + +Determines how the text content and button are arranged within the module. + +- **Inline:** Places the text content and button side by side in a horizontal row. +- **Stacked:** Stacks the text content above the button in a vertical column. + +
+Alignment + + +
+Alignment (Stacked Only) Default: Center + + +Sets the horizontal alignment of all content within the module. This field appears when **Layout** is set to **Stacked**. +
+
+
+ +
+Background Color Supports: Field Connections + + +Sets the background color of the module content area. +
+ +
+Border settings + +Border settings control border style, width, color, radius, and related responsive border controls where available. + +
+ +
+Padding Default: 0; Supports: Responsive, Link Values + + +Sets the inner spacing around the module content area. Accepts `px`, `em`, or `%` units. +
+ +
+Heading + + +The Heading section controls the color and typography of the heading. + +
+Heading Settings + + +
+Heading Color Supports: Field Connections + + +Sets the text color of the module heading. +
+ +
+Heading Typography Supports: Responsive + + +The font settings for the module heading. + +
+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 color and typography of the body text. + +
+Text Settings + + +
+Text Color Supports: Field Connections + + +Sets the text color of the body text. +
+ +
+Text Typography Supports: Responsive + + +The font settings for the body text. + +
+Typography settings + +Typography settings control font family, size, weight, line height, letter spacing, text transform, and responsive text styling where available. + +
+
+
+
+ +### Button Tab + +The Button tab sets the button label, link, icon, padding, text colors, background, and border. + +
+Button Text Default: Click Here; Supports: Field Connections + + +Sets the label displayed inside the button. +
+ +
+Button Link Supports: Field Connections + + +Sets the URL, target, and link attributes for the button. + +
+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 an optional icon to the button and controls its position and visibility. + +
+Button Icon Settings + + +
+Button Icon Supports: Field Connections + + +Adds an optional icon to the button. Selecting an icon reveals the icon position and visibility controls. +
+ +
+DuoTone Primary Color (DuoTone Icons Only) Supports: Field Connections + + +Sets the primary color of the selected DuoTone icon. +
+ +
+DuoTone Secondary Color (DuoTone Icons Only) Supports: Field Connections + + +Sets the secondary color of the selected DuoTone icon. +
+ +
+Button Icon Position (Icon Only) Default: Before Text + + +Places the icon before or after the button text when an icon is selected. + +- **Before Text:** Displays the icon to the left of the button label. +- **After Text:** Displays the icon to the right of the button label. + +
+ +
+Button Icon Visibility (Icon Only) Default: Always Visible + + +Controls whether the icon is always shown or appears only on hover when an icon is selected. + +- **Always Visible:** The icon displays at all times. +- **Fade In On Hover:** The icon is hidden by default and fades in when the button is hovered. + +
+
+
+ +
+Button Padding Supports: Responsive, Link Values + + +Sets the inner spacing around the button label and icon. +
+ +
+Button Text + + +The Button Text section controls the colors and typography used for the button label. + +
+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. +
+ +
+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 button fill style, color, gradients, and hover animation. + +
+Button Background Settings + + +
+Button Background Style Default: Flat + + +Selects the background rendering mode for the button. + +- **Flat:** Uses a solid background color with an optional hover color and background animation. +- **Auto Gradient:** Automatically generates a gradient from the button background color. +- **Advanced Gradient:** Uses gradient pickers for full control over gradient colors, type, angle, and position. + +
+Flat settings + + +
+Button Background Color Supports: Field Connections + + +Sets the button background color when **Button Background Style** is **Flat**. +
+ +
+Button Background Hover Color Supports: Field Connections + + +Sets the background color on hover when **Button Background Style** is **Flat**. +
+ +
+Button Background Animation Default: Disabled + + +Enables or disables the background color transition on hover when **Button Background Style** is **Flat**. + +- **Disabled:** No transition between default and hover background colors. +- **Enabled:** Smoothly animates between the default and hover background colors. + +
+
+ +
+Auto Gradient settings + + +
+Button Background Color Supports: Field Connections + + +Sets the button background color used to generate the gradient when **Button Background Style** is **Auto Gradient**. +
+ +
+Button Background Hover Color Supports: Field Connections + + +Sets the background color on hover used to generate the hover gradient when **Button Background Style** is **Auto Gradient**. +
+
+ +
+Advanced Gradient settings + + +
+Background Gradient (Advanced Gradient Only) + + +Configures the default gradient colors, type, angle, and position when **Button Background Style** is set to **Advanced Gradient**. +
+ +
+Background Hover Gradient (Advanced Gradient Only) + + +Configures the hover gradient colors, type, angle, and position when **Button Background Style** is set to **Advanced Gradient**. +
+
+
+
+
+ +
+Button Border + + +The Button Border section controls the border style, color, width, radius, and shadow for the button. + +
+Button Border Settings + + +
+Button Border Supports: Responsive + + +Configures the button border style, color, width, radius, and box shadow. +
+ +
+Button Border Hover Color Supports: Field Connections + + +Sets the border color used when the button is hovered. +
+
+
+ +## 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. diff --git a/beaver-builder/layouts/modules/gallery.mdx b/beaver-builder/layouts/modules/gallery.mdx new file mode 100644 index 00000000..bea11664 --- /dev/null +++ b/beaver-builder/layouts/modules/gallery.mdx @@ -0,0 +1,139 @@ +--- +title: Gallery +sidebar_label: Gallery +icon: "images" +description: "Use Gallery to display multiple photos in a collage or grid layout with optional captions, lightbox, and SmugMug support." +--- + + +Use Gallery to display multiple photos in a collage or grid layout with optional captions, lightbox, and SmugMug support. + +## Usage + +Use Gallery to display multiple photos in a single module using either a Collage layout that arranges photos at varied widths or a Thumbs layout that renders uniform thumbnails. Photos can come from the WordPress media library or a SmugMug RSS feed, and each image can open in a built-in lightbox, link to its full-size source, or render without a click action. Captions read from the WordPress media manager or the SmugMug feed and can show on hover or below each photo. + +Use Gallery on portfolio pages, event recaps, product showcases, and any layout that needs to present a curated set of images without building a custom grid by hand. It fits straightforward image-collection workflows where photo selection, layout, and click behavior need to stay simple. + +## Module Settings + +The Gallery module settings control which photos appear, how the gallery is laid out, what happens when a photo is clicked, and the spacing and border applied to each image. + +### General Tab + +The General tab selects the layout, photo source, photos, captions, and click behavior. + +
+Layout Default: Collage + + +Sets how photos are arranged in the gallery. + +- **Collage:** Arranges photos at varied widths in a masonry-style layout and reveals the **Photo Size** field. +- **Thumbs:** Renders photos as uniform thumbnails based on the WordPress thumbnail size. + +
+ +
+Source Default: Media Library + + +Selects whether photos come from the WordPress media library or a SmugMug RSS feed. + +- **Media Library:** Pulls images from the WordPress media library and reveals the **Photos** field. +- **SmugMug:** Pulls images from a SmugMug gallery RSS feed and reveals the **Feed URL** field. The RSS feed URL can be accessed by using the get a link function in your SmugMug gallery. + +
+Media Library Settings + + +
+Photos Supports: Field Connections + + +The set of photos selected from the WordPress media library. This field appears when **Source** is set to **Media Library**. +
+
+ +
+SmugMug Settings + + +
+Feed URL Supports: Field Connections + + +The SmugMug gallery RSS feed URL used to load photos. This field appears when **Source** is set to **SmugMug**. +
+
+
+ +
+Photo Size Default: Medium + + +Sets the rendered photo width used for the Collage layout. This field appears when **Layout** is set to **Collage**. + +- **Small:** Renders photos at approximately 200px wide. +- **Medium:** Renders photos at approximately 300px wide. +- **Large:** Renders photos at approximately 400px wide. + +
+ +
+Show Captions Default: Never + + +Controls whether photo captions display and where they appear. Captions read from the caption field in the WordPress media manager, or directly from the SmugMug feed when SmugMug is the source. + +- **Never:** Hides photo captions. +- **On Hover:** Shows the caption as an overlay when a photo is hovered. +- **Below Photo:** Shows the caption beneath each photo. + +
+ +
+Click Action Default: Lightbox + + +Selects what happens when a visitor clicks a photo. + +- **None:** Disables the click action so photos are not clickable. +- **Lightbox:** Opens the photo in the built-in lightbox and reveals the **Lightbox Photo Size** field. +- **Photo Link:** Links each photo to its full-size image URL. + +
+Lightbox Settings + + +
+Lightbox Photo Size Default: Large + + +Sets the WordPress image size used when a photo opens in the lightbox. This field appears when **Click Action** is set to **Lightbox**. +
+
+
+ +### Style Tab + +The Style tab controls the spacing between photos and the border applied to each photo. + +
+Photo Spacing Default: 20 + + +The space, in pixels, between photos in the gallery. +
+ +
+Photo Border Supports: Responsive + + +The border style, width, color, and radius applied to each photo, plus an optional box shadow. +
+ +## 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. diff --git a/beaver-builder/layouts/modules/heading.mdx b/beaver-builder/layouts/modules/heading.mdx new file mode 100644 index 00000000..01e49acb --- /dev/null +++ b/beaver-builder/layouts/modules/heading.mdx @@ -0,0 +1,91 @@ +--- +title: Heading Module +sidebar_label: Heading +icon: "heading" +description: "Add styled heading text to your layout using semantic HTML heading tags, with full control over typography, alignment, and responsive behavior." +--- + + +Add styled heading text to your layout using semantic HTML heading tags, with full control over typography, alignment, and responsive behavior. + +## Usage + +The Heading module outputs a semantic HTML heading element (`h1`–`h6`) with the text, tag, optional link, and typographic styles you configure. It renders the heading directly in your layout and supports inline HTML for custom inline formatting. + +Use the Heading module to add section titles, page headings, or content separators throughout your layout. Full typography controls let you customize font, size, weight, color, alignment, and spacing without writing custom CSS, with responsive support for each setting. + +:::tip + +The Heading module is the recommended method for adding HTML headings to your Beaver Builder layouts and is preferred over the Text or HTML modules. If you need more control over the underlying HTML markup, the HTML module is the better choice. +::: + +## Module Settings + +The Heading module settings control the heading text, semantic tag, optional link, and visual styles. + +### General tab + +The General tab contains the core settings for the heading text, semantic HTML structure, and optional link behavior. + +
+Heading Supports: Field Connections + + +The text displayed as the heading in your layout. Supports inline HTML and inline CSS for applying custom formatting and styling to specific words or phrases within the heading. + +```html Inline HTML & CSS Example icon="file-code" + Build Your Dream Website Today! +``` +
+ +
+HTML Tag Default: h2 + + +Sets the semantic HTML tag for the heading (`h1` through `h6`). Choose the tag that matches the heading's role in the page content hierarchy: `h1` for the main page title, `h2` for major sections, and so on. +
+ +
+Link + + +Optionally wraps the heading in a link. + +
+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 visual appearance of the heading, including text color and typography. + +
+Color Supports: Responsive + + +The text color of the heading. Uses the [Color Picker](/beaver-builder/essentials/color-picker). +
+ +
+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. + +
+
+ +## 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. diff --git a/beaver-builder/layouts/modules/html.mdx b/beaver-builder/layouts/modules/html.mdx new file mode 100644 index 00000000..4d755604 --- /dev/null +++ b/beaver-builder/layouts/modules/html.mdx @@ -0,0 +1,212 @@ +--- +title: HTML Module +sidebar_label: HTML +icon: "code-xml" +description: "Versatile module for inserting HTML, CSS, JavaScript code, and shortcodes directly into your page layouts" +--- + + +Versatile module for inserting HTML, CSS, JavaScript code, and shortcodes directly into your page layouts + +## Usage + +Use the HTML module when you need to add custom markup or embed content that is not available through standard Beaver Builder modules. It includes a code editor for inserting raw HTML and supports embed code, inline stylesheets, custom scripts, and shortcodes. + +:::tip + +The HTML module is the recommended method for adding shortcodes to your Beaver Builder layouts and is preferred over the Text Editor module. +::: + + +
+Adding Custom HTML + + +Adding custom HTML is the primary purpose of the HTML module. It is useful when you need specific markup that isn’t available through Beaver Builder’s other modules, such as custom containers, specialized text formatting, or unique structural elements for your design. + +The example below shows how to add an HTML table to your Beaver Builder layout, a type of structural markup that isn’t available through other modules. + +```html expandable + + + + + + + + + + + + + + + + + +
ModulePurpose
HTMLAdd custom markup and embeds
Text EditorAdd basic text content
+``` +
+
+Adding Custom CSS via style tags + + +Add custom CSS directly within the editor by wrapping it in ` + +
+

Lorem ex mollit sunt exercitation

+
+``` +
+
+Shortcodes + + +The HTML module is the recommended choice for adding shortcodes to your layouts. This includes Beaver Builder layout shortcodes, the BB Theme Year shortcode, Beaver Themer field connection shortcodes, and shortcodes from third-party plugins. + +The example below shows how combining HTML with multiple Beaver Themer field connections allows you to create unique layouts that aren’t possible with other modules. + +```html +

+ + [wpbb post:title] + +

+``` +
+
+Embeds + + +Use the HTML module to embed third-party content that isn’t available through standard modules, such as YouTube videos, Spotify playlists, Google Maps, or other embed code provided by external services. + +To do this, copy the embed code from the service and paste it into the HTML module. + +:::note + +Some services may require additional scripts, which may need to be added using the Custom Scripts option. +::: +
+ + +## Module Settings + +The HTML module includes a single option, the HTML Code Editor. + +### HTML Code Editor + +Use this editor to add your custom code. It supports HTML markup, CSS within `