Porsche Design System
You are currently viewing an earlier release of the Porsche Design System.Switch to the latest Porsche Design System documentation.
SearchNavigate to GitHub repository of Porsche Design SystemOpen sidebar
ConfiguratorExamplesUsageAccessibilityAPI
Banner Table of ContentsPropertiesPropertyAttributeDescriptionTypeDefaultdescription descriptionDescription of the banner.string''dismissButton dismiss-buttonIf false, the banner will not have a dismiss button.booleantrueheading headingHeading of the banner.string''headingTag heading-tagSets a heading tag, so it fits correctly within the outline of the page.type BannerHeadingTag =
'h1'
'h2'
'h3'
'h4'
'h5'
'h6''h5'open openIf true, the banner is open.booleanfalsepersistent 🚫persistentdeprecated since v3.0.0, will be removed with next major release, use dismissButton instead. Defines if the banner can be closed/removed by the user.booleanundefinedstate stateState of the banner.type BannerState =
'info'
'warning'
'error'
'neutral' 🚫'info'theme themeAdapts the banner color depending on the theme.type Theme =
'light'
'dark'
'auto''light'width 🚫widthHas no effect anymore deprecated since v3.0.0, will be removed with next major releaseBannerWidthundefinedEventsEventDescriptionTypedismiss Emitted when the close button is clicked.CustomEvent<void>SlotsSlotDescriptionisRequiredaltPropallowedTagNames<slot name="heading"> Defines the heading used in the banner. Can be used alternatively to the heading prop. Can be used for rich content.heading<slot name="title"> 🚫Please use the heading prop or slot="heading" instead.title<slot name="description"> Defines the description used in the banner. Can be used alternatively to the description prop. Can be used for rich content.descriptionCSS VariablesCSS VariableDescriptiondefaultValue--p-banner-position-top Position top of banner56px--p-banner-position-bottom Position bottom of banner. Only has an effect below breakpoint 's'.56px
Global settingsThemeChanges the theme of the application and any Porsche Design System component. It's possible to choose between forced theme light and dark. It's also possible to use auto, which applies light or dark theme depending on the operating system settings automatically.LightDarkAuto (sync with operating system)DirectionThe 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%