@ui5/webcomponents-react
Version:
React Wrapper for UI5 Web Components and additional components
53 lines (52 loc) • 2.26 kB
TypeScript
import '@ui5/webcomponents/dist/TableRowAction.js';
import type { CommonProps, Ui5CustomEvent, Ui5DomRef } from '@ui5/webcomponents-react-base';
interface TableRowActionAttributes {
/**
* Defines the icon of the row action.
*
* **Note:** For row actions to work properly, this property is mandatory.
*
* **Note:** SAP-icons font provides numerous built-in icons. To find all the available icons, see the
* [Icon Explorer](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html).
*/
icon?: string;
/**
* Defines the visibility of the row action.
*
* **Note:** Invisible row actions still take up space, allowing to hide the action while maintaining its position.
* @default false
*/
invisible?: boolean;
/**
* Defines the text of the row action.
*
* **Note:** For row actions to work properly, this property is mandatory.
*/
text?: string;
}
interface TableRowActionDomRef extends Required<TableRowActionAttributes>, Ui5DomRef {
}
interface TableRowActionPropTypes extends TableRowActionAttributes, Omit<CommonProps, keyof TableRowActionAttributes | 'onClick'> {
/**
* Fired when a row action is clicked.
*
* **Note:** Available since [v2.9.0](https://github.com/UI5/webcomponents/releases/tag/v2.9.0) of **@ui5/webcomponents**.
*
* | cancelable | bubbles |
* | :--------: | :-----: |
* | ❌|✅|
*/
onClick?: (event: Ui5CustomEvent<TableRowActionDomRef>) => void;
}
/**
* The `TableRowAction` component defines an action for table rows.
*
*
*
* __Note:__ This is a UI5 Web Component! [TableRowAction UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableRowAction) | [Repository](https://github.com/UI5/webcomponents)
*
* @since [2.7.0](https://github.com/UI5/webcomponents/releases/tag/v2.7.0) of __@ui5/webcomponents__.
*/
declare const TableRowAction: import("react").ForwardRefExoticComponent<TableRowActionPropTypes & import("@ui5/webcomponents-react-base").WithWebComponentPropTypes & import("react").RefAttributes<TableRowActionDomRef>>;
export { TableRowAction };
export type { TableRowActionDomRef, TableRowActionPropTypes };