slate-edit-list/dist/options.js.flow

A Slate plugin to handle keyboard events in lists.

// @flow
import type { Node } from 'slate';
import { Record } from 'immutable';

export type OptionsFormat = {
    types?: string[],
    typeItem?: string,
    typeDefault?: string,
    canMerge?: (listA: Node, listB: Node) => boolean
};

/**
 * The plugin options
 */
class Options extends Record({
    types: ['ul_list', 'ol_list'],
    typeItem: 'list_item',
    typeDefault: 'paragraph',
    canMerge: (a: Node, b: Node) => a.type === b.type
}) {
    // The possibles types for list containers
    types: string[];
    // The type of list items
    typeItem: string;
    // The type of default block in items
    typeDefault: string;
    // You can control here the automatic merging of adjacent lists
    canMerge: (listA: Node, listB: Node) => boolean;
}

export default Options;