wagtail/client/README.md
Tim Heap 75e58efab8 Move version from wagtail.wagtailcore to wagtail
This is where developers expect it to be, similar to Django and other
projects. The version info still exists at the old `wagtail.wagtailcore`
location, for backwards compatibility.

Fixes #2557
2016-08-18 12:05:33 +01:00

42 lines
617 B
Markdown

# 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`.