grid-tabulator.actionformatterparams

Home > @genesislcap/grid-tabulator > ActionFormatterParams

ActionFormatterParams interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Parameters for the action formatter.

actionClick: Callback function triggered when the action button is clicked.

actionName: The name or label of the action button.

appearance: The appearance style of the action button.

dataTestId: The data-test-id attribute value to be used for E2E testing.

isDisabled: Function to determine whether the action button should be disabled for a specific row.

uniqueFieldName: A unique field name used to identify the action button for E2E testing.

prefix: The prefix to use for the button element, e.g., 'foundation', 'zero', 'rapid'. Defaults to 'foundation' if not specified.

actionButtonStyle: Optional styling for the action button.

contentTemplate: Used to render some arbitrary content inside the action button.

Signature:

export interface ActionFormatterParams<T = any> 

Properties

Property	Modifiers	Type	Description
actionButtonStyle?		string	(ALPHA) (Optional)
actionClick?		(rowData: T) => void	(ALPHA) (Optional)
actionName?		string	(ALPHA) (Optional)
appearance?		string	(ALPHA) (Optional)
contentTemplate?		string	(ALPHA) (Optional)
dataTestId?		((rowData: T) => string) | string	(ALPHA) (Optional)
isDisabled?		(rowData: T) => boolean	(ALPHA) (Optional)
prefix?		string	(ALPHA) (Optional)
uniqueFieldName?		string	(ALPHA) (Optional)