Skip to content

Commit 34f7cd2

Browse files
bsastregxbsastregx
committed
[ch-tabular-grid] Regenerate readme.md 
1 parent a1ac265 commit 34f7cd2

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

‎src/components/tabular-grid/readme.md‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,19 @@ The `ch-tabular-grid` component represents a Grid/TreeGrid of data, with rows an
99

1010
## Properties
1111

12-
| Property | Attribute | Description | Type | Default |
13-
| ------------------------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ----------- |
14-
| `allowColumnReorder` | `allow-column-reorder` | A boolean indicating whether the user can drag column headers to reorder columns. | `boolean` | `true` |
15-
| `columnResizeMode` | `column-resize-mode` | One of "single" or "splitter", indicating the behavior of column resizing. "single", resize a single column at a time. "splitter", when adjusts the width of one column, the neighboring columns are also resized proportionally, maintaining the overall width. | `"single" \| "splitter"` | `"single"` |
16-
| `keyboardNavigationMode` | `keyboard-navigation-mode` | Specifies the keyboard navigation mode for the component. - "none": Disables keyboard navigation for the grid rows. - "select": Allows keyboard navigation by changing the selection of grid rows. - "focus": Allows keyboard navigation by focusing on grid rows, but does not change the selection. | `"focus" \| "none" \| "select"` | `"select"` |
17-
| `localization` | -- | An object that contains localized strings for the grid. | `GridLocalization` | `undefined` |
18-
| `rowFocusedClass` | `row-focused-class` | A CSS class name applied to a row when it is focused. | `string` | `undefined` |
19-
| `rowHighlightEnabled` | `row-highlight-enabled` | One of "false", "true" or "auto", indicating whether or not rows can be highlighted. "auto", row highlighting will be enabled if the row selection mode is set to "single" or "multiple". | `"auto" \| boolean` | `"auto"` |
20-
| `rowHighlightedClass` | `row-highlighted-class` | A CSS class name applied to a row when it is hovered. | `string` | `undefined` |
21-
| `rowMarkedClass` | `row-marked-class` | A CSS class name applied to a row when it is marked. | `string` | `undefined` |
22-
| `rowSelectedClass` | `row-selected-class` | A CSS class name applied to a row when it is selected. | `string` | `undefined` |
23-
| `rowSelectionMode` | `row-selection-mode` | One of "none", "single" or "multiple", indicating how rows can be selected. It can be set to "none" if no rows should be selectable, "single" if only one row can be selected at a time, or "multiple" if multiple rows can be selected at once. | `"multiple" \| "none" \| "single"` | `"single"` |
12+
| Property | Attribute | Description | Type | Default |
13+
| ------------------------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------- |
14+
| `allowColumnReorder` | `allow-column-reorder` | A boolean indicating whether the user can drag column headers to reorder columns. | `boolean` | `true` |
15+
| `columnResizeMode` | `column-resize-mode` | One of "single" or "splitter", indicating the behavior of column resizing. "single", resize a single column at a time. "splitter", when adjusts the width of one column, the neighboring columns are also resized proportionally, maintaining the overall width. | `"single" \| "splitter"` | `"single"` |
16+
| `keyboardNavigationMode` | `keyboard-navigation-mode` | Specifies the keyboard navigation mode for the component. - "none": Disables keyboard navigation for the grid rows. - "select": Allows keyboard navigation by changing the selection of grid rows. - "focus": Allows keyboard navigation by focusing on grid rows, but does not change the selection. | `"focus" \| "none" \| "select"` | `"select"` |
17+
| `localization` | -- | An object that contains localized strings for the grid. | `GridLocalization` | `undefined` |
18+
| `rowFocusedClass` | `row-focused-class` | A CSS class name applied to a row when it is focused. | `string` | `undefined` |
19+
| `rowHighlightEnabled` | `row-highlight-enabled` | One of "false", "true" or "auto", indicating whether or not rows can be highlighted. "auto", row highlighting will be enabled if the row selection mode is set to "single" or "multiple". | `"auto" \| boolean` | `"auto"` |
20+
| `rowHighlightedClass` | `row-highlighted-class` | A CSS class name applied to a row when it is hovered. | `string` | `undefined` |
21+
| `rowMarkedClass` | `row-marked-class` | A CSS class name applied to a row when it is marked. | `string` | `undefined` |
22+
| `rowSelectedClass` | `row-selected-class` | A CSS class name applied to a row when it is selected. | `string` | `undefined` |
23+
| `rowSelectionMode` | `row-selection-mode` | One of "none", "single" or "multiple", indicating how rows can be selected. It can be set to "none" if no rows should be selectable, "single" if only one row can be selected at a time, or "multiple" if multiple rows can be selected at once. | `"multiple" \| "none" \| "single"` | `"single"` |
24+
| `showLines` | `show-lines` | Defines which lines (or borders) are displayed within the tabular grid. Similar to the border options in spreadsheet applications, this property controls whether lines appear around and/or between rows and columns. **Note:** At the moment, this property does not affect the rendering of the grid. It only reflects the property value as an HTML attribute. - "all": Lines around and between all rows and columns. - "all-inside": Lines only between rows and columns. - "column": Lines around and between columns. - "column-inside": Lines only between columns. - "none": No lines at all. - "row": Lines around and between rows. - "row-inside": Lines only between rows. Default: "all". | `"all" \| "all-inside" \| "column" \| "column-inside" \| "none" \| "row" \| "row-inside"` | `"all"` |
2425

2526

2627
## Events

0 commit comments

Comments
 (0)