Skip to content

Commit

Permalink
Docs(web-react): Sort Field components props aplhabetically in READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
@literat
literat committed Jul 21, 2023
1 parent b80d336 commit 1f8afec
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 28 deletions.
14 changes: 7 additions & 7 deletions packages/web-react/src/components/CheckboxField/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ It could be disabled or have a validation state. The label could be hidden and s
| Prop name | Type | Default | Required | Description |
| ----------------- | ---------------------------------------------- | ------- | -------- | ------------------------------ |
| `id` | `string` | - | yes | Input and label identification |
| `name` | `string` | - | no | Input name |
| `label` | `string` | - | no | Label text |
| `value` | `string` | - | no | Input value |
| `validationState` | [Validation dictionary][dictionary-validation] | - | no | Type of validation state. |
| `validationText` | `string`, `string[]` | - | no | Validation text |
| `isDisabled` | `boolean` | - | no | Whether is field disabled |
| `isItem` | `boolean` | - | no | To render in [Item][item] mode |
| `isRequired` | `boolean` | - | no | Whether is field required |
| `isChecked` | `boolean` | - | no | Whether is field checked |
| `isItem` | `boolean` | - | no | To render in [Item][item] mode |
| `isLabelHidden` | `boolean` | - | no | Whether is label hidden |
| `isRequired` | `boolean` | - | no | Whether is field required |
| `label` | `string` | - | no | Label text |
| `name` | `string` | - | no | Input name |
| `ref` | `ForwardedRef<HTMLInputElement>` | - | no | Input element reference |
| `validationState` | [Validation dictionary][dictionary-validation] | - | no | Type of validation state. |
| `validationText` | `string`, `string[]` | - | no | Validation text |
| `value` | `string` | - | no | Input value |

## Custom component

Expand Down
2 changes: 1 addition & 1 deletion packages/web-react/src/components/Field/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ import { ValidationText } from '@lmc-eu/spirit-web-react/components';

| Name | Type | Default | Required | Description |
| ---------------- | -------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------- |
| `elementType` | `span`, `div` | `div` | no | Type of element used as main wrapper (applied only for single validation text, otherwise `ul`) |
| `className` | `string` | - | yes | Wrapper custom class name |
| `elementType` | `span`, `div` | `div` | no | Type of element used as main wrapper (applied only for single validation text, otherwise `ul`) |
| `validationText` | `string`, `string[]` | - | yes | Validation text |
6 changes: 3 additions & 3 deletions packages/web-react/src/components/RadioField/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ Use RadioField when you have a group of mutually exclusive choices and only one
| Prop name | Type | Default | Required | Description |
| ----------------- | ---------------------------------------------- | ------- | -------- | ------------------------------ |
| `id` | string | - | yes | Input and label identification |
| `name` | string | - | no | Input name |
| `label` | string | - | no | Label text |
| `value` | string | - | no | Input value |
| `isDisabled` | boolean | - | no | Whether is field disabled |
| `isChecked` | boolean | - | no | Whether is field checked |
| `isItem` | boolean | - | no | To render in [Item][item] mode |
| `isLabelHidden` | boolean | - | no | Whether is label hidden |
| `label` | string | - | no | Label text |
| `name` | string | - | no | Input name |
| `ref` | `ForwardedRef<HTMLInputElement>` | - | no | Input element reference |
| `validationState` | [Validation dictionary][dictionary-validation] | - | no | Type of validation state |
| `value` | string | - | no | Input value |

## Custom component

Expand Down
14 changes: 7 additions & 7 deletions packages/web-react/src/components/Select/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@

| Prop name | Type | Default | Required | Description |
| ----------------- | ---------------------------------------------- | ------- | -------- | ------------------------------- |
| `helperText` | `string` | - | no | Custom helper text |
| `children` | `ReactNode` | `null` | no | Content of the Select |
| `id` | `string` | - | yes | Select and label identification |
| `name` | `string` | - | no | Select name |
| `isDisabled` | `boolean` | - | no | Whether is field disabled |
| `isFluid` | `boolean` | - | no | Whether is field is fluid |
| `isLabelHidden` | `boolean` | - | no | Whether is label hidden |
| `isRequired` | `boolean` | - | no | Whether is field required |
| `label` | `string` | - | no | Label text |
| `validationText` | `string`, `string[]` | - | no | Validation text |
| `name` | `string` | - | no | Select name |
| `ref` | `ForwardedRef<HTMLSelectElement>` | - | no | Select element reference |
| `validationState` | [Validation dictionary][dictionary-validation] | - | no | Type of validation state |
| `isDisabled` | `boolean` | - | no | Whether is field disabled |
| `isRequired` | `boolean` | - | no | Whether is field required |
| `isLabelHidden` | `boolean` | - | no | Whether is label hidden |
| `isFluid` | `boolean` | - | no | Whether is field is fluid |
| `helperText` | `string` | - | no | Custom helper text |
| `validationText` | `string`, `string[]` | - | no | Validation text |

## Icons Provider

Expand Down
20 changes: 10 additions & 10 deletions packages/web-react/src/components/TextArea/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,22 @@ The label could be hidden and show if the textarea is required.

| Prop name | Type | Default | Required | Description |
| ----------------------- | ---------------------------------------------- | ------- | -------- | -------------------------------------------------------------------- |
| `autoResizingMaxHeight` | `number` | `400` | no | Maximum field height with automatic height control |
| `helperText` | `string` | - | no | Custom helper text |
| `id` | `string` | - | yes | Textarea and label identification |
| `name` | `string` | - | no | Textarea name |
| `isAutoResizing` | `boolean` | - | no | Whether is field auto resizing which adjusts its height while typing |
| `isDisabled` | `boolean` | - | no | Whether is field disabled |
| `isLabelHidden` | `boolean` | - | no | Whether is label hidden |
| `isRequired` | `boolean` | - | no | Whether is field required |
| `label` | `string` | - | no | Label text |
| `placeholder` | `string` | - | no | Textarea placeholder |
| `value` | `string` | - | no | Textarea value |
| `maxLength` | `number` | - | no | Maximum number of characters |
| `rows` | `number` | - | no | Number of visible rows |
| `name` | `string` | - | no | Textarea name |
| `placeholder` | `string` | - | no | Textarea placeholder |
| `ref` | `ForwardedRef<HTMLTextAreaElement>` | - | no | Textarea element reference |
| `rows` | `number` | - | no | Number of visible rows |
| `validationState` | [Validation dictionary][dictionary-validation] | - | no | Type of validation state |
| `validationText` | `string`, `string[]` | - | no | Validation text |
| `isAutoResizing` | `boolean` | - | no | Whether is field auto resizing which adjusts its height while typing |
| `isDisabled` | `boolean` | - | no | Whether is field disabled |
| `isRequired` | `boolean` | - | no | Whether is field required |
| `isLabelHidden` | `boolean` | - | no | Whether is label hidden |
| `helperText` | `string` | - | no | Custom helper text |
| `autoResizingMaxHeight` | `number` | `400` | no | Maximum field height with automatic height control |
| `value` | `string` | - | no | Textarea value |

## Custom component

Expand Down

0 comments on commit 1f8afec

Please sign in to comment.