@ui5/webcomponents-react/wrappers/webComponents/TableGrowing/index.d.ts

React Wrapper for UI5 Web Components and additional components

import '@ui5/webcomponents/dist/TableGrowing.js';
import type TableGrowingMode from '@ui5/webcomponents/dist/types/TableGrowingMode.js';
import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '@ui5/webcomponents-react-base';
interface TableGrowingAttributes {
    /**
     * Defines the mode of the <code>ui5-table</code> growing.
     *
     * Available options are:
     *
     * Button - Shows a More button at the bottom of the table, pressing it will load more rows.
     *
     * Scroll - The rows are loaded automatically by scrolling to the bottom of the table. If the table is not scrollable,
     * a growing button will be rendered instead to ensure growing functionality.
     * @default "Button"
     */
    mode?: TableGrowingMode | keyof typeof TableGrowingMode;
    /**
     * Defines the text that will be displayed below the `text` inside the growing button.
     * Has no effect when mode is set to Scroll.
     * @default undefined
     */
    subtext?: string | undefined;
    /**
     * Defines the text that will be displayed inside the growing button.
     * Has no effect when mode is set to `Scroll`.
     *
     * **Note:** When not provided and the mode is set to Button, a default text is displayed, corresponding to the
     * current language.
     * @default undefined
     */
    text?: string | undefined;
}
interface TableGrowingDomRef extends Required<TableGrowingAttributes>, Ui5DomRef {
}
interface TableGrowingPropTypes extends TableGrowingAttributes, Omit<CommonProps, keyof TableGrowingAttributes | 'onLoadMore'> {
    /**
     * Fired when the growing button is pressed or the user scrolls to the end of the table.
     *
     * | cancelable | bubbles |
     * | :--------: | :-----: |
     * | ❌|✅|
     */
    onLoadMore?: (event: Ui5CustomEvent<TableGrowingDomRef>) => void;
}
/**
 * The `TableGrowing` component is used inside the `Table` to add a growing/data loading functionalities
 * to the table.
 *
 * The component offers two options:
 * * Button - a More button is displayed, clicking it will load more data.
 * * Scroll - additional data is loaded automatically when the user scrolls to the end of the table.
 *
 * ### Usage
 *
 * The `TableGrowing` component is only used inside the `Table` component as a feature.
 * It has to be slotted inside the `Table` in the `features` slot.
 * The component is not intended to be used as a standalone component.
 *
 * ```html
 * <Table>
 * 	<TableGrowing mode="Button" text="More" slot="features"></TableGrowing>
 * </Table>
 * ```
 *
 * **Notes**:
 * * When the `TableGrowing` component is used with the `Scroll` mode and the table is currently not scrollable,
 * the component will render a growing button instead to ensure growing capabilities until the table becomes scrollable.
 *
 *
 *
 * __Note:__ This is a UI5 Web Component! [TableGrowing UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableGrowing) | [Repository](https://github.com/UI5/webcomponents)
 *
 * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__.
 */
declare const TableGrowing: import("react").ForwardRefExoticComponent<TableGrowingPropTypes & import("@ui5/webcomponents-react-base").WithWebComponentPropTypes & import("react").RefAttributes<TableGrowingDomRef>>;
export { TableGrowing };
export type { TableGrowingDomRef, TableGrowingPropTypes };