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.

installyarn add @adobe/react-spectrum
version3.1.1
usageimport {View} from '@adobe/react-spectrum'

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#


NameTypeDefaultDescription
elementTypestringJSXElementConstructor<any>The element to render as the node.
childrenReactNodeChildren to be displayed in the View.
Layout
NameTypeDefaultDescription
flexstringnumberbooleanWhen used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrownumberWhen used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinknumberWhen used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisnumberstringWhen 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.
ordernumberThe layout order for the element within a flex or grid container. See MDN.
gridAreastringWhen used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnstringWhen used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowstringWhen used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartstringWhen used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndstringWhen used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartstringWhen used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndstringWhen used in a grid layout, specifies the ending row to span within the grid. See MDN.
overflowstringSpecies what to do when the element's content is too long to fit its size. See MDN.
Spacing
NameTypeDefaultDescription
marginDimensionValueThe margin for all four sides of the element. See MDN.
marginTopDimensionValueThe margin for the top side of the element. See MDN.
marginBottomDimensionValueThe margin for the bottom side of the element. See MDN.
marginStartDimensionValueThe margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndDimensionValueThe margin for the logical end side of an element, depending on layout direction. See MDN.
marginXDimensionValueThe margin for both the left and right sides of the element. See MDN.
marginYDimensionValueThe margin for both the top and bottom sides of the element. See MDN.
paddingDimensionValueThe padding for all four sides of the element. See MDN.
paddingTopDimensionValueThe padding for the top side of the element. See MDN.
paddingBottomDimensionValueThe padding for the bottom side of the element. See MDN.
paddingStartDimensionValueThe padding for the logical start side of the element, depending on layout direction. See MDN.
paddingEndDimensionValueThe padding for the logical end side of an element, depending on layout direction. See MDN.
paddingXDimensionValueThe padding for both the left and right sides of the element. See MDN.
paddingYDimensionValueThe padding for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthDimensionValueThe width of the element. See MDN.
minWidthDimensionValueThe minimum width of the element. See MDN.
maxWidthDimensionValueThe maximum width of the element. See MDN.
heightDimensionValueThe height of the element. See MDN.
minHeightDimensionValueThe minimum height of the element. See MDN.
maxHeightDimensionValueThe maximum height of the element. See MDN.
Background
NameTypeDefaultDescription
backgroundColorBackgroundColorValueThe background color for the element.
Borders
NameTypeDefaultDescription
borderWidthBorderSizeValueThe width of the element's border on all four sides. See MDN.
borderStartWidthBorderSizeValueThe width of the border on the logical start side, depending on the layout direction. See MDN.
borderEndWidthBorderSizeValueThe width of the border on the logical end side, depending on the layout direction. See MDN.
borderTopWidthBorderSizeValueThe width of the top border. See MDN.
borderBottomWidthBorderSizeValueThe width of the bottom border. See MDN.
borderXWidthBorderSizeValueThe width of the left and right borders. See MDN.
borderYWidthBorderSizeValueThe width of the top and bottom borders. See MDN.
borderColorBorderColorValueThe color of the element's border on all four sides. See MDN.
borderStartColorBorderColorValueThe color of the border on the logical start side, depending on the layout direction. See MDN.
borderEndColorBorderColorValueThe color of the border on the logical end side, depending on the layout direction. See MDN.
borderTopColorBorderColorValueThe color of the top border. See MDN.
borderBottomColorBorderColorValueThe color of the bottom border. See MDN.
borderXColorBorderColorValueThe color of the left and right borders. See MDN.
borderYColorBorderColorValueThe color of the top and bottom borders. See MDN.
borderRadiusBorderRadiusValueThe border radius on all four sides of the element. See MDN.
borderTopStartRadiusBorderRadiusValueThe border radius for the top start corner of the element, depending on the layout direction. See MDN.
borderTopEndRadiusBorderRadiusValueThe border radius for the top end corner of the element, depending on the layout direction. See MDN.
borderBottomStartRadiusBorderRadiusValueThe border radius for the bottom start corner of the element, depending on the layout direction. See MDN.
borderBottomEndRadiusBorderRadiusValueThe border radius for the bottom end corner of the element, depending on the layout direction. See MDN.
Positioning
NameTypeDefaultDescription
position'static''relative''absolute''fixed''sticky'Specifies how the element is positioned. See MDN.
topDimensionValueThe top position for the element. See MDN.
bottomDimensionValueThe bottom position for the element. See MDN.
leftDimensionValueThe left position for the element. See MDN. Consider using start instead for RTL support.
rightDimensionValueThe right position for the element. See MDN. Consider using start instead for RTL support.
startDimensionValueThe logical start position for the element, depending on layout direction. See MDN.
endDimensionValueThe logical end position for the element, depending on layout direction. See MDN.
zIndexnumberThe stacking order for the element. See MDN.
isHiddenbooleanHides the element.
Accessibility
NameTypeDefaultDescription
idstringThe element's unique identifier. See MDN.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.