{"route":"/en-US-v0.14.1/reference/model/list/","title":"Bullet List","description":"Documentation for the `list` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"syntax","name":"Syntax","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-tight","name":"tight","children":[]},{"id":"parameters-marker","name":"marker","children":[]},{"id":"parameters-indent","name":"indent","children":[]},{"id":"parameters-body-indent","name":"body-indent","children":[]},{"id":"parameters-spacing","name":"spacing","children":[]},{"id":"parameters-children","name":"children","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-item","name":"Bullet List Item","children":[{"id":"definitions-item-body","name":"body","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"list","title":"Bullet List","keywords":[],"oneliner":"A bullet list.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A bullet list.

\n

Displays a sequence of items vertically, with each item introduced by a\nmarker.

\n

Example

\n
Normal list.\n- Text\n- Math\n- Layout\n- ...\n\nMultiple lines.\n- This list item spans multiple\n  lines because it is indented.\n\nFunction call.\n#list(\n  [Foundations],\n  [Calculate],\n  [Construct],\n  [Data Loading],\n)\n
\"Preview\"
\n

Syntax

\n

This functions also has dedicated syntax: Start a line with a hyphen,\nfollowed by a space to create a list item. A list item can contain multiple\nparagraphs and other block-level content. All content that is indented\nmore than an item's marker becomes part of that item.

"}],"self":false,"params":[{"name":"tight","details":[{"kind":"html","content":"

Defines the default spacing of the list. If it is\nfalse, the items are spaced apart with\nparagraph spacing. If it is true, they use\nparagraph leading instead. This makes the list more\ncompact, which can look better if the items are short.

\n

In markup mode, the value of this parameter is determined based on\nwhether items are separated with a blank line. If items directly follow\neach other, this is set to true; if items are separated by a blank\nline, this is set to false. The markup-defined tightness cannot be\noverridden with set rules.

"},{"kind":"example","content":{"body":"
- If a list has a lot of text, and\n  maybe other inline content, it\n  should not be tight anymore.\n\n- To make a list wide, simply insert\n  a blank line between the items.\n
\"Preview\"
","title":null}}],"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"marker","details":[{"kind":"html","content":"

The marker which introduces each item.

\n

Instead of plain content, you can also pass an array with multiple\nmarkers that should be used for nested lists. If the list nesting depth\nexceeds the number of markers, the markers are cycled. For total\ncontrol, you may pass a function that maps the list's nesting depth\n(starting from 0) to a desired marker.

"},{"kind":"example","content":{"body":"
#set list(marker: [--])\n- A more classic list\n- With en-dashes\n\n#set list(marker: ([•], [--]))\n- Top-level\n  - Nested\n  - Items\n- Items\n
\"Preview\"
","title":null}}],"types":["content","array","function"],"strings":[],"default":"([•], [‣], [–])","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"indent","details":[{"kind":"html","content":"

The indent of each item.

"}],"types":["length"],"strings":[],"default":"0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body-indent","details":[{"kind":"html","content":"

The spacing between the marker and the body of each item.

"}],"types":["length"],"strings":[],"default":"0.5em","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"spacing","details":[{"kind":"html","content":"

The spacing between the items of the list.

\n

If set to auto, uses paragraph leading for tight\nlists and paragraph spacing for wide (non-tight)\nlists.

"}],"types":["auto","length"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"children","details":[{"kind":"html","content":"

The bullet list's children.

\n

When using the list syntax, adjacent items are automatically collected\ninto lists, even through constructs like for loops.

"},{"kind":"example","content":{"body":"
#for letter in "ABC" [\n  - Letter #letter\n]\n
\"Preview\"
","title":null}}],"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["content"],"scope":[{"path":["list"],"name":"item","title":"Bullet List Item","keywords":[],"oneliner":"A bullet list item.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A bullet list item.

"}],"self":false,"params":[{"name":"body","details":[{"kind":"html","content":"

The item's body.

"}],"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["content"],"scope":[]}]}}}