Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PLAY-1610] Add details to dependencies docs #3885

Merged
merged 3 commits into from
Nov 6, 2024
Merged

[PLAY-1610] Add details to dependencies docs #3885

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
30cf760
Add details
markdoeswork Nov 5, 2024
04b393e
Fix wording
markdoeswork Nov 5, 2024
0216057
Update playbook-website/app/views/guides/getting_started/dependencies.md
jasperfurniss Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions playbook-website/app/views/guides/getting_started/dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ icon: code
description: Some of our kits require additional libraries to run properly.
---

## Playbook UI Dependencies | React

Playbook UI's React libray needs the following packages installed in your project to work properly:
jasperfurniss marked this conversation as resolved.
Show resolved Hide resolved

```json
"react"
"react-dom"
"react-is"
"react-trix"
```

## Playbook UI Dependencies | Rails

Playbook UI's Rails gem requires React for its components javascript to fully function. Follow the instructions in the [Ruby & React Setup](/guides/getting_started/rails_&_react_setup) guide to add react to your Rails app.

## Unbundled Dependencies

These kits require you to install additional libraries to get full functionality.
Expand Down
9 changes: 7 additions & 2 deletions playbook-website/app/views/guides/getting_started/react_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ description: React applications. Endlessly flexible presentational UI components
```sh
yarn add playbook-ui
```
#### Match your project's versions of React and ReactDOM with Playbook's versions
#### Match your project's versions of React, ReactDOM, react-is and React Trix with Playbook's versions

```json
"react": "17.0.2",
"react-dom": "17.0.2",
"react-is": "^17.0.2",
"react-trix": "0.10.1",
```
#### Import fonts and CSS styles
Can be imported in your Index.js file or top level app Component
Expand All @@ -28,4 +30,7 @@ import 'playbook-ui/dist/fonts/fontawesome-min';
import { Avatar, Button } from 'playbook-ui';
```
#### CodeSandbox React Setup Example
[Link to CodeSandbox Example](https://codesandbox.io/s/playbook-empty-6ixcw)
[Link to CodeSandbox Example](https://codesandbox.io/s/playbook-empty-6ixcw)

### Dependencies
[More details about Playbook dependencies](/guides/getting_started/dependencies)
Loading