{"route":"/en-US-v0.13.1/reference/visualize/rect/","title":"Rectangle","description":"Documentation for the `rect` 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-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-body","name":"body","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"rect","title":"Rectangle","keywords":[],"oneliner":"A rectangle with optional content.","element":true,"contextual":false,"deprecation":null,"details":"

A rectangle with optional content.

\n

Example

\n
// Without content.\n#rect(width: 35%, height: 30pt)\n\n// With content.\n#rect[\n  Automatically sized \\\n  to fit the content.\n]\n
\"Preview\"
","example":null,"self":false,"params":[{"name":"width","details":"

The rectangle's width, relative to its parent container.

","example":null,"types":["auto","relative"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"height","details":"

The rectangle's height, relative to its parent container.

","example":null,"types":["auto","relative","fraction"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"fill","details":"

How to fill the rectangle.

\n

When setting a fill, the default stroke disappears. To create a\nrectangle with both fill and stroke, you have to configure both.

","example":"
#rect(fill: blue)\n
\"Preview\"
","types":["none","color","gradient","tiling"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"stroke","details":"

How to stroke the rectangle. This can be:

\n","example":"
#stack(\n  dir: ltr,\n  spacing: 1fr,\n  rect(stroke: red),\n  rect(stroke: 2pt),\n  rect(stroke: 2pt + red),\n)\n
\"Preview\"
","types":["none","auto","length","color","gradient","stroke","tiling","dictionary"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"radius","details":"

How much to round the rectangle's corners, relative to the minimum of\nthe width and height divided by two. This can be:

\n","example":"
#set rect(stroke: 4pt)\n#rect(\n  radius: (\n    left: 5pt,\n    top-right: 20pt,\n    bottom-right: 10pt,\n  ),\n  stroke: (\n    left: red,\n    top: yellow,\n    right: green,\n    bottom: blue,\n  ),\n)\n
\"Preview\"
","types":["relative","dictionary"],"strings":[],"default":"(:)","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"inset","details":"

How much to pad the rectangle's content.\nSee the box's documentation for more details.

","example":null,"types":["relative","dictionary"],"strings":[],"default":"0% + 5pt","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"outset","details":"

How much to expand the rectangle's size without affecting the layout.\nSee the box's documentation for more details.

","example":null,"types":["relative","dictionary"],"strings":[],"default":"(:)","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":"

The content to place into the rectangle.

\n

When this is omitted, the rectangle takes on a default size of at most\n45pt by 30pt.

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