IMPORTANT: As we revamp and transition our documentation to this site, you may find the articles you need on Liferay's Help Center.

Analytics Cloud Commerce DXP / Portal Liferay Cloud Reference

Documentation Menu

Highlighting

Remove Highlighting

Go Back

• Getting Started
• Site Building
  • Introduction to Site Building
  • Sites
  • Creating Pages
    • Understanding Pages
    • Adding Pages
    • Using Content Pages
    • Defining Headers and Footers
    • Using Widget Pages
    • Page Fragments and Widgets
      • Using Fragments
        • Default Fragments Reference
        • Using Layout Elements
        • Configuring Fragments
          • General Settings Reference
          • Styles Reference
          • Advanced Settings Reference
          • Fragment Sub-Elements Reference
          • Localizing Fragment Configuration Fields
        • Mapping and Linking Fragment Elements
        • Configuring Fragment Visibility
        • Editing Fragment Elements
        • Creating Dropdown Menus with Fragments
        • Duplicating Fragments
        • Saving Fragment Compositions
        • Managing Fragments
        • Propagating Fragment Changes
    • Page Settings
  • Displaying Content
  • Site Appearance
  • Site Navigation
  • Personalizing Site Experience
  • Publishing Tools
  • Optimizing Sites
  • Site Settings
  • Developer Guide
• Content Authoring and Management
• Process Automation
• Using Search
• Collaboration and Social
• Users and Permissions
• System Administration
• Building Applications
• Liferay Internals
• Headless Delivery
• Installation and Upgrades

English

• Japanese
• English

• Liferay Learn
• DXP
• Site Building
• Creating Pages
• Page Fragments and Widgets
• Using Fragments
• Configuring Fragments
• General Settings Reference

General Settings Reference

All fragments have General settings except for the HTML, Paragraph, Separator, and Social fragments. Some of these options are standard (e.g., visibility and frame), while others are unique to each fragment. The following reference only includes fragments with General settings.

Follow these steps to access a fragment’s General settings:

1. Begin editing a page or template that supports fragments.

2. Open the Browser panel () in the sidebar menu and select the desired fragment.

   Alternatively, click the desired fragment in the page or template.

3. Click the General tab in the Page Elements side panel.

Standard General Settings

Hide Fragment

Field	Description
Hide Fragment	Check the box to hide the fragment for different viewports. See Configuring Fragment Visibility to learn more about how this setting interacts with Page viewports.

Frame

Field	Description
Width/Height	Determine the default height and width of the fragment’s frame.
Min Width/Max Width	Determine the min and max width for the frame when displayed in different viewports.
Min Height/Max Height	Determine the min and max height for the frame when displayed in different viewports.
Overflow	Determine whether to allow fragment content to overflow its frame. By default, fragment content is restricted to its frame. If overflow is allowed, you can determine how it is displayed (e.g., Scroll).

Container Options

Field	Description
Link	Determine if the Container links to a URL, Page, or Mapped URL; this setting determines which of the following fields are available.
URL (for URL)	Enter a localizable URL for the Container. To set a URL for other languages, first switch the language for the page or template via the editing bar. Then, enter the desired URL.
Page (for Page)	Select a Liferay Page for the Container.
Item (for Mapped URL)	Select an item from Documents and Media, Web Content, Blogs, or Categories. The selected item provides fields for mapping.
Field (for Mapped URL)	Select the URL field you want to map to the Container. Selecting a valid field automatically populates the URL field.
URL (for Mapped URL)	This field is auto-populated with the selected Field URL.
Open in New Tab	Determine whether the link is opened in a new tab.
Content Display	Determine whether the Container’s content is displayed in a Block, Flex Row, or Flex Column; the flex options have additional configurations.
Flex Wrap (for Flex Row or Flex Column) 7.4 U19+/GA19+	Configure wrapping for flex rows and columns: No Wrap, Wrap, or Wrap Reverse.
Align Items (for Flex Column) 7.4 U19+/GA19+	Determine how elements in the column are aligned: Start, Center, End, Stretch, or Baseline.
Justify Content (for Flex Row) 7.4 U19+/GA19+	Determine how elements in the row are justified: Start, Center, End, Between, or Around.
Container Width	Determine whether the Container uses a Fluid or Fixed Width.

Grid Options

Field	Description
Number of Modules	Determine the Grid’s number of drop zone modules: 1-6.
Show Gutter	Add or remove padding between the drop zone modules.
Layout	Determine how many drop zone modules are on each row: 1, 2, 3, or 6. Available options depends on the number of modules.
Inverse Order (for 1 Module per Row)	Check the box to reverse the order of modules.
Vertical Alignment	Determine the vertical alignment of the module’s content: Top, Middle, or Bottom.

Button Options

Field	Description
Type	Determine the Button’s style: Primary, Secondary, Link, Outline Primary, or Outline Secondary.
Size	Determine the Button’s size: Small, Normal, or Large.

Card Options

Field	Description
Image Size	Determine the image’s size: Fit or Original Size.

Drop-down Options

Field	Description
Type	Determine the Button’s style: Primary, Secondary, Link, Outline Primary, or Outline Secondary.
Size	Determine the Button’s size: Small, Normal, or Large.
Panel Type	Determine the size of the dropdown menu panel: Regular, Full Width, or Mega Menu.
Display on Hover	Check the box to determine if the menu panel is displays when a cursor hovers over the button.
Keep Panel Open in Edit Mode	Check the box to determine if the panel remains open while editing.

External Video Options

Field	Description
Video	Enter a URL to the desired video or select an External Video Shortcut from Documents and Media.
Width/Height	Determine the embedded video’s dimensions.
Align	Determine the video’s alignment: Left, Center, or Right.

Heading Options

Field	Description
Heading Level	Determine the header’s style: H1-H6.

Image Options

Field	Description
Image Size	Determine the image’s size: Fit or Original Size.

Separator Options

Field	Description
Bottom Spacing	Determine how much padding is added after the Separator: 1-5.
Separator Color	Select a color for the Separator.
Clear	Click Clear to remove the selected color.

Slider Options

Field	Description
Number of Slides	Determine how many slides are included in the fragment.

Tip

There is no limit to the number of slides you can add to a Slider. However, high numbers of slides can negatively impact performance.

Spacer Options

Field	Description
Height	Determine the thickness of the Spacer: 1-5.

Tabs Options

Field	Description
Number of Tabs	Determine how many tabs are included in the fragment.

Tip

There is no limit to the number of tabs you can add to a Tabs fragment. However, a high number of tabs can negatively impact performance.

Video URL Options

Field	Description
URL	Enter a valid video URL.
Autoplay	Determine if the video plays automatically when the page is loaded.
Loop	Determine if the video restarts once it’s finished.
Mute	Determine if the video is muted by default.
Hide Controls	Determine if users can access video controls.
Width/Height	Determine the embedded video’s dimensions.
Align	Determine the video’s alignment: Left, Center, or Right.

Content Display Options

Field	Description
Item	Select an item to display from Documents and Media, Web Content, Blogs, or Categories.
Template	Select a template to determine how the item is displayed. Available templates depend on the selected content type.

Content Flags Options

Field	Description
Item	Select the item you want to associate with the flag from Documents and Media, Web Content, Blogs, or Categories.
Message	Enter a message to display in the UI with the content flag.

Collection Filter Options

Field	Description
Target Collection	Select a collection to use with the filter.
Filter	Determine the filter’s type: Keywords or Category. When using Category, end users can select from predefined filter categories. When using Keywords, they can manually enter their own filter values.
Source (for Category)	Select the Vocabulary or Category used for filtering the target collection.
Single Selection (for Category)	Determine whether end users can apply only one or more filters to the collection.
Include Search Field (for Category)	Determine whether to include a field for end users to search available filter values.
Show Label	Check to show a label for the filter in the UI.
Label Text	Enter localizable text for the label. To set label text for another language, first switch the language for the page or template via the editing bar. Then, enter the desired text. See Localizing Fragment Configuration Fields for more information.

Applied Filters Options

Field	Description
Target Collection	Select a collection to use with the fragment. This fragment displays all filters applied to the selected collection.
Include Clear Filters Option	Determine whether to include the Clear Filters option to end users.

Note

This fragment is only displayed when a filter is applied to the target collection.

Content Ratings Options

Field	Description
Item	Select the item you want to associate with the fragment from Documents and Media, Web Content, Blogs, or Categories.

Collection Display Options

Field	Description
Collection	Select a collection or collection provider to display in the fragment. Once selected, you can click the Actions button to access additional options. Available actions depend on the selected collection or collection provider.
List Style	Select from available styles to determine how items are listed. Available styles depend on the selected collection or collection provider.
Layout (for Grid)	Determine how many columns the collection list has: 1-6.
List Item Style (for Templates)	Select from available styles to determine how each entry is displayed. Available styles depend on the selected collection asset type.
Pagination	Determine whether to use pagination for the collection. When enabled, you can select from two style options: Numeric or Simple.
Display All Collection Items	Determine whether to display all items in the selected collection or collection provider.
Maximum Number of Items	Set the maximum number of items to display from the selected collection or collection provider.
Maximum Number of Items per Page	Determine the number of items included in each fragment per page. This value cannot exceed 200.

Form Fragment Options

Available Liferay 7.4 U45+/GA45+

Form fragments include unique configuration options. To access them, you must map the fragment to an object field.

Form Container

Field	Description
Content Type	Select a custom object. This maps the form container and its fragments to the selected object. You can only map a form container to one object at a time.
Success Message	Determine whether the form submission success message is embedded in the current page or redirects users to a Liferay page or external URL.
Success Text (for Embedded)	Enter a localizable success message.
Preview Success State (for Embedded)	Preview the embedded success message.
Content Display	Determine whether the Container’s content is displayed in a Block, Flex Row, or Flex Column; the flex options have additional configurations.
Flex Wrap (for Flex Row or Flex Column)	Configure wrapping for flex rows and columns: No Wrap, Wrap, or Wrap Reverse.
Align Items (for Flex Column)	Determine how elements in the column are aligned: Start, Center, End, Stretch, or Baseline.
Justify Content (for Flex Row)	Determine how elements in the row are justified: Start, Center, End, Between, or Around.
Container Width	Determine whether the Container uses a Fluid or Fixed Width.

Other Form Fragment Configurations

Field	Description
Field	Map the fragment to an object field.
Mark as Required	Mark the fragment field as required for form submission. Mandatory object fields are marked as required automatically.
Show Label	Display or hide the fragment’s label.
Label	Set a localizable label for the fragment. By default, each fragment uses its object field’s label.
Show Help Text	Display or hide the fragment’s help text.
Help Text	Set a localizable help text for the fragment.
Placeholder	For the Numeric Input and Text Input fragments, enter an example value.
Button Text	For the File Upload fragment, set a localizable button text for attaching files.
Show Supported File Info	For the File Upload fragment, display or hide the list of supported extensions and file size limit.

Additional Information

• Configuring Fragments

• Fragment Styles Reference

• Fragment Sub-Elements Reference

Not finding what you're looking for?

Pardon our dust as we revamp and transition our product documentation to this site. If something seems missing, please check Liferay Help Center documentation for Liferay DXP 7.2 and previous versions.

Try Liferay's Help Center