Customize UI Builder pages using components
Summarize
Summary of Customize UI Builder pages using components
In UI Builder, components are the fundamental elements used to create and customize pages within your workspace or portal. Components range from simple items like buttons and labels to complex experience components such as lists and forms. By adding and configuring components, you can tailor the user interface to meet your organization's needs, such as displaying user-specific activity streams or embedding forms.
Show less
Adding Components
You can add components to your UI Builder pages through several methods:
- Using the add content (plus) icon and selecting from the Components tab.
- Using add before or add after icons on column layouts or existing components.
- Adding components directly from the Content tree.
- Using the floating menu above the page to insert components before or after others.
Column layouts help organize components by defining screen areas where you can add multiple columns and place components within them. You can add up to six columns per layout and multiple components per column.
Configuring Components
The configuration panel in UI Builder offers three main ways to customize components:
- Component Properties: Vary by component type, ranging from simple settings for buttons to advanced configurations for lists and forms. Properties can be set as static values, dynamic data bindings, or scripted via JavaScript.
- Styles: Customize the appearance using CSS overrides, such as colors, fonts, and borders.
- Events: Set up event handlers at the page or variant level, including dispatched and handled events.
Dynamic data binding is crucial for exposing and reusing data within components, enabling connections to tables, records, or page properties. You can view and edit component properties using a low-code JSON editor and bind or modify values through a formula editor that supports logical and functional operations.
Component Management and Advanced Features
- Component ID: Each component has a unique ID that can be customized for scripting or data binding purposes.
- Visibility: Components can be shown or hidden based on conditions, using dynamic data or scripted properties.
- Duplicate Components: Easily create copies of configured components with all their settings, enabling efficient reuse.
- Presets: Use or create component presets to automatically configure components on compatible pages, saving time and promoting consistency.
Additional Customization Options
- Change default appearance and styles of components and wrappers.
- Enhance accessibility through focus management for screen readers.
- Use conditional renderers to display content based on specified conditions.
- Group pages with Page Collections for reuse across multiple experiences.
- Add specialized UI elements such as tabbed content, contextual sidebars, forms, modals, popovers, and modeless dialogs to enrich user interaction.
- Extend experiences with viewport components that allow embedding content without owning the parent page.
Practical Tips
- Reload the stage view to see component updates without saving changes.
- Save your work regularly to persist changes made in UI Builder.
- Use the Content tree to review and manage page structure efficiently.
Learn what a component is in UI Builder. Also, see how components work within UI Builder.
Components are the base elements of your UI Builder page. Components range from core elements like buttons and labels to more complex experience components like lists and forms.
You can add these components to your UI Builder page to build or customize your workspace or portal experience. For example, adding an Activity stream component to your page that lets users see their travel request activity.
You can add components to your UI Builder page in the following ways.
| Location | Example |
|---|---|
| Directly from a page in UI Builder (option 1) | Select the add content (plus) icon, select the Components tab, and then select a component. |
| Directly from a page in UI Builder (option 2) | On a column layout or component, select the add before (plus) or add after (plus) icon, and then select a component. |
| From the Content tree in UI Builder | In the content tree, select + Add content and then select a component. |
| From the floating menu above the page in UI Builder | On a column layout or component, select the Menu icon, select Add before or Add after, and then select a component. |
Column layouts in UI Builder
Add column layouts and columns to your UI Builder page first. Then add components to the columns in a column layout to build and customize your page. Think of a column layout as a defined part of the screen where you add components like lists and headings. You can have as many column layouts on a UI Builder page as you want, with as many as six columns in any column layout. Multiple components can be added to a single column. View the structure of your page in the Content tree.
For more information, see Column layouts.
Configure components in UI Builder
- Configure the component properties.
- Add CSS style overrides.
- Set up event handlers for the components.
- Configure tab
- Component properties vary based on each component. Component configuration can be simple, as is the case with simple elements like buttons, headings, and labels. Components like lists and forms require significant configuration. For icon and image components, select from a variety of options or use a custom icon or image. You can modify component properties with UI Builder's low-code JSON editor. For more information about configuring components, see Next Experience Components.
- For each property in the component configure tab, you can choose from the following options.
- Static: Use data from a list, or enter your own data. The data doesn't connect to an external data source.
- Dynamic data binding: A way to bind a component property to a data resource, page property, or client state.
- Script: Enter JavaScript code to populate a property value.
- Styles tab
- You can change the Cascading Style Sheets (CSS) styles for individual components. Change color borders, font size, and so on.
- Events tab
- Configure page-level and variant-level event mappings. Also add dispatched events and handled events for your variant. The more complex, experience components rely heavily on dynamic data that is provided by a data resource. Binding dynamic data to a component is an important feature. You dynamically expose data from tables, records, or other elements on your page. Exposing data enables you to reuse your components. Also, you can point to the configuration fields to see icons data or scripting options for each field.
As you add and configure components on the page, the stage shows your work. If you make changes and the updates do not load on the stage, select the Open menu icon and then select Developer > Reload Stage. Reloading the stage shows your changes, but does not save them. To save your work, select Save at the top right.
Component Presets in UI Builder
Use component presets to automatically configure components on compatible pages. UI Builder page templates contain controllers that presets use to define component configuration values. For more information, see Automatically configure components using presets.
Component properties sections
Component properties are grouped into sections of similar properties. Open and close sections by selecting the arrows to the right of the property headings. UI Builder admins can select which component configuration properties are displayed or hidden based on UI policies.
Component formula editor
Use the UI Builder component formula editor in the configuration panel to bind or modify formulas. You can enter text, data bindings, and/or formulas. Formulas can consist of any combination of the three input types. The component formula editor supports logical, arithmetic, comparison, negation, and functional transform types.
Each function added to the component formula editor auto-completes. The component formula editor displays a label for each input of the function so you know what parameters each function requires. For more information about the supported functions in the component formula editor, see Supported functions in the UI Builder component formula editor.
Component ID
Use the component ID when you add a script or bind data to the component as a way to reference the component. A component ID is automatically created and is based on the component label when you add a component to a page. You can change the component ID to anything you want, as long as it is unique. Select the name of the component in the configuration panel to see the component ID.
Component visibility
Select the eye icon in the configuration panel to set component visibility. Component visibility is based on a property of the component itself, not who is viewing it. You could show or hide a component based on conditions. For example, hiding an image if it has a broken link.
You can set the visibility based on dynamic data binding, or by editing a scripted property value.
Set the Test value to test what happens when the visibility is set to true, false, or none.
Duplicate components
Create an exact copy of a configured component on your UI Builder page except for the name and ID. A duplicated component copies all properties, bindings, and events. For more information, see Duplicate a component.