@enonic/ui 1.6.0 → 1.7.0

package/README.md

@@ -32,6 +32,8 @@ npm install @enonic/ui preact @radix-ui/react-slot            # Preact
 
 </details>
 
+The package is built against React. A Preact app aliases `react`, `react-dom`, and `react/jsx-runtime` to `preact/compat` and `preact/jsx-runtime` — `@preact/preset-vite` does this in the bundler by default — and maps the same three in `tsconfig.json` `paths`, or the package's types resolve to `any`. See [Preact projects](https://enonic.github.io/npm-enonic-ui/?path=/docs/getting-started-installation--docs) for both configs.
+
 **2. Load the styles.** Components use Tailwind utility classes and render unstyled until a stylesheet is present. The prebuilt one needs no configuration:
 
 ```css
@@ -131,16 +133,18 @@ Inside a shadow root the document's theme does not reach in, even though custom
 
 Icons used inside components are bundled — no icon package is needed for components to render.
 
-A Lucide package is needed only when you pass your own icon to a component that takes one, such as the `icon` prop on `Tab`, `Link`, or `VirtualizedTreeList`:
+A Lucide package is needed only when you pass your own icon to a component that takes one, such as `icon` on `IconButton` or `Tab.DefaultTrigger`, or `leftIcon` on `Link`:
 
 ```tsx
 import { Tab } from '@enonic/ui';
-import { Star } from 'lucide-react'; // lucide-preact in Preact projects
+import { Star } from 'lucide-react'; // or lucide-preact
 
-<Tab icon={Star} label='Favorites' />;
+<Tab.DefaultTrigger value='favorites' icon={Star}>
+  Favorites
+</Tab.DefaultTrigger>;
 ```
 
-The `icon` prop accepts either package.
+Icon props accept icons from either package.
 
 ## Requirements
 
@@ -149,10 +153,10 @@ The `icon` prop accepts either package.
 | Requirement                                     | Notes                               |
 | ----------------------------------------------- | ----------------------------------- |
 | `@radix-ui/react-slot`                          | Required — backs the `asChild` prop |
-| `react` + `react-dom` v19, **or** `preact` v10+ | Pick one framework                  |
+| `react` + `react-dom` v19, **or** `preact` v10+ | Preact needs the `react` aliases    |
 | Tailwind CSS v4                                 | Only for the `preset.css` path      |
 
-Optional peers, needed per feature:
+Optional packages, needed per feature:
 
 | Package          | Needed for                                        |
 | ---------------- | ------------------------------------------------- |