Skip to contentPorsche Design System
You are currently viewing an earlier release of the Porsche Design System.Switch to the latest Porsche Design System documentation.
SearchGitHub repository of Porsche Design SystemOpen settings sidebar
Banner Table of ContentsPropertiestype BreakpointCustomizable<T> = { base: T; xs?: T; s?: T; m?: T; l?: T; xl?: T; xxl?: T; };PropertyAttributeDescriptionTypeDefaultdescription descriptionSets the supporting description text shown below the heading.string''dismissButton dismiss-buttonShows a dismiss button so the user can manually close the banner.booleantrueheading headingSets the heading text displayed at the top of the banner.string''headingTag heading-tagSets the HTML heading tag (e.g. h2, h3) to maintain correct document structure for the heading.type BannerHeadingTag =
'h1'
'h2'
'h3'
'h4'
'h5'
'h6''h5'open openControls whether the banner is visible. Set to true to show it and false to hide it.booleanfalseposition 🛠positionSets the position of the banner on screen — top or bottom. Supports responsive breakpoint values.type BannerPosition =
'top'
'bottom'
BreakpointCustomizable<BannerPosition>{ "base": "bottom", "s": "top" }state stateSets the visual state of the banner — controls the icon and color scheme (info, warning, error, success).type BannerState =
'info'
'success'
'warning'
'error''info'EventsEventDescriptionTypedismiss Emitted when the user closes the banner via the dismiss button or Escape key.CustomEvent<void>SlotsSlotDescriptionisRequiredaltPropallowedTagNames<slot name="heading"> Defines the heading of the banner. Can be used as an alternative to the `heading` prop for rich content.<slot> Default slot for the banner description content.<slot name="description"> 🚫Deprecated: Use the default slot instead.CSS VariablesCSS VariableDescriptiondefaultValue--p-banner-max-w Defines the maximum width of the Banner.100ch--p-banner-top Defines the distance from the top of the viewport. Only takes effect when the `position` property is set to `top` (at the respective breakpoint).56px--p-banner-bottom Defines the distance from the bottom of the viewport. Only takes effect when the `position` property is set to `bottom` (at the respective breakpoint).56px--p-banner-inset-x Defines the horizontal offset of the Banner from the edges of the viewport.max(22px, 10.625vw - 12px)
Global settingsColor SchemeAll color tokens use the light-dark() CSS function. Set the theme via the CSS color-scheme property: light for light mode, dark for dark mode, or light dark to follow the user's system preference.LightDarkLight DarkDirectionThe dir global attribute in HTML changes the direction of text and other content within an element. It's most often used on the <html> tag to set the entire page's direction, which is crucial for supporting languages that are written from right to left (RTL), such as Arabic and Hebrew. For example, using <html dir="rtl"> makes the entire page display from right to left, adjusting the layout and text flow accordingly.LTR (left-to-right)RTL (right-to-left)Text ZoomTo ensure accessibility and comply with WCAG 2.2 AA standards, it is mandatory for web content to support text resizing up to at least 200% without loss of content or functionality. Using relative units like rem is a best practice for achieving this, as they allow the text to scale uniformly based on the user's browser settings.100%130%150%200%