Skip to content

Commit

Permalink
add lab docs (#411)
Browse files Browse the repository at this point in the history
  • Loading branch information
robphoenix authored Jul 11, 2024
1 parent 2221fbd commit 3cc9a59
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion packages/web-ui/docs/web-ui/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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';

[...]

<Button>New button</Button>
```

## 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

Expand Down

0 comments on commit 3cc9a59

Please sign in to comment.