@ui5/webcomponents-react

import '@ui5/webcomponents/dist/MultiInput.js'; import type { InputSelectionChangeEventDetail } from '@ui5/webcomponents/dist/Input.js'; import type { MultiInputTokenDeleteEventDetail } from '@ui5/webcomponents/dist/MultiInput.js'; import type InputSuggestionsFilter from '@ui5/webcomponents/dist/types/InputSuggestionsFilter.js'; import type InputType from '@ui5/webcomponents/dist/types/InputType.js'; import type ValueState from '@ui5/webcomponents-base/dist/types/ValueState.js'; import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '@ui5/webcomponents-react-base'; import type { ReactNode } from 'react'; interface MultiInputAttributes { /** * Defines the accessible description of the component. * * **Note:** Available since [v2.9.0](https://github.com/UI5/webcomponents/releases/tag/v2.9.0) of **@ui5/webcomponents**. * @default undefined */ accessibleDescription?: string | undefined; /** * Receives id(or many ids) of the elements that describe the input. * * **Note:** Available since [v2.9.0](https://github.com/UI5/webcomponents/releases/tag/v2.9.0) of **@ui5/webcomponents**. * @default undefined */ accessibleDescriptionRef?: string | undefined; /** * Defines the accessible ARIA name of the component. * @default undefined */ accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the input. * @default undefined */ accessibleNameRef?: string | undefined; /** * Defines whether the component is in disabled state. * * **Note:** A disabled component is completely noninteractive. * @default false */ disabled?: boolean; /** * Defines the filter type of the component. * * **Note:** Available since [v2.19.0](https://github.com/UI5/webcomponents/releases/tag/v2.19.0) of **@ui5/webcomponents**. * @default "None" */ filter?: InputSuggestionsFilter | keyof typeof InputSuggestionsFilter; /** * Sets the maximum number of characters available in the input field. * * **Note:** This property is not compatible with the ui5-input type InputType.Number. If the ui5-input type is set to Number, the maxlength value is ignored. * @default undefined */ maxlength?: number | undefined; /** * Determines the name by which the component will be identified upon submission in an HTML form. * * **Note:** This property is only applicable within the context of an HTML Form element. * **Note:** When the component is used inside a form element, * the value is sent as the first element in the form data, even if it's empty. * @default undefined */ name?: string | undefined; /** * Defines whether the value will be autcompleted to match an item * * **Note:** Available since [v1.4.0](https://github.com/UI5/webcomponents/releases/tag/v1.4.0) of **@ui5/webcomponents**. * @default false */ noTypeahead?: boolean; /** * Defines whether the suggestions picker is open. * The picker will not open if the `showSuggestions` property is set to `false`, the input is disabled or the input is readonly. * The picker will close automatically and `close` event will be fired if the input is not in the viewport. * * **Note:** Available since [v2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. * @default false */ open?: boolean; /** * Defines a short hint intended to aid the user with data entry when the * component has no value. * @default undefined */ placeholder?: string | undefined; /** * Defines whether the component is read-only. * * **Note:** A read-only component is not editable, * but still provides visual feedback upon user interaction. * @default false */ readonly?: boolean; /** * Defines whether the component is required. * @default false */ required?: boolean; /** * Defines whether the clear icon of the input will be shown. * * **Note:** Available since [v1.2.0](https://github.com/UI5/webcomponents/releases/tag/v1.2.0) of **@ui5/webcomponents**. * @default false */ showClearIcon?: boolean; /** * Defines whether the component should show suggestions, if such are present. * @default false */ showSuggestions?: boolean; /** * Determines whether a value help icon will be visualized in the end of the input. * Pressing the icon will fire `value-help-trigger` event. * @default false */ showValueHelpIcon?: boolean; /** * Defines the HTML type of the component. * * **Notes:** * * - The particular effect of this property differs depending on the browser * and the current language settings, especially for type `Number`. * - The property is mostly intended to be used with touch devices * that use different soft keyboard layouts depending on the given input type. * - Type `Number` does not support suggestions. * @default "Text" */ type?: InputType | keyof typeof InputType; /** * Defines the value of the component. * * **Note:** The property is updated upon typing. */ value?: string; /** * Defines the value state of the component. * @default "None" */ valueState?: ValueState | keyof typeof ValueState; } interface MultiInputDomRef extends Required<MultiInputAttributes>, Ui5DomRef { } interface MultiInputPropTypes extends MultiInputAttributes, Omit<CommonProps, keyof MultiInputAttributes | 'children' | 'icon' | 'tokens' | 'valueStateMessage' | 'onChange' | 'onClose' | 'onInput' | 'onOpen' | 'onSelect' | 'onSelectionChange' | 'onTokenDelete' | 'onValueHelpTrigger'> { /** * Defines the suggestion items. * * **Note:** The suggestions would be displayed only if the `showSuggestions` * property is set to `true`. * * **Note:** The `<SuggestionItem>`, `<SuggestionItemGroup>` and `SuggestionItemCustom` are recommended to be used as suggestion items. * * **Note:** Input with type `Number` does not support suggestions. * * __Supported Node Type/s:__ `Array<IInputSuggestionItem>` */ children?: ReactNode | ReactNode[]; /** * Defines the icon to be displayed in the component. * * __Note:__ The content of the prop will be rendered into a [<slot>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/slot) by assigning the respective [slot](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/slot) attribute (`slot="icon"`). * Since you can't change the DOM order of slots when declaring them within a prop, it might prove beneficial to manually mount them as part of the component's children, especially when facing problems with the reading order of screen readers. * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * __Supported Node Type/s:__ `Array<IIcon>` */ icon?: UI5WCSlotsNode; /** * Defines the component tokens. * * __Note:__ The content of the prop will be rendered into a [<slot>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/slot) by assigning the respective [slot](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/slot) attribute (`slot="tokens"`). * Since you can't change the DOM order of slots when declaring them within a prop, it might prove beneficial to manually mount them as part of the component's children, especially when facing problems with the reading order of screen readers. * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * __Supported Node Type/s:__ `Array<IToken>` */ tokens?: UI5WCSlotsNode; /** * Defines the value state message that will be displayed as pop up under the component. * The value state message slot should contain only one root element. * * **Note:** If not specified, a default text (in the respective language) will be displayed. * * **Note:** The `valueStateMessage` would be displayed, * when the component is in `Information`, `Critical` or `Negative` value state. * * **Note:** If the component has `suggestionItems`, * the `valueStateMessage` would be displayed as part of the same popover, if used on desktop, or dialog - on phone. * * __Note:__ The content of the prop will be rendered into a [<slot>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/slot) by assigning the respective [slot](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/slot) attribute (`slot="valueStateMessage"`). * Since you can't change the DOM order of slots when declaring them within a prop, it might prove beneficial to manually mount them as part of the component's children, especially when facing problems with the reading order of screen readers. * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * __Supported Node Type/s:__ `Array<HTMLElement>` */ valueStateMessage?: UI5WCSlotsNode; /** * Fired when the input operation has finished by pressing Enter or on focusout. * * | cancelable | bubbles | * | :--------: | :-----: | * | ❌|✅| */ onChange?: (event: Ui5CustomEvent<MultiInputDomRef>) => void; /** * Fired when the suggestions picker is closed. * * **Note:** Available since [v2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. * * | cancelable | bubbles | * | :--------: | :-----: | * | ❌|❌| */ onClose?: (event: Ui5CustomEvent<MultiInputDomRef>) => void; /** * Fired when the value of the component changes at each keystroke, * and when a suggestion item has been selected. * * **Note:** Call `event.preventDefault()` inside the handler of this event to prevent its default action/s. * * | cancelable | bubbles | * | :--------: | :-----: | * | ✅|✅| */ onInput?: (event: Ui5CustomEvent<MultiInputDomRef>) => void; /** * Fired when the suggestions picker is open. * * **Note:** Available since [v2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. * * | cancelable | bubbles | * | :--------: | :-----: | * | ❌|✅| */ onOpen?: (event: Ui5CustomEvent<MultiInputDomRef>) => void; /** * Fired when some text has been selected. * * **Note:** Available since [v2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. * * | cancelable | bubbles | * | :--------: | :-----: | * | ❌|✅| */ onSelect?: (event: Ui5CustomEvent<MultiInputDomRef>) => void; /** * Fired when the user navigates to a suggestion item via the ARROW keys, * as a preview, before the final selection. * * **Note:** Available since [v2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. * * | cancelable | bubbles | * | :--------: | :-----: | * | ❌|✅| */ onSelectionChange?: (event: Ui5CustomEvent<MultiInputDomRef, InputSelectionChangeEventDetail>) => void; /** * Fired when tokens are being deleted. * * | cancelable | bubbles | * | :--------: | :-----: | * | ❌|✅| */ onTokenDelete?: (event: Ui5CustomEvent<MultiInputDomRef, MultiInputTokenDeleteEventDetail>) => void; /** * Fired when the value help icon is pressed * and F4 or ALT/OPTION + ARROW_UP/ARROW_DOWN keyboard keys are used. * * | cancelable | bubbles | * | :--------: | :-----: | * | ❌|✅| */ onValueHelpTrigger?: (event: Ui5CustomEvent<MultiInputDomRef>) => void; } /** * A `MultiInput` field allows the user to enter multiple values, which are displayed as `Token`. * * User can choose interaction for creating tokens. * Fiori Guidelines say that user should create tokens when: * * - Type a value in the input and press enter or focus out the input field (`change` event is fired) * - Move between suggestion items (`selection-change` event is fired) * - Clicking on a suggestion item (`selection-change` event is fired if the clicked item is different than the current value. Also `change` event is fired ) * * * * __Note:__ This is a UI5 Web Component! [MultiInput UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/MultiInput) | [Repository](https://github.com/UI5/webcomponents) */ declare const MultiInput: import("react").ForwardRefExoticComponent<MultiInputPropTypes & import("@ui5/webcomponents-react-base").WithWebComponentPropTypes & import("react").RefAttributes<MultiInputDomRef>>; export { MultiInput }; export type { MultiInputDomRef, MultiInputPropTypes };