build(docs-generation): implement type override rule

sbb-design-systems · Sep 20, 2024 · 623dcc4 · 623dcc4
1 parent a776ed5
commit 623dcc4
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 15 deletions.
diff --git a/src/elements/checkbox/checkbox-panel/readme.md b/src/elements/checkbox/checkbox-panel/readme.md
@@ -71,6 +71,9 @@ The component provides the same accessibility features as the native checkbox.
 Always provide an accessible label via `aria-label` for checkboxes without descriptive text content.
 If you don't want the label to appear next to the checkbox, you can use `aria-label` to specify an appropriate label.
 
+<!-- Override
+  @type value => string \| null
+-->
 <!-- Auto Generated Below -->
 
 ## Properties
@@ -87,7 +90,7 @@ If you don't want the label to appear next to the checkbox, you can use `aria-la
 | `name`          | `name`          | public  | `string`                          |           | Name of the form element. Will be read from name attribute.    |
 | `required`      | `required`      | public  | `boolean`                         | `false`   | Whether the component is required.                             |
 | `size`          | `size`          | public  | `SbbPanelSize`                    | `'m'`     | Size variant.                                                  |
-| `value`         | `value`         | public  | `V \| null`                       | `null`    | Value of the form element.                                     |
+| `value`         | `value`         | public  | `string \| null`                  | `null`    | Value of the form element.                                     |
 
 ## Events
 

diff --git a/src/elements/checkbox/checkbox/readme.md b/src/elements/checkbox/checkbox/readme.md
@@ -77,6 +77,9 @@ If you don't want the label to appear next to the checkbox, you can use `aria-la
 <sbb-checkbox aria-label="Subscribed to email message"></sbb-checkbox>
 ```
 
+<!-- Override
+  @type value => string \| null
+-->
 <!-- Auto Generated Below -->
 
 ## Properties
@@ -93,7 +96,7 @@ If you don't want the label to appear next to the checkbox, you can use `aria-la
 | `name`          | `name`           | public  | `string`                          |         | Name of the form element. Will be read from name attribute.                                                                      |
 | `required`      | `required`       | public  | `boolean`                         | `false` | Whether the component is required.                                                                                               |
 | `size`          | `size`           | public  | `SbbCheckboxSize`                 | `'m'`   | Size variant.                                                                                                                    |
-| `value`         | `value`          | public  | `V \| null`                       | `null`  | Value of the form element.                                                                                                       |
+| `value`         | `value`          | public  | `string \| null`                  | `null`  | Value of the form element.                                                                                                       |
 
 ## Events
 

diff --git a/src/elements/select/readme.md b/src/elements/select/readme.md
@@ -111,22 +111,25 @@ Opened panel:
 | <kbd>Shift</kbd><kbd>Up Arrow</kbd>     | If `multiple`, moves to the next non-disabled option and toggle its selection.                                                                    |
 | Any char or number                      | If exists, select the first non-disabled matching option after the selected value.                                                                |
 
+<!-- Override
+  @type value => string \| string[] \| null
+-->
 <!-- Auto Generated Below -->
 
 ## Properties
 
-| Name          | Attribute     | Privacy | Type                      | Default | Description                                                    |
-| ------------- | ------------- | ------- | ------------------------- | ------- | -------------------------------------------------------------- |
-| `disabled`    | `disabled`    | public  | `boolean`                 | `false` | Whether the component is disabled.                             |
-| `form`        | -             | public  | `HTMLFormElement \| null` |         | Returns the form owner of the internals of the target element. |
-| `isOpen`      | -             | public  | `boolean`                 |         | Whether the element is open.                                   |
-| `multiple`    | `multiple`    | public  | `boolean`                 | `false` | Whether the select allows for multiple selection.              |
-| `name`        | `name`        | public  | `string`                  |         | Name of the form element. Will be read from name attribute.    |
-| `negative`    | `negative`    | public  | `boolean`                 | `false` | Negative coloring variant flag.                                |
-| `placeholder` | `placeholder` | public  | `string \| undefined`     |         | The placeholder used if no value has been selected.            |
-| `readonly`    | `readonly`    | public  | `boolean`                 | `false` | Whether the select is readonly.                                |
-| `required`    | `required`    | public  | `boolean`                 | `false` | Whether the select is required.                                |
-| `value`       | `value`       | public  | `V \| null`               | `null`  | Value of the form element.                                     |
+| Name          | Attribute     | Privacy | Type                         | Default | Description                                                    |
+| ------------- | ------------- | ------- | ---------------------------- | ------- | -------------------------------------------------------------- |
+| `disabled`    | `disabled`    | public  | `boolean`                    | `false` | Whether the component is disabled.                             |
+| `form`        | -             | public  | `HTMLFormElement \| null`    |         | Returns the form owner of the internals of the target element. |
+| `isOpen`      | -             | public  | `boolean`                    |         | Whether the element is open.                                   |
+| `multiple`    | `multiple`    | public  | `boolean`                    | `false` | Whether the select allows for multiple selection.              |
+| `name`        | `name`        | public  | `string`                     |         | Name of the form element. Will be read from name attribute.    |
+| `negative`    | `negative`    | public  | `boolean`                    | `false` | Negative coloring variant flag.                                |
+| `placeholder` | `placeholder` | public  | `string \| undefined`        |         | The placeholder used if no value has been selected.            |
+| `readonly`    | `readonly`    | public  | `boolean`                    | `false` | Whether the select is readonly.                                |
+| `required`    | `required`    | public  | `boolean`                    | `false` | Whether the select is required.                                |
+| `value`       | `value`       | public  | `string \| string[] \| null` | `null`  | Value of the form element.                                     |
 
 ## Methods
 

diff --git a/src/elements/toggle-check/readme.md b/src/elements/toggle-check/readme.md
@@ -60,6 +60,9 @@ you can not provide it and then use `aria-label` to specify an appropriate label
 <sbb-toggle-check aria-label="Subscribed to email message"></sbb-toggle-check>
 ```
 
+<!-- Override
+  @type value => string \| null
+-->
 <!-- Auto Generated Below -->
 
 ## Properties
@@ -74,7 +77,7 @@ you can not provide it and then use `aria-label` to specify an appropriate label
 | `name`          | `name`           | public  | `string`                           |                | Name of the form element. Will be read from name attribute.    |
 | `required`      | `required`       | public  | `boolean`                          | `false`        | Whether the component is required.                             |
 | `size`          | `size`           | public  | `'xs' \| 's' \| 'm'`               | `'s'`          | Size variant, either m, s or xs.                               |
-| `value`         | `value`          | public  | `V \| null`                        | `null`         | Value of the form element.                                     |
+| `value`         | `value`          | public  | `string \| null`                   | `null`         | Value of the form element.                                     |
 
 ## Events