Dropdown
Introduction
Dropdown is a component that is used to create a list of predefined choices and options. It allows users to select a single option from the available choices by clicking on the dropdown. This component is particularly useful when there are multiple options to choose from, such as selecting a country, category, and so on.
The dropdown component is based on Input Picker. It is included within the following NPM package: @react-form-builder/components-rsuite.
This component can be customized to include a range of custom choices and also to change the format and appearance of the dropdown list 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 |
---|---|---|
Label | string | Text that is displayed for the component |
Value | string | Sets default value for the component |
Placeholder | string | Placeholder string |
Placement | choice | Select the placement of component (e.g., bottom end, top start, etc.) |
Size | choice | Select the size of the input field (e.g., large, small, etc. ) |
Preload | boolean | If set to true, the data is downloaded in advance, before the user opens dropdown |
Data | string | Used to define values and labels for your dropdown list. Add more options by using the corresponding (+) button |
Cleanable | boolean | If set to true, allows users to clear their selection |
Creatable | boolean | If set to true, allows users to create and select their own option |
Disabled | boolean | Disables the component |
Read Only | boolean | If set to true, makes your component unavailable for users to interact with |
Group by | string | Used to specify the key; i.e., criteria for grouping data |
At the bottom of the Main properties menu, you can find additional options:
- Render When: Provides conditional rendering for your calendar 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 number
Specifies the width for your component Height number
Specifies the height for your component Margin top/right/bottom/left number
Margin values for you component Color string
Allows customizing the text color Background color string
Enables customizing the background color