bustle / mobiledoc-kit

A toolkit for building WYSIWYG editors with Mobiledoc
https://bustle.github.io/mobiledoc-kit/demo/
MIT License
1.55k stars 150 forks source link

docs: add onTextInput to README, add example to docs #398

Open bantic opened 8 years ago

bantic commented 8 years ago

As mentioned in Gitter by @martinklepsch, the readme should mention onTextInput here: https://github.com/bustlelabs/mobiledoc-kit#editor-api And inline documentation should be added to the method definition in editor.js

mixonic commented 8 years ago

We still need some inline docs.

Aside: Is there a benefit to having the matcher pass as a property on options? Perhaps the key pressed should simply be passed as an argument to the hook, unifying it with other hook argument signatures.