{"route":"/en-US-v0.14.1/reference/foundations/content/","title":"Content","description":"Documentation for the Content type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"representation","name":"Representation","children":[]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-func","name":"Func","children":[]},{"id":"definitions-has","name":"Has","children":[{"id":"definitions-has-field","name":"field","children":[]}]},{"id":"definitions-at","name":"At","children":[{"id":"definitions-at-field","name":"field","children":[]},{"id":"definitions-at-default","name":"default","children":[]}]},{"id":"definitions-fields","name":"Fields","children":[]},{"id":"definitions-location","name":"Location","children":[]}]}],"body":{"kind":"type","content":{"name":"content","title":"Content","keywords":[],"oneliner":"A piece of document content.","details":"

A piece of document content.

\n

This type is at the heart of Typst. All markup you write and most\nfunctions you call produce content values. You can create a\ncontent value by enclosing markup in square brackets. This is also how you\npass content to functions.

\n

Example

\n
Type of *Hello!* is\n#type([*Hello!*])\n
\"Preview\"
\n

Content can be added with the + operator,\njoined together and multiplied with integers. Wherever\ncontent is expected, you can also pass a string or none.

\n

Representation

\n

Content consists of elements with fields. When constructing an element with\nits element function, you provide these fields as arguments and when you\nhave a content value, you can access its fields with field access\nsyntax.

\n

Some fields are required: These must be provided when constructing an\nelement and as a consequence, they are always available through field access\non content of that type. Required fields are marked as such in the\ndocumentation.

\n

Most fields are optional: Like required fields, they can be passed to the\nelement function to configure them for a single element. However, these can\nalso be configured with set rules to apply them to\nall elements within a scope. Optional fields are only available with field\naccess syntax when they were explicitly passed to the element function, not\nwhen they result from a set rule.

\n

Each element has a default appearance. However, you can also completely\ncustomize its appearance with a show rule. The show\nrule is passed the element. It can access the element's field and produce\narbitrary content from it.

\n

In the web app, you can hover over a content variable to see exactly which\nelements the content is composed of and what fields they have.\nAlternatively, you can inspect the output of the repr function.

","constructor":null,"scope":[{"path":["content"],"name":"func","title":"Func","keywords":[],"oneliner":"The content's element function.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

The content's element function. This function can be used to create the element\ncontained in this content. It can be used in set and show rules for the\nelement. Can be compared with global functions to check whether you have\na specific\nkind of element.

"}],"self":true,"params":[],"returns":["function"],"scope":[]},{"path":["content"],"name":"has","title":"Has","keywords":[],"oneliner":"Whether the content has the specified field.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Whether the content has the specified field.

"}],"self":true,"params":[{"name":"field","details":[{"kind":"html","content":"

The field to look for.

"}],"types":["str"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["bool"],"scope":[]},{"path":["content"],"name":"at","title":"At","keywords":[],"oneliner":"Access the specified field on the content.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Access the specified field on the content. Returns the default value if\nthe field does not exist or fails with an error if no default value was\nspecified.

"}],"self":true,"params":[{"name":"field","details":[{"kind":"html","content":"

The field to access.

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

A default value to return if the field does not exist.

"}],"types":["any"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["content"],"name":"fields","title":"Fields","keywords":[],"oneliner":"Returns the fields of this content.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the fields of this content.

"},{"kind":"example","content":{"body":"
#rect(\n  width: 10cm,\n  height: 10cm,\n).fields()\n
\"Preview\"
","title":null}}],"self":true,"params":[],"returns":["dictionary"],"scope":[]},{"path":["content"],"name":"location","title":"Location","keywords":[],"oneliner":"The location of the content.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

The location of the content. This is only available on content returned\nby query or provided by a show rule,\nfor other content it will be none. The resulting location can be\nused with counters, state and queries.

"}],"self":true,"params":[],"returns":["none","location"],"scope":[]}]}}}