DISCLAIMER: This project isn't usable yet
This is at an experimental stage, mostly this project isn't complete and ready for use. If you're interested in participating, whether it's code or just debate, please open an issue, hit me up on twitter or the draft js slack channel
npm install(we use package-lock.json rather than
yarn lerna bootstrap, this will install all dependencies of all packages and examples.
- Please open an issue first
- We're reachable on the draft js slack
In order to work on packages and examples at the same time, just run
yarn lerna link and start
yarn watch in the package/example folders you want to work on.
If you'd like to contribute, please follow this process. If you disagree with the process or would like to change it, just open an issue or talk to me on slack.
- Plugins go into the
packagesfolder. Plugins are basic building blocks, they don't cater to a specific usecase, but should be used as composable building blocks for your draft js app. Generally I'm trying to avoid any styling and leave that up to user land. Usage of render props and inversion of control is encouraged, if you're not sure what I mean, please have a peak at Kent's video building downshift.
- We use flow for type checking.
- Examples are our playground for trying out packages we're working out and building out different usecases. standalone
create-react-appapps found in the examples folder. To add an example, just copy an existing example and modify it to suit your needs.
Working on Documentation
We use gitbook for documentation, in order to add documentation for a package you're working on, you can just add a readme in the package folder, and link it from the main readme.
To show the docs in your browser while writing them, run
npm run docs
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!