List
Introduction
The List component displays a collection of items in a structured, scrollable container. It is commonly used for navigation menus, data listings, selection interfaces, and any scenario where items need to be presented in an organized, vertical layout. The component follows Material Design guidelines for lists with proper spacing, dividers, and interactive states.
The List component is based on Material UI List. It is included within the following NPM package: @react-form-builder/components-material-ui.
The List component can be styled and configured to fit specific design and functionality requirements by using various properties that are presented and described below.
Main properties
The following general properties are available within the Main tab:
| Name | Type | Description |
|---|---|---|
| Dense | boolean | If true, compact vertical padding will be used for list items |
| Disable padding | boolean | If true, vertical padding will be removed from the list |
| Sx | object | The system prop that allows defining system overrides as well as additional CSS styles |
At the bottom of the Main properties menu, you can find additional options:
- Render When: Provides conditional rendering for your component as described in the corresponding chapter.
- HTML attributes: Allows you to provide custom HTML attributes for your form.
Style properties
These are properties that allow to customize the size, color and other style properties of your component:
- For Device: You can provide component's style customization for all devices or specific devices by using this dropdown list. Refer to Adaptive Layout for more details.
- Component > Class Name: Add a class name for your component for the subsequent styling if necessary.
-
Wrapper: The options below enable you to tailor the appearance of your component and customize it for a specific device type, as selected in the For Device property:
Name Type Description Width numberSpecifies the width for your component Height numberSpecifies the height for your component Margin top/right/bottom/left numberMargin values for you component Color stringAllows customizing the text color Background color stringEnables customizing the background color