Toast

View source on GitHub

Toasts can educate people on the content of the screen, provide confirmation when people complete an action, or simply communicate a short message.

Toast is purely visual. In order to properly handle the showing and dismissing of Toasts, as well as any animations, you will need to implement a Toast manager.

⚠️ Please note: Toast is not currently supported in dark mode.

Props

Component props
Name	Type	Default
`text` Required	`string \| Element<*>`	-
	Use string for guide toasts (one line of text) and React.Node for confirmation toasts (complex text, potentially containing a Link). Do not specify a Text color within this property, as the color is automatically determined based on the `variant`.
`button`	`React.Node`	-
	Add an optional button for user interaction. Generally not recommended given the ephemeral nature of Toasts.
`thumbnail`	`React.Node`	-
	An optional thumbnail image to displayed next to the text.
`thumbnailShape`	`"circle" \| "rectangle" \| "square"`	`"square"`
	The masked shape of the thumbnail.
`variant`	`"default" \| "error"`	`"default"`
	Use the `'error'` variant to indicate an error message. Generally not recommended given the ephemeral nature of Toasts.

Usage guidelines

When to use

Displaying non-critical feedback on the result of an action.
Reinforcing success at the surface level.

When not to use

Providing an update related to anything other than confirmation of a successful action. Consider a Callout instead.
Presenting mandatory and/or critical actions to a user.
Displaying feedback at the element level (e.g., entered password doesn't meet requirements). Use inline text instead.

Example: How to display

Toasts should be displayed in the center of the viewport, opposite the main navbar (e.g. at the top of the viewport on mobile, bottom of the viewport on desktop). Though not implemented here, Toasts are meant to be ephemeral and disappear after a few seconds.

function ToastExample() {
  const [showToast, setShowToast] = React.useState(false);

  return (
    <Box>
      <Button
        onClick={() => setShowToast((currVal) => !currVal)}
        text={showToast ? 'Close toast' : 'Show toast'}
      />

      {showToast && (
        <Layer>
          <Box
            dangerouslySetInlineStyle={{
              __style: {
                bottom: 50,
                left: '50%',
                transform: 'translateX(-50%)',
              },
            }}
            fit
            paddingX={1}
            position="fixed"
          >
            <Toast
              button={<Button key="button-key" text="Undo" size="lg" />}
              text={
                <React.Fragment>
                  Saved to{' '}
                  <Text inline weight="bold">
                    <Link inline target="blank" href="https://www.pinterest.com/search/pins/?q=home%20decor" underline="hover">
                      Home decor
                    </Link>
                  </Text>
                </React.Fragment>
              }
              thumbnail={
                <Image
                  alt="Modern ceramic vase pin."
                  naturalHeight={564}
                  naturalWidth={564}
                  src="https://i.ibb.co/Lx54BCT/stock1.jpg"
                />
              }
            />
          </Box>
        </Layer>
      )}
    </Box>
  );
}

function ToastExample() {
  const [showToast, setShowToast] = React.useState(false);

  return (
    <Box>
      <Button
        onClick={() => setShowToast((currVal) => !currVal)}
        text={showToast ? 'Close toast' : 'Show toast'}
      />

      {showToast && (
        <Layer>
          <Box
            dangerouslySetInlineStyle={{
              __style: {
                bottom: 50,
                left: '50%',
                transform: 'translateX(-50%)',
              },
            }}
            fit
            paddingX={1}
            position="fixed"
          >
            <Toast
              button={<Button key="button-key" text="Undo" size="lg" />}
              text={
                <React.Fragment>
                  Saved to{' '}
                  <Text inline weight="bold">
                    <Link inline target="blank" href="https://www.pinterest.com/search/pins/?q=home%20decor" underline="hover">
                      Home decor
                    </Link>
                  </Text>
                </React.Fragment>
              }
              thumbnail={
                <Image
                  alt="Modern ceramic vase pin."
                  naturalHeight={564}
                  naturalWidth={564}
                  src="https://i.ibb.co/Lx54BCT/stock1.jpg"
                />
              }
            />
          </Box>
        </Layer>
      )}
    </Box>
  );
}

Example: Simple Text

<Flex justifyContent="center" width="100%">
  <Toast text="Section created!" />
</Flex>

<Flex justifyContent="center" width="100%">
  <Toast text="Section created!" />
</Flex>

Example: Complex Text

When passing in your own Text component for text, do not specify color on Text. Toast will automatically pick the correct text color for the given variant.

<Flex justifyContent="center" width="100%">
  <Toast
    text={
      <React.Fragment>
        Saved to{' '}
        <Text inline weight="bold">
          <Link inline target="blank" href="https://www.pinterest.com/search/pins/?q=home%20decor" underline="hover">
            Home decor
          </Link>
        </Text>
      </React.Fragment>
    }
  />
</Flex>

<Flex justifyContent="center" width="100%">
  <Toast
    text={
      <React.Fragment>
        Saved to{' '}
        <Text inline weight="bold">
          <Link inline target="blank" href="https://www.pinterest.com/search/pins/?q=home%20decor" underline="hover">
            Home decor
          </Link>
        </Text>
      </React.Fragment>
    }
  />
</Flex>

Example: Error variant

<Flex justifyContent="center" width="100%">
  <Toast
    text="Oops! Something went wrong. Please try again later."
    variant="error"
  />
</Flex>

<Flex justifyContent="center" width="100%">
  <Toast
    text="Oops! Something went wrong. Please try again later."
    variant="error"
  />
</Flex>

Example: Image + Text

<Flex justifyContent="center" width="100%">
  <Toast
    text={
      <React.Fragment>
        Saved to{' '}
        <Text inline weight="bold">
          <Link inline target="blank" href="https://www.pinterest.com/search/pins/?q=home%20decor" underline="hover">
            Home decor
          </Link>
        </Text>
      </React.Fragment>
    }
    thumbnail={
      <Image
        alt="Modern ceramic vase pin."
        naturalHeight={564}
        naturalWidth={564}
        src="https://i.ibb.co/Lx54BCT/stock1.jpg"
      />
    }
  />
</Flex>

<Flex justifyContent="center" width="100%">
  <Toast
    text={
      <React.Fragment>
        Saved to{' '}
        <Text inline weight="bold">
          <Link inline target="blank" href="https://www.pinterest.com/search/pins/?q=home%20decor" underline="hover">
            Home decor
          </Link>
        </Text>
      </React.Fragment>
    }
    thumbnail={
      <Image
        alt="Modern ceramic vase pin."
        naturalHeight={564}
        naturalWidth={564}
        src="https://i.ibb.co/Lx54BCT/stock1.jpg"
      />
    }
  />
</Flex>

Example: Image + Text + Button

<Flex justifyContent="center" width="100%">
  <Toast
    button={<Button key="button-key" text="Undo" size="lg" />}
    text={
      <React.Fragment>
        Saved to{' '}
        <Text inline weight="bold">
          <Link inline target="blank" href="https://www.pinterest.com/search/pins/?q=home%20decor" underline="hover">
            Home decor
          </Link>
        </Text>
      </React.Fragment>
    }
    thumbnail={
      <Image
        alt="Modern ceramic vase pin."
        naturalHeight={564}
        naturalWidth={564}
        src="https://i.ibb.co/Lx54BCT/stock1.jpg"
      />
    }
  />
</Flex>

<Flex justifyContent="center" width="100%">
  <Toast
    button={<Button key="button-key" text="Undo" size="lg" />}
    text={
      <React.Fragment>
        Saved to{' '}
        <Text inline weight="bold">
          <Link inline target="blank" href="https://www.pinterest.com/search/pins/?q=home%20decor" underline="hover">
            Home decor
          </Link>
        </Text>
      </React.Fragment>
    }
    thumbnail={
      <Image
        alt="Modern ceramic vase pin."
        naturalHeight={564}
        naturalWidth={564}
        src="https://i.ibb.co/Lx54BCT/stock1.jpg"
      />
    }
  />
</Flex>

Combinations: Overview

Section created!

Section created!

Saved to Home decor

Combinations: Thumbnail shapes

Saved to Home decor

Edit page on GitHub