Skip to content

Commit 0cd07fb

Browse files
Vojtěch Václav Portešvojtechportes
authored andcommitted
docs: Updated Radix adapter documentation
- Updated installation guide for Radix UI adapter in README and on the library website
1 parent f6e5863 commit 0cd07fb

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,9 +237,12 @@ export const MyFluentUiBuilder = () => {
237237
Radix example:
238238

239239
```bash
240-
npm install @radix-ui/themes@^1.1.2
240+
npm install @radix-ui/themes@^1.1.2 @radix-ui/react-icons@^1.3.2
241241
```
242242

243+
The Radix adapter also uses `@radix-ui/react-icons`, so install it alongside
244+
`@radix-ui/themes`.
245+
243246
```tsx
244247
import React from 'react';
245248
import '@radix-ui/themes/styles.css';

example/src/pages/documentation-page/pages/documentation-content.tsx

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ const mantineAdaptersInstallSnippet = `npm install @mantine/core@^9.0.0 @mantine
262262

263263
const fluentUiAdaptersInstallSnippet = `npm install @fluentui/react@^8.125.6`;
264264

265-
const radixAdaptersInstallSnippet = `npm install @radix-ui/themes@^1.1.2`;
265+
const radixAdaptersInstallSnippet = `npm install @radix-ui/themes@^1.1.2 @radix-ui/react-icons@^1.3.2`;
266266

267267
const muiCreateComponentsSnippet = `import {
268268
Builder,
@@ -2242,13 +2242,20 @@ export const documentationPages: IDocumentationPage[] = [
22422242
</List>
22432243
<SectionTitle>Installing Radix Themes</SectionTitle>
22442244
<p>
2245-
Install the Radix Themes peer dependency before using the adapter.
2245+
Install the Radix Themes peer dependency and the Radix icons package
2246+
before using the adapter.
22462247
</p>
22472248
<CodeBlock
22482249
code={radixAdaptersInstallSnippet}
22492250
language="bash"
22502251
label="Radix Themes v1 peer"
22512252
/>
2253+
<AlertBox title="Icons package required" variant="info">
2254+
The Radix adapter renders icons from{' '}
2255+
<InlineCode>@radix-ui/react-icons</InlineCode>, so applications using
2256+
the adapter should install that package alongside{' '}
2257+
<InlineCode>@radix-ui/themes</InlineCode>.
2258+
</AlertBox>
22522259
<AlertBox title="Stylesheet required" variant="info">
22532260
Import <InlineCode>@radix-ui/themes/styles.css</InlineCode> once in your
22542261
application entrypoint so Radix Themes components render with the expected

0 commit comments

Comments
 (0)