diff --git a/CHANGELOG.md b/CHANGELOG.md index 7d4a4021d33..3e46c0961a8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,6 @@ ## [`master`](https://github.com/elastic/eui/tree/master) +- Added props descriptions for `EuiComboBox` ([#3007](https://github.com/elastic/eui/pull/3007)) - Exported `dateFormatAliases` as a part of the public API ([#3043](https://github.com/elastic/eui/pull/3043)) - Exported `EuiTextProps` type definition ([#3039](https://github.com/elastic/eui/pull/3039)) - Removed `role` attribute from `EuiImage`([#3036](https://github.com/elastic/eui/pull/3036)) diff --git a/src/components/combo_box/combo_box.tsx b/src/components/combo_box/combo_box.tsx index b9938176c77..740fff697f0 100644 --- a/src/components/combo_box/combo_box.tsx +++ b/src/components/combo_box/combo_box.tsx @@ -55,24 +55,60 @@ interface _EuiComboBoxProps Omit, 'onChange'>, DrillProps { 'data-test-subj'?: string; + /** + * Updates the list of options asynchronously + */ async: boolean; className?: string; + /** + * When `true` creates a shorter height input + */ compressed: boolean; + /** + * When `true` expands to the entire width available + */ fullWidth: boolean; id?: string; inputRef?: RefCallback; + /** + * Shows a button that quickly clears any input + */ isClearable: boolean; + /** + * Disables the input + */ isDisabled?: boolean; isInvalid?: boolean; + /** + * Swaps the dropdown options for a loading spinner + */ isLoading?: boolean; + /** + * Doesn't show the suggestions list/dropdown + */ noSuggestions?: boolean; onBlur?: FocusEventHandler; + /** + * Called every time the query in the combo box is parsed + */ onChange?: (options: Array>) => void; onFocus?: FocusEventHandler; onKeyDown?: KeyboardEventHandler; + /** + * Called every time the text query in the search box is parsed + */ onSearchChange?: (searchValue: string, hasMatchingOptions?: boolean) => void; + /** + * Sets the placeholder of the input + */ placeholder?: string; + /** + * Every option must be the same height and must be explicitly set if using a custom render + */ rowHeight?: number; + /** + * When `true` only allows the user to select a single option. Set to `{ asPlainText: true }` to not render input selection as pills + */ singleSelection: boolean | EuiComboBoxSingleSelectionShape; /** * Creates an input group with element(s) coming before input. It won't show if `singleSelection` is set to `false`.