The next version of draft-js-plugins (alpha)
Branch: master
Clone or download
juliankrispel Merge pull request #52 from draft-js-plugins/patch-example
Update example's title and remove fontawesome in block-switcher-example
Latest commit 6e41163 Jan 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.storybook move examples to examples folder Oct 2, 2018
examples remove unused dependency in static-toolbar-example Jan 10, 2019
packages
scripts update running flow scripts Oct 17, 2018
.all-contributorsrc Add @Rosey as a contributor Oct 5, 2018
.bookignore update core package a little Oct 25, 2018
.editorconfig - move editorconfig to root Oct 8, 2018
.eslintignore quote lint glob Oct 17, 2018
.eslintrc add test for getCharCount in utils Dec 23, 2018
.gitignore gitignore .vscode Oct 17, 2018
.nvmrc update node version via nvmrc Oct 16, 2018
.prettierignore add prettier, husky and eslint Oct 8, 2018
.prettierrc added prettier & eslint, tidied up any code formatting/styling issues Oct 8, 2018
.travis.yml disable flow on travis :/, add pre push hook Nov 20, 2018
LICENSE init Sep 11, 2018
README.md codeship badge Nov 20, 2018
SUMMARY.md update core package a little Oct 25, 2018
babel.config.js
draft-js-plugins-next.code-workspace - add flow-typed to uitls Oct 10, 2018
lerna.json v0.1.5 Nov 5, 2018
logo.sketch
package-lock.json test: add test script Jan 7, 2019
package.json test: add test script Jan 7, 2019
rationale.md - update docs Oct 16, 2018

README.md

draft-js-plugins@next

All Contributors Build Status codeship

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

Examples

Contributing

Install project

  1. Run npm install (we use package-lock.json rather than yarn)
  2. Run yarn lerna bootstrap, this will install all dependencies of all packages and examples.

Contributing

Feature prs

  • Please open an issue first
  • We're reachable on the draft js slack

Working locally

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.

Process

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.

  1. Plugins go into the packages folder. 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.
  2. We use flow for type checking.
  3. Examples are our playground for trying out packages we're working out and building out different usecases. standalone create-react-app apps 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

Contributors

Thanks goes to these wonderful people (emoji key):


blackywkl

💻 📖 💡

Hosmel Quintana

💻

Rose

💻

This project follows the all-contributors specification. Contributions of any kind welcome!