From 3cc9a5984251719e7fb6eb98545acec103831d0a Mon Sep 17 00:00:00 2001 From: Rob Phoenix <9257284+robphoenix@users.noreply.github.com> Date: Thu, 11 Jul 2024 10:34:28 +0100 Subject: [PATCH] add lab docs (#411) --- packages/web-ui/docs/web-ui/introduction.mdx | 27 +++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/packages/web-ui/docs/web-ui/introduction.mdx b/packages/web-ui/docs/web-ui/introduction.mdx index c15d600cc..a92498a66 100644 --- a/packages/web-ui/docs/web-ui/introduction.mdx +++ b/packages/web-ui/docs/web-ui/introduction.mdx @@ -105,9 +105,34 @@ All other components can be used without being wrapped in a `ThemeProvider`, and will nnot be affected if wrapped in a `ThemeProvider` from another component library, including the deprecated `customer-ui-material`. +## The `lab` submodule + +In an effort to avoid blocking the UX team, at the same time as avoiding +forcing breaking changes on dev teams, we use the `lab` submodule to add +component updates when necessary. for instance, if significant design updates, +required by product, also incur breaking api changes, or a complete refactor, +we can introduce them via the `lab` import path, alongside the existing +component. components introduced in this way can then replace the existing +component in the next major release. + +After being released, components within `lab` will still be subject to semantic +releasing, so any breaking changes will be considered as just that and will +require a major release. + +```tsx +import { Button } from '@utilitywarehouse/web-ui/dist/lab'; + +[...] + + +``` + ## ES modules -In an effort to provide a tree-shakeable library we export bundles for both ES modules and CommonJS. This however may cause issues with Webpack based applications as they default to expecting ES module files to be referenced with a file extension. +In an effort to provide a tree-shakeable library we export bundles for both ES +modules and CommonJS. This however may cause issues with Webpack based +applications as they default to expecting ES module files to be referenced with +a file extension. ### Plain React App