View

View is a general purpose container with no specific semantics that can be used for custom styling purposes. It supports Spectrum style props to ensure consistency with other Spectrum components.

install	`yarn add @react-spectrum/view`
version	3.1.0
usage	`import {View} from '@react-spectrum/view'`

View repository

GitHub

View package

NPM

Introduction#

The View component can be used as a general purpose container element, similar to a div. It supports Spectrum style props, which enable you to use Spectrum variables for styling to ensure consistency with other Spectrum components. In addition, Spectrum variables automatically adapt to color scheme changes (e.g. dark mode), and platform scale (e.g. touch vs. mouse input). See Styling to learn more.

Example#

The following example shows how you might build a container element using Spectrum defined variables for the border and padding. Use the color scheme and scale pickers to see how the view changes automatically based on these variables.

<View
  borderWidth="thin"
  borderColor="dark"
  borderRadius="medium"
  padding="size-250">
  <TextField label="Name" placeholder="John Smith" />
</View>

<View
  borderWidth="thin"
  borderColor="dark"
  borderRadius="medium"
  padding="size-250">
  <TextField label="Name" placeholder="John Smith" />
</View>

<View
  borderWidth="thin"
  borderColor="dark"
  borderRadius="medium"
  padding="size-250">
  <TextField
    label="Name"
    placeholder="John Smith"
  />
</View>

Props#

Name	Type	Default	Description
`elementType`	`string \| JSXElementConstructor<any>`	—	The element to render as the node.
`children`	`ReactNode`	—	Children to be displayed in the View.

Layout

Name	Type	Default	Description
`flex`	`string \| number \| boolean`	—	When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
`flexGrow`	`number`	—	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`number`	—	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`number \| string`	—	When used in a flex layout, specifies the initial main size of the element. See MDN.
`alignSelf`	`'auto' \| 'normal' \| 'start' \| 'end' \| 'center' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'stretch'`	—	Overrides the `alignItems` property of a flex or grid container. See MDN.
`justifySelf`	`'auto' \| 'normal' \| 'start' \| 'end' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'center' \| 'left' \| 'right' \| 'stretch'`	—	Specifies how the element is justified inside a flex or grid container. See MDN.
`order`	`number`	—	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`string`	—	When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
`gridColumn`	`string`	—	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`string`	—	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`string`	—	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`string`	—	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`string`	—	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`string`	—	When used in a grid layout, specifies the ending row to span within the grid. See MDN.
`overflow`	`string`	—	Species what to do when the element's content is too long to fit its size. See MDN.

Spacing

Name	Type	Default	Description
`margin`	`DimensionValue`	—	The margin for all four sides of the element. See MDN.
`marginTop`	`DimensionValue`	—	The margin for the top side of the element. See MDN.
`marginBottom`	`DimensionValue`	—	The margin for the bottom side of the element. See MDN.
`marginStart`	`DimensionValue`	—	The margin for the logical start side of the element, depending on layout direction. See MDN.
`marginEnd`	`DimensionValue`	—	The margin for the logical end side of an element, depending on layout direction. See MDN.
`marginX`	`DimensionValue`	—	The margin for both the left and right sides of the element. See MDN.
`marginY`	`DimensionValue`	—	The margin for both the top and bottom sides of the element. See MDN.
`padding`	`DimensionValue`	—	The padding for all four sides of the element. See MDN.
`paddingTop`	`DimensionValue`	—	The padding for the top side of the element. See MDN.
`paddingBottom`	`DimensionValue`	—	The padding for the bottom side of the element. See MDN.
`paddingStart`	`DimensionValue`	—	The padding for the logical start side of the element, depending on layout direction. See MDN.
`paddingEnd`	`DimensionValue`	—	The padding for the logical end side of an element, depending on layout direction. See MDN.
`paddingX`	`DimensionValue`	—	The padding for both the left and right sides of the element. See MDN.
`paddingY`	`DimensionValue`	—	The padding for both the top and bottom sides of the element. See MDN.

Sizing

Name	Type	Default	Description
`width`	`DimensionValue`	—	The width of the element. See MDN.
`minWidth`	`DimensionValue`	—	The minimum width of the element. See MDN.
`maxWidth`	`DimensionValue`	—	The maximum width of the element. See MDN.
`height`	`DimensionValue`	—	The height of the element. See MDN.
`minHeight`	`DimensionValue`	—	The minimum height of the element. See MDN.
`maxHeight`	`DimensionValue`	—	The maximum height of the element. See MDN.

Background

Name	Type	Default	Description
`backgroundColor`	`BackgroundColorValue`	—	The background color for the element.

Borders

Name	Type	Default	Description
`borderWidth`	`BorderSizeValue`	—	The width of the element's border on all four sides. See MDN.
`borderStartWidth`	`BorderSizeValue`	—	The width of the border on the logical start side, depending on the layout direction. See MDN.
`borderEndWidth`	`BorderSizeValue`	—	The width of the border on the logical end side, depending on the layout direction. See MDN.
`borderTopWidth`	`BorderSizeValue`	—	The width of the top border. See MDN.
`borderBottomWidth`	`BorderSizeValue`	—	The width of the bottom border. See MDN.
`borderXWidth`	`BorderSizeValue`	—	The width of the left and right borders. See MDN.
`borderYWidth`	`BorderSizeValue`	—	The width of the top and bottom borders. See MDN.
`borderColor`	`BorderColorValue`	—	The color of the element's border on all four sides. See MDN.
`borderStartColor`	`BorderColorValue`	—	The color of the border on the logical start side, depending on the layout direction. See MDN.
`borderEndColor`	`BorderColorValue`	—	The color of the border on the logical end side, depending on the layout direction. See MDN.
`borderTopColor`	`BorderColorValue`	—	The color of the top border. See MDN.
`borderBottomColor`	`BorderColorValue`	—	The color of the bottom border. See MDN.
`borderXColor`	`BorderColorValue`	—	The color of the left and right borders. See MDN.
`borderYColor`	`BorderColorValue`	—	The color of the top and bottom borders. See MDN.
`borderRadius`	`BorderRadiusValue`	—	The border radius on all four sides of the element. See MDN.
`borderTopStartRadius`	`BorderRadiusValue`	—	The border radius for the top start corner of the element, depending on the layout direction. See MDN.
`borderTopEndRadius`	`BorderRadiusValue`	—	The border radius for the top end corner of the element, depending on the layout direction. See MDN.
`borderBottomStartRadius`	`BorderRadiusValue`	—	The border radius for the bottom start corner of the element, depending on the layout direction. See MDN.
`borderBottomEndRadius`	`BorderRadiusValue`	—	The border radius for the bottom end corner of the element, depending on the layout direction. See MDN.

Positioning

Name	Type	Default	Description
`position`	`'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky'`	—	Specifies how the element is positioned. See MDN.
`top`	`DimensionValue`	—	The top position for the element. See MDN.
`bottom`	`DimensionValue`	—	The bottom position for the element. See MDN.
`left`	`DimensionValue`	—	The left position for the element. See MDN. Consider using `start` instead for RTL support.
`right`	`DimensionValue`	—	The right position for the element. See MDN. Consider using `start` instead for RTL support.
`start`	`DimensionValue`	—	The logical start position for the element, depending on layout direction. See MDN.
`end`	`DimensionValue`	—	The logical end position for the element, depending on layout direction. See MDN.
`zIndex`	`number`	—	The stacking order for the element. See MDN.
`isHidden`	`boolean`	—	Hides the element.

Accessibility

Name	Type	Default	Description
`id`	`string`	—	The element's unique identifier. See MDN.

Advanced

Name	Type	Default	Description
`UNSAFE_className`	`string`	—	Sets the CSS className for the element. Only use as a last resort. Use style props instead.
`UNSAFE_style`	`CSSProperties`	—	Sets inline style for the element. Only use as a last resort. Use style props instead.