Skip to content

Commit

Permalink
docs(Table): fix readme (#1911)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Raubzeug
Raubzeug authored Oct 22, 2024
1 parent 679c537 commit bdfed60
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions src/components/Table/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -239,11 +239,13 @@ const MyTable1 = withTableSettings({sortable: false})(Table);

### Options

| Name | Description | Type | Default |
| :--------- | :-------------------------------------------------- | :--------------: | :-----: |
| width | Settings' popup width | `number` `"fit"` | |
| sortable | Whether or not add ability to sort settings items | `boolean` | `true` |
| filterable | Whether or not add ability to filter settings items | `boolean` | `false` |
| Name | Description | Type | Default |
| :-------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ | :-----------------: | :-----: |
| width | Settings' popup width | `number` `"fit"` | |
| sortable | Whether or not add ability to sort settings items | `boolean` | `true` |
| filterable | Whether or not add ability to filter settings items | `boolean` | `false` |
| defaultSettings | Settings to which you can reset the current settings | `TableSettingsData` | |
| showResetButton | Display a reset button that resets the current settings changes. If the `defaultSettings` prop is set then the settings reset to the `defaultSettings`. | `boolean` | |

### ColumnMeta

Expand All @@ -254,15 +256,15 @@ const MyTable1 = withTableSettings({sortable: false})(Table);

### Properties

| Name | Description | Type |
| :------------------------- | :----------------------------------------------------------- | :------------------------------------------------------: |
| settingsPopupWidth | TableColumnSetup pop-up width | `number` `"fit"` |
| settings | Current settings | `TableSettingsData` |
| updateSettings | Settings update handle | `(data: TableSettingsData) => Promise<void>` |
| renderControls | Allows to render custom actions | `RenderControls` |
| settingsFilterPlaceholder | Text that appears in the control when no search value is set | `string` |
| settingsFilterEmptyMessage | Text that appears when no one item is found | `string` |
| filterSettings | Function for filtering items | `(value: string, item: TableColumnSetupItem) => boolean` |
| Name | Description | Type |
| :------------------------- | :------------------------------------------------------------------------- | :------------------------------------------------------: |
| settingsPopupWidth | TableColumnSetup pop-up width | `number` `"fit"` |
| settings | Current settings | `TableSettingsData` |
| updateSettings | Settings update handle | `(data: TableSettingsData) => Promise<void>` |
| renderControls | (deprecated) use `defaultSettings` and `showResetButton` to reset settings | `RenderControls` |
| settingsFilterPlaceholder | Text that appears in the control when no search value is set | `string` |
| settingsFilterEmptyMessage | Text that appears when no one item is found | `string` |
| filterSettings | Function for filtering items | `(value: string, item: TableColumnSetupItem) => boolean` |

### TableSettingsData

Expand Down

0 comments on commit bdfed60

Please sign in to comment.