Highlight

Mark and reference text for review.

Highlight Leaf
Loading...
Files
components/demo.tsx
'use client';

import React from 'react';

import { Plate } from '@udecode/plate-common/react';

import { editorPlugins } from '@/components/editor/plugins/editor-plugins';
import { useCreateEditor } from '@/components/editor/use-create-editor';
import { Editor, EditorContainer } from '@/components/plate-ui/editor';

import { DEMO_VALUES } from './values/demo-values';

export default function Demo({ id }: { id: string }) {
  const editor = useCreateEditor({
    plugins: [...editorPlugins],
    value: DEMO_VALUES[id],
  });

  return (
    <Plate editor={editor}>
      <EditorContainer variant="demo">
        <Editor />
      </EditorContainer>
    </Plate>
  );
}

Features

  • Provides text marking tools for content review and referencing.
  • Uses inline <mark> elements supporting markers (background color).
  • Enables support for highlights, useful when reviewing content or highlighting it for future reference.

Installation

npm install @udecode/plate-highlight

Usage

import { HighlightPlugin } from '@udecode/plate-highlight/react';
 
const plugins = [
  // ...otherPlugins,
  HighlightPlugin,
];

Keyboard Shortcuts

KeyDescription
Cmd + Shift + H

Apply a highlight to the selected text.

Plugins

HighlightPlugin

Forced LayoutHorizontal Rule