0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/client/README.md

43 lines
617 B
Markdown
Raw Normal View History

# Wagtail client-side components
This library aims to give developers the ability to subclass and configure Wagtail's UI components.
## Usage
```
npm install wagtail
```
```javascript
import { Explorer } from 'wagtail';
...
<Explorer onChoosePage={(page)=> { console.log(`You picked ${page}`); }} />
```
## Available components
TODO
- [ ] Explorer
- [ ] Modal
- [ ] DatePicker
- [ ] LinkChooser
- [ ] DropDown
## Building in development
Run `webpack` from the Wagtail project root.
```
webpack
```
## How to release
The front-end is bundled at the same time as the Wagtail project, via `setuptools`.