@bangle.dev/core

@bangle.dev/core as the name suggests is the core of Bangle and most packages expect it as a peer dependency. To install run:

npm install @bangle.dev/core

💡 Use the right sidebar or the hamburger at bottom-right (mobile screens) to navigate quickly.

Component#

The building block of Bangle is a component. At it's heart, we have a vanilla Javascript module which exports the follow properties:

  • ?spec(opts: Object): Spec
    The specification which defines how the component will be rendered in the Editor. If the component has nothing to render it will not export this method.

  • ?plugins(opts: Object): Plugins
    This injects the superpowers 🧙‍♀️ to your component. Fantasy aside: you can pretty do anything to your node/mark with Plugins.

  • ?commands: CommandObject

  • ?defaultKeys: KeybindingsObject

Spec#

An object with the following fields:

  • type: 'node' | 'mark'
    This is a Prosemirror concept which divides the spec in two groups node type or mark type. Please checkout Your first editor guide guide.

  • topNode: ?boolean
    Whether the node will be the top node for the document. By default the doc node is the top node for Bangle. There can only be one top node and is only applicable for node types.

  • name: string
    The name of the node or mark.

  • schema: Prosemirror.NodeSpec | Prosemirror.MarkSpec

  • markdown: ?{toMarkdown: fn(), parseMarkdown: object}\

  • options: ?object
    Use this to save data in this spec. You can use this field to save some data options to make it available to anyone having access to specRegistry.

Plugins#

🧠 Please note this is a recursive type - it contains reference to itself!

Prosemirror.Plugin | Plugins[] | (fn({ schema, specRegistry }) -> Plugins) | undefined

This is designed in a way to provide flexibility and extensibility when grouping multiple plugins under a Component. Please checkout this example on how to create a small plugin or read the source code of some of the core components.

Plugin#

Prosemirror.Plugin

KeybindingsObject#

{ [string]: string | undefined }

An object which defines the keybindings that are active for a given component. The keys are the name given to an action and the value is valid w3c-keyname. Setting a key to undefined will make it a no-op.

In the example below, it tells that an action named moveUp will be executed when a user presses Alt and ArrowUp key.

{
'moveUp': 'Alt-ArrowUp'
}

📖 Please checkout the Keybindings Guide

CommandObject#

{ [string]: fn(opts: object) -> Command }

A collection of commands exported by a component.

Command#

fn(state: Prosemirror.EditorState, ?dispatch: ?⁠fn(tr: Prosemirror.Transaction), ?view: Prosemirror.EditorView) -> boolean

A function that carries out a bunch of transformations in the editor. The return value indicates whether it was executed or not. For example, running a toggleBold command on a code block will return false to indicate command did not execute, however it will return true when run on a paragraph.

If a dispatch callback is not passed, the command will run in dry run mode -- it will pretend to do things but will actually make no changes to the editor.

💡 Bangle's API will always export a higher order function which then returns a Command, which means it will not export a Command directly. It is designed this way to allow for configurability and to keep the command params predictable -- (config) => (state, dispatch, view) => boolean.

Please read commands guide for more details.

QueryCommand#

fn(state: Prosemirror.EditorState) -> T

This is a special type of command which makes no changes to the editor but queries the editor state and returns the value.

💡 Bangle follows the convention of prefixing query to any function that returns a QueryCommand.

import { heading } from '@bangle.dev/core';
const isActive = heading.commands.queryIsHeadingActive(3)(state); // true or false

In the example above, queryIsHeadingActive queries the editor state's selection for a node with name heading having a level of 3.

BangleEditor#

new BangleEditor(element, options)

Initializes and mounts the editor in your application. Create an editor instance with following params:

The class exposes the following fields/methods:

  • focusView(): void
    Focus the editor.

  • destroy(): void
    Destroy the editor instance.

  • toHTMLString(): string
    Returns the HTML representation of editors content.

  • view: Prosemirror.EditorView

Usage

import { BangleEditor, BangleEditorState } from '@bangle.dev/core';
// 'editor' is the id of the dom Node on which bangle will
// be mounted.
const editorNode = document.getElementById('editor');
const state = new BangleEditorState({
initialValue: 'Hello world!',
});
const editor = new BangleEditor(editorNode, { state });
const view = editor.view;
// Programmatically type
view.dispatch(view.state.tr.insertText('Wow'));

📖 See Bangle Markdown example

BangleEditorState#

new BangleEditorState(options)

Create an editor state instance with following params:

  • options: Object

    • specRegistry: ?SpecRegistry
      The SpecRegistry of your editor. Note: you can either set specRegistry or specs but not both.

    • specs: ?Spec[]
      A shorthand which initializes SpecRegistry for you behind the scenes. Use this if you don't care about creating and managing a SpecRegistry instance. Note: you can either set specRegistry or specs but not both.

    • plugins: ?Plugins[]
      The list of plugins for your editor.

    • initialValue: string | htmlString | undefined
      The initial content of the editor.

    • editorProps: Prosemirror.EditorProps

    • pmStateOpts: ?Prosemirror.EditorStateCreateConfig

The class exposes the following fields/methods:

Usage

See usage of BangleEditor.

SpecRegistry#

new SpecRegistry(specs, options)

A wrapper class which sets up the Prosemirror.Schema. SpecRegistry combines and merges all the spec's of your components.

Params:

  • specs: ?Spec[]
    An array containing the specs. Note: the order of specs matters.

  • options: ?Object

    • defaultSpecs: ?boolean=true
      Automatically include critical specdoc, text & paragraph if they are not already provided in the specs param.

The class exposes the following fields/methods:

  • schema: Prosemirror.Schema
    The Prosemirror schema instance associated with the specRegistry. This comes in handy when dealing directly with Prosemirror libraries.

  • options: Object<name, object>
    A dictionary of the key value pair of node ormark name and the option field in their spec.

Usage

In the example below, we are loading a bunch of specs & plugins.

import {
bulletList,
listItem,
orderedList,
bold,
link,
} from '@bangle.dev/core';
const specRegistry = new SpecRegistry([
link.spec(),
bold.spec(),
bulletList.spec(),
listItem.spec(),
orderedList.spec(),
]);
const plugins = [
link.plugins(),
bold.plugins(),
bulletList.plugins(),
listItem.plugins(),
orderedList.plugins(),
];
const editorNode = document.queryElement('#editor');
const state = new BangleEditorState({
specRegistry,
plugins,
initialValue: 'Hello world!',
});
const editor = new BangleEditor(editorNode, { state });

Components#

The following is a list of components exported by this package.

blockquote: Component#

Enables blockquote in your editor.

spec(): NodeSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • markdownShortcut: ?boolean=true
    Toggle the markdown shortcut for creating a blockquote. If enabled, type > followed by a space to create one.

defaultKeys: KeybindingsObject#

  • wrapIn=Ctrl-ArrowRight: wrap text in blockquote.

  • moveDown=Alt-ArrowDown: move blockquote down

  • moveUp=Alt-ArrowUp: move blockquote up

  • emptyCopy=Mod-c: Execute a clipboard copy on the node when the selection is empty.

  • emptyCut=Mod-x: Execute a clipboard cut on the node when the selection is empty.

  • insertEmptyParaAbove=Mod-Shift-Enter: Inserts an empty paragraph above.

  • insertEmptyParaBelow=Mod-Enter: Inserts an empty paragraph below.

commands: CommandObject#

  • queryIsBlockquoteActive(): QueryCommand<boolean>
    Query if the selection is inside a blockquote or not.

Usage

import { blockquote } from '@bangle.dev/core';
const specFactory = [
// other specs
blockquote.spec(),
];
const plugins = [
// other plugins
blockquote.plugins(),
];

bold: Component#

Allows text in your editor to be marked as bold.

spec(): MarkSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • markdownShortcut: ?boolean=true
    Toggle the markdown shortcut for creating a bold mark. If enabled, type **text** to create the mark.

defaultKeys: KeybindingsObject#

  • toggleBold = Mod-b: toggle bold mark

commands: CommandObject#

  • toggleBold(): Command
    Toggles bold mark.

  • queryIsBoldActive(): QueryCommand<boolean>
    Query if the selection is inside a bold mark or not.

Usage

import { bold } from '@bangle.dev/core';
const specFactory = [
// other specs
bold.spec(),
];
const plugins = [
// other plugins
bold.plugins(),
];

bulletList: Component#

Enables bulletList <ul/>. Requires node components with names orderedList & listItem to work.

spec(): NodeSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • markdownShortcut: ?boolean=true
    Enable the markdown shortcut for creating a bullet list. If enabled, type -, * or + followed by a space to create a bullet list on an empty paragraph.

defaultKeys: KeybindingsObject#

  • toggle=Shift-Ctrl-8: Executes toggleBulletList command.

commands: CommandObject#

  • toggleBulletList(): Command
    Convert to a bulletList and if already a bulletList, convert it to a paragraph node.

  • queryIsBulletListActive(): QueryCommand<boolean>
    Query if the selection is inside a bullet list.

Usage

import { bulletList, listItem } from '@bangle.dev/core';
const specFactory = [
// other specs
listItem.spec(),
bulletList.spec(),
orderedList.spec(),
];
const plugins = [
// other plugins
listItem.plugins(),
bulletList.plugins(),
orderedList.plugins(),
];

code: Component#

Allows text in your editor to be marked as code.

spec(): MarkSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • escapeAtEdge: ?Boolean=true
    Allows automatic escaping of code mark at the edges. This particularly helps to escape code mark by pressing left or right arrow key at the edges.

  • markdownShortcut: ?Boolean=true
    Toggle the markdown shortcut for creating a code mark. If enabled, type `text` to create a code mark.

defaultKeys: KeybindingsObject#

  • toggleCode = Mod-`: toggle code mark

commands: CommandObject#

  • toggleCode(): Command
    Toggles code mark.

  • queryIsCodeActive(): QueryCommand<boolean>
    Query if the selection is inside a code mark or not.

Usage

import { code } from '@bangle.dev/core';
const specFactory = [
// other specs
code.spec(),
];
const plugins = [
// other plugins
code.plugins(),
];

codeBlock: Component#

Enables <code/> in your editor.

spec(): NodeSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • markdownShortcut: ?Boolean=true
    Toggle the markdown shortcut for creating a codeBlock. If enabled, type ``` to create one.

defaultKeys: KeybindingsObject#

  • toCodeBlock=Shift-Ctrl-\: wraps text in codeBlock.

  • moveDown=Alt-ArrowDown: move codeBlock down

  • moveUp=Alt-ArrowUp: move codeBlock up

  • insertEmptyParaAbove=Mod-Shift-Enter: Inserts an empty paragraph above.

  • insertEmptyParaBelow=Mod-Enter: Inserts an empty paragraph below.

commands: CommandObject#

  • queryIsCodeActiveBlock(): QueryCommand<boolean>
    Query if the selection is inside a codeBlock or not.

Usage

import { codeBlock } from '@bangle.dev/core';
const specFactory = [
// other specs
codeBlock.spec(),
];
const plugins = [
// other plugins
codeBlock.plugins(),
];

doc: Component#

Top level node needed by the editor to contain every other node. The spec & plugins for this component are required for Bangle to function, if a spec named doc is not defined, Bangle will automatically default to this one.

spec(): NodeSpec#

Returns a node spec with topNode set to true, read more Your first editor guide.

heading: Component#

Enables headings of various levels in your editor .

spec({ ... }): NodeSpec#

Named parameters:

  • levels: ?number[]=[1,2,3,4,5,6]
    The allowed levels for the heading, think <h1/>, <h2/> and so on. The array must be contiguous and the first element must be 1 and the last element must be less than or equal to 6.

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • markdownShortcut: ?Boolean=true
    Toggle the markdown shortcut for heading. If enabled, type # followed by a space to create one a level one heading.

defaultKeys: KeybindingsObject#

  • toH1=Shift-Ctrl-1: Convert a node to heading of level 1. Is a no-op if the level 1 is disallowed.

  • toH2=Shift-Ctrl-2: Convert a node to heading of level 2. Is a no-op if the level 2 is disallowed.

  • toH3=Shift-Ctrl-3: Convert a node to heading of level 3. Is a no-op if the level 3 is disallowed.

  • toH4=Shift-Ctrl-4: Convert a node to heading of level 4. Is a no-op if the level 4 is disallowed.

  • toH5=Shift-Ctrl-5: Convert a node to heading of level 5. Is a no-op if the level 5 is disallowed.

  • toH6=Shift-Ctrl-6: Convert a node to heading of level 6. Is a no-op if the level 6 is disallowed.

  • moveDown=Alt-ArrowDown: move heading down

  • moveUp=Alt-ArrowUp: move heading up

  • emptyCopy=Mod-c: Execute a clipboard copy on the node when the selection is empty.

  • emptyCut=Mod-x: Execute a clipboard cut on the node when the selection is empty.

  • insertEmptyParaAbove=Mod-Shift-Enter: Inserts an empty paragraph above.

  • insertEmptyParaBelow=Mod-Enter: Inserts an empty paragraph below.

  • toggleCollapse: -: Toggle collapsing of heading.

commands: CommandObject#

  • toggleHeading(level: number=3): Command
    Toggles text into heading of a given level and vice versa.

  • queryIsHeadingActive(level:number=3): QueryCommand<boolean>
    Query if the selection is inside a heading of given level.

  • queryIsCollapseActive(): Command
    Query if the current heading is collapsed.

  • collapseHeading(): Command
    Hides every node below that is not heading or has a heading level less than that of the current heading.

  • uncollapseHeading(): Command
    Brings back all the hidden nodes of a collapsed heading. Will only uncollapse shallowly i.e a collapse heading inside of a collapsed heading will not be uncollapsed.

  • toggleHeadingCollapse(): Command
    Collapses an uncollapsed heading and vice versa.

  • uncollapseAllHeadings(): Command
    Uncollapses all headings in the doc. Will also deep uncollapse every heading that was inside of a collapsed heading.

On Heading collapse

The heading component also allows you to collapse and uncollapse any content, after the current heading, that is not of type heading or has a heading of level greater than the current heading.

💡 The collapsed data is saved in the node attribute collapseContent, it is also accessible inside the DOM data attribute by accessing data-bangle-attrs.

💡 A collapsed heading will have a class name of bangle-heading-collapsed to allow for styling.

⚠️ For serializing to Markdown you will have to uncollapse your document, since markdown doesn't support collapsing. You should run the commanduncollapseAllHeadings before serializing to markdown.

On top of the collapse commands, the component also exports the following helper functions to help with collapse functionality:

  • listCollapsibleHeading(state: Prosemirror.EditorState): [{node: Prosemirror.Node, pos: number}]
    Lists all the headings that can be collapsed or uncollapsed.

  • listCollapsedHeading(state: Prosemirror.EditorState): [{node: Prosemirror.Node, pos: number}]
    Lists all the headings that are currently collapsed.

  • flattenFragmentJSON(fragmentJSON: Object): Object
    Deep flattens any nested collapsed heading in the object. Bangle internally uses this to implement uncollapseAllHeadings command. Example flattenFragmentJSON(node.attrs.collapseContent).

Usage

import { heading } from '@bangle.dev/core';
const specFactory = [
// other specs
heading.spec({ levels: [1, 2] }),
];
const plugins = [
// other plugins
heading.plugins(),
];

history: Component#

Enables history in your editor, this is a wrapper for the prosemirror's history module. Unless you are overriding this component, it will be included by default.

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • historyOpts: Object
    see the Prosemirror history config docs for the API.

defaultKeys: KeybindingsObject#

  • undo=Mod-x

  • redo=Mod-y Shift-Mod-z

commands: CommandObject#

  • undo(): Command
    Undoes the last step.

  • redo(): Command
    Redoes the last step.

hardBreak: Component#

Enables the <br /> element in your editor.

spec(): NodeSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

defaultKeys: KeybindingsObject#

  • insert = Shift-Enter: inserts a hard break

Usage

import { hardBreak } from '@bangle.dev/core';
const specFactory = [
// other specs
hardBreak.spec(),
];
const plugins = [
// other plugins
hardBreak.plugins(),
];

horizontalRule: Component#

Enables a horizontal (<hr />) rule component in your editor.

spec(): NodeSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • markdownShortcut: ?boolean=true
    Toggle the markdown shortcut for creating a horizontalRule. Type --- and ___ to insert a horizontal rule.

Usage

import { horizontalRule } from '@bangle.dev/core';
const specFactory = [
// other specs
horizontalRule.spec(),
];
const plugins = [
// other plugins
horizontalRule.plugins(),
];

image: Component#

Enables images in your editor.

spec(): NodeSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • handleDragAndDrop: ?boolean=true
    Toggle the functionality of dragging, dropping and pasting of images into the editor.

Usage

import { image } from '@bangle.dev/core';
const specFactory = [
// other specs
image.spec(),
];
const plugins = [
// other plugins
image.plugins(),
];

italic: Component#

Allows text in your editor to be marked as italic.

spec(): MarkSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • markdownShortcut: ?boolean=true
    Toggle the markdown shortcut for creating am italic mark. If enabled, type _text_ to enable italic mark.

defaultKeys: KeybindingsObject#

  • toggleItalic = Mod-i: toggle an italic mark

commands: CommandObject#

  • toggleItalic(): Command
    Toggles italic mark.

  • queryIsItalicActive(): QueryCommand<boolean>
    Query if the selection is inside an italic mark or not.

Usage

import { italic } from '@bangle.dev/core';
const specFactory = [
// other specs
italic.spec(),
];
const plugins = [
// other plugins
italic.plugins(),
];

link: Component#

Allows text in your editor to be marked as link.

spec({ ... }): MarkSpec#

Named parameters:

  • openOnClick: ?boolean=false
    If enabled clicking a link will open the link in new tab. If disabled, clicking a link will set the cursor on it.

plugins(): Plugins#

commands: CommandObject#

  • createLink(href : string): Command
    Creates a link mark on the selection text.

  • updateLink(href : ?string): Command
    Updates a link mark on the selection text with href. Set href to undefined to clear the link mark. If selection is empty, it will update the parent text node.

  • queryLinkAttrs(): QueryCommand<?{href: string, text: string}>
    Returns the details of the link mark in selection.

  • queryIsLinkAllowedInRange(from: number, to: number): QueryCommand<boolean>
    Queries if the range allows for creation of link mark.

  • queryIsLinkActive(): QueryCommand<boolean>
    Queries if the selection is in a link mark.

  • queryIsSelectionAroundLink(): QueryCommand<boolean>
    Queries if the selection is around a link mark.

Usage

import { link } from '@bangle.dev/core';
const specFactory = [
// other specs
link.spec(),
];
const plugins = [
// other plugins
link.plugins(),
];

listItem: Component#

Creates a listItem <li/>. Requires node components with names bulletList and orderedList to work

spec({ ... }): NodeSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

defaultKeys: KeybindingsObject#

  • indent=Tab: Indents the listItem

  • outdent=Shift-Tab: Outdents the listItem

  • moveDown=Alt-ArrowDown: move listItem down

  • moveUp=Alt-ArrowUp: move listItem up

  • emptyCopy=Mod-c: Execute a clipboard copy on the node when the selection is empty.

  • emptyCut=Mod-x: Execute a clipboard cut on the node when the selection is empty.

  • insertEmptyListAbove=Mod-Shift-Enter: Insert a new list above the current list and move cursor to it.

  • insertEmptyListBelow=Mod-Enter: Insert a new list below the current list and move cursor to it.

commands: CommandObject#

  • indentListItem(): Command
    Indents list item one level. Can only indent 1 plus the parent's level.

  • outdentListItem(): QueryCommand<boolean>
    Outdents list item one level. If level is root, outdents to a paragraph.

Usage

import { orderedList, bulletList, listItem } from '@bangle.dev/core';
const specFactory = [
// other specs
listItem.spec(),
orderedList.spec(),
bulletList.spec(),
];
const plugins = [
// other plugins
listItem.plugins(),
orderedList.plugins(),
bulletList.spec(),
];

orderedList: Component#

Enables orderedList <ol/>. Requires node components with names bulletList, listItem to work.

spec(): NodeSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • markdownShortcut: ?boolean=true
    Enable the markdown shortcut for creating an ordered list. Type 1. followed by a space to create an ordered list.

defaultKeys: KeybindingsObject#

  • toggle=Shift-Ctrl-9: Executes toggleOrderedList command.

commands: CommandObject#

  • toggleOrderedList(): Command
    Convert to an orderedList and if already an orderedList, convert it to a paragraph node.

  • queryIsSelectionInsideOrderedList(): QueryCommand<boolean>
    Query if the selection is inside an ordered list.

Usage

import { orderedList, bulletList, listItem } from '@bangle.dev/core';
const specFactory = [
// other specs
listItem.spec(),
orderedList.spec(),
bulletList.spec(),
];
const plugins = [
// other plugins
listItem.plugins(),
orderedList.plugins(),
bulletList.spec(),
];

paragraph: Component#

Enables paragraph (<p/> in html) nodes in your editor. The spec for this component are required for Bangle to function, if a spec with a name=paragraph is not specified, Bangle will automatically default to this one.

spec(): NodeSpec#

Returns a spec, read more Your first editor guide.

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

defaultKeys: KeybindingsObject#

  • jumpToStartOfParagraph=Ctrl-a (mac) Ctrl-Home (linux/pc): Executes the jumpToStartOfParagraph command (see commands below).

  • jumpToEndOfParagraph=Ctrl-a (mac) Ctrl-Home (linux/pc): Executes the jumpToEndOfParagraph command (see commands below).

  • moveDown=Alt-ArrowDown: Move paragraph down.

  • moveUp=Alt-ArrowUp: Move paragraph up.

  • emptyCopy=Mod-c: Execute a clipboard copy on the node when the selection is empty.

  • emptyCut=Mod-x: Execute a clipboard cut on the node when the selection is empty.

  • insertEmptyParaAbove=Mod-Shift-Enter: Inserts an empty paragraph above.

  • insertEmptyParaBelow=Mod-Enter: Inserts an empty paragraph below.

  • convertToParagraph=Ctrl-Shift-0: Toggles a node to paragraph and vice versa.

commands: CommandObject#

  • jumpToStartOfParagraph(): Command
    Jumps the cursor to the start of paragraph.

  • jumpToEndOfParagraph(): Command
    Jumps the cursor to the end of paragraph.

  • convertToParagraph(): Command
    Coverts the node in selection to paragraph type.

  • queryIsParagraph(): QueryCommand<boolean>
    Query if it is paragraph under the selection.

  • queryIsTopLevelParagraph(): QueryCommand<boolean>
    Query if it is paragraph under the selection and it is a direct descendant of the top level node, which by default is doc.

Usage

import { blockquote } from '@bangle.dev/core';
const specFactory = [
// other specs
blockquote.spec(),
];
const plugins = [
// other plugins
blockquote.plugins(),
];

strike: Component#

Allows text in your editor to be marked as strike.

spec(): MarkSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

defaultKeys: KeybindingsObject#

  • toggleStrike = Mod-d: toggle a strike mark

commands: CommandObject#

  • toggleStrike(): Command
    Toggles strike mark.

  • queryIsStrikeActive(): QueryCommand<boolean>
    Query if the selection is inside a strike mark or not.

Usage

import { strike } from '@bangle.dev/core';
const specFactory = [
// other specs
strike.spec(),
];
const plugins = [
// other plugins
strike.plugins(),
];

text: Component#

The text node which the editor uses to wrap the text. The spec for this component are required for Bangle to function, if a spec named text is not defined, Bangle will automatically default to this one.

spec(): NodeSpec#

Creates a todoItem node spec with done attribute, read more Your first editor guide.

todoItem: Component#

Creates a todoItem with a done attribute. Requires node components with names todoList, bulletList,orderedList & listItem to work

spec({ ... }): NodeSpec#

Named parameters:

  • nested: boolean=true
    Allows nesting of todo items.

  • draggable: boolean=true
    Make todo items draggable.

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • nodeView: boolean=true
    If true, will use the default todoItem nodeView. Set it to false to disable the default todoItem nodeView. The typical use-case for setting it to false is when you want to use a custom nodeView for todoItem. See the section for more details.

defaultKeys: KeybindingsObject#

  • toggleDone=Ctrl-Enter (mac) Ctrl-I (linux/windows): Toggles the todo item's done status.

  • indent=Tab: Indents the todo item

  • outdent=Shift-Tab: Outdents the todo item

  • moveDown=Alt-ArrowDown: move todoItem down

  • moveUp=Alt-ArrowUp: move todoItem up

  • emptyCopy=Mod-c: Execute a clipboard copy on the node when the selection is empty.

  • emptyCut=Mod-x: Execute a clipboard cut on the node when the selection is empty.

  • insertEmptyParaAbove=Mod-Shift-Enter: Inserts an empty paragraph above.

  • insertEmptyParaBelow=Mod-Enter: Inserts an empty paragraph below.

commands: CommandObject#

  • toggleTodoItemDone(): Command
    Toggle the done attribute of the todo item in the selection.

  • queryTodoItemAttrs(): QueryCommand<?{done: boolean}>
    Query the todo item attributes.

Usage

import {
todoList,
todoItem,
orderedList,
bulletList,
listItem,
} from '@bangle.dev/core';
const specFactory = [
// other specs
listItem.spec(),
todoItem.spec(),
orderedList.spec(),
bulletList.spec(),
todoList.spec(),
];
const plugins = [
// other plugins
listItem.plugins(),
todoItem.plugins(),
orderedList.plugins(),
bulletList.plugins(),
todoList.plugins(),
];

todoList: Component#

A wrapper node component for todoItem, similar to how orderedList is a wrapper for listItem. Requires node components with names todoItem, bulletList,orderedList & listItem to work.

spec(): NodeSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

  • markdownShortcut: ?boolean=true
    Enable the markdown shortcut for creating a todo list. Type [ ] or [] followed by a space to create an unchecked todoList.

defaultKeys: KeybindingsObject#

  • toggle=Shift-Ctrl-7: Executes toggleTodoList command.

commands: CommandObject#

  • toggleTodoList(): Command
    Convert to an todoList and if already an todoList, convert it to a paragraph node.

  • queryIsTodoListActive(): QueryCommand<boolean>
    Query if the selection is inside a todo list.

Usage

See todoitem usage.

underline: Component#

Allows text in your editor to be marked with underlined style.

spec(): MarkSpec#

plugins({ ... }): Plugins#

Named parameters:

  • keybindings: ?KeybindingsObject=defaultKeys
    For a list of allowed keys see defaultKeys below.

defaultKeys: KeybindingsObject#

  • toggleUnderline = Mod-u: toggle an underline mark

commands: CommandObject#

  • toggleUnderline(): Command
    Toggles underline mark.

  • queryIsUnderlineActive(): QueryCommand<boolean>
    Query if the selection is inside an underline mark or not.

Usage

import { underline } from '@bangle.dev/core';
const specFactory = [
// other specs
underline.spec(),
];
const plugins = [
// other plugins
underline.plugins(),
];
Edit this page