Array of Portable Text blocks and other arbitrary types
Mode to use for nesting, direct or html
Array of potentially nested nodes optimized for rendering
Takes an array of blocks and returns an array of nodes optimized for rendering in HTML-like environment, where lists are nested inside of eachother instead of appearing "flat" as in native Portable Text data structures.
Note that the list node is not a native Portable Text node type, and thus is represented
using the @list type name ({_type: '@list'}).
The nesting can be configured in two modes:
direct: deeper list nodes will appear as a direct child of the parent listhtml, deeper list nodes will appear as a child of the last list item in the parent listWhen using direct, all list nodes will be of type ToolkitPortableTextDirectList,
while with html they will be of type ToolkitPortableTextHtmlList
These modes are available as LIST_NEST_MODE_HTML and LIST_NEST_MODE_DIRECT.
In both modes, a list node is always nested as deeply as its level says it is. List items can
start at any level and skip any number of levels, so the levels that were never authored are
generated to keep the two in sync - meaning renderers can indent by tree depth or by level and
get the same result. A generated list holds an empty list item in html mode, since HTML can
only nest a list inside a list item, and holds nothing but the deeper list in direct mode.
Array of Portable Text blocks and other arbitrary types
Mode to use for nesting, direct or html
Array of potentially nested nodes optimized for rendering
Takes an array of blocks and returns an array of nodes optimized for rendering in HTML-like environment, where lists are nested inside of eachother instead of appearing "flat" as in native Portable Text data structures.
Note that the list node is not a native Portable Text node type, and thus is represented
using the @list type name ({_type: '@list'}).
The nesting can be configured in two modes:
direct: deeper list nodes will appear as a direct child of the parent listhtml, deeper list nodes will appear as a child of the last list item in the parent listWhen using direct, all list nodes will be of type ToolkitPortableTextDirectList,
while with html they will be of type ToolkitPortableTextHtmlList
These modes are available as LIST_NEST_MODE_HTML and LIST_NEST_MODE_DIRECT.
In both modes, a list node is always nested as deeply as its level says it is. List items can
start at any level and skip any number of levels, so the levels that were never authored are
generated to keep the two in sync - meaning renderers can indent by tree depth or by level and
get the same result. A generated list holds an empty list item in html mode, since HTML can
only nest a list inside a list item, and holds nothing but the deeper list in direct mode.
Array of Portable Text blocks and other arbitrary types
Mode to use for nesting, direct or html
Array of potentially nested nodes optimized for rendering
Takes an array of blocks and returns an array of nodes optimized for rendering in HTML-like environment, where lists are nested inside of eachother instead of appearing "flat" as in native Portable Text data structures.
Note that the list node is not a native Portable Text node type, and thus is represented using the
@listtype name ({_type: '@list'}).The nesting can be configured in two modes:
direct: deeper list nodes will appear as a direct child of the parent listhtml, deeper list nodes will appear as a child of the last list item in the parent listWhen using
direct, all list nodes will be of type ToolkitPortableTextDirectList, while withhtmlthey will be of type ToolkitPortableTextHtmlListThese modes are available as LIST_NEST_MODE_HTML and LIST_NEST_MODE_DIRECT.
In both modes, a list node is always nested as deeply as its
levelsays it is. List items can start at any level and skip any number of levels, so the levels that were never authored are generated to keep the two in sync - meaning renderers can indent by tree depth or byleveland get the same result. A generated list holds an empty list item inhtmlmode, since HTML can only nest a list inside a list item, and holds nothing but the deeper list indirectmode.