Provider

Provider is the container for all React Spectrum applications. It defines the theme, locale, and other application level settings, and can also be used to provide common properties to a group of components.

installyarn add @adobe/react-spectrum
version3.1.2
usageimport {Provider} from '@adobe/react-spectrum'

Example#


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

function App() {
  return (
    <Provider theme={defaultTheme}>
      <Button variant="cta">Hello React Spectrum!</Button>
    </Provider>
  );
}
import {
  Provider,
  defaultTheme,
  Button
} from '@adobe/react-spectrum';

function App() {
  return (
    <Provider theme={defaultTheme}>
      <Button variant="cta">Hello React Spectrum!</Button>
    </Provider>
  );
}
import {
  Provider,
  defaultTheme,
  Button
} from '@adobe/react-spectrum';

function App() {
  return (
    <Provider
      theme={
        defaultTheme
      }>
      <Button variant="cta">
        Hello React
        Spectrum!
      </Button>
    </Provider>
  );
}

Application provider#


A Provider must be the root component of your application. All other React Spectrum components rely on the Provider to define the theme, locale, and other settings that they need in order to render.

Themes#

In order to provide the styling attributes that components need to render, you must pass a theme as a prop to the root provider in your application. Themes consist of a light and dark color scheme, along with medium and large platform scales. By default, React Spectrum will select the color scheme according to the user’s operating system setting, and the scale according to the device type (e.g. touch vs mouse input). To read more details about how theming works in React Spectrum, see the theming docs.

Color Schemes#

We recommend supporting both light and dark color schemes in your app, however, if you need to override this with an application specific setting, you can use the colorScheme prop.

<Provider theme={theme} colorScheme="light">
  <ActionButton margin="size-100">I'm a light button</ActionButton>
</Provider>
<Provider theme={theme} colorScheme="light">
  <ActionButton margin="size-100">
    I'm a light button
  </ActionButton>
</Provider>
<Provider
  theme={theme}
  colorScheme="light">
  <ActionButton margin="size-100">
    I'm a light button
  </ActionButton>
</Provider>

See the styling docs for more information about using Spectrum color variables in your app to ensure it adapts to light and dark mode properly.

Locales#

Another important setting for your application is the locale. By default, React Spectrum chooses the locale matching the user’s browser/operating system language, but this can be overridden with the locale prop if you have an application specific setting. This prop accepts a BCP 47 language code. A list of supported locales is available here.

<Provider theme={theme} locale={appSettings.locale}>
  <YourApp />
</Provider>
<Provider theme={theme} locale={appSettings.locale}>
  <YourApp />
</Provider>
<Provider
  theme={theme}
  locale={
    appSettings.locale
  }>
  <YourApp />
</Provider>

To access the current locale anywhere in your application, see the useLocale hook.

Property groups#


Provider can also be used to define common properties for a group of components within it. For example, a group of components could be disabled together rather than individually by setting the isDisabled prop on any parent provider.

<Flex direction="column" gap="size-100" alignItems="start">
  <Provider isDisabled>
    <RadioGroup label="Favorite animal">
      <Radio value="dogs">Dogs</Radio>
      <Radio value="cats">Cats</Radio>
      <Radio value="horses">Horses</Radio>
    </RadioGroup>
    <Checkbox>I agree</Checkbox>
    <Button variant="primary">Submit</Button>
  </Provider>
</Flex>
<Flex
  direction="column"
  gap="size-100"
  alignItems="start">
  <Provider isDisabled>
    <RadioGroup label="Favorite animal">
      <Radio value="dogs">Dogs</Radio>
      <Radio value="cats">Cats</Radio>
      <Radio value="horses">Horses</Radio>
    </RadioGroup>
    <Checkbox>I agree</Checkbox>
    <Button variant="primary">Submit</Button>
  </Provider>
</Flex>
<Flex
  direction="column"
  gap="size-100"
  alignItems="start">
  <Provider isDisabled>
    <RadioGroup label="Favorite animal">
      <Radio value="dogs">
        Dogs
      </Radio>
      <Radio value="cats">
        Cats
      </Radio>
      <Radio value="horses">
        Horses
      </Radio>
    </RadioGroup>
    <Checkbox>
      I agree
    </Checkbox>
    <Button variant="primary">
      Submit
    </Button>
  </Provider>
</Flex>

Provider supports many other properties that can be used in this way: isQuiet, isEmphasized, isDisabled, isRequired, isReadOnly, and validationState. These will be applied to any child components that support them.

Property groups can also be nested. For example, a group of components could be made quiet or emphasized, with a sub-group that is also disabled. The inner-most provider will override outer ones, as will corresponding props on the components themselves.

The following example shows a registration form, which disables a picker and submit button until an email address is entered. All elements within the form use a quiet style, except the submit button, which overrides the provider setting using a prop.

function Register() {
  let [email, setEmail] = React.useState('');

  return (
    <Flex direction="column" gap="size-100" alignItems="start">
      <Provider isQuiet>
        <TextField
          label="Email"
          placeholder="example@adobe.com"
          value={email}
          onChange={setEmail}
        />
        <Provider isDisabled={email.length === 0}>
          <Picker label="Favorite color">
            <Item key="magenta">Magenta</Item>
            <Item key="indigo">Indigo</Item>
            <Item key="chartreuse">Chartreuse</Item>
          </Picker>
          <Button variant="primary" isQuiet={false}>
            Submit
          </Button>
        </Provider>
      </Provider>
    </Flex>
  );
}
function Register() {
  let [email, setEmail] = React.useState('');

  return (
    <Flex
      direction="column"
      gap="size-100"
      alignItems="start">
      <Provider isQuiet>
        <TextField
          label="Email"
          placeholder="example@adobe.com"
          value={email}
          onChange={setEmail}
        />
        <Provider isDisabled={email.length === 0}>
          <Picker label="Favorite color">
            <Item key="magenta">Magenta</Item>
            <Item key="indigo">Indigo</Item>
            <Item key="chartreuse">Chartreuse</Item>
          </Picker>
          <Button variant="primary" isQuiet={false}>
            Submit
          </Button>
        </Provider>
      </Provider>
    </Flex>
  );
}
function Register() {
  let [
    email,
    setEmail
  ] = React.useState('');

  return (
    <Flex
      direction="column"
      gap="size-100"
      alignItems="start">
      <Provider isQuiet>
        <TextField
          label="Email"
          placeholder="example@adobe.com"
          value={email}
          onChange={
            setEmail
          }
        />
        <Provider
          isDisabled={
            email.length ===
            0
          }>
          <Picker label="Favorite color">
            <Item key="magenta">
              Magenta
            </Item>
            <Item key="indigo">
              Indigo
            </Item>
            <Item key="chartreuse">
              Chartreuse
            </Item>
          </Picker>
          <Button
            variant="primary"
            isQuiet={
              false
            }>
            Submit
          </Button>
        </Provider>
      </Provider>
    </Flex>
  );
}

Props#


NameTypeDefaultDescription
childrenReactNodeThe content of the Provider.
themeThemeThe theme for your application.
colorSchemeColorSchemeThe color scheme for your application. Defaults to operating system preferences.
defaultColorSchemeColorScheme'light'The default color scheme if no operating system setting is available.
scaleScaleSets the scale for your applications. Defaults based on device pointer type.
localestring'en-US'The locale for your application as a BCP 47 language code. Defaults to the browser/OS language setting.
isQuietbooleanWhether descendants should be displayed with the quiet style.
isEmphasizedbooleanWhether descendants should be displayed with the emphasized style.
isDisabledbooleanWhether descendants should be disabled.
isRequiredbooleanWhether descendants should be displayed with the required style.
isReadOnlybooleanWhether descendants should be read only.
validationStateValidationStateWhether descendants should be displayed with the validation state style.
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.
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.
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.
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.