Skip to content

Vizel API / core/src / createVizelDetailsExtensions

Function: createVizelDetailsExtensions()

ts
function createVizelDetailsExtensions(options?): Extensions;

Defined in: packages/core/src/extensions/details.ts:78

Creates details extensions for collapsible content blocks.

Markdown round-trip uses raw HTML (<details> / <summary>), which tiptap-markdown supports because html: true is enabled by default. On the way in, markdown-it preserves the inline HTML and Tiptap's parseHTML rules hydrate the nodes.

Parameters

ParameterType
optionsVizelDetailsOptions

Returns

Extensions

Example

typescript
import { createVizelDetailsExtensions } from '@vizel/core'

const extensions = createVizelDetailsExtensions({
  details: { HTMLAttributes: { "data-testid": "details" } }
})

Released under the MIT License.