{"route":"/en-US-v0.14.1/reference/layout/box/","title":"Box","description":"Documentation for the `box` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-width","name":"width","children":[]},{"id":"parameters-height","name":"height","children":[]},{"id":"parameters-baseline","name":"baseline","children":[]},{"id":"parameters-fill","name":"fill","children":[]},{"id":"parameters-stroke","name":"stroke","children":[]},{"id":"parameters-radius","name":"radius","children":[]},{"id":"parameters-inset","name":"inset","children":[]},{"id":"parameters-outset","name":"outset","children":[]},{"id":"parameters-clip","name":"clip","children":[]},{"id":"parameters-body","name":"body","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"box","title":"Box","keywords":[],"oneliner":"An inline-level container that sizes content.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

An inline-level container that sizes content.

\n

All elements except inline math, text, and boxes are block-level and cannot\noccur inside of a paragraph. The box function can be used to\nintegrate such elements into a paragraph. Boxes take the size of their\ncontents by default but can also be sized explicitly.

\n

Example

\n
Refer to the docs\n#box(\n  height: 9pt,\n  image("docs.svg")\n)\nfor more information.\n
\"Preview\"
"}],"self":false,"params":[{"name":"width","details":[{"kind":"html","content":"

The width of the box.

\n

Boxes can have fractional widths, as the example below\ndemonstrates.

\n

Note: Currently, only boxes and only their widths might be fractionally\nsized within paragraphs. Support for fractionally sized images, shapes,\nand more might be added in the future.

"},{"kind":"example","content":{"body":"
Line in #box(width: 1fr, line(length: 100%)) between.\n
\"Preview\"
","title":null}}],"types":["auto","relative","fraction"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"height","details":[{"kind":"html","content":"

The height of the box.

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

An amount to shift the box's baseline by.

"},{"kind":"example","content":{"body":"
Image: #box(baseline: 40%, image("tiger.jpg", width: 2cm)).\n
\"Preview\"
","title":null}}],"types":["relative"],"strings":[],"default":"0% + 0pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"fill","details":[{"kind":"html","content":"

The box's background color. See the\nrectangle's documentation for more details.

"}],"types":["none","color","gradient","tiling"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"stroke","details":[{"kind":"html","content":"

The box's border color. See the\nrectangle's documentation for more details.

"}],"types":["none","length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"(:)","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"radius","details":[{"kind":"html","content":"

How much to round the box's corners. See the\nrectangle's documentation for more details.

"}],"types":["relative","dictionary"],"strings":[],"default":"(:)","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"inset","details":[{"kind":"html","content":"

How much to pad the box's content.

\n

This can be a single length for all sides or a dictionary of lengths\nfor individual sides. When passing a dictionary, it can contain the\nfollowing keys in order of precedence: top, right, bottom, left\n(controlling the respective cell sides), x, y (controlling vertical\nand horizontal insets), and rest (covers all insets not styled by\nother dictionary entries). All keys are optional; omitted keys will use\ntheir previously set value, or the default value if never set.

\n

Relative lengths for this parameter are relative to the box\nsize excluding outset. Note that relative insets and\noutsets are different from relative widths and\nheights, which are relative to the container.

\n

Note: When the box contains text, its exact size depends on the\ncurrent text edges.

"},{"kind":"example","content":{"body":"
#rect(inset: 0pt)[Tight]\n
\"Preview\"
","title":null}}],"types":["relative","dictionary"],"strings":[],"default":"(:)","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"outset","details":[{"kind":"html","content":"

How much to expand the box's size without affecting the layout.

\n

This can be a single length for all sides or a dictionary of lengths for\nindividual sides. Relative lengths for this parameter are\nrelative to the box size excluding outset. See the documentation for\ninset above for further details.

\n

This is useful to prevent padding from affecting line layout. For a\ngeneralized version of the example below, see the documentation for the\nraw text's block parameter.

"},{"kind":"example","content":{"body":"
An inline\n#box(\n  fill: luma(235),\n  inset: (x: 3pt, y: 0pt),\n  outset: (y: 3pt),\n  radius: 2pt,\n)[rectangle].\n
\"Preview\"
","title":null}}],"types":["relative","dictionary"],"strings":[],"default":"(:)","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"clip","details":[{"kind":"html","content":"

Whether to clip the content inside the box.

\n

Clipping is useful when the box's content is larger than the box itself,\nas any content that exceeds the box's bounds will be hidden.

"},{"kind":"example","content":{"body":"
#box(\n  width: 50pt,\n  height: 50pt,\n  clip: true,\n  image("tiger.jpg", width: 100pt, height: 100pt)\n)\n
\"Preview\"
","title":null}}],"types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":[{"kind":"html","content":"

The contents of the box.

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