From 58912789738176fdd4ea5679e9d12c89b5dd52a0 Mon Sep 17 00:00:00 2001 From: Paul Stanton Date: Fri, 16 Aug 2024 08:37:37 +0100 Subject: [PATCH 1/2] Add product support detail to documentation --- docs/docs/components/badge.mdx | 5 + docs/docs/components/block-list.mdx | 5 + docs/docs/components/breadcrumb.mdx | 5 + docs/docs/components/button-group.mdx | 5 + docs/docs/components/button.mdx | 21 +- docs/docs/components/card.mdx | 5 + docs/docs/components/datatable.mdx | 5 + docs/docs/components/dropdown-button.mdx | 5 + docs/docs/components/dropzone.mdx | 5 + docs/docs/components/flash-message.mdx | 5 + docs/docs/components/icon.mdx | 5 + docs/docs/components/label.mdx | 20 +- docs/docs/components/link-list.mdx | 7 +- docs/docs/components/link.mdx | 5 + docs/docs/components/list.mdx | 5 + docs/docs/components/loading-spinner.mdx | 5 + docs/docs/components/media.mdx | 5 + docs/docs/components/metadata.mdx | 5 + docs/docs/components/modal.mdx | 5 + docs/docs/components/pagination.mdx | 5 + docs/docs/components/panel.mdx | 5 + docs/docs/components/progress-bar.mdx | 17 +- docs/docs/components/progress-list.mdx | 5 + docs/docs/components/remove-button.mdx | 5 + docs/docs/components/status.mdx | 5 + docs/docs/components/table.mdx | 5 + docs/docs/components/tooltips.mdx | 5 + docs/docs/forms/button-group.mdx | 5 + docs/docs/forms/checkbox.mdx | 11 +- docs/docs/forms/choice.mdx | 5 + docs/docs/forms/color.mdx | 5 + docs/docs/forms/compound.mdx | 5 + docs/docs/forms/content.mdx | 5 + docs/docs/forms/creating-a-form.mdx | 5 + docs/docs/forms/date.mdx | 5 + docs/docs/forms/error-summary.mdx | 5 + docs/docs/forms/fieldset.mdx | 5 + docs/docs/forms/file.mdx | 5 + docs/docs/forms/hidden.mdx | 5 + docs/docs/forms/password.mdx | 5 + docs/docs/forms/radio.mdx | 3 +- docs/docs/forms/range.mdx | 5 + docs/docs/forms/repeater.mdx | 6 + docs/docs/forms/select.mdx | 5 + docs/docs/forms/select2.mdx | 5 + docs/docs/forms/text.mdx | 5 + docs/docs/forms/textarea.mdx | 5 + docs/docs/forms/time.mdx | 6 + docs/docs/forms/toggle-switch.mdx | 99 +- docs/docs/guides/colour-and-state.mdx | 471 +- docs/docs/guides/helpers.mdx | 345 +- docs/docs/patterns/actionsbar.mdx | 5 + docs/docs/patterns/common-form.mdx | 5 + docs/docs/patterns/common-list.mdx | 5 + docs/docs/patterns/disabled-ui.mdx | 6 + docs/docs/patterns/filter-bar.mdx | 5 + docs/docs/patterns/integrations.mdx | 38 +- docs/docs/patterns/masterswitch.mdx | 5 + docs/docs/patterns/no-results.mdx | 5 + docs/docs/patterns/piano.mdx | 10 + docs/docs/patterns/rules.mdx | 5 + docs/docs/patterns/table-detail.mdx | 5 + docs/docusaurus.config.js | 15 +- docs/package-lock.json | 19972 ++++++++++++++------- docs/package.json | 20 +- 65 files changed, 14111 insertions(+), 7196 deletions(-) diff --git a/docs/docs/components/badge.mdx b/docs/docs/components/badge.mdx index 4f1c96f838..43e7632214 100644 --- a/docs/docs/components/badge.mdx +++ b/docs/docs/components/badge.mdx @@ -2,6 +2,11 @@ id: badge title: Badge sidebar_label: Badge +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/block-list.mdx b/docs/docs/components/block-list.mdx index 9f1a43572b..a0d735365d 100644 --- a/docs/docs/components/block-list.mdx +++ b/docs/docs/components/block-list.mdx @@ -2,6 +2,11 @@ id: block-list title: Block List sidebar_label: Block List +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/breadcrumb.mdx b/docs/docs/components/breadcrumb.mdx index b3e2e0af45..93d37f8ee9 100644 --- a/docs/docs/components/breadcrumb.mdx +++ b/docs/docs/components/breadcrumb.mdx @@ -2,6 +2,11 @@ id: breadcrumb title: Breadcrumb sidebar_label: Breadcrumb +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/button-group.mdx b/docs/docs/components/button-group.mdx index 737597d715..987e437b94 100644 --- a/docs/docs/components/button-group.mdx +++ b/docs/docs/components/button-group.mdx @@ -2,6 +2,11 @@ id: button-group title: Button group sidebar_label: Button group +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/button.mdx b/docs/docs/components/button.mdx index ee75514410..8dc3b377ad 100644 --- a/docs/docs/components/button.mdx +++ b/docs/docs/components/button.mdx @@ -2,6 +2,11 @@ id: button title: Button sidebar_label: Button +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; @@ -77,15 +82,17 @@ Other recommendations for labelling your buttons include:
-
- -
-
Do use title case
-
- +
-
Don’t use sentence case or all caps
+
Do use title case
+
+
+ +
+
Don’t use sentence case or all caps
+
+
diff --git a/docs/docs/components/card.mdx b/docs/docs/components/card.mdx index 0c1e94423f..bfa75fd32d 100644 --- a/docs/docs/components/card.mdx +++ b/docs/docs/components/card.mdx @@ -2,6 +2,11 @@ id: card title: Card sidebar_label: Card +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/datatable.mdx b/docs/docs/components/datatable.mdx index ce0a0e0bb3..dd33a4a3e4 100644 --- a/docs/docs/components/datatable.mdx +++ b/docs/docs/components/datatable.mdx @@ -2,6 +2,11 @@ id: datatable title: Datatable sidebar_label: Datatable +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/dropdown-button.mdx b/docs/docs/components/dropdown-button.mdx index 5702941183..8c7f4c3eba 100644 --- a/docs/docs/components/dropdown-button.mdx +++ b/docs/docs/components/dropdown-button.mdx @@ -2,6 +2,11 @@ id: dropdown-button title: Dropdown button sidebar_label: Dropdown button +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/dropzone.mdx b/docs/docs/components/dropzone.mdx index b51fb84c69..3180269785 100644 --- a/docs/docs/components/dropzone.mdx +++ b/docs/docs/components/dropzone.mdx @@ -2,6 +2,11 @@ id: dropzone title: Dropzone sidebar_label: Dropzone +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/flash-message.mdx b/docs/docs/components/flash-message.mdx index af6fa1dd3b..762e9f6f30 100644 --- a/docs/docs/components/flash-message.mdx +++ b/docs/docs/components/flash-message.mdx @@ -2,6 +2,11 @@ id: flash-message title: Flash Message sidebar_label: Flash message +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/icon.mdx b/docs/docs/components/icon.mdx index d6ac1d1ee0..1ff070fe60 100644 --- a/docs/docs/components/icon.mdx +++ b/docs/docs/components/icon.mdx @@ -2,6 +2,11 @@ id: icon title: Icon sidebar_label: Icon +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/label.mdx b/docs/docs/components/label.mdx index d3a73b91c3..5b487807ab 100644 --- a/docs/docs/components/label.mdx +++ b/docs/docs/components/label.mdx @@ -2,17 +2,20 @@ id: label title: Label sidebar_label: Label +products: + supported: + - Central CMS + - Central Forms + - Connect --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - Provide extra contextual meaning to things, like stateful information.
New
+ ## Basic usage
-
- online offline +
+ online offline +
+
Do use a descriptive text label
-
Do use a descriptive text label
+
online online
-
Don’t rely on colour to convey meaning
+
Don’t rely on colour to convey meaning
+
## Linked labels diff --git a/docs/docs/components/link-list.mdx b/docs/docs/components/link-list.mdx index 5d5d5463aa..d68d09c0db 100644 --- a/docs/docs/components/link-list.mdx +++ b/docs/docs/components/link-list.mdx @@ -2,6 +2,11 @@ id: link-list title: Link List sidebar_label: Link list +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; @@ -69,7 +74,7 @@ You can configure this helper using the common helper options, the following opt | Option | Type | Description | | ------ | ---- | ----------- | | active_item | int | The index of the active item, will have the `is-active` class applied | -| items | hash | A hash of links formatted by `{ 'label': 'href' } | +| items | hash | A hash of links formatted by `{ 'label': 'href' }` | | type | string | Markup scheme to use: `ul` (default), `ol`, `div` or `link` | ## Setting the active item diff --git a/docs/docs/components/link.mdx b/docs/docs/components/link.mdx index 8e0594a229..4971707354 100644 --- a/docs/docs/components/link.mdx +++ b/docs/docs/components/link.mdx @@ -2,6 +2,11 @@ id: link title: Link sidebar_label: Link +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/list.mdx b/docs/docs/components/list.mdx index f2b1f84e10..58fc59183a 100644 --- a/docs/docs/components/list.mdx +++ b/docs/docs/components/list.mdx @@ -2,6 +2,11 @@ id: list title: List sidebar_label: List +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/loading-spinner.mdx b/docs/docs/components/loading-spinner.mdx index 205d83c814..e03edda8e2 100644 --- a/docs/docs/components/loading-spinner.mdx +++ b/docs/docs/components/loading-spinner.mdx @@ -2,6 +2,11 @@ id: loading-spinner title: Loading spinner sidebar_label: Loading spinner +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/media.mdx b/docs/docs/components/media.mdx index 84e521de37..dea2578ab0 100644 --- a/docs/docs/components/media.mdx +++ b/docs/docs/components/media.mdx @@ -2,6 +2,11 @@ id: media title: Media sidebar_label: Media +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/metadata.mdx b/docs/docs/components/metadata.mdx index 1b5fa9904f..53576abe9d 100644 --- a/docs/docs/components/metadata.mdx +++ b/docs/docs/components/metadata.mdx @@ -2,6 +2,11 @@ id: metadata title: Metadata sidebar_label: Metadata +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/modal.mdx b/docs/docs/components/modal.mdx index de06d406fb..651ba073cf 100644 --- a/docs/docs/components/modal.mdx +++ b/docs/docs/components/modal.mdx @@ -2,6 +2,11 @@ id: modal title: Modal sidebar_label: Modal +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/pagination.mdx b/docs/docs/components/pagination.mdx index 579990355f..f5905ac749 100644 --- a/docs/docs/components/pagination.mdx +++ b/docs/docs/components/pagination.mdx @@ -2,6 +2,11 @@ id: pagination title: Pagination sidebar_label: Pagination +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/panel.mdx b/docs/docs/components/panel.mdx index 92a93f19f0..3a0be15ced 100644 --- a/docs/docs/components/panel.mdx +++ b/docs/docs/components/panel.mdx @@ -2,6 +2,11 @@ id: panel title: Panel sidebar_label: Panel +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/progress-bar.mdx b/docs/docs/components/progress-bar.mdx index ddff5070c4..084ae03654 100644 --- a/docs/docs/components/progress-bar.mdx +++ b/docs/docs/components/progress-bar.mdx @@ -2,6 +2,11 @@ id: progress-bar title: Progress Bar sidebar_label: Progress Bar +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; @@ -270,16 +275,8 @@ Use the common state variation classes to help communicate progress, or lack of
-
75% Upload failed -
+
75% Upload failed
diff --git a/docs/docs/components/progress-list.mdx b/docs/docs/components/progress-list.mdx index 7331ff8008..c521bd2d84 100644 --- a/docs/docs/components/progress-list.mdx +++ b/docs/docs/components/progress-list.mdx @@ -2,6 +2,11 @@ id: progress-list title: Progress List sidebar_label: Progress List +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/remove-button.mdx b/docs/docs/components/remove-button.mdx index c88e886863..a67a3ed950 100644 --- a/docs/docs/components/remove-button.mdx +++ b/docs/docs/components/remove-button.mdx @@ -2,6 +2,11 @@ id: remove-button title: Remove Button sidebar_label: Remove Button +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/status.mdx b/docs/docs/components/status.mdx index 21ba45f5c0..864c7bad48 100644 --- a/docs/docs/components/status.mdx +++ b/docs/docs/components/status.mdx @@ -2,6 +2,11 @@ id: status title: Status sidebar_label: Status +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/table.mdx b/docs/docs/components/table.mdx index 0d5d0d666d..040cbd0656 100644 --- a/docs/docs/components/table.mdx +++ b/docs/docs/components/table.mdx @@ -2,6 +2,11 @@ id: table title: Table sidebar_label: Table +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/components/tooltips.mdx b/docs/docs/components/tooltips.mdx index 2660878c2c..7f60e01a03 100644 --- a/docs/docs/components/tooltips.mdx +++ b/docs/docs/components/tooltips.mdx @@ -2,6 +2,11 @@ id: tooltips title: Tooltips sidebar_label: Tooltips +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/button-group.mdx b/docs/docs/forms/button-group.mdx index b722a1fef1..8d05ac9772 100644 --- a/docs/docs/forms/button-group.mdx +++ b/docs/docs/forms/button-group.mdx @@ -2,6 +2,11 @@ id: button-group title: Button Group sidebar_label: Button Group +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/checkbox.mdx b/docs/docs/forms/checkbox.mdx index c34ec38998..637ffe2877 100644 --- a/docs/docs/forms/checkbox.mdx +++ b/docs/docs/forms/checkbox.mdx @@ -2,6 +2,11 @@ id: checkbox title: Checkbox sidebar_label: Checkbox +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; @@ -183,14 +188,12 @@ Using `form.checkbox_inline` will cause the checkbox input to not follow the nor
- +
- +
diff --git a/docs/docs/forms/choice.mdx b/docs/docs/forms/choice.mdx index 052fc6245f..c480046604 100644 --- a/docs/docs/forms/choice.mdx +++ b/docs/docs/forms/choice.mdx @@ -2,6 +2,11 @@ id: choice title: Choice sidebar_label: Choice +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/color.mdx b/docs/docs/forms/color.mdx index e9fdaed2f6..d02fc56c9f 100644 --- a/docs/docs/forms/color.mdx +++ b/docs/docs/forms/color.mdx @@ -2,6 +2,11 @@ id: color title: Color sidebar_label: Color +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/compound.mdx b/docs/docs/forms/compound.mdx index 5be5611ab4..fc9b7a7622 100644 --- a/docs/docs/forms/compound.mdx +++ b/docs/docs/forms/compound.mdx @@ -2,6 +2,11 @@ id: compound title: Compound sidebar_label: Compound +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/content.mdx b/docs/docs/forms/content.mdx index 5a9ba3c468..0ee56c30a0 100644 --- a/docs/docs/forms/content.mdx +++ b/docs/docs/forms/content.mdx @@ -2,6 +2,11 @@ id: content title: Content sidebar_label: Content +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/creating-a-form.mdx b/docs/docs/forms/creating-a-form.mdx index 2a3559fbf3..e4fbd45a30 100644 --- a/docs/docs/forms/creating-a-form.mdx +++ b/docs/docs/forms/creating-a-form.mdx @@ -3,6 +3,11 @@ id: creating-a-form title: Creating a form sidebar_label: Creating a form sidebar_position: 1 +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/date.mdx b/docs/docs/forms/date.mdx index 60c8f950f2..18624a41bf 100644 --- a/docs/docs/forms/date.mdx +++ b/docs/docs/forms/date.mdx @@ -2,6 +2,11 @@ id: date title: Date sidebar_label: Date +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/error-summary.mdx b/docs/docs/forms/error-summary.mdx index 36c30074a8..c3a181dd77 100644 --- a/docs/docs/forms/error-summary.mdx +++ b/docs/docs/forms/error-summary.mdx @@ -2,6 +2,11 @@ id: error-summary title: Error summary sidebar_label: Error summary +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/fieldset.mdx b/docs/docs/forms/fieldset.mdx index 889c76af23..f4fc6d16a8 100644 --- a/docs/docs/forms/fieldset.mdx +++ b/docs/docs/forms/fieldset.mdx @@ -2,6 +2,11 @@ id: fieldset title: Fieldset sidebar_label: Fieldset +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/file.mdx b/docs/docs/forms/file.mdx index ed460ecb71..c311b87870 100644 --- a/docs/docs/forms/file.mdx +++ b/docs/docs/forms/file.mdx @@ -2,6 +2,11 @@ id: file title: File sidebar_label: File +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/hidden.mdx b/docs/docs/forms/hidden.mdx index 69e36503bb..27fa6c6f54 100644 --- a/docs/docs/forms/hidden.mdx +++ b/docs/docs/forms/hidden.mdx @@ -2,6 +2,11 @@ id: hidden title: Hidden sidebar_label: Hidden +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/password.mdx b/docs/docs/forms/password.mdx index 253a036273..cb4515f68c 100644 --- a/docs/docs/forms/password.mdx +++ b/docs/docs/forms/password.mdx @@ -2,6 +2,11 @@ id: password title: Password sidebar_label: Password +products: + supported: + - Central CMS + - Central Forms + - Connect --- import Tabs from '@theme/Tabs'; diff --git a/docs/docs/forms/radio.mdx b/docs/docs/forms/radio.mdx index ba8165ae8d..4bf02c1529 100644 --- a/docs/docs/forms/radio.mdx +++ b/docs/docs/forms/radio.mdx @@ -80,8 +80,7 @@ The `form.radio_inline()` helper creates a `