diff --git a/packages/admin-ui/.storybook/main.ts b/packages/admin-ui/.storybook/main.ts index 1fdf253a3a9..8090aabb88e 100644 --- a/packages/admin-ui/.storybook/main.ts +++ b/packages/admin-ui/.storybook/main.ts @@ -11,7 +11,11 @@ function getAbsolutePath(value: string): any { } const config: StorybookConfig = { - stories: ["../docs/stories/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"], + stories: [ + "../docs/stories/**/*.mdx", + "../src/**/*.mdx", + "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)" + ], staticDirs: ["../assets"], addons: [ getAbsolutePath("@storybook/addon-a11y"), diff --git a/packages/admin-ui/.storybook/preview.ts b/packages/admin-ui/.storybook/preview.ts index 2aef0f83262..0dd3314486b 100644 --- a/packages/admin-ui/.storybook/preview.ts +++ b/packages/admin-ui/.storybook/preview.ts @@ -4,7 +4,8 @@ import "../src/theme.scss"; const preview: Preview = { parameters: { - layout: "centered" + layout: "centered", + docs: { toc: { headingSelector: "h2, h3, h4" } } } }; diff --git a/packages/admin-ui/assets/images/design-system-cover.png b/packages/admin-ui/assets/images/design-system-cover.png index bc18c218d27..6c2f960effc 100644 Binary files a/packages/admin-ui/assets/images/design-system-cover.png and b/packages/admin-ui/assets/images/design-system-cover.png differ diff --git a/packages/admin-ui/assets/images/storybook/alert/examples.png b/packages/admin-ui/assets/images/storybook/alert/examples.png new file mode 100644 index 00000000000..f7259812a34 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/alert/examples.png differ diff --git a/packages/admin-ui/assets/images/storybook/alert/floating-element.png b/packages/admin-ui/assets/images/storybook/alert/floating-element.png new file mode 100644 index 00000000000..8a8f3551cfc Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/alert/floating-element.png differ diff --git a/packages/admin-ui/assets/images/storybook/alert/full-width-banner.png b/packages/admin-ui/assets/images/storybook/alert/full-width-banner.png new file mode 100644 index 00000000000..ae41f487a9b Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/alert/full-width-banner.png differ diff --git a/packages/admin-ui/assets/images/storybook/alert/nested-element.png b/packages/admin-ui/assets/images/storybook/alert/nested-element.png new file mode 100644 index 00000000000..1fac4b70c96 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/alert/nested-element.png differ diff --git a/packages/admin-ui/assets/images/storybook/alert/options.png b/packages/admin-ui/assets/images/storybook/alert/options.png new file mode 100644 index 00000000000..d3d9198aabf Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/alert/options.png differ diff --git a/packages/admin-ui/assets/images/storybook/alert/style.png b/packages/admin-ui/assets/images/storybook/alert/style.png new file mode 100644 index 00000000000..10327613dba Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/alert/style.png differ diff --git a/packages/admin-ui/assets/images/storybook/alert/type.png b/packages/admin-ui/assets/images/storybook/alert/type.png new file mode 100644 index 00000000000..be7772ce88c Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/alert/type.png differ diff --git a/packages/admin-ui/assets/images/storybook/autocomplete/field-size.png b/packages/admin-ui/assets/images/storybook/autocomplete/field-size.png new file mode 100644 index 00000000000..eec94755717 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/autocomplete/field-size.png differ diff --git a/packages/admin-ui/assets/images/storybook/autocomplete/input-anatomy.png b/packages/admin-ui/assets/images/storybook/autocomplete/input-anatomy.png new file mode 100644 index 00000000000..3a208243219 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/autocomplete/input-anatomy.png differ diff --git a/packages/admin-ui/assets/images/storybook/autocomplete/label-anatomy.png b/packages/admin-ui/assets/images/storybook/autocomplete/label-anatomy.png new file mode 100644 index 00000000000..f329582e155 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/autocomplete/label-anatomy.png differ diff --git a/packages/admin-ui/assets/images/storybook/autocomplete/label-options.png b/packages/admin-ui/assets/images/storybook/autocomplete/label-options.png new file mode 100644 index 00000000000..aea0aad98a2 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/autocomplete/label-options.png differ diff --git a/packages/admin-ui/assets/images/storybook/autocomplete/label-properties.png b/packages/admin-ui/assets/images/storybook/autocomplete/label-properties.png new file mode 100644 index 00000000000..284f4feb077 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/autocomplete/label-properties.png differ diff --git a/packages/admin-ui/assets/images/storybook/autocomplete/option.png b/packages/admin-ui/assets/images/storybook/autocomplete/option.png new file mode 100644 index 00000000000..ac8361e84a5 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/autocomplete/option.png differ diff --git a/packages/admin-ui/assets/images/storybook/autocomplete/states-and-styles.png b/packages/admin-ui/assets/images/storybook/autocomplete/states-and-styles.png new file mode 100644 index 00000000000..db05b38ed52 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/autocomplete/states-and-styles.png differ diff --git a/packages/admin-ui/assets/images/storybook/autocomplete/style.png b/packages/admin-ui/assets/images/storybook/autocomplete/style.png new file mode 100644 index 00000000000..69a41e160d7 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/autocomplete/style.png differ diff --git a/packages/admin-ui/assets/images/storybook/autocomplete/used-in-forms.png b/packages/admin-ui/assets/images/storybook/autocomplete/used-in-forms.png new file mode 100644 index 00000000000..2a636abfe76 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/autocomplete/used-in-forms.png differ diff --git a/packages/admin-ui/assets/images/storybook/avatar/header.png b/packages/admin-ui/assets/images/storybook/avatar/header.png new file mode 100644 index 00000000000..9ea02477dd2 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/avatar/header.png differ diff --git a/packages/admin-ui/assets/images/storybook/avatar/size.png b/packages/admin-ui/assets/images/storybook/avatar/size.png new file mode 100644 index 00000000000..b22e36d712b Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/avatar/size.png differ diff --git a/packages/admin-ui/assets/images/storybook/avatar/style.png b/packages/admin-ui/assets/images/storybook/avatar/style.png new file mode 100644 index 00000000000..9ca1141f8f8 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/avatar/style.png differ diff --git a/packages/admin-ui/assets/images/storybook/avatar/table.png b/packages/admin-ui/assets/images/storybook/avatar/table.png new file mode 100644 index 00000000000..4af80bebda9 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/avatar/table.png differ diff --git a/packages/admin-ui/assets/images/storybook/avatar/type.png b/packages/admin-ui/assets/images/storybook/avatar/type.png new file mode 100644 index 00000000000..5faa684b4bb Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/avatar/type.png differ diff --git a/packages/admin-ui/assets/images/storybook/button/button-group.png b/packages/admin-ui/assets/images/storybook/button/button-group.png new file mode 100644 index 00000000000..3cf8fdaa38f Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/button/button-group.png differ diff --git a/packages/admin-ui/assets/images/storybook/button/contruction.png b/packages/admin-ui/assets/images/storybook/button/contruction.png new file mode 100644 index 00000000000..00d29cc0324 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/button/contruction.png differ diff --git a/packages/admin-ui/assets/images/storybook/button/icon-usage.png b/packages/admin-ui/assets/images/storybook/button/icon-usage.png new file mode 100644 index 00000000000..d991420489f Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/button/icon-usage.png differ diff --git a/packages/admin-ui/assets/images/storybook/button/options.png b/packages/admin-ui/assets/images/storybook/button/options.png new file mode 100644 index 00000000000..b520db65f96 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/button/options.png differ diff --git a/packages/admin-ui/assets/images/storybook/button/primary-button-usage.png b/packages/admin-ui/assets/images/storybook/button/primary-button-usage.png new file mode 100644 index 00000000000..cf2b92f4b3a Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/button/primary-button-usage.png differ diff --git a/packages/admin-ui/assets/images/storybook/button/size-icon-only.png b/packages/admin-ui/assets/images/storybook/button/size-icon-only.png new file mode 100644 index 00000000000..714f8f4ca12 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/button/size-icon-only.png differ diff --git a/packages/admin-ui/assets/images/storybook/button/size.png b/packages/admin-ui/assets/images/storybook/button/size.png new file mode 100644 index 00000000000..3bfa15b20d1 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/button/size.png differ diff --git a/packages/admin-ui/assets/images/storybook/button/states.png b/packages/admin-ui/assets/images/storybook/button/states.png new file mode 100644 index 00000000000..877d850d60c Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/button/states.png differ diff --git a/packages/admin-ui/assets/images/storybook/button/type.png b/packages/admin-ui/assets/images/storybook/button/type.png new file mode 100644 index 00000000000..98b1e908c00 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/button/type.png differ diff --git a/packages/admin-ui/assets/images/storybook/card/construction.png b/packages/admin-ui/assets/images/storybook/card/construction.png new file mode 100644 index 00000000000..2a4a78493fd Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/card/construction.png differ diff --git a/packages/admin-ui/assets/images/storybook/card/elevation.png b/packages/admin-ui/assets/images/storybook/card/elevation.png new file mode 100644 index 00000000000..e2b6ea8fe39 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/card/elevation.png differ diff --git a/packages/admin-ui/assets/images/storybook/card/padding.png b/packages/admin-ui/assets/images/storybook/card/padding.png new file mode 100644 index 00000000000..dd9e491decf Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/card/padding.png differ diff --git a/packages/admin-ui/assets/images/storybook/card/radius.png b/packages/admin-ui/assets/images/storybook/card/radius.png new file mode 100644 index 00000000000..c496289f232 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/card/radius.png differ diff --git a/packages/admin-ui/assets/images/storybook/card/stacked.png b/packages/admin-ui/assets/images/storybook/card/stacked.png new file mode 100644 index 00000000000..517b30569a0 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/card/stacked.png differ diff --git a/packages/admin-ui/assets/images/storybook/checkbox-group/general.png b/packages/admin-ui/assets/images/storybook/checkbox-group/general.png new file mode 100644 index 00000000000..079df4de469 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/checkbox-group/general.png differ diff --git a/packages/admin-ui/assets/images/storybook/checkbox/checkbox-input-options.png b/packages/admin-ui/assets/images/storybook/checkbox/checkbox-input-options.png new file mode 100644 index 00000000000..90fdfa923cf Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/checkbox/checkbox-input-options.png differ diff --git a/packages/admin-ui/assets/images/storybook/checkbox/general.png b/packages/admin-ui/assets/images/storybook/checkbox/general.png new file mode 100644 index 00000000000..079df4de469 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/checkbox/general.png differ diff --git a/packages/admin-ui/assets/images/storybook/checkbox/states.png b/packages/admin-ui/assets/images/storybook/checkbox/states.png new file mode 100644 index 00000000000..c756f30b185 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/checkbox/states.png differ diff --git a/packages/admin-ui/assets/images/storybook/checkbox/text-overflow.png b/packages/admin-ui/assets/images/storybook/checkbox/text-overflow.png new file mode 100644 index 00000000000..16a43ce5d7e Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/checkbox/text-overflow.png differ diff --git a/packages/admin-ui/assets/images/storybook/circular-progress/background-overlay.png b/packages/admin-ui/assets/images/storybook/circular-progress/background-overlay.png new file mode 100644 index 00000000000..e1fe6d06ca9 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/circular-progress/background-overlay.png differ diff --git a/packages/admin-ui/assets/images/storybook/circular-progress/construction.png b/packages/admin-ui/assets/images/storybook/circular-progress/construction.png new file mode 100644 index 00000000000..f45ec1de2bb Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/circular-progress/construction.png differ diff --git a/packages/admin-ui/assets/images/storybook/circular-progress/size.png b/packages/admin-ui/assets/images/storybook/circular-progress/size.png new file mode 100644 index 00000000000..c53e4d9bfae Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/circular-progress/size.png differ diff --git a/packages/admin-ui/assets/images/storybook/circular-progress/style.png b/packages/admin-ui/assets/images/storybook/circular-progress/style.png new file mode 100644 index 00000000000..821e6dd1936 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/circular-progress/style.png differ diff --git a/packages/admin-ui/assets/images/storybook/circular-progress/type.png b/packages/admin-ui/assets/images/storybook/circular-progress/type.png new file mode 100644 index 00000000000..57eb1ea488c Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/circular-progress/type.png differ diff --git a/packages/admin-ui/assets/images/storybook/circular-progress/usage-1.png b/packages/admin-ui/assets/images/storybook/circular-progress/usage-1.png new file mode 100644 index 00000000000..cb474cfc5e8 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/circular-progress/usage-1.png differ diff --git a/packages/admin-ui/assets/images/storybook/circular-progress/usage-2.png b/packages/admin-ui/assets/images/storybook/circular-progress/usage-2.png new file mode 100644 index 00000000000..6e005db8116 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/circular-progress/usage-2.png differ diff --git a/packages/admin-ui/assets/images/storybook/dialog/anatomy.png b/packages/admin-ui/assets/images/storybook/dialog/anatomy.png new file mode 100644 index 00000000000..298fc189c50 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/dialog/anatomy.png differ diff --git a/packages/admin-ui/assets/images/storybook/dialog/overlay-and-positioning.png b/packages/admin-ui/assets/images/storybook/dialog/overlay-and-positioning.png new file mode 100644 index 00000000000..89e6a8d2f38 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/dialog/overlay-and-positioning.png differ diff --git a/packages/admin-ui/assets/images/storybook/dialog/usage.png b/packages/admin-ui/assets/images/storybook/dialog/usage.png new file mode 100644 index 00000000000..d19a2210d78 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/dialog/usage.png differ diff --git a/packages/admin-ui/assets/images/storybook/drawer/anatomy.png b/packages/admin-ui/assets/images/storybook/drawer/anatomy.png new file mode 100644 index 00000000000..8855503100e Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/drawer/anatomy.png differ diff --git a/packages/admin-ui/assets/images/storybook/drawer/dividers.png b/packages/admin-ui/assets/images/storybook/drawer/dividers.png new file mode 100644 index 00000000000..e295c4ef3fe Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/drawer/dividers.png differ diff --git a/packages/admin-ui/assets/images/storybook/drawer/header.png b/packages/admin-ui/assets/images/storybook/drawer/header.png new file mode 100644 index 00000000000..d117a0c1400 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/drawer/header.png differ diff --git a/packages/admin-ui/assets/images/storybook/drawer/positioning.png b/packages/admin-ui/assets/images/storybook/drawer/positioning.png new file mode 100644 index 00000000000..0f9c98f7e13 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/drawer/positioning.png differ diff --git a/packages/admin-ui/assets/images/storybook/grid/breakpoints.png b/packages/admin-ui/assets/images/storybook/grid/breakpoints.png new file mode 100644 index 00000000000..1e860281501 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/grid/breakpoints.png differ diff --git a/packages/admin-ui/assets/images/storybook/grid/column-offsets.png b/packages/admin-ui/assets/images/storybook/grid/column-offsets.png new file mode 100644 index 00000000000..773f38b9183 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/grid/column-offsets.png differ diff --git a/packages/admin-ui/assets/images/storybook/grid/column-spans.png b/packages/admin-ui/assets/images/storybook/grid/column-spans.png new file mode 100644 index 00000000000..4258b5baa7e Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/grid/column-spans.png differ diff --git a/packages/admin-ui/assets/images/storybook/grid/fixed-dashboard.png b/packages/admin-ui/assets/images/storybook/grid/fixed-dashboard.png new file mode 100644 index 00000000000..70f36c35855 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/grid/fixed-dashboard.png differ diff --git a/packages/admin-ui/assets/images/storybook/grid/fixed.png b/packages/admin-ui/assets/images/storybook/grid/fixed.png new file mode 100644 index 00000000000..73e8f87a762 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/grid/fixed.png differ diff --git a/packages/admin-ui/assets/images/storybook/grid/fluid-dashboard.png b/packages/admin-ui/assets/images/storybook/grid/fluid-dashboard.png new file mode 100644 index 00000000000..bcdc5cc93ee Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/grid/fluid-dashboard.png differ diff --git a/packages/admin-ui/assets/images/storybook/grid/fluid.png b/packages/admin-ui/assets/images/storybook/grid/fluid.png new file mode 100644 index 00000000000..eb92a242c11 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/grid/fluid.png differ diff --git a/packages/admin-ui/assets/images/storybook/grid/grid-gutter-size-comfortable.png b/packages/admin-ui/assets/images/storybook/grid/grid-gutter-size-comfortable.png new file mode 100644 index 00000000000..05552bd2bab Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/grid/grid-gutter-size-comfortable.png differ diff --git a/packages/admin-ui/assets/images/storybook/grid/grid-gutter-size-spacious.png b/packages/admin-ui/assets/images/storybook/grid/grid-gutter-size-spacious.png new file mode 100644 index 00000000000..7261808e45f Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/grid/grid-gutter-size-spacious.png differ diff --git a/packages/admin-ui/assets/images/storybook/input/anatomy.png b/packages/admin-ui/assets/images/storybook/input/anatomy.png new file mode 100644 index 00000000000..6f77adc3788 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/input/anatomy.png differ diff --git a/packages/admin-ui/assets/images/storybook/input/field-size.png b/packages/admin-ui/assets/images/storybook/input/field-size.png new file mode 100644 index 00000000000..07ba7e57706 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/input/field-size.png differ diff --git a/packages/admin-ui/assets/images/storybook/input/label-anatomy.png b/packages/admin-ui/assets/images/storybook/input/label-anatomy.png new file mode 100644 index 00000000000..d4a13499c95 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/input/label-anatomy.png differ diff --git a/packages/admin-ui/assets/images/storybook/input/label-options.png b/packages/admin-ui/assets/images/storybook/input/label-options.png new file mode 100644 index 00000000000..4b9ccfd09be Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/input/label-options.png differ diff --git a/packages/admin-ui/assets/images/storybook/input/label-properties.png b/packages/admin-ui/assets/images/storybook/input/label-properties.png new file mode 100644 index 00000000000..08f8dfaa87c Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/input/label-properties.png differ diff --git a/packages/admin-ui/assets/images/storybook/input/states-and-styles.png b/packages/admin-ui/assets/images/storybook/input/states-and-styles.png new file mode 100644 index 00000000000..c85e5318ac5 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/input/states-and-styles.png differ diff --git a/packages/admin-ui/assets/images/storybook/input/styles.png b/packages/admin-ui/assets/images/storybook/input/styles.png new file mode 100644 index 00000000000..b5273deb00a Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/input/styles.png differ diff --git a/packages/admin-ui/assets/images/storybook/input/used-in-forms.png b/packages/admin-ui/assets/images/storybook/input/used-in-forms.png new file mode 100644 index 00000000000..00a851b9eba Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/input/used-in-forms.png differ diff --git a/packages/admin-ui/assets/images/storybook/link/primary.png b/packages/admin-ui/assets/images/storybook/link/primary.png new file mode 100644 index 00000000000..7c0fc2dacf8 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/link/primary.png differ diff --git a/packages/admin-ui/assets/images/storybook/link/secondary.png b/packages/admin-ui/assets/images/storybook/link/secondary.png new file mode 100644 index 00000000000..45241e7ea0f Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/link/secondary.png differ diff --git a/packages/admin-ui/assets/images/storybook/link/sizing.png b/packages/admin-ui/assets/images/storybook/link/sizing.png new file mode 100644 index 00000000000..032c65e59b1 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/link/sizing.png differ diff --git a/packages/admin-ui/assets/images/storybook/link/states.png b/packages/admin-ui/assets/images/storybook/link/states.png new file mode 100644 index 00000000000..c4d7d6aa9cc Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/link/states.png differ diff --git a/packages/admin-ui/assets/images/storybook/link/usage.png b/packages/admin-ui/assets/images/storybook/link/usage.png new file mode 100644 index 00000000000..03331a3083b Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/link/usage.png differ diff --git a/packages/admin-ui/assets/images/storybook/radio-group/anatomy.png b/packages/admin-ui/assets/images/storybook/radio-group/anatomy.png new file mode 100644 index 00000000000..c41104ead42 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/radio-group/anatomy.png differ diff --git a/packages/admin-ui/assets/images/storybook/radio-group/options.png b/packages/admin-ui/assets/images/storybook/radio-group/options.png new file mode 100644 index 00000000000..dfa594fea5d Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/radio-group/options.png differ diff --git a/packages/admin-ui/assets/images/storybook/radio-group/states.png b/packages/admin-ui/assets/images/storybook/radio-group/states.png new file mode 100644 index 00000000000..275b8d4b9ea Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/radio-group/states.png differ diff --git a/packages/admin-ui/assets/images/storybook/radio-group/text-overflow.png b/packages/admin-ui/assets/images/storybook/radio-group/text-overflow.png new file mode 100644 index 00000000000..1c783dd9cba Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/radio-group/text-overflow.png differ diff --git a/packages/admin-ui/assets/images/storybook/select/anatomy.png b/packages/admin-ui/assets/images/storybook/select/anatomy.png new file mode 100644 index 00000000000..1021e08266a Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/select/anatomy.png differ diff --git a/packages/admin-ui/assets/images/storybook/select/label-anatomy.png b/packages/admin-ui/assets/images/storybook/select/label-anatomy.png new file mode 100644 index 00000000000..bd1777e07e4 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/select/label-anatomy.png differ diff --git a/packages/admin-ui/assets/images/storybook/select/label-options.png b/packages/admin-ui/assets/images/storybook/select/label-options.png new file mode 100644 index 00000000000..4872dd4fe14 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/select/label-options.png differ diff --git a/packages/admin-ui/assets/images/storybook/select/label-properties.png b/packages/admin-ui/assets/images/storybook/select/label-properties.png new file mode 100644 index 00000000000..a7d79d73329 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/select/label-properties.png differ diff --git a/packages/admin-ui/assets/images/storybook/select/options.png b/packages/admin-ui/assets/images/storybook/select/options.png new file mode 100644 index 00000000000..4752e02a33d Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/select/options.png differ diff --git a/packages/admin-ui/assets/images/storybook/select/states-and-styles.png b/packages/admin-ui/assets/images/storybook/select/states-and-styles.png new file mode 100644 index 00000000000..6d773452150 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/select/states-and-styles.png differ diff --git a/packages/admin-ui/assets/images/storybook/select/styles.png b/packages/admin-ui/assets/images/storybook/select/styles.png new file mode 100644 index 00000000000..56e7a701f32 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/select/styles.png differ diff --git a/packages/admin-ui/assets/images/storybook/select/used-in-forms.png b/packages/admin-ui/assets/images/storybook/select/used-in-forms.png new file mode 100644 index 00000000000..6c15662cc02 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/select/used-in-forms.png differ diff --git a/packages/admin-ui/assets/images/storybook/tabs/construction.png b/packages/admin-ui/assets/images/storybook/tabs/construction.png new file mode 100644 index 00000000000..c0ebe9a2d34 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/tabs/construction.png differ diff --git a/packages/admin-ui/assets/images/storybook/tabs/size-and-states.png b/packages/admin-ui/assets/images/storybook/tabs/size-and-states.png new file mode 100644 index 00000000000..dd5897d5b59 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/tabs/size-and-states.png differ diff --git a/packages/admin-ui/assets/images/storybook/tabs/tab-group.png b/packages/admin-ui/assets/images/storybook/tabs/tab-group.png new file mode 100644 index 00000000000..ddc54cd68bc Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/tabs/tab-group.png differ diff --git a/packages/admin-ui/assets/images/storybook/tabs/usage.png b/packages/admin-ui/assets/images/storybook/tabs/usage.png new file mode 100644 index 00000000000..faca6f0328e Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/tabs/usage.png differ diff --git a/packages/admin-ui/assets/images/storybook/tag/construction.png b/packages/admin-ui/assets/images/storybook/tag/construction.png new file mode 100644 index 00000000000..6d0e1d602de Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/tag/construction.png differ diff --git a/packages/admin-ui/assets/images/storybook/tag/states.png b/packages/admin-ui/assets/images/storybook/tag/states.png new file mode 100644 index 00000000000..eba452dceca Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/tag/states.png differ diff --git a/packages/admin-ui/assets/images/storybook/tag/style.png b/packages/admin-ui/assets/images/storybook/tag/style.png new file mode 100644 index 00000000000..29458b4fd85 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/tag/style.png differ diff --git a/packages/admin-ui/assets/images/storybook/tag/usage.png b/packages/admin-ui/assets/images/storybook/tag/usage.png new file mode 100644 index 00000000000..26c61187df0 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/tag/usage.png differ diff --git a/packages/admin-ui/assets/images/storybook/textarea/anatomy.png b/packages/admin-ui/assets/images/storybook/textarea/anatomy.png new file mode 100644 index 00000000000..a6252083dfb Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/textarea/anatomy.png differ diff --git a/packages/admin-ui/assets/images/storybook/textarea/field-size.png b/packages/admin-ui/assets/images/storybook/textarea/field-size.png new file mode 100644 index 00000000000..31b944f8175 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/textarea/field-size.png differ diff --git a/packages/admin-ui/assets/images/storybook/textarea/label-anatomy.png b/packages/admin-ui/assets/images/storybook/textarea/label-anatomy.png new file mode 100644 index 00000000000..5756e04df55 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/textarea/label-anatomy.png differ diff --git a/packages/admin-ui/assets/images/storybook/textarea/label-options.png b/packages/admin-ui/assets/images/storybook/textarea/label-options.png new file mode 100644 index 00000000000..272f3aa6d70 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/textarea/label-options.png differ diff --git a/packages/admin-ui/assets/images/storybook/textarea/label-properties.png b/packages/admin-ui/assets/images/storybook/textarea/label-properties.png new file mode 100644 index 00000000000..f583300c06c Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/textarea/label-properties.png differ diff --git a/packages/admin-ui/assets/images/storybook/textarea/states-and-styles.png b/packages/admin-ui/assets/images/storybook/textarea/states-and-styles.png new file mode 100644 index 00000000000..20a1a2761a0 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/textarea/states-and-styles.png differ diff --git a/packages/admin-ui/assets/images/storybook/textarea/styles.png b/packages/admin-ui/assets/images/storybook/textarea/styles.png new file mode 100644 index 00000000000..9a0c28871e0 Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/textarea/styles.png differ diff --git a/packages/admin-ui/assets/images/storybook/textarea/used-in-forms.png b/packages/admin-ui/assets/images/storybook/textarea/used-in-forms.png new file mode 100644 index 00000000000..acce6fcb69a Binary files /dev/null and b/packages/admin-ui/assets/images/storybook/textarea/used-in-forms.png differ diff --git a/packages/admin-ui/docs/stories/00-getting-started/welcome.mdx b/packages/admin-ui/docs/stories/00-getting-started/welcome.mdx index 3d94dab76cc..94291724e96 100644 --- a/packages/admin-ui/docs/stories/00-getting-started/welcome.mdx +++ b/packages/admin-ui/docs/stories/00-getting-started/welcome.mdx @@ -2,6 +2,14 @@ import { Meta } from '@storybook/blocks'; + + ![Webiny Design System cover](/images/design-system-cover.png) # Welcome diff --git a/packages/admin-ui/src/Alert/Alert.mdx b/packages/admin-ui/src/Alert/Alert.mdx new file mode 100644 index 00000000000..35afeb58046 --- /dev/null +++ b/packages/admin-ui/src/Alert/Alert.mdx @@ -0,0 +1,43 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as AlertStories from './Alert.stories'; + + + +# Alert + +Alert component is an element used to display important messages to users, such as notifications, warnings, errors, or success confirmations. Its purpose is to bring attention to users by providing feedback on user actions or system states, ensuring users are informed about critical information. Alerts are relevant for guiding user behaviour, preventing errors, and improving user experience by delivering timely feedback and enhancing teh communication between the user and the system. + + + +## Usage + +``` +import { Alert } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Options +Options + +### Style +Style + +### Type +Type + +### Examples +Examples + +## Usage + +### Full width banner +Full width banner + + +### Floating element +Floating element + +### Nested element +Nested element \ No newline at end of file diff --git a/packages/admin-ui/src/Alert/Alert.stories.tsx b/packages/admin-ui/src/Alert/Alert.stories.tsx index f2a293cc917..a39cca1ec54 100644 --- a/packages/admin-ui/src/Alert/Alert.stories.tsx +++ b/packages/admin-ui/src/Alert/Alert.stories.tsx @@ -5,7 +5,6 @@ import React from "react"; const meta: Meta = { title: "Components/Alert", component: Alert, - tags: ["autodocs"], argTypes: {}, decorators: [ Story => ( diff --git a/packages/admin-ui/src/AutoComplete/AutoComplete.mdx b/packages/admin-ui/src/AutoComplete/AutoComplete.mdx new file mode 100644 index 00000000000..788876ff911 --- /dev/null +++ b/packages/admin-ui/src/AutoComplete/AutoComplete.mdx @@ -0,0 +1,42 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as AutoComplete from './AutoComplete.stories'; + + + +# AutoComplete + +The Input component is a user interface element that allows users to enter textual, numerical or any other kind of data into system database. It is essential for collecting user information, enabling interaction, and driving application functionality. As the user input is one of the most crucial aspects of using a system, we are ensuring that all our input options have necessary mechanism to make the data input as frictionless as possible. + + + +## Usage + +``` +import { AutoComplete } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Input Anatomy +Input Anatomy + +### Style +Style + +### Option +Option + +### States and Styles +States and Styles + +### Label Anatomy +Label Anatomy + +### Label Properties +Label Properties + +## Usage + +### Used in forms +Used in forms \ No newline at end of file diff --git a/packages/admin-ui/src/AutoComplete/AutoComplete.stories.tsx b/packages/admin-ui/src/AutoComplete/AutoComplete.stories.tsx index b8a2ae70fcd..f44ab6b0d24 100644 --- a/packages/admin-ui/src/AutoComplete/AutoComplete.stories.tsx +++ b/packages/admin-ui/src/AutoComplete/AutoComplete.stories.tsx @@ -5,7 +5,6 @@ import { AutoComplete } from "./AutoComplete"; const meta: Meta = { title: "Components/Form/AutoComplete", component: AutoComplete, - tags: ["autodocs"], argTypes: { onValueChange: { action: "onValueChange" }, onOpenChange: { action: "onOpenChange" } diff --git a/packages/admin-ui/src/Avatar/Avatar.mdx b/packages/admin-ui/src/Avatar/Avatar.mdx new file mode 100644 index 00000000000..767a3e1bd4d --- /dev/null +++ b/packages/admin-ui/src/Avatar/Avatar.mdx @@ -0,0 +1,36 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as AvatarStories from './Avatar.stories'; + + + +# Avatar + +The Avatar component is a UI element that displays a user’s profile image, initials, or icon, often used to represent a person or entity in an application. Its purpose is to personalize the user experience, making interactions feel more engaging and identifiable and improve recognition and user interaction. + + + +## Usage + +``` +import { Avatar } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Size +Size + +### Type +Type + +### Style +Style + +## Usage + +### Header +Header + +### Table +Table diff --git a/packages/admin-ui/src/Avatar/Avatar.stories.tsx b/packages/admin-ui/src/Avatar/Avatar.stories.tsx index 18683c652a6..383f13b69b2 100644 --- a/packages/admin-ui/src/Avatar/Avatar.stories.tsx +++ b/packages/admin-ui/src/Avatar/Avatar.stories.tsx @@ -6,7 +6,6 @@ import { Avatar } from "./Avatar"; const meta: Meta = { title: "Components/Avatar", component: Avatar, - tags: ["autodocs"], argTypes: { size: { control: "select", diff --git a/packages/admin-ui/src/Button/Button.mdx b/packages/admin-ui/src/Button/Button.mdx new file mode 100644 index 00000000000..8063c8be8b2 --- /dev/null +++ b/packages/admin-ui/src/Button/Button.mdx @@ -0,0 +1,58 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as ButtonStories from './Button.stories'; + + + +# Button + +The Button component is a key UI element that enables users to trigger actions or events, such as submitting forms, navigating pages, or interacting with system functionality. Its purpose is to provide a clear, intuitive way for users to interact with an system. Buttons are relevant in virtually all interfaces, ensuring user engagement by offering a simple, recognizable mechanism for executing commands. They are essential for usability, guiding user behavior and driving application workflows. + + + +## Usage + +``` +import { Button } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Construction +Construction + +### Options +Options + +### Type +Type + +### Size +Regular buttons come in four different sizes: small, medium, large, and xl. The medium size is the default and most frequently used option. Use the other sizes sparingly; they should be used to create a hierarchy of importance within the page. + +Size + +Icon-only button come in six different sizes to accommodate for various component needs. + +Size - Icon Only + + +### States +States + +## Usage + +### Icon Usage +An icon should only be used in a button when it's benefitial and when it has a meaningful association with the label. + +Icon Usage + +### Use primary buttons sparingly +Use primary buttons as the desired action for users. Competing primary buttons may leave the user unsure of next steps in their user journey. As a rule of thumb limit primary buttons to 1 in contained UIs and 3 in full page UIs. + +Primary Button Usage + +### Button Group +When used in groups, buttons should support only maximum of two type variants, with an exception of third variant being ghost extension button (eg. ellipsis). Avoid using random type and icon options within the button groups. Avoid using different sizes within the same group. + +Button Group diff --git a/packages/admin-ui/src/Button/Button.stories.tsx b/packages/admin-ui/src/Button/Button.stories.tsx index 55e5bae5a9c..fb752d98a0e 100644 --- a/packages/admin-ui/src/Button/Button.stories.tsx +++ b/packages/admin-ui/src/Button/Button.stories.tsx @@ -8,7 +8,6 @@ const meta: Meta = { title: "Components/Button", component: Button, // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/writing-docs/autodocs - tags: ["autodocs"], // More on argTypes: https://storybook.js.org/docs/api/argtypes argTypes: { variant: { diff --git a/packages/admin-ui/src/Card/Card.mdx b/packages/admin-ui/src/Card/Card.mdx new file mode 100644 index 00000000000..cf23f3bc444 --- /dev/null +++ b/packages/admin-ui/src/Card/Card.mdx @@ -0,0 +1,46 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as CardStories from './Card.stories'; + + + +# Cards + +A Card component in design systems is a versatile UI element used to encapsulate content and actions about a single subject. It serves as a modular container that can include images, text, links, buttons, and other interactive elements. Cards are designed to present information in a concise and organized manner, making it easier for users to scan and interact with multiple pieces of content. + + + +## Usage + +``` +import { Card } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Construction +Depending on the content type and card usage, there are several elevation options available. + +Construction + +### Elevation + +Elevation + +### Radius +Depending on the content type and card usage, there are three basic paddings options to consider. Border radius can vary from 4px - 12px + +Radius + +### Padding + +Padding + +## Usage + +### Stacked + +Stacked + + + diff --git a/packages/admin-ui/src/Card/Card.stories.tsx b/packages/admin-ui/src/Card/Card.stories.tsx index b984e047b8b..a6172353e03 100644 --- a/packages/admin-ui/src/Card/Card.stories.tsx +++ b/packages/admin-ui/src/Card/Card.stories.tsx @@ -8,7 +8,6 @@ import { Icon } from "~/Icon"; const meta: Meta = { title: "Components/Card", component: Card, - tags: ["autodocs"], decorators: [ Story => (
diff --git a/packages/admin-ui/src/Checkbox/Checkbox.mdx b/packages/admin-ui/src/Checkbox/Checkbox.mdx new file mode 100644 index 00000000000..274df2dfffb --- /dev/null +++ b/packages/admin-ui/src/Checkbox/Checkbox.mdx @@ -0,0 +1,42 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as CheckboxStories from './Checkbox.stories'; + + + +# Checkbox + +Checkboxes allow users to select multiple items from a list of individual items, or to mark one individual item as selected. A checkbox group is a grouping of checkboxes that are related to each other. + + + +## Usage + +``` +import { Checkbox } from '@webiny/admin-ui'; +``` + +## Anatomy + +### General +Checkbox input enable users to select a single or multiple items from a list of offered choices. A chackbox input group organizes related checkbox input options together for better clarity and functionality. + +General + +### Checkbox input options +Checkbox inputs can exist in two different states: Selected and Not Selected. + +Checkbox input options + +### States +States + +## Usage + +### Text overflow +When the checkbox text content is too long for the horizontal space available, the content should wrap to form another line aligning the text and checkbox on top. + +Text overflow + + + diff --git a/packages/admin-ui/src/Checkbox/Checkbox.stories.tsx b/packages/admin-ui/src/Checkbox/Checkbox.stories.tsx index 318beaf05ed..5d3d3aa4701 100644 --- a/packages/admin-ui/src/Checkbox/Checkbox.stories.tsx +++ b/packages/admin-ui/src/Checkbox/Checkbox.stories.tsx @@ -5,7 +5,6 @@ import { Checkbox } from "~/Checkbox"; const meta: Meta = { title: "Components/Form/Checkbox", component: Checkbox, - tags: ["autodocs"], parameters: { layout: "padded" }, diff --git a/packages/admin-ui/src/CheckboxGroup/CheckboxGroup.mdx b/packages/admin-ui/src/CheckboxGroup/CheckboxGroup.mdx new file mode 100644 index 00000000000..3c533806465 --- /dev/null +++ b/packages/admin-ui/src/CheckboxGroup/CheckboxGroup.mdx @@ -0,0 +1,28 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as CheckboxGroupStories from './CheckboxGroup.stories'; + + + +# Checkbox Group + +Checkboxes allow users to select multiple items from a list of individual items, or to mark one individual item as selected. A checkbox group is a grouping of checkboxes that are related to each other. + + + +## Usage + +``` +import { CheckboxGroup } from '@webiny/admin-ui'; +``` + +## Anatomy + +### General +Checkbox input enable users to select a single or multiple items from a list of offered choices. A chackbox input group organizes related checkbox input options together for better clarity and functionality. + +General + + + + diff --git a/packages/admin-ui/src/CheckboxGroup/CheckboxGroup.stories.tsx b/packages/admin-ui/src/CheckboxGroup/CheckboxGroup.stories.tsx index 3e9c7b22826..9cd8dad5c31 100644 --- a/packages/admin-ui/src/CheckboxGroup/CheckboxGroup.stories.tsx +++ b/packages/admin-ui/src/CheckboxGroup/CheckboxGroup.stories.tsx @@ -5,7 +5,6 @@ import { CheckboxGroup } from "~/CheckboxGroup"; const meta: Meta = { title: "Components/Form/CheckboxGroup", component: CheckboxGroup, - tags: ["autodocs"], parameters: { layout: "padded" }, diff --git a/packages/admin-ui/src/Dialog/Dialog.mdx b/packages/admin-ui/src/Dialog/Dialog.mdx new file mode 100644 index 00000000000..d8a5b1be2aa --- /dev/null +++ b/packages/admin-ui/src/Dialog/Dialog.mdx @@ -0,0 +1,28 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as DialogStories from './Dialog.stories'; + + + +# Dialog + +A Dialog is used to display content or actions in a focused, overlay window that requires user interaction before returning to the main interface. Modals are valuable for drawing attention to important information, capturing user input, and streamlining workflows without navigating away from the current page. + + + +## Usage + +``` +import { Dialog } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Dialog Construction +Anatomy + +### Overlay and Positioning +Dialog Overlay and Positioning + +## Usage +Usage diff --git a/packages/admin-ui/src/Dialog/Dialog.stories.tsx b/packages/admin-ui/src/Dialog/Dialog.stories.tsx index 7ae97403384..5b89b95ca5c 100644 --- a/packages/admin-ui/src/Dialog/Dialog.stories.tsx +++ b/packages/admin-ui/src/Dialog/Dialog.stories.tsx @@ -13,7 +13,6 @@ import { Tabs } from "~/Tabs"; const meta: Meta = { title: "Components/Dialog", component: Dialog, - tags: ["autodocs"], argTypes: {} }; diff --git a/packages/admin-ui/src/Drawer/Drawer.mdx b/packages/admin-ui/src/Drawer/Drawer.mdx new file mode 100644 index 00000000000..73120e687a4 --- /dev/null +++ b/packages/admin-ui/src/Drawer/Drawer.mdx @@ -0,0 +1,36 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as DrawerStories from './Drawer.stories'; + + + +# Drawer + +A Drawer is a UI component used to display additional or expanded content options without leaving the current view. The drawer should slide in from left or right side of the screen, overlaying the main content. + + + +## Usage + +``` +import { Drawer } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Construction +Anatomy + +### Header + +Header needs to support multiple formation options that can be independently enabled or disabled. + +Header + +## Usage + +### Positioning + +Drawers should slide in from either the left or right side, depending on the context. The drawer should overlay the content, and clicking outside of it should close it. There also needs to be an option to use an overlay behind the drawer. + +Positioning diff --git a/packages/admin-ui/src/Drawer/Drawer.stories.tsx b/packages/admin-ui/src/Drawer/Drawer.stories.tsx index 6219b2e01f1..e27534a4beb 100644 --- a/packages/admin-ui/src/Drawer/Drawer.stories.tsx +++ b/packages/admin-ui/src/Drawer/Drawer.stories.tsx @@ -9,7 +9,6 @@ import { ReactComponent as DoorbellIcon } from "@material-design-icons/svg/outli const meta: Meta = { title: "Components/Drawer", component: Drawer, - tags: ["autodocs"], argTypes: {} }; diff --git a/packages/admin-ui/src/Grid/Grid.mdx b/packages/admin-ui/src/Grid/Grid.mdx new file mode 100644 index 00000000000..5a3eedb4a46 --- /dev/null +++ b/packages/admin-ui/src/Grid/Grid.mdx @@ -0,0 +1,62 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as GridStories from './Grid.stories'; + + + +# Grid + +Grid structures layouts with clarity and consistency, organizing content, maintaining alignment, and ensuring a seamless experience across screen sizes. Settings include column configuration, gutter spacing, and responsive behavior. + + + +## Usage + +``` +import { Grid } from '@webiny/admin-ui'; +``` + +## Horizontal Grids +The grids within the Webiny Design System behave as fixed and fluid elements relevant to the elements on the page. + +### Grid types +Webiny Design System use two types of grids: fluid and fixed. Both grid types use breakpoints to determine whether the layout needs to change between viewport sizes. + +### Fluid +The fluid grid stretches across an area to fill all available space within the screen, part of the screen or within the specific element if needed. + +Fluid + +Fluid Dashboard + + +### Fixed +The fixed grid applies the ideal maximum width to page or page element. + +Fixed + +Fixed Dashboard + +## Grid Gutter Sizes +We considered using two main sizes for grid application, to be used dependent on the content type. + +### Comfortable (Default) +Comfortable (Default) + +### Spacious +Spacious + +## Breakpoints +A breakpoint marks the point where a website’s layout adapts to provide the best user experience. In responsive design, the range of each breakpoint defines the ideal number of columns for a given viewport size, along with the suggested widths for margins and gutters. + +Breakpoints + +## Column Spans +Content should be distributed across a minimum of 3 columns, with the option to extend up to 12 columns. To achieve a range of layouts, vary the number of columns used, allowing for flexible design across different breakpoints. + +Column Spans + +## Column Offsets +Content isn't required to span the full 12 columns. It can cover a smaller number of columns, creating a layout where the content is centered within a 12-column grid. + +Column Offsets \ No newline at end of file diff --git a/packages/admin-ui/src/Grid/Grid.stories.tsx b/packages/admin-ui/src/Grid/Grid.stories.tsx index 7b18e15e864..046a9548201 100644 --- a/packages/admin-ui/src/Grid/Grid.stories.tsx +++ b/packages/admin-ui/src/Grid/Grid.stories.tsx @@ -6,8 +6,7 @@ import { StyledColumn } from "./stories/StyledColumn"; const meta: Meta = { title: "Components/Grid", - component: Grid, - tags: ["autodocs"] + component: Grid }; export default meta; diff --git a/packages/admin-ui/src/Input/Input.mdx b/packages/admin-ui/src/Input/Input.mdx new file mode 100644 index 00000000000..a8734ffbe58 --- /dev/null +++ b/packages/admin-ui/src/Input/Input.mdx @@ -0,0 +1,45 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as InputStories from './Input.stories'; + + + +# Text Input + +Text input field component enable users to input, edit, or search text in digital interfaces. It facilitates data collection, user interaction, and communication. Text fields ensure clarity, consistency, and accessibility across applications, supporting tasks like form completion, authentication, and search queries in an intuitive and efficient manner. + + + +## Usage + +``` +import { Input } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Input Anatomy +Input Anatomy + +### Styles +Styles + +### Field Size +Field Size + +### States and Styles +States and Styles + +### Label Anatomy +Label Anatomy + +### Label Properties +Label Properties + +### Label Options +Label Options + +## Usage + +### Used in forms +Used in forms diff --git a/packages/admin-ui/src/Input/Input.stories.tsx b/packages/admin-ui/src/Input/Input.stories.tsx index 35d063f1010..526824da609 100644 --- a/packages/admin-ui/src/Input/Input.stories.tsx +++ b/packages/admin-ui/src/Input/Input.stories.tsx @@ -6,7 +6,6 @@ import { Input } from "~/Input"; const meta: Meta = { title: "Components/Form/Input", component: Input, - tags: ["autodocs"], argTypes: { onChange: { action: "onChange" }, type: { diff --git a/packages/admin-ui/src/Link/Link.mdx b/packages/admin-ui/src/Link/Link.mdx new file mode 100644 index 00000000000..99b65d12057 --- /dev/null +++ b/packages/admin-ui/src/Link/Link.mdx @@ -0,0 +1,35 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as LinkStories from './Link.stories'; + + + +# Link + +The purpose of the Link component is to enable seamless navigation by connecting users to other pages, sections, or resources. It provides a consistent, accessible, and visually recognizable way to interact with content, ensuring clarity and usability while maintaining the design system's cohesion. + + + +## Usage + +``` +import { Link } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Primary +Primary + +### Secondary +Secondary + +### Sizing +Links inherit font styles of surrounding text. +Sizing + +### State +State + +## Usage +State \ No newline at end of file diff --git a/packages/admin-ui/src/Link/Link.stories.tsx b/packages/admin-ui/src/Link/Link.stories.tsx index 86bec7d8e89..9a596ad9af2 100644 --- a/packages/admin-ui/src/Link/Link.stories.tsx +++ b/packages/admin-ui/src/Link/Link.stories.tsx @@ -7,7 +7,6 @@ import { Text } from "~/Text"; const meta: Meta = { title: "Components/Link", component: Link, - tags: ["autodocs"], decorators: [ (Story: React.ComponentType) => ( diff --git a/packages/admin-ui/src/Progress/CircularProgress.mdx b/packages/admin-ui/src/Progress/CircularProgress.mdx new file mode 100644 index 00000000000..f92c1791cff --- /dev/null +++ b/packages/admin-ui/src/Progress/CircularProgress.mdx @@ -0,0 +1,45 @@ +import { Canvas, Meta, Story } from '@storybook/blocks'; + +import * as CircularProgressStories from './CircularProgress.stories'; + + + +# Circular Progress + +The Circular Progress Loader visually represents ongoing processes, such as loading or background tasks, by displaying continuous or determinate progress. It provides users with clear feedback, ensuring a smooth and informed experience while maintaining design consistency. + + + +## Usage + +``` +import { CircularProgress } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Construction +Construction + +### Style +Style + +### Type + +A **determinate** circular loader visually represents progress with a circular arc that fills proportionally based on the completed percentage, providing users with a clear indication of task completion. + +An **indeterminate loader** does not display exact progress but continuously animates, signaling that a process is ongoing without a known completion time. + +Type + +### Size +Size + +### Background Overlay +Background Overlay + +## Usage + +Usage + +Usage diff --git a/packages/admin-ui/src/Progress/CircularProgress.stories.tsx b/packages/admin-ui/src/Progress/CircularProgress.stories.tsx index afcc7c7495c..95a5fc2c377 100644 --- a/packages/admin-ui/src/Progress/CircularProgress.stories.tsx +++ b/packages/admin-ui/src/Progress/CircularProgress.stories.tsx @@ -2,9 +2,8 @@ import type { Meta, StoryObj } from "@storybook/react"; import { CircularProgress } from "./CircularProgress"; const meta: Meta = { - title: "Components/CircularProgress", + title: "Components/Circular Progress", component: CircularProgress, - tags: ["autodocs"], argTypes: { text: { control: "text" } } diff --git a/packages/admin-ui/src/RadioGroup/RadioGroup.mdx b/packages/admin-ui/src/RadioGroup/RadioGroup.mdx new file mode 100644 index 00000000000..8cbf945111c --- /dev/null +++ b/packages/admin-ui/src/RadioGroup/RadioGroup.mdx @@ -0,0 +1,41 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as RadioGroupStories from './RadioGroup.stories'; + + + +# Radio Group + +Radio buttons allow users to select only one option from a set of mutually exclusive choices. A radio group is a collection of radio buttons that are related to each other, ensuring that only one option can be selected at a time. + + + +## Usage + +``` +import { RadioGroup } from '@webiny/admin-ui'; +``` + +## Anatomy + +### General +Radio input enable users to select a single item from a list of offered choices. A radio input group organizes related radio input options together for better clarity and functionality. + +Anatomy + +### Radio input options +Radio inputs can exist in two different states: Selected and Not Selected. When a radio input is used for bulk selection, all other options must be excluded since the very purpose of a radio input is to provide only one selectable option. +Radio input options + +### States +States + +## Usage + +### Text overflow +When the radio item text content is too long for the horizontal space available, the content should wrap to form another line aligning the text and checkbox on top. + +Text overflow + + + diff --git a/packages/admin-ui/src/RadioGroup/RadioGroup.stories.tsx b/packages/admin-ui/src/RadioGroup/RadioGroup.stories.tsx index 46b3db4ae36..bfc42e373f3 100644 --- a/packages/admin-ui/src/RadioGroup/RadioGroup.stories.tsx +++ b/packages/admin-ui/src/RadioGroup/RadioGroup.stories.tsx @@ -5,7 +5,6 @@ import { RadioGroup } from "./RadioGroup"; const meta: Meta = { title: "Components/Form/RadioGroup", component: RadioGroup, - tags: ["autodocs"], parameters: { layout: "padded" }, diff --git a/packages/admin-ui/src/Select/Select.mdx b/packages/admin-ui/src/Select/Select.mdx new file mode 100644 index 00000000000..7578c96b8d2 --- /dev/null +++ b/packages/admin-ui/src/Select/Select.mdx @@ -0,0 +1,45 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as SelectStories from './Select.stories'; + + + +# Select + +The Select component is a user interface element that allows users to choose one or multiple options from a predefined list. It simplifies data input by presenting a structured selection, reducing errors, and improving usability. Since selecting options is a crucial aspect of user interaction, we ensure that all our select components have the necessary mechanisms to make the selection process as seamless as possible. + + + +## Usage + +``` +import { Select } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Select Anatomy +Select Anatomy + +### Styles +Styles + +### Options +Options + +### States and Styles +States and Styles + +### Label Anatomy +Label Anatomy + +### Label Properties +Label Properties + +### Label Options +Label Options + +## Usage + +### Used in forms +Used in forms diff --git a/packages/admin-ui/src/Select/Select.stories.tsx b/packages/admin-ui/src/Select/Select.stories.tsx index e0bde5eb9e7..233263d0620 100644 --- a/packages/admin-ui/src/Select/Select.stories.tsx +++ b/packages/admin-ui/src/Select/Select.stories.tsx @@ -5,7 +5,6 @@ import { Select } from "~/Select"; const meta: Meta = { title: "Components/Form/Select", component: Select, - tags: ["autodocs"], argTypes: { onValueChange: { action: "onValueChange" }, onOpenChange: { action: "onOpenChange" } diff --git a/packages/admin-ui/src/Tabs/Tabs.mdx b/packages/admin-ui/src/Tabs/Tabs.mdx new file mode 100644 index 00000000000..a6b9bbf5ecc --- /dev/null +++ b/packages/admin-ui/src/Tabs/Tabs.mdx @@ -0,0 +1,31 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as Tabs from './Tabs.stories'; + + + +# Tabs + +A tab component organizes content into multiple sections, enabling users to seamlessly switch between views without page reloads, enhancing navigation and user experience. + + + +## Usage + +``` +import { Tabs } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Construction +Construction + +### Size & States +Size & States + +### Tab Group +Tab Group + +## Usage +Usage \ No newline at end of file diff --git a/packages/admin-ui/src/Tabs/Tabs.stories.tsx b/packages/admin-ui/src/Tabs/Tabs.stories.tsx index ca22e0e52bf..fe4aa53a762 100644 --- a/packages/admin-ui/src/Tabs/Tabs.stories.tsx +++ b/packages/admin-ui/src/Tabs/Tabs.stories.tsx @@ -7,7 +7,6 @@ import { Tabs } from "./Tabs"; const meta: Meta = { title: "Components/Tabs", component: Tabs, - tags: ["autodocs"], parameters: { layout: "padded" } diff --git a/packages/admin-ui/src/Tag/Tag.mdx b/packages/admin-ui/src/Tag/Tag.mdx new file mode 100644 index 00000000000..c5f1d584b20 --- /dev/null +++ b/packages/admin-ui/src/Tag/Tag.mdx @@ -0,0 +1,31 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as Tag from './Tag.stories'; + + + +# Tag + +The tag is a visual element used to display brief, contextual information or status, such as counts, labels, or indicators. It enhances UI clarity by drawing attention to critical updates (e.g., notifications), item counts, or states (e.g., “new,” “active”). + + + +## Usage + +``` +import { Tag } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Construction +Construction + +### Style +Style + +### States +States + +## Usage +Usage \ No newline at end of file diff --git a/packages/admin-ui/src/Tag/Tag.stories.tsx b/packages/admin-ui/src/Tag/Tag.stories.tsx index 997cfabc688..ad235e9d2c7 100644 --- a/packages/admin-ui/src/Tag/Tag.stories.tsx +++ b/packages/admin-ui/src/Tag/Tag.stories.tsx @@ -6,7 +6,6 @@ import { Tag } from "./Tag"; const meta: Meta = { title: "Components/Tag", component: Tag, - tags: ["autodocs"], parameters: { layout: "padded" } diff --git a/packages/admin-ui/src/Textarea/Textarea.mdx b/packages/admin-ui/src/Textarea/Textarea.mdx new file mode 100644 index 00000000000..b71bc563606 --- /dev/null +++ b/packages/admin-ui/src/Textarea/Textarea.mdx @@ -0,0 +1,45 @@ +import { Canvas, Meta } from '@storybook/blocks'; + +import * as TextareaStories from './Textarea.stories'; + + + +# Textarea + +Text textarea field component enable users to textarea, edit, or search text in digital interfaces. It facilitates data collection, user interaction, and communication. Text fields ensure clarity, consistency, and accessibility across applications, supporting tasks like form completion, authentication, and search queries in an intuitive and efficient manner. + + + +## Usage + +``` +import { Textarea } from '@webiny/admin-ui'; +``` + +## Anatomy + +### Textarea +Textarea Anatomy + +### Styles +Styles + +### Field Size +Field Size + +### States and Styles +States and Styles + +### Label Anatomy +Label Anatomy + +### Label Properties +Label Properties + +### Label Options +Label Options + +## Usage + +### Used in forms +Used in forms diff --git a/packages/admin-ui/src/Textarea/Textarea.stories.tsx b/packages/admin-ui/src/Textarea/Textarea.stories.tsx index 6c56ca44001..7ddc7d7fcb6 100644 --- a/packages/admin-ui/src/Textarea/Textarea.stories.tsx +++ b/packages/admin-ui/src/Textarea/Textarea.stories.tsx @@ -6,7 +6,6 @@ import { Textarea } from "~/Textarea"; const meta: Meta = { title: "Components/Form/Textarea", component: Textarea, - tags: ["autodocs"], argTypes: { onChange: { action: "onChange" } },