ColorSwatch
A ColorSwatch displays a preview of a selected color.
< ColorSwatch color = "#f00" / >
< ColorSwatch color = "#f00" / >
< ColorSwatch color = "#f00" / >
ColorSwatch accepts a value via the color
prop. The value should be a color string or
object.
In the example below, the
function is used to parse the initial color from an HSL string. This is passed to the value
prop of a ColorSlider , and the color
prop of a ColorSwatch
to show a preview of the selected color.
import { ColorSlider , parseColor } from '@adobe/react-spectrum' ;
function Example ( ) {
let [ color , setColor ] = React . useState ( parseColor ( 'hsl(0, 100%, 50%)' ) ) ;
return (
< Flex direction = "column" gap = "size-100" >
< ColorSlider value = { color } onChange = { setColor } channel = "hue" / >
< ColorSwatch color = { color } / >
< / Flex >
) ;
}
import {
ColorSlider ,
parseColor
} from '@adobe/react-spectrum' ;
function Example ( ) {
let [ color , setColor ] = React . useState (
parseColor ( 'hsl(0, 100%, 50%)' )
) ;
return (
< Flex direction = "column" gap = "size-100" >
< ColorSlider
value = { color }
onChange = { setColor }
channel = "hue"
/ >
< ColorSwatch color = { color } / >
< / Flex >
) ;
}
import {
ColorSlider ,
parseColor
} from '@adobe/react-spectrum' ;
function Example ( ) {
let [ color , setColor ] =
React . useState (
parseColor (
'hsl(0, 100%, 50%)'
)
) ;
return (
< Flex
direction = "column"
gap = "size-100"
>
< ColorSlider
value = { color }
onChange = { setColor }
channel = "hue"
/ >
< ColorSwatch
color = { color }
/ >
< / Flex >
) ;
}
Fully transparent colors are displayed with a red slash through the swatch, while partially transparent colors are shown with a checkerboard background.
import { ColorSlider , parseColor } from '@adobe/react-spectrum' ;
function Example ( ) {
let [ color , setColor ] = React . useState ( parseColor ( 'hsla(0, 100%, 50%, 0)' ) ) ;
return (
< Flex direction = "column" gap = "size-100" >
< ColorSlider value = { color } onChange = { setColor } channel = "alpha" / >
< ColorSwatch color = { color } / >
< / Flex >
) ;
}
import {
ColorSlider ,
parseColor
} from '@adobe/react-spectrum' ;
function Example ( ) {
let [ color , setColor ] = React . useState (
parseColor ( 'hsla(0, 100%, 50%, 0)' )
) ;
return (
< Flex direction = "column" gap = "size-100" >
< ColorSlider
value = { color }
onChange = { setColor }
channel = "alpha"
/ >
< ColorSwatch color = { color } / >
< / Flex >
) ;
}
import {
ColorSlider ,
parseColor
} from '@adobe/react-spectrum' ;
function Example ( ) {
let [ color , setColor ] =
React . useState (
parseColor (
'hsla(0, 100%, 50%, 0)'
)
) ;
return (
< Flex
direction = "column"
gap = "size-100"
>
< ColorSlider
value = { color }
onChange = { setColor }
channel = "alpha"
/ >
< ColorSwatch
color = { color }
/ >
< / Flex >
) ;
}
By default, ColorSwatch includes a localized color description for screen reader users (e.g. "dark vibrant blue") as an aria-label
. If you have a more specific color name (e.g. Pantone colors), the automatically generated color description can be overridden via the colorName
prop. An additional label describing the context of the color swatch (e.g. "Background color") can also be provided via the aria-label
or aria-labelledby
props.
In the example below, the full accessible name of the color swatch will be "Fire truck red, Background color".
< ColorSwatch
color = "#f00"
aria-label = "Background color"
colorName = "Fire truck red"
/ >
< ColorSwatch
color = "#f00"
aria-label = "Background color"
colorName = "Fire truck red"
/ >
< ColorSwatch
color = "#f00"
aria-label = "Background color"
colorName = "Fire truck red"
/ >
Name Type Default Description size
'XS'
| 'S'
| 'M'
| 'L'
"M"
The size of the ColorSwatch. rounding
'default'
| 'none'
| 'full'
"default"
The corner rounding of the ColorSwatch. color
string |
— The color value to display in the swatch. colorName
string
— A localized accessible name for the color.
By default, a description is generated from the color value,
but this can be overridden if you have a more specific color
name (e.g. Pantone colors).
LayoutName Type 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 .
SpacingName Type Description margin
< >
The margin for all four sides of the element. See MDN . marginTop
< >
The margin for the top side of the element. See MDN . marginBottom
< >
The margin for the bottom side of the element. See MDN . marginStart
< >
The margin for the logical start side of the element, depending on layout direction. See MDN . marginEnd
< >
The margin for the logical end side of an element, depending on layout direction. See MDN . marginX
< >
The margin for both the left and right sides of the element. See MDN . marginY
< >
The margin for both the top and bottom sides of the element. See MDN .
SizingName Type Description width
< >
The width of the element. See MDN . minWidth
< >
The minimum width of the element. See MDN . maxWidth
< >
The maximum width of the element. See MDN . height
< >
The height of the element. See MDN . minHeight
< >
The minimum height of the element. See MDN . maxHeight
< >
The maximum height of the element. See MDN .
PositioningName Type Description position
< 'static'
| 'relative'
| 'absolute'
| 'fixed'
| 'sticky' >
Specifies how the element is positioned. See MDN . top
< >
The top position for the element. See MDN . bottom
< >
The bottom position for the element. See MDN . left
< >
The left position for the element. See MDN . Consider using start
instead for RTL support. right
< >
The right position for the element. See MDN . Consider using start
instead for RTL support. start
< >
The logical start position for the element, depending on layout direction. See MDN . end
< >
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.
AccessibilityName Type Description id
string
The element's unique identifier. See MDN . aria-label
string
Defines a string value that labels the current element. aria-labelledby
string
Identifies the element (or elements) that labels the current element. aria-describedby
string
Identifies the element (or elements) that describes the object. aria-details
string
Identifies the element (or elements) that provide a detailed, extended description for the object.
AdvancedName Type 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.
View guidelines
< Flex gap = "size-100" >
< ColorSwatch color = "#ff0" size = "XS" / >
< ColorSwatch color = "#ff0" size = "S" / >
< ColorSwatch color = "#ff0" size = "M" / >
< ColorSwatch color = "#ff0" size = "L" / >
< / Flex >
< Flex gap = "size-100" >
< ColorSwatch color = "#ff0" size = "XS" / >
< ColorSwatch color = "#ff0" size = "S" / >
< ColorSwatch color = "#ff0" size = "M" / >
< ColorSwatch color = "#ff0" size = "L" / >
< / Flex >
< Flex gap = "size-100" >
< ColorSwatch
color = "#ff0"
size = "XS"
/ >
< ColorSwatch
color = "#ff0"
size = "S"
/ >
< ColorSwatch
color = "#ff0"
size = "M"
/ >
< ColorSwatch
color = "#ff0"
size = "L"
/ >
< / Flex >
View guidelines
< Flex gap = "size-100" >
< ColorSwatch color = "#0ff" rounding = "none" / >
< ColorSwatch color = "#0ff" rounding = "default" / >
< ColorSwatch color = "#0ff" rounding = "full" / >
< / Flex >
< Flex gap = "size-100" >
< ColorSwatch color = "#0ff" rounding = "none" / >
< ColorSwatch color = "#0ff" rounding = "default" / >
< ColorSwatch color = "#0ff" rounding = "full" / >
< / Flex >
< Flex gap = "size-100" >
< ColorSwatch
color = "#0ff"
rounding = "none"
/ >
< ColorSwatch
color = "#0ff"
rounding = "default"
/ >
< ColorSwatch
color = "#0ff"
rounding = "full"
/ >
< / Flex >
View guidelines
< ColorSwatch color = "#00f" width = "size-1000" / >
< ColorSwatch color = "#00f" width = "size-1000" / >
< ColorSwatch
color = "#00f"
width = "size-1000"
/ >