react.arquerodetailslistprops.md
January 18, 2023 ยท View on GitHub
Home > @datashaper/react > ArqueroDetailsListProps
ArqueroDetailsListProps interface
Props for the Arquero Details List component
Signature:
export interface ArqueroDetailsListProps extends Omit<IDetailsListProps, 'items'>
Extends: Omit<IDetailsListProps, 'items'>
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| compactRowHeight? | number | (Optional) If compact = true, override the default height. FluentUI hard-codes the compact height, so this gives us a way to customize how dense the rows are. Note that if compact = false (the default), this has no effect. | |
| defaultSortColumn? | string | (Optional) Default sort column | |
| defaultSortDirection? | SortDirection | (Optional) Resizable sort direction | |
| features? | ArqueroDetailsListFeatures | (Optional) | |
| fields? | Field[] | (Optional) | |
| fill? | boolean | (Optional) Indicates that the table should fill its container space, including the use of pseudo columns and rows to present a "spreadsheet-like" view. | |
| isHeaderFixed? | boolean | (Optional) Fixed headers on top when scrolling | |
| limit? | number | (Optional) | |
| metadata? | TableMetadata | (Optional) Optional metadata to use for column smart features. Use this if you need to cache expensive stats computes separately to prevent recompute on remounting. | |
| offset? | number | (Optional) | |
| onCellDropdownSelect? | DropdownOptionSelect | (Optional) If array cells are displayed with a dropdown, this will fire when a value is selected. | |
| onColumnSelect? | ColumnSelectFunction | (Optional) Fires a column-wide select event for all columns, including headers. If you need custom behavior, use the built-in table-level onColumnHeaderClick and per-column onClick | |
| onRenderGroupHeader? | GroupHeaderFunction | (Optional) Passthrough to the group header rendering, when using the group by verb | |
| resizable? | boolean | (Optional) Resizable columns | |
| selectedColumn? | string | (Optional) Key for a selected column - this is not normally an option in DetailsList | |
| showColumnBorders? | boolean | (Optional) Indicates to use borders between columns so the cells look more like a spreadsheet (row borders are always on). | |
| sortable? | boolean | (Optional) | |
| striped? | boolean | (Optional) Indicates whether to use even/odd row coloring. | |
| style? | CSSProperties | (Optional) Style to pass to the container. Use the regular DetailsList.styles prop for deeper customization of the table itself. | |
| table | ColumnTable | ||
| validationResult? | ValidationResult | (Optional) |