Search
Introduction
The Search component represents a user interface element that allows users to search for specific information within your specified dataset. This component consists of an input field where users can enter their search query and a search button to initiate the search. It provides a convenient way for users to quickly find relevant information by filtering and narrowing down the available options.
This component is based on Input Picker. It is included within the following NPM package: @react-form-builder/components-rsuite.
You can customize this component to fit your needs by using available options and properties that are introduced 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 your search component |
Value | string | Sets default value for the component |
Placeholder | string | Placeholder for the search field |
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 starts searching |
Data | string | Used to define values and labels for subsequent search. Add 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 data |
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