{"route":"/en-US-v0.14.1/reference/text/linebreak/","title":"Line Break","description":"Documentation for the `linebreak` 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-justify","name":"justify","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"linebreak","title":"Line Break","keywords":[],"oneliner":"Inserts a line break.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"<p>Inserts a line break.</p>\n<p>Advances the paragraph to the next line. A single trailing line break at the\nend of a paragraph is ignored, but more than one creates additional empty\nlines.</p>\n<h2 id=\"example\">Example</h2>\n<div class=\"previewed-code\"><pre><code><span class=\"typ-strong\">*Date:*</span> 26.12.2022 <span class=\"typ-escape\">\\</span>\n<span class=\"typ-strong\">*Topic:*</span> Infrastructure Test <span class=\"typ-escape\">\\</span>\n<span class=\"typ-strong\">*Severity:*</span> High <span class=\"typ-escape\">\\</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.14.1/assets/384cb289bb242b86c8b1387b41ca7b38.png\" alt=\"Preview\"></div></div>\n<h2 id=\"syntax\">Syntax</h2>\n<p>This function also has dedicated syntax: To insert a line break, simply write\na backslash followed by whitespace. This always creates an unjustified\nbreak.</p>"}],"self":false,"params":[{"name":"justify","details":[{"kind":"html","content":"<p>Whether to justify the line before the break.</p>\n<p>This is useful if you found a better line break opportunity in your\njustified text than Typst did.</p>"},{"kind":"example","content":{"body":"<div class=\"previewed-code\"><pre><code><span class=\"typ-key\">#</span><span class=\"typ-key\">set</span> <span class=\"typ-func\">par</span><span class=\"typ-punct\">(</span>justify<span class=\"typ-punct\">:</span> <span class=\"typ-key\">true</span><span class=\"typ-punct\">)</span>\n<span class=\"typ-key\">#</span><span class=\"typ-key\">let</span> jb <span class=\"typ-op\">=</span> <span class=\"typ-func\">linebreak</span><span class=\"typ-punct\">(</span>justify<span class=\"typ-punct\">:</span> <span class=\"typ-key\">true</span><span class=\"typ-punct\">)</span>\n\nI have manually tuned the <span class=\"typ-pol\">#</span><span class=\"typ-pol\">jb</span>\nline breaks in this paragraph <span class=\"typ-pol\">#</span><span class=\"typ-pol\">jb</span>\nfor an <span class=\"typ-emph\">_interesting_</span> result. <span class=\"typ-pol\">#</span><span class=\"typ-pol\">jb</span>\n</code></pre><div class=\"preview\"><img src=\"/en-US-v0.14.1/assets/4652670040cf88f551099ee9a0e1d33b.png\" alt=\"Preview\"></div></div>","title":null}}],"types":["bool"],"strings":[],"default":"<code><span class=\"typ-key\">false</span></code>","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]}}}