0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/client/README.md
2017-05-13 23:53:10 +03:00

32 lines
907 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Wagtail client-side components
> This library aims to give developers the ability to subclass and configure Wagtail's UI components.
## Usage
```sh
npm install wagtail
```
```javascript
import { Explorer } from 'wagtail';
// [...]
<Explorer />
```
## Development
```sh
# From the project root, start the webpack + styles compilation.
npm run start
```
You will also need:
- [React DevTools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) React developer tools integrated into Chrome.
- [Redux DevTools](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd) Redux developer tools integrated into Chrome.
## Releases
The front-end is bundled at the same time as the Wagtail project. This package also aims to be available separately on npm as [`wagtail`](https://www.npmjs.com/package/wagtail).