{"route":"/en-US-v0.14.1/reference/foundations/symbol/","title":"Symbol","description":"Documentation for the Symbol type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"constructor","name":"Constructor","children":[{"id":"constructor-variants","name":"variants","children":[]}]}],"body":{"kind":"type","content":{"name":"symbol","title":"Symbol","keywords":[],"oneliner":"A Unicode symbol.","details":"

A Unicode symbol.

\n

Typst defines common symbols so that they can easily be written with\nstandard keyboards. The symbols are defined in modules, from which they can\nbe accessed using field access notation:

\n\n

Moreover, you can define custom symbols with this type's constructor\nfunction.

\n
#sym.arrow.r \\\n#sym.gt.eq.not \\\n$gt.eq.not$ \\\n#emoji.face.halo\n
\"Preview\"
\n

Many symbols have different variants, which can be selected by appending the\nmodifiers with dot notation. The order of the modifiers is not relevant.\nVisit the documentation pages of the symbol modules and click on a symbol to\nsee its available variants.

\n
$arrow.l$ \\\n$arrow.r$ \\\n$arrow.t.quad$\n
\"Preview\"
","constructor":{"path":[],"name":"symbol","title":"Construct","keywords":[],"oneliner":"Create a custom symbol with modifiers.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Create a custom symbol with modifiers.

"},{"kind":"example","content":{"body":"
#let envelope = symbol(\n  "🖂",\n  ("stamped", "🖃"),\n  ("stamped.pen", "🖆"),\n  ("lightning", "🖄"),\n  ("fly", "🖅"),\n)\n\n#envelope\n#envelope.stamped\n#envelope.stamped.pen\n#envelope.lightning\n#envelope.fly\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"variants","details":[{"kind":"html","content":"

The variants of the symbol.

\n

Can be a just a string consisting of a single character for the\nmodifierless variant or an array with two strings specifying the modifiers\nand the symbol. Individual modifiers should be separated by dots. When\ndisplaying a symbol, Typst selects the first from the variants that have\nall attached modifiers and the minimum number of other modifiers.

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