From 878e186d4334e0c16ede3681013f6f85f88f0cf1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kater=CC=8Cina=20Dlouha=CC=81?= Date: Wed, 14 Feb 2024 16:53:43 +0100 Subject: [PATCH] Docs(web-react, web-twig): Add `isFluid` to the API documentations of `FieldGroup` --- .../src/components/FieldGroup/README.md | 25 ++++++++------- .../Resources/components/FieldGroup/README.md | 31 ++++++++++--------- 2 files changed, 29 insertions(+), 27 deletions(-) diff --git a/packages/web-react/src/components/FieldGroup/README.md b/packages/web-react/src/components/FieldGroup/README.md index 319ab74ce5..2c8b1bf57f 100644 --- a/packages/web-react/src/components/FieldGroup/README.md +++ b/packages/web-react/src/components/FieldGroup/README.md @@ -94,18 +94,19 @@ Validation states can be presented either by adding the `validationState` attrib ## API -| Name | Type | Default | Required | Description | -| ----------------- | ---------------------------------------------- | ------- | -------- | ---------------------------------------- | -| `form` | `string` | `null` | ✕ | Parent form ID | -| `helperText` | `string` | `null` | ✕ | Custom helper text | -| `id` | `string` | — | ✔ | Group and label identification | -| `isDisabled` | `bool` | `false` | ✕ | If true, the group is disabled | -| `isLabelHidden` | `bool` | `false` | ✕ | If true, label is hidden | -| `isRequired` | `bool` | `false` | ✕ | If true, the group is marked as required | -| `label` | `string` | — | ✔ | Label text | -| `name` | `string` | `null` | ✕ | Group name | -| `validationState` | [Validation dictionary][dictionary-validation] | `null` | ✕ | Type of validation state | -| `validationText` | [`string` \| `string[]`] | `null` | ✕ | Validation text | +| Name | Type | Default | Required | Description | +| ----------------- | ---------------------------------------------- | ------- | -------- | ---------------------------------------------------------- | +| `form` | `string` | `null` | ✕ | Parent form ID | +| `helperText` | `string` | `null` | ✕ | Custom helper text | +| `id` | `string` | — | ✔ | Group and label identification | +| `isDisabled` | `bool` | `false` | ✕ | If true, the group is disabled | +| `isFluid` | `bool` | — | ✕ | If true, the element spans to the full width of its parent | +| `isLabelHidden` | `bool` | `false` | ✕ | If true, label is hidden | +| `isRequired` | `bool` | `false` | ✕ | If true, the group is marked as required | +| `label` | `string` | — | ✔ | Label text | +| `name` | `string` | `null` | ✕ | Group name | +| `validationState` | [Validation dictionary][dictionary-validation] | `null` | ✕ | Type of validation state | +| `validationText` | [`string` \| `string[]`] | `null` | ✕ | Validation text | On top of the API options, the components accept [additional attributes][readme-additional-attributes]. If you need more control over the styling of a component, you can use [style props][readme-style-props] diff --git a/packages/web-twig/src/Resources/components/FieldGroup/README.md b/packages/web-twig/src/Resources/components/FieldGroup/README.md index da6cb27726..72f3323f40 100644 --- a/packages/web-twig/src/Resources/components/FieldGroup/README.md +++ b/packages/web-twig/src/Resources/components/FieldGroup/README.md @@ -97,21 +97,22 @@ When validated on server: ## API -| Name | Type | Default | Required | Description | -| ----------------------- | ---------------------------------------------- | ------- | -------- | ------------------------------------------ | -| `form` | `string` | `null` | ✕ | Parent form ID | -| `helperText` | `string` | `null` | ✕\*\* | Custom helper text | -| `id` | `string` | — | ✔ | Group and label identification | -| `isDisabled` | `bool` | `false` | ✕ | If true, the group is disabled | -| `isLabelHidden` | `bool` | `false` | ✕ | If true, label is hidden | -| `isRequired` | `bool` | `false` | ✕ | If true, the group is marked as required | -| `label` | `string` | `null` | ✕\* | Label text | -| `name` | `string` | `null` | ✕ | Group name | -| `UNSAFE_helperText` | `string` | `null` | ✕\*\* | Unescaped custom helper text (allows HTML) | -| `UNSAFE_label` | `string` | `null` | ✕\* | Unescaped label text (allows HTML) | -| `UNSAFE_validationText` | [`string` \| `string[]`] | `null` | ✕\*\* | Unescaped validation text (allows HTML) | -| `validationState` | [Validation dictionary][dictionary-validation] | `null` | ✕ | Type of validation state | -| `validationText` | [`string` \| `string[]`] | `null` | ✕\*\* | Validation text | +| Name | Type | Default | Required | Description | +| ----------------------- | ---------------------------------------------- | ------- | -------- | ---------------------------------------------------------- | +| `form` | `string` | `null` | ✕ | Parent form ID | +| `helperText` | `string` | `null` | ✕\*\* | Custom helper text | +| `id` | `string` | — | ✔ | Group and label identification | +| `isDisabled` | `bool` | `false` | ✕ | If true, the group is disabled | +| `isFluid` | `bool` | `false` | ✕ | If true, the element spans to the full width of its parent | +| `isLabelHidden` | `bool` | `false` | ✕ | If true, label is hidden | +| `isRequired` | `bool` | `false` | ✕ | If true, the group is marked as required | +| `label` | `string` | `null` | ✕\* | Label text | +| `name` | `string` | `null` | ✕ | Group name | +| `UNSAFE_helperText` | `string` | `null` | ✕\*\* | Unescaped custom helper text (allows HTML) | +| `UNSAFE_label` | `string` | `null` | ✕\* | Unescaped label text (allows HTML) | +| `UNSAFE_validationText` | [`string` \| `string[]`] | `null` | ✕\*\* | Unescaped validation text (allows HTML) | +| `validationState` | [Validation dictionary][dictionary-validation] | `null` | ✕ | Type of validation state | +| `validationText` | [`string` \| `string[]`] | `null` | ✕\*\* | Validation text | (\*) To keep the component accessible, a label is always required. You can use the `label` for simple text or `UNSAFE_label` for HTML content. (\*\*) Props with and without `UNSAFE_` prefix are mutually exclusive.