Banner (banner)

Banners identify official websites of government organizations in the United States. They also help visitors understand whether a website is official and secure.

🔗 External documentation.

ID Label Description Schema
icon_path Icon path Path to the icon to use in banner.
                        type: string

                      
mil .mil site Is the site a .mil site?
                        type: boolean

                      
            id: banner
label: Banner
description: 'Banners identify official websites of government organizations in the United States. They also help visitors understand whether a website is official and secure.'
group: 'Alerts / Banner'
homepage: 'https://designsystem.digital.gov/components/banner/'
props:
    icon_path:
        id: icon_path
        label: 'Icon path'
        description: 'Path to the icon to use in banner.'
        schema:
            type: string
    mil:
        id: mil
        label: '.mil site'
        description: 'Is the site a .mil site?'
        schema:
            type: boolean
examples:
    preview:
        id: preview
        label: Preview
        renderable:
            '@component': banner
            icon_path: 'https://cdn.jsdelivr.net/npm/@uswds/uswds@3.7.0/dist/img/'