Skip to content

Commit 820806f

Browse files
authored
docs(AnalyticalTable): improve width & minWidth column property description (#7353)
Closes #7352
1 parent 741ff5c commit 820806f

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

packages/main/src/components/AnalyticalTable/AnalyticalTable.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@ const TableComp = () => {
103103
| `headerTooltip` | `string` | Tooltip for the column header. If not set, the display text will be the same as the Header if it is a `string` |
104104
| `Cell` | `ComponentType` | Custom cell renderer. If set, the table will call that component for every cell and pass all required information as props, e.g. the cell value as `props.cell.value` |
105105
| `cellLabel` | `({cell, instance}) => string` | Defines a function that receives an object as a parameter, including the cell and table instance, and should return the `aria-label` of the current cell. <br /><br />**Note:** Use this property if there is no textual content available through the dataset (e.g. no `accessor` field available), or if you want to provide additional context when navigating to the respective cell for screen readers.<br /><br />**Note:** To retrieve the internal `aria-label`, utilize the `cell.cellLabel` property. |
106-
| `width` | `number` | Cell width, if not set the table will distribute all columns without a width evenly |
107-
| `minWidth` | `number` | min width of the column, e.g. used for resizing |
108-
| `maxWidth` | `number` | max width of the column, e.g. used for resizing |
106+
| `width` | `number` | Defines the column width. If not set, the table will distribute all columns without a width evenly.<br />**Note:** Values lower than `minWidth` are not supported! |
107+
| `minWidth` | `number` | Minimum width of the column.<br />**Default:** `60` |
108+
| `maxWidth` | `number` | Maximum width of the column. |
109109
| `Filter` | `ComponentType` | Filter Component to be rendered in the Header |
110110
| `disableFilters` | `boolean` | Disable filters for this column |
111111
| `disableGlobalFilter` | `boolean` | Disable global filtering for this column |

packages/main/src/components/AnalyticalTable/types/index.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -418,15 +418,19 @@ export interface AnalyticalTableColumnDefinition {
418418
*/
419419
cellLabel?: (param?: CellLabelParam) => string;
420420
/**
421-
* Cell width, if not set the table will distribute all columns without a width evenly.
421+
* Defines the column width. If not set the table will distribute all columns without a width evenly.
422+
*
423+
* __Note:__ Values lower than `minWidth` are not supported!
422424
*/
423425
width?: number;
424426
/**
425-
* Minimum width of the column, e.g. used for resizing.
427+
* Minimum width of the column.
428+
*
429+
* @default: 60
426430
*/
427431
minWidth?: number;
428432
/**
429-
* Maximum with of the column, e.g. used for resizing.
433+
* Maximum width of the column.
430434
*/
431435
maxWidth?: number;
432436
/**

0 commit comments

Comments
 (0)