Installing Slate

Slate is an npm module, so to install it you do:

npm install slate

You'll also need to be sure to install Slate's peer dependencies for React:

npm install react react-dom

Note, if you'd rather use a pre-bundled version of Slate, you can npm install slate and retrieve the bundled dist/slate.js file! Check out the Using the Bundled Source guide for more information.

Once you've install it, you'll need to import it.

Slate exposes a set of modules that you'll use to build your editor. The most important of which is an Editor component.

// Import the Slate editor.
import { Editor } from 'slate'

In addition to rendering the editor, you need to give Slate a "initial state" to render as content.

To keep things simple, we'll use the Raw serializer that ships with Slate to create a new initial state that just contains a single paragraph block with some text in it:

// Import the "raw" serializer that ships with Slate.
import { Editor, Raw } from 'slate'

// Create our initial state...
const initialState = Raw.deserialize({
  nodes: [
    {
      kind: 'block',
      type: 'paragraph',
      nodes: [
        {
          kind: 'text',
          text: 'A line of text in a paragraph.'
        }
      ]
    }
  ]
}, { terse: true })

The terse: true option there isn't important for now, but if you're curious about it you can check out the Raw serializer reference.

And now that we've our initial state, we define our App and pass it into Slate's Editor component, like so:

// Import React!
import React from 'react'
import { Editor, Raw } from 'slate'

const initialState = Raw.deserialize({
  nodes: [
    {
      kind: 'block',
      type: 'paragraph',
      nodes: [
        {
          kind: 'text',
          text: 'A line of text in a paragraph.'
        }
      ]
    }
  ]
}, { terse: true })

// Define our app...
class App extends React.Component {

  // Set the initial state when the app is first constructed.
  state = {
    state: initialState
  }

  // On change, update the app's React state with the new editor state.
  render() {
    return (
      <Editor
        state={this.state.state}
        onChange={state => this.setState({ state })}
      />
    )
  }

}

You'll notice that the onChange handler passed into the Editor component just updates the app's state with the newest editor state. That way, when it re-renders the editor, the new state is reflected with your changes.

And that's it!

That's the most basic example of Slate. If you render that onto the page, you should see a paragraph with the text A line of text in a paragraph.. And when you type, you should see the text change!

Next:
Adding Event Handlers

2.9 KiB Raw Blame History

Installing Slate

2.9 KiB

Raw Blame History