Trevixal API
    Preparing search index...

    Module @trevixal/extension-blocks

    @trevixal/extension-blocks

    CI npm types license

    Documentation · Live editor · Changelog · Issues

    The Trevixal editor

    • Callouts, toggles, columns, cards and timelines
    • Page breaks, badges, buttons, footnotes and anchors
    • 6.8 kB minified and gzipped, with TypeScript types in the package

    The structural blocks a document needs beyond paragraphs and lists: callouts, toggles, columns, cards, timelines, tabs, accordions, footnotes and citations.

    npm install @trevixal/extension-blocks
    

    Merge the nodes into your schema:

    new Schema({ nodes: { ...defaultNodes(), ...blockNodes() }, marks: defaultMarks() })
    
    import { blockKeymap, blockBindings, insertCallout, insertColumns } from '@trevixal/extension-blocks'

    const editor = createEditor({ schema, element, keymap: blockKeymap() })
    blockBindings(editor) // click handling for toggles, tabs and accordions

    editor.exec(insertCallout('warning'))
    editor.exec(insertColumns(3))
    Block Commands
    Callout, five tones insertCallout(variant), setCalloutVariant
    Toggle insertToggleBlock, toggleToggleOpen
    Columns, 2-4 insertColumns(count), setColumnCount
    Card, timeline insertCard, insertTimeline, insertTimelineItem
    Tabs insertTabs(count), addTab, removeTab, moveTab, activateTab
    Accordion insertAccordion, addAccordionItem, setAccordionItemOpen, toggleAccordionExclusive
    Badge, button, anchor insertBadge, insertButton, insertAnchor
    Footnotes, citations insertFootnote, insertCitation, insertReferenceList, renumberCitations
    Page break insertPageBreak

    blockKeymap() supplies the two gestures every nested block needs. Enter on an empty trailing paragraph inside a container leaves it, without that, a callout at the end of the document traps the cursor, because every Enter makes another paragraph inside it. Enter on a toggle summary, tab title or accordion title moves into the body rather than splitting the title.

    An accordion is a native <details>, so it keeps working in a saved file because the browser owns it. A tab strip is laid out from a data-active attribute that only the editor moves, so @trevixal/ui inlines a small script into exports to make the titles work there too. Before adding an interactive block, decide what it does in an export, and add the print rule, or the PDF quietly loses whatever is not on top.

    Apache-2.0

    SourceFileError
    AccordionContext
    AdvancedBlocksOptions
    BlockUICommands
    CaptionListEntry
    CaptionOptions
    CitationAuthor
    CitationSource
    ImportedSource
    IndexEntry
    IndexEntryOptions
    IndexLocation
    MapNodeOptions
    PollOption
    ReferenceMatch
    ReferenceTarget
    TabsContext
    BadgeTone
    CalloutVariant
    CaptionKind
    CaptionPosition
    CitationStyle
    CrossReferenceFormat
    NoteColor
    ReferenceKind
    TabDirection
    addAccordionItem
    addTab
    BADGE_TONES
    CALLOUT_VARIANTS
    CAPTION_KINDS
    CITATION_STYLES
    CROSS_REFERENCE_FORMATS
    DEFAULT_CITATION_STYLE
    enterFromTitle
    escapeContainerOnEnter
    insertCard
    insertDocumentIndex
    insertPageBreak
    insertReferenceList
    insertTimeline
    insertTimelineItem
    insertToggleBlock
    liftOutOfContainer
    MAX_COLUMNS
    MAX_SECTIONS
    MIN_COLUMNS
    MISSING_REFERENCE
    NOTE_COLORS
    OSM_ATTRIBUTION
    OSM_TILES
    removeAccordionItem
    removeTab
    renumberCitations
    splitReferenceItem
    toggleAccordionExclusive
    toggleToggleOpen
    accordionContextAt
    activateTab
    activateTabAt
    advancedBlockNodes
    badgeTone
    blockBindings
    blockKeymap
    blockNodes
    blockUICommands
    calloutVariant
    captionKind
    citationAt
    citationLabel
    citationStyleOf
    clampColumnCount
    closeOtherItems
    conditionMet
    crossReferenceFormat
    documentIds
    enableAdvancedBlocks
    endnoteLabel
    fieldSteps
    formatReference
    freshId
    importSources
    insertAccordion
    insertAnchor
    insertBadge
    insertButton
    insertCallout
    insertCaption
    insertCaptionList
    insertCitation
    insertColumns
    insertCrossReference
    insertEndnote
    insertFootnote
    insertMap
    insertMarginNote
    insertPoll
    insertSectionBreak
    insertTabs
    installFieldUpdater
    isCitationStyle
    isContainerNode
    isContentContainerNode
    isTitleNode
    markIndexEntry
    moveTab
    parseBibTeX
    parseCoordinates
    parseCSLJSON
    parseSource
    parseSources
    pollOptions
    referenceChoices
    referenceFor
    referenceMarks
    referenceNodes
    referenceSortKey
    referenceTargets
    referenceText
    refreshFields
    resolveConditionals
    safeAnchorId
    setAccordionItemOpen
    setAccordionItemOpenAt
    setCalloutVariant
    setCitationStyle
    setColumnCount
    setTemplateVariables
    tabsContextAt
    tileOf
    updateFieldsTransform
    wrapInConditional