Skip to main content

MultiSelectFabric component

Component for rendering a multi-select dropdown with keyword search.

📝 Signature​

MultiSelectFabric(props: {
styles: {
backgroundColor: string;
borderColor: string;
borderSize?: number;
roundness?: number;
textColor?: string;
errorColor: string;
scale?: number;
pills?: "filled" | "outline";
overlayWidth?: "auto" | "full";
};
overlay: TOverlayContext;
id: string;
options: IMultiSelectOption[];
placeholder?: string;
required?: boolean;
error?: boolean;
tabIndex?: number;
maxSelected?: number;
ariaDescribedBy?: string;
onChange?: (value: string) => void;
onFocus?: (e: FocusEvent) => void;
onBlur?: (e: FocusEvent) => void;
onAutoFocus?: (el: HTMLInputElement | null) => void;
onSubmit?: () => void;
onCancel?: () => void;
}): JSX.Element

📇 Props​

NameTypeOptionalDescription
stylesobjectNoSpecifies the styles for the multi-select component. Supports the following styles:
- backgroundColor: Background color for the control;
- borderColor: Border color for the control;
- borderSize: Optional border size in pixels for the control;
- roundness: Optional roundness in pixels for the control;
- textColor: Text color for the component;
- errorColor: Error color for the component;
- scale: Optional scale factor for the component (defaults to 1);
- pills: Optional setting to display the pills (defaults to filled);
- overlayWidth: Optional setting to display the overlay (defaults to auto).
overlayTOverlayContextNoSpecifies the overlay context used for rendering the list with options.
idstringNoSpecifies the identifier.
optionsIMultiSelectOption[]NoSpecifies the options (see IMultiSelectOption).
placeholderstringYesOptional placeholder that is shown when there is no value entered.
requiredbooleanYesSpecifies if the component is required.
errorbooleanYesSpecifies if the component has an error.
tabIndexnumberYesSpecifies the tabindex for the component.
maxSelectednumberYesSpecifies the maximum amount of options to select for the component.
ariaDescribedBystringYesSpecifies the aria-describedby identifier of the element that describes the component.
onChange(value: string) => voidYesInvoked when the value of the component is changed.
onFocus(e: FocusEvent) => voidYesInvoked when the component gets focus.
onBlur(e: FocusEvent) => voidYesInvoked when the component loses focus.
onAutoFocus(el: HTMLInputElement | null) => voidYesInvoked when the HTML element of the component is available for auto-focus.
onSubmit() => voidYesInvoked when the user presses the Shift + Enter key combination or the Tab key (this event is often used to go to the next input control in a form).
onCancel() => voidYesInvoked when the user presses the Shift + Tab key combination (this event is often used to go to the previous input control in a form).

↩ī¸ Return value​

Returns the JSX.Element for the component.

👩‍đŸ’ģ Example​

import { MultiSelectFabric } from "tripetto-runner-fabric/components/multi-select";
import { useOverlay } from "tripetto-runner-fabric/overlay";

const MultiSelectExample = () => {
const [OverlayProvider, OverlayContext] = useOverlay();

return (
<>
<MultiSelectFabric
styles={{
backgroundColor: "white",
borderColor: "black",
errorColor: "red"
}}
overlay: OverlayContext
id: "1"
options={[
{
id: "1",
name: "Option 1"
},
{
id: "2",
name: "Option 2"
}
]}
/>
<OverlayProvider />
</>
);
}

⛓ī¸ Interfaces​


🔗 IMultiSelectOption​

Describes the interface for a multi-select option.

Type declaration​

interface IMultiSelectOption {
/* Identifier for the option. */
id: string;

/* Name for the option. */
name: string;

/* Label for the option. */
label?: string | JSX.Element;

/* Description for the option. */
description?: string | JSX.Element;

/* Specifies if the option is disabled. */
disabled?: boolean;

/* Value for the option. */
value?: Value;
}