FrameworkJavaScript

Underline: underlined text in Blok

Wraps selected text in <u>. Activated with Cmd/Ctrl+U or by clicking the U button in the inline toolbar.

Import

TypeScript

import { Underline } from '@bloklabs/core/tools';

Save Data

TypeScript

// A mark on a run of the block's text field:
// { "text": "world", "marks": { "underline": true } }

JSON

{
  "type": "paragraph",
  "data": {
    "text": [{ "text": "Hello " }, { "text": "world", "marks": { "underline": true } }]
  }
}

Usage Example

TypeScript

import { Blok } from '@bloklabs/core';
import { Underline, Paragraph } from '@bloklabs/core/tools';

const editor = new Blok({
  holder: 'editor',
  tools: {
    // Paragraph is the default block and is not bundled with the core —
    // without it the editor starts with an "unsupported block" stub.
    paragraph: Paragraph,
    underline: Underline,
  },
});