Skip to content

Commit

Permalink
fix: regenerate outdated README.md files (#2900)
Browse files Browse the repository at this point in the history
  • Loading branch information
@misama-ct
misama-ct authored Sep 12, 2024
1 parent 7bce61c commit fba8594
Show file tree
Hide file tree
Showing 8 changed files with 159 additions and 60 deletions.
146 changes: 124 additions & 22 deletions packages/components/data-table/README.md
View file

Large diffs are not rendered by default.

5 changes: 1 addition & 4 deletions packages/components/dropdowns/dropdown-menu/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,7 @@ It allows to use any component as the element used to trigger the floating panel

The panel can be customized to render whatever is needed. However, as a common use case would be to render a list of elements and select one of them, this component provides some helpers to easily implement such use case.

Something to bear in mind:

- when the panel is open, the document scroll is blocked
- if there is limited screen estate, the `menuPosition` may be adjusted to ensure the menu is displayed properly
Something to bear in mind is that, when the panel is open, the document scroll is blocked.

## Installation

Expand Down
6 changes: 3 additions & 3 deletions packages/components/fields/date-field/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ export default Example;
| `isCondensed` | `boolean` | | | Use this property to reduce the paddings of the component for a ui compact variant |
| `minValue` | `string` | | | A minimum selectable date. Must either be an empty string or a date formatted as "YYYY-MM-DD". |
| `maxValue` | `string` | | | A maximum selectable date. Must either be an empty string or a date formatted as "YYYY-MM-DD". |
| `title` | `union`<br/>Possible values:<br/>`string , ReactNode` | ✅ | | Title of the label |
| `hint` | `union`<br/>Possible values:<br/>`string , ReactNode` | | | Hint for the label. Provides a supplementary but important information regarding the behaviour of the input (e.g warn about uniqueness of a field, when it can only be set once), whereas `description` can describe it in more depth. Can also receive a `hintIcon`. |
| `description` | `union`<br/>Possible values:<br/>`string , ReactNode` | | | Provides a description for the title. |
| `title` | `ReactNode` | ✅ | | Title of the label |
| `hint` | `ReactNode` | | | Hint for the label. Provides a supplementary but important information regarding the behaviour of the input (e.g warn about uniqueness of a field, when it can only be set once), whereas `description` can describe it in more depth. Can also receive a `hintIcon`. |
| `description` | `ReactNode` | | | Provides a description for the title. |
| `onInfoButtonClick` | `Function`<br/>[See signature.](#signature-onInfoButtonClick) | | | Function called when info button is pressed.&#xA;<br />&#xA;Info button will only be visible when this prop is passed. |
| `hintIcon` | `ReactElement` | | | Icon to be displayed beside the hint text.&#xA;<br />&#xA;Will only get rendered when `hint` is passed as well. |
| `badge` | `ReactNode` | | | Badge to be displayed beside the label.&#xA;<br />&#xA;Might be used to display additional information about the content of the field (E.g verified email) |
Expand Down
2 changes: 1 addition & 1 deletion packages/components/fields/radio-field/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export default Example;
| `isRequired` | `boolean` | | | Indicates if the value is required. Shows an the "required asterisk" if so. |
| `touched` | `boolean` | | | Indicates whether the field was touched. Errors will only be shown when the field was touched. |
| `name` | `string` | | | Used as HTML name of the input component. |
| `value` | `string` or `boolean` | ✅ | | Value of the input component. |
| `value` | `union`<br/>Possible values:<br/>`string , boolean` | ✅ | | Value of the input component. |
| `onChange` | `ChangeEventHandler` | | | Called with an event containing the new value. Required when input is not read only. Parent should pass it back as value. |
| `onBlur` | `FocusEventHandler` | | | Called when input is blurred |
| `onFocus` | `FocusEventHandler` | | | Called when input is focused |
Expand Down
2 changes: 1 addition & 1 deletion packages/components/inputs/multiline-text-input/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export default Example;
| `hasError` | `boolean` | | | Indicates that input has errors |
| `hasWarning` | `boolean` | | | Control to indicate on the input if there are selected values that are potentially invalid |
| `horizontalConstraint` | `union`<br/>Possible values:<br/>`, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 'scale', 'auto'` | | | Horizontal size limit of the input fields. |
| `rightActionIcon` | `ReactElement` | | | Custom action icon to be displayed on the right side of the input. |
| `rightActionIcon` | `ReactElement` | | | Custom action icon to be displayed on the right side of the input.&#xA;**Will only show**, if `rightActionProps` is provided. |
| `rightActionProps` | `TSecondaryButtonIconProps` | | | Props for the right-action icon-button. Required when rightActionIcon is provided.&#xA;At least a `label` and an `onClick` prop/function need to be provided. |
| `isCondensed` | `boolean` | | | Set this to `true` to reduce the paddings of the input allowing the input to display&#xA;more data in less space. |
| `maxRows` | `number` | | | Set this to value to determine the maximum text rows of the text area.&#xA;Any text overflow past this row number would implement a scroll |
Expand Down
Loading

0 comments on commit fba8594

Please sign in to comment.