diff --git a/components/bl-autocomplete-component/README.md b/components/bl-autocomplete-component/README.md index 6847301ea..53751c4a9 100644 --- a/components/bl-autocomplete-component/README.md +++ b/components/bl-autocomplete-component/README.md @@ -1,19 +1,32 @@ # Autocomplete -Autocomplete is a component of Backendless UI-Builder designer. This allows you to select an item from a list of options. +Autocomplete is the component of Backendless UI-Builder designer. It allows selecting one of the options from the list.

main thumbnail

+All options are stored in a JSON object, that can be set either by using UI-Builder settings or Codeless Logic. You can also group options by passing a list containing JSON objects to the component: + +

+ Array of objects +

+ +Once the option is selected from the list it gets saved to the local variable **Input Value** in the Codeless Logic. Suppose you selected the "Basketball" option from the list in the e-commerce store, then this value can be used later on to load and display products of a specific category ("Basketball") on the page. You must use the **On Changed Event** handler to get the selected value. + +

+ On Changed Handler +

+ + ## Properties | Property | Type | Default Value | Logic | Data Binding | UI Setting | Description | |---------------------------------------------|--------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|--------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Disabled
`disabled` | Checkbox | `false` | Disabled Logic | YES | YES | This handler allows you to disable a component. | -| Placeholder
`placeholder` | Text | "Placeholder" | Placeholder Logic | YES | YES | This handler allows you to specify a label of autocomplete component. | -| Empty Options Label
`emptyOptionsLabel` | Text | "No options" | Empty Options Label Logic | YES | YES | This handler allows you to add a label that will be displayed when the dropdown menu is empty. | -| Variant
`variant` | Select [Outlined:`outlined`
Standart:`standart`
Filled:`filled`] | Outlined:`outlined` | Variant Logic | YES | YES | This handler allows you to specify the variant of autocomplete. | +| Disabled
`disabled` | Checkbox | `false` | Disabled Logic | YES | YES | This handler allows disabling a component. | +| Placeholder
`placeholder` | Text | "Placeholder" | Placeholder Logic | YES | YES | This handler allows specifying a label of autocomplete component. | +| Empty Options Label
`emptyOptionsLabel` | Text | "No options" | Empty Options Label Logic | YES | YES | This handler allows adding a label that will be displayed when the dropdown menu is empty. | +| Variant
`variant` | Select [Outlined:`outlined`
Standart:`standart`
Filled:`filled`] | Outlined:`outlined` | Variant Logic | YES | YES | This handler allows specifying the variant of the autocomplete. | | Options
`options` | JSON | `[`
`{"groupLabel":"Winter",`
`"children": [{"label": "December", "value": "December"},{"label": "January", "value": "January"},{"label": "February", "value": "February"}]},`
`{"groupLabel": "Summer",`
`"children": [{"label": "June", "value": "June"},{"label": "July", "value": "July"},{"label": "August", "value": "August"}]}`
`]` | Options Logic | YES | YES | This handler allows you to add options to be displayed in the options list. Watch [Codeless Examples](#examples). Signature of options: list of objects `{value: String, label: String}`. Signature of grouped options: list of objects `{groupLabel: String, children: list of objects {value: String, label: String}}` | ## Events diff --git a/components/bl-autocomplete-component/example-images/autocomplete_component_1.png b/components/bl-autocomplete-component/example-images/autocomplete_component_1.png new file mode 100644 index 000000000..cbb83525d Binary files /dev/null and b/components/bl-autocomplete-component/example-images/autocomplete_component_1.png differ diff --git a/components/bl-autocomplete-component/example-images/autocomplete_component_2.png b/components/bl-autocomplete-component/example-images/autocomplete_component_2.png new file mode 100644 index 000000000..0975b4373 Binary files /dev/null and b/components/bl-autocomplete-component/example-images/autocomplete_component_2.png differ