Interface TableHeaderProps

The TableHeaderProps interface represents the properties of the TableHeader component.

Hierarchy

  • TableHeaderProps

Properties

dateFormat disableFilter? disableSort? handleColumnSort handleReset handleSearchByProperty handleToggle inputValues isOpenSearchByProperty isSortKey isVisible label property sortOrder

Properties

dateFormat

dateFormat: string

The date format of the table header.

Optional disableFilter

disableFilter?: boolean

Flag indicating if filtering is disabled for the table header (optional).

Optional disableSort

disableSort?: boolean

Flag indicating if sorting is disabled for the table header (optional).

handleColumnSort

handleColumnSort: ((property, dateFormat) => void)

Type declaration

    • (property, dateFormat): void

    • The function that is called when the sort button is clicked.

      Parameters

      • property: string
      • dateFormat: string

      Returns void

handleReset

handleReset: ((property) => void)

Type declaration

    • (property): void

    • The function that is called when the reset button is clicked.

      Parameters

      • property: string

      Returns void

handleSearchByProperty

handleSearchByProperty: ((property, value) => void)

Type declaration

    • (property, value): void

    • The function that is called when the search by property is triggered.

      Parameters

      • property: string
      • value: string

      Returns void

handleToggle

handleToggle: ((property) => void)

Type declaration

    • (property): void

    • The function that is called when the toggle button is clicked.

      Parameters

      • property: string

      Returns void

inputValues

inputValues: {
    [key: string]: string | undefined;
}

The current input values for searching.

Type declaration

  • [key: string]: string | undefined

isOpenSearchByProperty

isOpenSearchByProperty: {
    [property: string]: boolean;
}

Record indicating whether search by property is open for each property.

Type declaration

  • [property: string]: boolean

isSortKey

isSortKey: boolean

Indicates if the property is currently the sort key.

isVisible

isVisible: boolean

Flag indicating if the table header is visible.

label

label: string

The label of the table header.

property

property: string

The property of the table header.

sortOrder

sortOrder: "asc" | "desc" | "noSort"

The current order of the sort. Can be 'asc', 'desc' or 'noSort'.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc