Adding DOM Attributes

BlockNote allows you to add custom HTML attributes to various DOM elements within the editor. This gives you fine-grained control over styling and functionality.

Available DOM Elements

The following DOM elements can receive custom attributes:

editor: The main editor container, excluding menus & toolbars
block: The container element for individual blocks
blockGroup: Wrapper for top-level and nested blocks
blockContent: Wrapper for a block's content
inlineContent: Wrapper for rich-text content within blocks

Example Usage

The demo below shows how to add a custom class to the block element to create a border around each block:

GitHub

StackBlitz

import "@blocknote/core/fonts/inter.css";
import { useCreateBlockNote } from "@blocknote/react";
import { BlockNoteView } from "@blocknote/mantine";
import "@blocknote/mantine/style.css";

import "./styles.css";

export default function App() {
  // Creates a new editor instance.
  const editor = useCreateBlockNote({
    // Sets attributes on DOM elements in the editor.
    domAttributes: {
      // Adds a class to all `blockContainer` elements.
      block: {
        class: "hello-world-block",
      },
    },
    initialContent: [
      {
        type: "paragraph",
        content: "Welcome to this demo!",
      },
      {
        type: "paragraph",
        content: "You can see there's a border around each block",
      },
      {
        type: "paragraph",
        content: [
          {
            type: "text",
            text: "This is because there's a CSS rule using the ",
            styles: {},
          },
          {
            type: "text",
            text: "hello-world-block",
            styles: { code: true },
          },
          {
            type: "text",
            text: " class we added",
            styles: {},
          },
        ],
      },
      {
        type: "paragraph",
      },
    ],
  });

  // Renders the editor instance using a React component.
  return <BlockNoteView editor={editor} />;
}

.hello-world-block {
  border: 2px solid lightgray;
  border-radius: 4px;
  padding: 2px;
  margin: 2px;
}

Adding DOM Attributes

Available DOM Elements

Example Usage

On this page

Learn

Collaborate

Community

Legal

Theme