@gpa-gemstone/react-forms
Version:
React Form modules for gpa webapps
43 lines (42 loc) • 1.13 kB
TypeScript
interface IProps {
/**
* Label to display for the form, defaults to the Field prop
* @type {string}
* @optional
*/
Label?: string;
/**
* Array of options for the multi-select checkboxe
* @type {{ Value: number | string; Text: string; Selected: boolean }[]}
*/
Options: {
Value: number | string;
Text: string;
Selected: boolean;
}[];
/**
* Function to handle changes in the selection
* @param evt - The change event
* @param Options - The updated options array
* @returns {void}
*/
OnChange: (evt: any, Options: {
Value: number | string;
Text: string;
Selected: boolean;
}[]) => void;
/**
* Help message or element to display
* @type {string | JSX.Element}
* @optional
*/
Help?: string | JSX.Element;
/**
* Tooltip style for the items
* @type {'no-tip' | 'dark' | 'light'}
* @optional
*/
ItemTooltip?: 'no-tip' | 'dark' | 'light';
}
declare const MultiSelect: (props: IProps) => JSX.Element;
export default MultiSelect;