lexical/README.md

Outline

Outline is a fast, light-weight, extensible library for building rich text editors on the web.

Environment setup

1. Clone this repository

2. Install dependencies

   • npm install

3. Start local server and run tests

   • npm run start
   • npm run test
     • The server needs to be running for the e2e tests

Getting started with React

Below is an example of a basic plain text editor using outline and outline-react.

import {useCallback} from 'react';
import useOutlineEditor from 'outline-react/useOutlineEditor';
import useOutlinePlainText from 'outline-react/useOutlinePlainText';

function Editor() {
  // When Outline encounters an error, this is where
  // we can report/handle it.
  const onError = useCallback((error) => {
    throw error;
  }, [])

  // Create an Outline editor instance and also a ref
  // that we need to pass to our content editable.
  const [editor, contentEditableRef, showPlaceholder] = useOutlineEditor(
    onError,
  );

  // Setup event handlers for plain text entry.
  const eventHandlers = useOutlinePlainText(editor);

  // Our <div> content editable element with some basic styling.
  return (
    <div>
      <div
        {...eventHandlers}
        ref={contentEditableRef}
        contentEditable={true}
        role="textbox"
        spellCheck={true}
        style={{
          outline: 0,
          overflowWrap: 'break-word',
          padding: '10px',
          userSelect: 'text',
          whiteSpace: 'pre-wrap',
        }}
        tabIndex={0}
      />
      {showPlaceholder && (
        <div className="placeholder">Enter some plain text...</div>
      )}
    </div>
  );
}

Optional but recommended, use VSCode for development

1. Download and install VSCode

   • Download from here (it’s recommended to use the unmodified version)

2. Install extensions

   • Flow Language Support
     • Make sure to follow the setup steps in the README
   • Prettier
     • Set prettier as the default formatter in editor.defaultFormatter
     • Optional: set format on save editor.formatOnSave
   • ESlint

Documentation

• How Outline was designed
• Testing

Contributing

1. Create a new branch
   • git checkout -b my-new-branch
2. Commit your changes
   • git commit -a -m 'Description of the changes'
     • There are many ways of doing this and this is just a suggestion
3. Push your branch to GitHub
   • git push origin my-new-branch
4. Go to the repository page in GitHub and click on "Compare & pull request"
   • The GitHub CLI allows you to skip the web interface for this step (and much more)

Running tests

• npm run test-unit runs only unit tests.
• npm run test-e2e:chromium runs only chromium e2e tests.
• npm run test-e2e:firefox runs only firefox e2e tests.
• npm run test-e2e:webkit runs only webkit e2e tests.