{"route":"/en-US-v0.13.1/reference/visualize/square/","title":"Square","description":"Documentation for the `square` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-size","name":"size","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":"square","title":"Square","keywords":[],"oneliner":"A square with optional content.","element":true,"contextual":false,"deprecation":null,"details":"

A square with optional content.

\n

Example

\n
// Without content.\n#square(size: 40pt)\n\n// With content.\n#square[\n  Automatically \\\n  sized to fit.\n]\n
\"Preview\"
","example":null,"self":false,"params":[{"name":"size","details":"

The square's side length. This is mutually exclusive with width and\nheight.

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

The square's width. This is mutually exclusive with size and height.

\n

In contrast to size, this can be relative to the parent container's\nwidth.

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

The square's height. This is mutually exclusive with size and width.

\n

In contrast to size, this can be relative to the parent container's\nheight.

","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 square. See the rectangle's documentation\nfor more details.

","example":null,"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 square. See the\nrectangle's documentation for more details.

","example":null,"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 square's corners. See the\nrectangle's documentation for more details.

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

How much to pad the square's content. See the\nbox'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 square's size without affecting the layout. See\nthe 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 square. The square expands to fit this\ncontent, keeping the 1-1 aspect ratio.

\n

When this is omitted, the square takes on a default size of at most\n30pt.

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