@capgeminiuk/dcx-react-library
Version:
[](https://circleci.com/gh/Capgemini/dcx-react-library)
85 lines (84 loc) • 2.25 kB
TypeScript
import React from 'react';
import { MultiSelectOption } from './Types';
export type MultiSelectProps = {
/**
* Multi Select options
*/
selectOptions: MultiSelectOption[];
/**
* Multi Select class name
*/
className?: string;
/**
* you can style the look and feel of your hint text
*/
hintClass?: string;
/**
* you can specify a description label to provide additional information
*/
hintText?: string;
/**
* Multi Select id
*/
id?: string;
/**
* Multi Select input placeholder
*/
inputProperties?: React.InputHTMLAttributes<{
placeholder?: string;
style?: React.CSSProperties;
}>;
/**
* Multi Select result container id
*/
resultUlId?: string;
/**
* Multi Select result container styling
*/
resultUlStyle?: React.CSSProperties;
/**
* Multi Select result items styling
*/
resultLiStyle?: React.CSSProperties;
/**
* Multi Select remove all button
*/
removeAllButtonClass?: string;
/**
* Multi Select Selected list styling
*/
selectedListStyle?: React.CSSProperties;
/**
* Multi Select Selected list item styling
*/
selectedListItemStyle?: React.CSSProperties;
/**
* Multi Select search container
*/
searchContainerStyle?: React.CSSProperties;
/**
* Multi Select filtering debounce in milliseconds
*/
searchDebounceMs?: number;
/**
* Multi Select onFocus
*/
onFocus?: () => void;
/**
* Multi Select onRemove
*/
onRemove?: (value: string) => void;
/**
* Multi Select onRemoveAll
*/
onRemoveAll?: () => void;
/**
* Multi Select onSelect
*/
onSelect?: (value: string) => void;
/**
* tab index value to focus on input field
*/
tabIndex?: number;
};
export declare const MultiSelect: ({ className, hintClass, hintText, id, inputProperties, resultUlId, resultUlStyle, resultLiStyle, removeAllButtonClass, selectOptions, selectedListStyle, selectedListItemStyle, searchContainerStyle, searchDebounceMs, onFocus, onRemove, onRemoveAll, onSelect, tabIndex, }: MultiSelectProps) => React.JSX.Element;