Custom Icons

Custom icons can be used by wrapping them in an Icon component.

install	`yarn add @adobe/react-spectrum`
version	3.25.1
usage	`import {Icon} from '@adobe/react-spectrum'`

View guidelines

Spectrum

Example#

function CustomIcon(props) {
  return (
    <Icon {...props}>
      <svg viewBox="0 0 36 36">
        <path d="M18.477.593,22.8,12.029l12.212.578a.51.51,0,0,1,.3.908l-9.54,7.646,3.224,11.793a.51.51,0,0,1-.772.561L18,26.805,7.78,33.515a.51.51,0,0,1-.772-.561l3.224-11.793L.692,13.515a.51.51,0,0,1,.3-.908L13.2,12.029,17.523.593A.51.51,0,0,1,18.477.593Z" />
      </svg>
    </Icon>
  );
}

<CustomIcon aria-label="Star" />

function CustomIcon(props) {
  return (
    <Icon {...props}>
      <svg viewBox="0 0 36 36">
        <path d="M18.477.593,22.8,12.029l12.212.578a.51.51,0,0,1,.3.908l-9.54,7.646,3.224,11.793a.51.51,0,0,1-.772.561L18,26.805,7.78,33.515a.51.51,0,0,1-.772-.561l3.224-11.793L.692,13.515a.51.51,0,0,1,.3-.908L13.2,12.029,17.523.593A.51.51,0,0,1,18.477.593Z" />
      </svg>
    </Icon>
  );
}

<CustomIcon aria-label="Star" />

function CustomIcon(
  props
) {
  return (
    <Icon {...props}>
      <svg viewBox="0 0 36 36">
        <path d="M18.477.593,22.8,12.029l12.212.578a.51.51,0,0,1,.3.908l-9.54,7.646,3.224,11.793a.51.51,0,0,1-.772.561L18,26.805,7.78,33.515a.51.51,0,0,1-.772-.561l3.224-11.793L.692,13.515a.51.51,0,0,1,.3-.908L13.2,12.029,17.523.593A.51.51,0,0,1,18.477.593Z" />
      </svg>
    </Icon>
  );
}

<CustomIcon aria-label="Star" />

Wrapping the SVG with Icon will ensure it recieves proper styling when used within React Spectrum components:

import {Button, Text} from '@adobe/react-spectrum';

<Button variant="primary">
  <CustomIcon />
  <Text>Favorite</Text>
</Button>

import {Button, Text} from '@adobe/react-spectrum';

<Button variant="primary">
  <CustomIcon />
  <Text>Favorite</Text>
</Button>

import {
  Button,
  Text
} from '@adobe/react-spectrum';

<Button variant="primary">
  <CustomIcon />
  <Text>Favorite</Text>
</Button>

Sizing#

Icons support t-shirt sizing. When used inside another React Spectrum component, they'll generally be sized automatically, but if you use icons standalone, you can use the size prop to control the sizing. The default size is "M" in medium scale (desktop), and "L" in large scale (mobile).

<Flex gap="size-100">
  <CustomIcon aria-label="XXS Star" size="XXS" />
  <CustomIcon aria-label="XS Star" size="XS" />
  <CustomIcon aria-label="S Star" size="S" />
  <CustomIcon aria-label="M Star" size="M" />
  <CustomIcon aria-label="L Star" size="L" />
  <CustomIcon aria-label="XL Star" size="XL" />
  <CustomIcon aria-label="XXL Star" size="XXL" />
</Flex>

<Flex gap="size-100">
  <CustomIcon aria-label="XXS Star" size="XXS" />
  <CustomIcon aria-label="XS Star" size="XS" />
  <CustomIcon aria-label="S Star" size="S" />
  <CustomIcon aria-label="M Star" size="M" />
  <CustomIcon aria-label="L Star" size="L" />
  <CustomIcon aria-label="XL Star" size="XL" />
  <CustomIcon aria-label="XXL Star" size="XXL" />
</Flex>

<Flex gap="size-100">
  <CustomIcon
    aria-label="XXS Star"
    size="XXS"
  />
  <CustomIcon
    aria-label="XS Star"
    size="XS"
  />
  <CustomIcon
    aria-label="S Star"
    size="S"
  />
  <CustomIcon
    aria-label="M Star"
    size="M"
  />
  <CustomIcon
    aria-label="L Star"
    size="L"
  />
  <CustomIcon
    aria-label="XL Star"
    size="XL"
  />
  <CustomIcon
    aria-label="XXL Star"
    size="XXL"
  />
</Flex>

Coloring#

Icons support four Spectrum semantic colors: negative, notice, positive, and informative. Icons within React Spectrum components typically have their colors styled appropriately, but you can use the color prop to adjust the color of any standalone icons.

<Flex gap="size-100">
  <CustomIcon aria-label="Default Star" />
  <CustomIcon aria-label="Negative Star" color="negative" />
  <CustomIcon aria-label="Notification Star" color="notice" />
  <CustomIcon aria-label="Positive Star" color="positive" />
  <CustomIcon aria-label="Informative Star" color="informative" />
</Flex>

<Flex gap="size-100">
  <CustomIcon aria-label="Default Star" />
  <CustomIcon
    aria-label="Negative Star"
    color="negative"
  />
  <CustomIcon
    aria-label="Notification Star"
    color="notice"
  />
  <CustomIcon
    aria-label="Positive Star"
    color="positive"
  />
  <CustomIcon
    aria-label="Informative Star"
    color="informative"
  />
</Flex>

<Flex gap="size-100">
  <CustomIcon aria-label="Default Star" />
  <CustomIcon
    aria-label="Negative Star"
    color="negative"
  />
  <CustomIcon
    aria-label="Notification Star"
    color="notice"
  />
  <CustomIcon
    aria-label="Positive Star"
    color="positive"
  />
  <CustomIcon
    aria-label="Informative Star"
    color="informative"
  />
</Flex>

Labeling#

By default, icons are considered decorative, and are hidden from assistive technology. When used within a component like a button that has no label, an aria-label should be provided to the parent component. If used standalone, an aria-label can be provided to the icon itself.

Props#

Name	Type	Default	Description
`children`	`ReactElement`	—	The content to display. Should be an SVG.
`size`	`'XXS' \| 'XS' \| 'S' \| 'M' \| 'L' \| 'XL' \| 'XXL'`	—	Size of Icon (changes based on scale).

Layout

Name	Type	Default	Description
`flex`	`Responsive<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`	`Responsive<number>`	—	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`Responsive<number>`	—	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`Responsive<number \| string>`	—	When used in a flex layout, specifies the initial main size of the element. See MDN.
`alignSelf`	`Responsive<'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`	`Responsive<'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`	`Responsive<number>`	—	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`Responsive<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`	`Responsive<string>`	—	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`Responsive<string>`	—	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`Responsive<string>`	—	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`Responsive<string>`	—	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`Responsive<string>`	—	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`Responsive<string>`	—	When used in a grid layout, specifies the ending row to span within the grid. See MDN.
`slot`	`string`	`'icon'`	A slot to place the icon in.

Spacing

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

Sizing

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

Positioning

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

Typography

Name	Type	Default	Description
`color`	`IconColorValue`	—	Color of the Icon.

Accessibility

Name	Type	Default	Description
`id`	`string`	—	The element's unique identifier. See MDN.
`aria-label`	`string`	—	A screen reader only label for the Icon.
`aria-hidden`	`boolean \| 'false' \| 'true'`	—	Indicates whether the element is exposed to an accessibility API.
`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.

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.