@uniformdev/design-system 20.47.2-alpha.4 → 20.48.1-alpha.11

package/README.md

@@ -55,7 +55,59 @@ export default function Document() {
 }
 ```
 
-### 2. Use Components
+### 2. Set up Providers (as needed)
+
+Some components rely on React context providers to function correctly. Set them up as needed:
+
+#### IconsProvider
+
+Required by the `Icon` component when using string-based icon names (e.g. `icon="mail"`). Without the provider, you can still pass icon components directly.
+
+```tsx
+import { IconsProvider, Icon } from '@uniformdev/design-system';
+
+function App() {
+  return (
+    <IconsProvider>
+      <Icon icon="mail" />
+    </IconsProvider>
+  );
+}
+```
+
+**Direct consumers:** `Icon`
+**Indirect consumers:** Any component that renders an `Icon` internally (e.g. `Button`, `Callout`, `Details`, `Menu`, and many more)
+
+#### DrawerProvider
+
+Optional for basic `Drawer` usage -- `Drawer` creates its own internal provider and renderer when no external `DrawerProvider` is present. An explicit `DrawerProvider` is only needed for shared drawer stacks (e.g. multiple drawers rendering into the same `DrawerRenderer`).
+
+Required by `DrawerRenderer` and `TakeoverDrawerRenderer`, which must be rendered inside a `DrawerProvider`.
+
+```tsx
+import { DrawerProvider, Drawer, DrawerRenderer } from '@uniformdev/design-system';
+
+function App() {
+  return (
+    <DrawerProvider>
+      <Drawer id="my-drawer" header="Title">Content</Drawer>
+      <DrawerRenderer stackId="_default" />
+    </DrawerProvider>
+  );
+}
+```
+
+**Required by:** `DrawerRenderer`, `TakeoverDrawerRenderer`
+**Optional for:** `Drawer` (self-sufficient for simple cases)
+
+#### ParameterShell
+
+Only required when using `*Inner` components directly (e.g. `ParameterInputInner`, `ParameterSelectInner`). The outer wrapper components (`ParameterInput`, `ParameterSelect`, etc.) create a `ParameterShell` automatically, so no external setup is needed for typical usage.
+
+**Required by:** `ParameterInputInner`, `ParameterSelectInner`, `ParameterLinkInner`, `ParameterSelectSliderInner`, `ParameterToggleInner`, `ParameterNumberSliderInner`, `ParameterMultiSelectInner`, `ParameterTextareaInner`, `ParameterImageInner`
+**Not required by:** `ParameterInput`, `ParameterSelect`, `ParameterLink`, and other outer wrappers (they provide it internally)
+
+### 3. Use Components
 
 ```tsx
 import { Button, Heading, Card, Input } from '@uniformdev/design-system';