Type Alias TableRowAction<TComponent, TPropsData, TConditionData>

The basis for the row actions that appear in Tidy's tables.

type TableRowAction<
    TComponent extends Component<any>,
    TPropsData extends object,
    TConditionData extends object,
> = {
    component: TComponent;
    condition?: (args: TableRowActionProps<TConditionData>) => boolean;
    props: (
        args: TableRowActionProps<TPropsData>,
    ) => ComponentProps<TComponent>;
}

Type Parameters

TComponent extends Component<any>
The svelte component used to render the action.
TPropsData extends object
The data passed to the props function.
TConditionData extends object
The data passed to the condition function.

Index

Properties

component condition? props

Properties

component

component: TComponent

The Svelte component to render.

`Optional`condition

condition?: (args: TableRowActionProps<TConditionData>) => boolean

An optional condition callback that determines whether the row action should be included for a given row in the table

props

props: (args: TableRowActionProps<TPropsData>) => ComponentProps<TComponent>

A function that maps row data → component props for this row action, for a given row in the table.