@portabletext/toolkit - v3.0.1
    Preparing search index...

    Interface ToolkitPortableTextListItem

    Toolkit-specific type representing a list item block, but where the children can be another list

    interface ToolkitPortableTextListItem {
        _type: string;
        children: (ToolkitPortableTextList | PortableTextSpan)[];
        listItem: string;
        _key?: string;
        markDefs?: PortableTextMarkDefinition[];
        style?: string;
        level?: number;
    }

    Hierarchy

    • PortableTextListItemBlock<
          PortableTextMarkDefinition,
          PortableTextSpan
          | ToolkitPortableTextList,
      >
      • ToolkitPortableTextListItem
    Index

    Properties

    _type: string

    Type name identifying this as a portable text block. All items within a portable text array should have a _type property.

    Usually 'block', but can be customized to other values

    children: (ToolkitPortableTextList | PortableTextSpan)[]

    Array of inline items for this block. Usually contain text spans, but can be configured to include inline objects of other types as well.

    listItem: string
    _key?: string

    A key that identifies this block uniquely within the parent array. Used to more easily address the block when editing collaboratively, but is also very useful for keys inside of React and other rendering frameworks that can use keys to optimize operations.

    markDefs?: PortableTextMarkDefinition[]

    Array of mark definitions used in child text spans. By having them be on the block level, the same mark definition can be reused for multiple text spans, which is often the case with nested marks.

    style?: string

    Visual style of the block Common values: 'normal', 'blockquote', 'h1'...'h6'

    level?: number

    If this block is a list item, identifies which level of nesting it belongs within