Banner

Banners surface important information and feedback to the user about a task, action, or state.

GitHub Storybook

yarn add @workday/canvas-kit-react

Sources

GitHub Storybook

Install

yarn add @workday/canvas-kit-react

Anatomy

Icon: Supplementary visual indicator used to distinguish between error and alert Banners.
Label: Total count of all errors and/or alerts on a page.
Action Text (Conditional): Link text that indicates the Banner is actionable. Activating the link opens a list of all errors and alerts on a page. Action text is only available in the full Banner variant and has a default value of View All.
Container: Colored container that houses the error or alert icon, message, and action text. The container can be full or sticky, in which the Banner is to be displayed along the right edge of the page.

Usage Guidance

Banners consist of errors and alerts:

Typically appearing in response to user action, errors prevent the user from moving forward in their process until the error is corrected. Common error triggers include failing to enter a value for required fields, entering values in a form that are incompatible, or when user input is not understood.
Alerts convey information the user should be aware of to help prevent a future error, but allow the user to proceed without addressing the alert.

When to Use

Use Banners to notify users of missteps that happen within a workflow and describe how the user can take appropriate action to resolve them.
Banners should bring a user’s attention to problems or mistakes either before they happen, or before the user can move on.

When to Use Something Else

Ideally, a design won’t create a scenario that causes the need for a Banner. If you can avoid these scenarios by mentioning information that will help in hint text, or by simplifying your design, always do so.

Do's and Don'ts

Combine error and alert messages into a single error Banner.

Don't

Do not use separate error and alert Banners if there are both errors and alerts on the same page.

Examples

Basic Example

Use the children of Banner.Label to set the main text for the Banner.

Action Text

Use the children of Banner.ActionText to customize the action text contained in the Banner. The text has default value of View All.

Error Type

Set the hasError prop of the Banner to designate the severity of the message presented in the banner. This will change the defualt icon to exclamationCircleIcon.

Sticky

Set the isSticky prop of the Banner to display it along the right edge of the page. When true, the Banner.ActionText will be hidden. Some basic styles will be applied, but you will still need to manually set the css position value.

You can use keyframes to animate the Banner in.

RefForwarding

Banner supports ref forwarding. It will forward ref to its underlying button element.

Right-to-Left (RTL)

Banner supports right-to-left languages when specified in the CanvasProvider theme.

Themed Banners

Banners use the useThemedPalette hook for themeing. By default, your alert theme is used. main will be used for the background, dark for the hover background, and contrast for the text.

If you set the hasError prop, the banner will use your error theme.

Component API

Banner is a container component rendered as a <button> element that is responsible for creating a BannerModel and sharing it with its subcomponents using React context.

<Banner
    isSticky={true}
    hasError={true}
    id='custom-banner-id'
    onClick={() => console.log('clicked banner')}
>
  {Child components}
</Banner>

Alternatively, you may pass in a model using the hoisted model pattern.

const model = useBannerModel({
  isSticky: true,
  hasError: true,
  id: 'custom-banner-id',
});

return (
  <Banner onClick={() => console.log('clicked banner')} model={model}>
    {Child components}
  </Banner>
);

Banner supports all props from thelayout component.

Props extend from button. Changing the as prop will change the element interface.

Props extend from . If a model is passed, props from BannerModelConfig are ignored.

Name	Type	Description	Default
`children`	`ReactNode`	Children of the Banner. Should contain a `<Banner.Label>` a <Banner.Icon> and an optional `<Banner.ActionText>`
`as`	`React.ElementType`	Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element. Note: Not all elements make sense and some elements may cause accessibility issues. Change this value with care.	`button`
`ref`	`React.Ref`	Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).
`model`		Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.
`elemPropsHook`	`( model: , elemProps: TProps ) => HTML Attributes`	Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.

useBanner

Adds the necessary props to a Banner component. Used by the Banner component

(
  model: , 
  elemProps: {}, 
  ref: React.Ref
) => {
  aria-describedby: string;
  aria-labelledby: string;
}

Banner.Icon is a styled . The icon defaults to exclamationTriangleIcon or exclamationCircleIcon when the model's hasError is true.

<Banner.Icon />

Banner.Icon supports all props from thelayout component.

Props extend from span. Changing the as prop will change the element interface.

Name	Type	Description	Default
`icon`		Icon to show next to label
`fill`		The fill color of the SystemIcon. This overrides `color`.
`color`		The color of the SystemIcon. This defines `accent` and `fill`. `color` may be overriden by `accent` and `fill`.
`size`	`number \| string \| undefined`	The size of the SystemIcon in `px`.
`styles`
`shouldMirror`	`boolean`	If set to `true`, transform the SVG's x-axis to mirror the graphic	`false`
`background`		The background color of the SystemIcon.
`children`	`ReactNode`
`accent`		The accent color of the SystemIcon. This overrides `color`.
`accentHover`		The accent color of the SystemIcon on hover. This overrides `colorHover`.
`backgroundHover`		The background color of the SystemIcon on hover.
`colorHover`		The hover color of the SystemIcon. This defines `accentHover` and `fillHover`. `colorHover` may be overriden by `accentHover` and `fillHover`.
`fillHover`		The fill color of the SystemIcon on hover. This overrides `colorHover`.
`as`	`React.ElementType`	Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element. Note: Not all elements make sense and some elements may cause accessibility issues. Change this value with care.	`span`
`ref`	`React.Ref`	Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).
`model`		Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.
`elemPropsHook`	`( model: , elemProps: TProps ) => HTML Attributes`	Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.

useBannerIcon

Adds the necessary props to a Icon component. Used by the Banner.Icon subcomponent

(
  model: , 
  elemProps: {}, 
  ref: React.Ref
) => {
  icon: ;
  color:  string  | undefined;
  colorHover:  string  | undefined;
  size: number;
}

Banner.Label is a styled . This component will get an id that will be used for the aria-describedby on the top level <button>.

<Banner.Label>3 Warnings</Banner.Label>

Banner.Label supports all props from thelayout component.

Props extend from div. Changing the as prop will change the element interface.

Name	Type	Description	Default
`children`	`ReactNode`	The text of the Banner.
`as`	`React.ElementType`	Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element. Note: Not all elements make sense and some elements may cause accessibility issues. Change this value with care.	`div`
`ref`	`React.Ref`	Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).
`model`		Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.
`elemPropsHook`	`( model: , elemProps: TProps ) => HTML Attributes`	Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.

useBannerLabel

Adds the necessary props to a Label component. Used by the Banner.Label subcomponent

(
  model: , 
  elemProps: {}, 
  ref: React.Ref
) => {
  id: string;
}

Banner.ActionText

Banner.ActionText is a styled . This component will get an id that will be used for the aria-labelledby on the top level <button>. This component will be visually hidden when the model's isSticky prop is set to true.

<Banner.ActionText>Custom call to action</Banner.ActionText>

Layout Component

Banner.ActionTextText supports all props from thelayout component.

Props

Props extend from span. Changing the as prop will change the element interface.

Name	Type	Description	Default
`children`	`ReactNode`	The text of the Banner action.	`'View All'`
`as`	`React.ElementType`	Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element. Note: Not all elements make sense and some elements may cause accessibility issues. Change this value with care.	`span`
`ref`	`React.Ref`	Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).
`model`		Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.
`elemPropsHook`	`( model: , elemProps: TProps ) => HTML Attributes`	Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.

useBannerActionText

Adds the necessary props to a ActionText component. Used by the Banner.ActionText subcomponent

(
  model: , 
  elemProps: {}, 
  ref: React.Ref
) => {
  id: string;
}

useBannerModel

useBannerModel (config: ):

Accessibility Guidelines

Avoid using color alone to differentiate between errors and alerts. Instead, use icons or text that says “Error” or “Alert.”
If both icons and visible text are used to differentiate between errors and alerts, the icons are considered redundant and should not provide any alternative text for screen readers.
When possible, error and alert states should provide information on how to fix issues or hints on fixing formatting.

Content Guidelines

When writing error or alert messages, refer to the Errors and Alerts section of the Content Style Guide.

Can't Find What You Need?

Check out our FAQ section which may help you find the information you're looking for.

FAQ Section