Skip to content

Latest commit

 

History

History
100 lines (72 loc) · 3.25 KB

Readme.md

File metadata and controls

100 lines (72 loc) · 3.25 KB
Raw

slate-suggestions

A Slate plugin to suggestion replacements or actions based on input. Useful for implementing "mention" or other suggestion based behaviors.

Install

npm install --save slate-suggestions

You will need to have installed slate as a dependency already.

Usage

import SuggestionsPlugin from 'slate-suggestions'
import { Editor } from 'slate'

const suggestions = [
  {
    key: 'jon-snow',
    value: '@Jon Snow',
    suggestion: '@Jon Snow' // Can be string or react component
  },
  // Some other suggestions
]

const suggestionsPlugin = SuggestionsPlugin({
  trigger: '@',
  capture: /@([\w]*)/,
  suggestions,
  onEnter: (suggestion) => {
    // Modify your state up to your use-cases
    return modifiedState
  }
})

// Extract portal component from the plugin
const { SuggestionPortal } = suggestionPlugin

// Add the plugin to your set of plugins...
const plugins = [
  suggestionPlugin
]

// And later pass it into the Slate editor...
<Editor
  ...
  plugins={plugins}
/>
// And add portal component together with the editor
<SuggestionPortal
  state={this.state.state}
/>
Option Type Description
trigger String The trigger to match the inputed character, use to open the portal.
capture RegExp A regexp that must match the text after the trigger to keep the portal open and extract the text to filter suggestions.
suggestions Array An array of suggestions object which have the following keys key, value and suggestion. suggestion can be string or react component.
onEnter Function A function use to handle return/enter keypress to append suggestion into editor.
startOfParagraph Bool An optional flag that use to check that portal will trigger only when trigger string is at the start of paragraph.
resultSize Number An optional number use to set size of suggestion result. Default is 5.

Development

Clone the repository and then run:

npm install
npm run watch

And open the example page in your browser:

http://localhost:8888/

License

Copyright © 2016, Oozou

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.