@ui5/webcomponents-react/dist/webComponents/SuggestionItemGroup/index.d.ts

React Wrapper for UI5 Web Components and additional components

import '@ui5/webcomponents/dist/SuggestionItemGroup.js';
import type { ListItemGroupMoveEventDetail } from '@ui5/webcomponents/dist/ListItemGroup.js';
import type { ReactNode } from 'react';
import type { CommonProps, Ui5CustomEvent, Ui5DomRef, UI5WCSlotsNode } from '../../types/index.js';
interface SuggestionItemGroupAttributes {
    /**
     * Defines the accessible name of the header.
     * @default undefined
     */
    headerAccessibleName?: string | undefined;
    /**
     * Defines the header text of the <code>ui5-li-group</code>.
     * @default undefined
     */
    headerText?: string | undefined;
}
interface SuggestionItemGroupDomRef extends Required<SuggestionItemGroupAttributes>, Ui5DomRef {
}
interface SuggestionItemGroupPropTypes extends SuggestionItemGroupAttributes, Omit<CommonProps, keyof SuggestionItemGroupAttributes | 'children' | 'header' | 'onMove' | 'onMoveOver'> {
    /**
     * Defines the items of the <code>ui5-suggestion-item-group</code>.
     */
    children?: ReactNode | ReactNode[];
    /**
     * Defines the header of the component.
     *
     * **Note:** Using this slot, the default header text of group and the value of `headerText` property will be overwritten.
     *
     * __Note:__ The content of the prop will be rendered into a [&lt;slot&gt;](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="header"`).
     * 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://sap.github.io/ui5-webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs).
     */
    header?: UI5WCSlotsNode;
    /**
     * Fired when a movable list item is dropped onto a drop target.
     *
     * **Note:** `move` event is fired only if there was a preceding `move-over` with prevented default action.
     *
     * **Note:** Call `event.preventDefault()` inside the handler of this event to prevent its default action/s.
     *
     * **Note:** Available since [v2.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.1.0) of **@ui5/webcomponents**.
     */
    onMove?: (event: Ui5CustomEvent<SuggestionItemGroupDomRef, ListItemGroupMoveEventDetail>) => void;
    /**
     * Fired when a movable list item is moved over a potential drop target during a dragging operation.
     *
     * If the new position is valid, prevent the default action of the event using `preventDefault()`.
     *
     * **Note:** Call `event.preventDefault()` inside the handler of this event to prevent its default action/s.
     *
     * **Note:** Available since [v2.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.1.0) of **@ui5/webcomponents**.
     */
    onMoveOver?: (event: Ui5CustomEvent<SuggestionItemGroupDomRef, ListItemGroupMoveEventDetail>) => void;
}
/**
 * The `SuggestionItemGroup` is type of suggestion item,
 * that can be used to split the `Input` suggestions into groups.
 *
 * __Note__: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/)
 *
 * @since [2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__.
 */
declare const SuggestionItemGroup: import("react").ForwardRefExoticComponent<SuggestionItemGroupPropTypes & import("../../internal/withWebComponent.js").WithWebComponentPropTypes & import("react").RefAttributes<SuggestionItemGroupDomRef>>;
export { SuggestionItemGroup };
export type { SuggestionItemGroupDomRef, SuggestionItemGroupPropTypes };