# Banner

**📖 Live documentation:** https://cds.coinbase.com/components/feedback/Banner/

Displays important messages and actions to users.

## Import

```tsx
import { Banner } from '@coinbase/cds-web/banner/Banner'
```

## Examples

### Global Warning Banner

The global warning banner is used to communicate important alerts or warnings to users across the entire platform, ensuring universal visibility and building trust.

```tsx live
<Banner
  showDismiss
  label="Message last updated today at 3:33pm"
  startIcon="warning"
  startIconActive
  styleVariant="global"
  title="Some features are temporarily unavailable"
  variant="warning"
  primaryAction={<Link to="https://www.coinbase.com">Primary</Link>}
  secondaryAction={<Link to="https://www.coinbase.com">Secondary</Link>}
>
  <Text as="p" font="label2">
    Your funds are safe. We’re looking into it and expect our usual service to return soon.
    <Link to="https://www.coinbase.com">Learn more</Link>
  </Text>
</Banner>
```

### In-line Error Banner

The In-line Error Banner is used to display specific error messages directly beneath the relevant section headers. Use in-line banners to help users identify exactly where the error or outage is located.

```tsx live
<Banner
  startIcon="info"
  startIconActive
  styleVariant="inline"
  title="Some features are temporarily unavailable"
  variant="error"
  primaryAction={<Link to="https://www.coinbase.com">Primary</Link>}
  secondaryAction={<Link to="https://www.coinbase.com">Secondary</Link>}
>
  <Text as="p" font="label2">
    Your funds are safe. We’re looking into it and expect our usual service to return soon.
    <Link to="https://www.coinbase.com">Learn more</Link>
  </Text>
</Banner>
```

### Contextual Promotional Banner

The Contextual Promotional Banner is used to highlight special offers, promotions, or announcements within a specific context or section of the platform. It is used to increase user engagement and drive conversions.

```tsx live
<Banner
  startIcon="info"
  startIconActive
  styleVariant="contextual"
  title="Some features are temporarily unavailable"
  variant="promotional"
>
  <Text as="p" font="label2">
    Your funds are safe. We’re looking into it and expect our usual service to return soon.
    <Link to="https://www.coinbase.com">Learn more</Link>
  </Text>
</Banner>
```

### In-line Informational Banner

The in-line Informational Banner is used to provide users with additional information or helpful tips directly within the content or interface, providing relevant guidance.

```tsx live
<VStack gap={2}>
  <Banner
    startIcon="info"
    startIconActive
    styleVariant="inline"
    title="Some features are temporarily unavailable"
    variant="informational"
    primaryAction={<Link to="https://www.coinbase.com">Primary</Link>}
    secondaryAction={<Link to="https://www.coinbase.com">Secondary</Link>}
  >
    <Text as="p" font="label2">
      Your funds are safe. We’re looking into it and expect our usual service to return soon.
      <Link to="https://www.coinbase.com">Learn more</Link>
    </Text>
  </Banner>
  <Banner
    startIcon="warning"
    startIconActive
    styleVariant="inline"
    title="Some features are temporarily unavailable"
    variant="warning"
  >
    <Text as="p" font="label2">
      <Link to="https://www.coinbase.com">Retry</Link>
    </Text>
  </Banner>
</VStack>
```

### Rounded Corner Banners

You can customize `borderRadius` to soften contextual and in-line banners.

```tsx live
<VStack gap={2}>
  <Banner
    borderRadius={200}
    startIcon="info"
    startIconActive
    styleVariant="contextual"
    title="Rounded contextual banner"
    variant="informational"
  >
    <Text as="p" font="label2">
      Rounded corners help align with softer surface treatments within a page section.
    </Text>
  </Banner>
  <Banner
    borderRadius={400}
    primaryAction={<Link to="https://www.coinbase.com">Primary</Link>}
    secondaryAction={<Link to="https://www.coinbase.com">Secondary</Link>}
    startIcon="info"
    startIconActive
    styleVariant="inline"
    title="Rounded inline banner"
    variant="promotional"
  >
    <Text as="p" font="label2">
      You can incrementally increase the radius to match surrounding cards or panels.
    </Text>
  </Banner>
</VStack>
```

:::tip
Avoid setting `borderRadius` for `styleVariant="global"` so the vertical status bar remains aligned.
:::

### Bleed with Margin Props

When using negative `margin*` props to create a bleed effect, explicitly set `width` so the Banner expands beyond its container.

```tsx live
<VStack height={150} background="bgPositiveWash">
  <Banner
    marginX={-2}
    startIcon="info"
    startIconActive
    styleVariant="contextual"
    title="Bleeding banner"
    variant="informational"
    width="auto"
  >
    <Text as="p" font="label2">
      Use with prop to override the default 100% width
    </Text>
  </Banner>
</VStack>
```

## Props

| Prop | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `startIcon` | `IconName` | Yes | `-` | Name of icon to be shown in the banner |
| `variant` | `BannerVariant` | Yes | `-` | Sets the variant of the banner - which is responsible for foreground and background color assignment |
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
| `as` | `div` | No | `-` | The underlying element or component the polymorphic component will render.  Changing as also changes the inherited native props (e.g. href for as=a) and the expected ref type. |
| `aspectRatio` | `ResponsiveProp<AspectRatio>` | No | `-` | - |
| `background` | `ResponsiveProp<Color>` | No | `-` | - |
| `borderBottomLeftRadius` | `ResponsiveProp<BorderRadius>` | No | `-` | - |
| `borderBottomRightRadius` | `ResponsiveProp<BorderRadius>` | No | `-` | - |
| `borderBottomWidth` | `ResponsiveProp<BorderWidth>` | No | `-` | - |
| `borderColor` | `ResponsiveProp<Color>` | No | `-` | - |
| `borderEndWidth` | `ResponsiveProp<BorderWidth>` | No | `-` | - |
| `borderRadius` | `(BorderRadius & (BorderRadius \| { base?: BorderRadius; phone?: BorderRadius \| undefined; tablet?: BorderRadius \| undefined; desktop?: BorderRadius \| undefined; })) \| undefined` | No | `400 for contextual, undefined for global and inline` | Determines banners border radius |
| `borderStartWidth` | `ResponsiveProp<BorderWidth>` | No | `-` | - |
| `borderTopLeftRadius` | `ResponsiveProp<BorderRadius>` | No | `-` | - |
| `borderTopRightRadius` | `ResponsiveProp<BorderRadius>` | No | `-` | - |
| `borderTopWidth` | `ResponsiveProp<BorderWidth>` | No | `-` | - |
| `borderWidth` | `ResponsiveProp<BorderWidth>` | No | `-` | - |
| `bordered` | `boolean` | No | `true` | Determines whether banner has a border or not Add a border around all sides of the box. |
| `borderedBottom` | `boolean` | No | `-` | Add a border to the bottom side of the box. |
| `borderedEnd` | `boolean` | No | `-` | Add a border to the trailing side of the box. |
| `borderedHorizontal` | `boolean` | No | `-` | Add a border to the leading and trailing sides of the box. |
| `borderedStart` | `boolean` | No | `-` | Add a border to the leading side of the box. |
| `borderedTop` | `boolean` | No | `-` | Add a border to the top side of the box. |
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
| `children` | `ReactNode` | No | `-` | Message of banner |
| `closeAccessibilityLabel` | `string` | No | `'close'` | Accessibility label for close button on the banner |
| `color` | `ResponsiveProp<Color>` | No | `-` | - |
| `columnGap` | `ResponsiveProp<Space>` | No | `-` | - |
| `dangerouslySetBackground` | `string` | No | `-` | - |
| `display` | `ResponsiveProp<grid \| revert \| none \| block \| inline \| inline-block \| flex \| inline-flex \| inline-grid \| contents \| flow-root \| list-item>` | No | `-` | - |
| `elevation` | `ResponsiveProp<Elevation>` | No | `-` | - |
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
| `flexGrow` | `ResponsiveProp<FlexGrow>` | No | `-` | - |
| `flexShrink` | `ResponsiveProp<FlexShrink>` | No | `-` | - |
| `flexWrap` | `ResponsiveProp<nowrap \| wrap \| wrap-reverse>` | No | `-` | - |
| `font` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
| `fontFamily` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
| `fontSize` | `ResponsiveProp<FontSize \| inherit>` | No | `-` | - |
| `fontWeight` | `ResponsiveProp<FontWeight \| inherit>` | No | `-` | - |
| `gap` | `ResponsiveProp<Space>` | No | `-` | - |
| `grid` | `ResponsiveProp<Grid>` | No | `-` | - |
| `gridArea` | `ResponsiveProp<GridArea>` | No | `-` | - |
| `gridAutoColumns` | `ResponsiveProp<GridAutoColumns<string \| number>>` | No | `-` | - |
| `gridAutoFlow` | `ResponsiveProp<GridAutoFlow>` | No | `-` | - |
| `gridAutoRows` | `ResponsiveProp<GridAutoRows<string \| number>>` | No | `-` | - |
| `gridColumn` | `ResponsiveProp<GridColumn>` | No | `-` | - |
| `gridColumnEnd` | `ResponsiveProp<GridColumnEnd>` | No | `-` | - |
| `gridColumnStart` | `ResponsiveProp<GridColumnStart>` | No | `-` | - |
| `gridRow` | `ResponsiveProp<GridRow>` | No | `-` | - |
| `gridRowEnd` | `ResponsiveProp<GridRowEnd>` | No | `-` | - |
| `gridRowStart` | `ResponsiveProp<GridRowStart>` | No | `-` | - |
| `gridTemplate` | `ResponsiveProp<GridTemplate>` | No | `-` | - |
| `gridTemplateAreas` | `ResponsiveProp<GridTemplateAreas>` | No | `-` | - |
| `gridTemplateColumns` | `ResponsiveProp<GridTemplateColumns<string \| number>>` | No | `-` | - |
| `gridTemplateRows` | `ResponsiveProp<GridTemplateRows<string \| number>>` | No | `-` | - |
| `height` | `ResponsiveProp<Height<string \| number>>` | No | `-` | - |
| `justifyContent` | `ResponsiveProp<left \| right \| center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| space-between \| space-around \| space-evenly>` | No | `-` | - |
| `key` | `Key \| null` | No | `-` | - |
| `label` | `ReactNode` | No | `-` | Use for supplemental data |
| `left` | `ResponsiveProp<Left<string \| number>>` | No | `-` | - |
| `lineHeight` | `ResponsiveProp<LineHeight \| inherit>` | No | `-` | - |
| `margin` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginBottom` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginEnd` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginStart` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginTop` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginX` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginY` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `maxHeight` | `ResponsiveProp<MaxHeight<string \| number>>` | No | `-` | - |
| `maxWidth` | `ResponsiveProp<MaxWidth<string \| number>>` | No | `-` | - |
| `minHeight` | `ResponsiveProp<MinHeight<string \| number>>` | No | `-` | - |
| `minWidth` | `ResponsiveProp<MinWidth<string \| number>>` | No | `-` | - |
| `numberOfLines` | `number` | No | `-` | Indicates the max number of lines after which body text will be truncated |
| `onChange` | `FormEventHandler<HTMLDivElement>` | No | `-` | - |
| `onClose` | `(() => void)` | No | `-` | A callback fired when banner is dismissed |
| `opacity` | `ResponsiveProp<Opacity>` | No | `-` | - |
| `overflow` | `ResponsiveProp<hidden \| auto \| visible \| clip \| scroll>` | No | `-` | - |
| `padding` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingBottom` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingEnd` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingStart` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingTop` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingX` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingY` | `ResponsiveProp<Space>` | No | `-` | - |
| `pin` | `PinningDirection` | No | `-` | Direction in which to absolutely pin the box. |
| `position` | `ResponsiveProp<fixed \| static \| relative \| absolute \| sticky>` | No | `-` | - |
| `primaryAction` | `ReactNode` | No | `-` | Provide a CDS Link component to be used as a primary action. It will inherit colors depending on the provided variant |
| `ref` | `RefObject<HTMLDivElement> \| ((instance: HTMLDivElement \| null) => void) \| null` | No | `-` | - |
| `right` | `ResponsiveProp<Right<string \| number>>` | No | `-` | - |
| `rowGap` | `ResponsiveProp<Space>` | No | `-` | - |
| `secondaryAction` | `ReactNode` | No | `-` | Provide a CDS Link component to be used as a secondary action. It will inherit colors depending on the provided tone |
| `showDismiss` | `boolean` | No | `true` | Determines whether banner can be dismissed or not. Banner is not dismisable when styleVariant is set to global. |
| `startIconAccessibilityLabel` | `string` | No | `-` | Accessibility label for start icon on the banner |
| `startIconActive` | `boolean` | No | `-` | Whether the start icon is active |
| `style` | `CSSProperties` | No | `-` | - |
| `styleVariant` | `BannerStyleVariant` | No | `'contextual'` | Determines the banner style and indicates the suggested positioning for the banner |
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
| `textAlign` | `ResponsiveProp<center \| start \| end \| justify>` | No | `-` | - |
| `textDecoration` | `ResponsiveProp<none \| underline \| overline \| line-through \| underline overline \| underline double>` | No | `-` | - |
| `textTransform` | `ResponsiveProp<capitalize \| lowercase \| none \| uppercase>` | No | `-` | - |
| `title` | `ReactNode` | No | `-` | Title of banner. Indicates the intent of this banner |
| `top` | `ResponsiveProp<Top<string \| number>>` | No | `-` | - |
| `transform` | `ResponsiveProp<Transform>` | No | `-` | - |
| `userSelect` | `ResponsiveProp<text \| none \| auto \| all>` | No | `-` | - |
| `visibility` | `ResponsiveProp<hidden \| visible>` | No | `-` | - |
| `width` | `ResponsiveProp<Width<string \| number>>` | No | `-` | - |
| `zIndex` | `ResponsiveProp<ZIndex>` | No | `-` | - |