slate-instant-replace

A Slate plugin that gives you full power on the last word your user typed.

⚠️ This package is compatible with <= [email protected], please refer to this issue if you are working on >= [email protected] ⚠️

Why ?

I was looking at some plugin to automatically replace some text at the very same moment that you press the key that completes the word you want to replace. There is already a SlateJS auto replace plugin, however you need to specify a key to trigger the replacement and this key cannot be a part of the replaced text.

How ?

This plugin applies your transformations every time you write a new letter and has no opinion on the changes you make to the SlateJS's editor instance. Your transformation functions will receive as arguments the editor instance and the last word write and the rest is up to you !

Install

npm install --save slate-instant-replace
yarn add slate-instant-replace

Usage

import InstantReplace from "slate-instant-replace";
import { Editor } from "slate-react";

const YourFunction = (editor, lastWord) => {
  ...
}

// Add the plugin to your set of plugins...
const plugins = [InstantReplace(YourFunction)];

// And later pass it into the Slate editor...
<Editor
  ...
  plugins={plugins}
/>

Multiple transforms

You can also apply a set of multiple replacement functions, in that case the argument needs to be an array of functions like (in which case the function will be applied in the same order you write them):

const plugins = [InstantReplace([YourFunction1, YourFunction2, YourFunction3])];

Options

| Option | Type | Description | | --------------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | transform | Function ArrayOf(Function) | The transforms to apply to the change object each time a letter is pressed. If an array is passed, the functions will be applied from the first element of the array to the last. |

Commands and queries

Additionally this plugins exposes the follow commands and queries if you want to reuse them for your other plugins:

| Name | Type | Description | | ----------------------- | --------- | ----------------------------------------------------------------------------------------- | | getSelection | query | Returns the current selection. | | getCurrentWordOffset | query | Returns the offset of the current word in the node. | | getLastWord | query | Returns the last word using as a reference the current anchor position. | | getPreviousNode | query | Returns the previous node to the one currently focused. | | isFirstCharOfNode | query | Returns true if the anchor is at position 0 of the current node. | | focusPreviousInlineNode | command | Focuses the previous Inline node. |

Commands and queries get automatically attached to the editor instance. This means you can use them like this:

editor.getSelection();
editor.focusPreviousInlineNode();

Examples

• Emoji auto replacement (check source code)

• URL inline-node auto insert (check source code)

• Multiples transforms (hello => hi + emoji auto replacement) (check source code)