Parámetros Nunjucks del componente: "Header"
params:
- name: skipLink
type: component
required: false
description: The skipLink component parameters
- name: homepageUrl
type: string
required: false
description: The url of the homepage. Defaults to /
- name: expandedLogo
type: boolean
required: false
description: When true, the logo has the complete logo with text. Use it when showing header to citizen public apps.
- name: noLogo
type: boolean
required: false
description: When true, there will be no Gobierno de Aragón logo.
- name: customLogoHtml
type: string
required: false
description: HTML for the custom logo. If provided there will appear a custom logo after the Gobierno de Aragón logo
- name: mobileTitle
type: object
required: false
description: The title of the app that appears after the logo only in mobile.
- name: text
type: string
required: true
description: If `html` is set, this is not required. Text for the mobileTitle. If `html` is provided, the `text` argument will be ignored.
- name: html
type: string
required: true
description: If `text` is set, this is not required. HTML for the mobileTitle. If `html` is provided, the `text` argument will be ignored.
- name: classes
type: string
required: false
description: Classes to add to the mobileTitle.
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the mobileTitle.
- name: subnav
type: object
required: false
description: Options for the subnav at right.
params:
- name: text
type: string
required: true
description: If `html` is set, this is not required. Text for the dropdown. If `html` is provided, the `text` argument will be ignored.
- name: html
type: string
required: true
description: If `text` is set, this is not required. HTML for the dropdown. If `html` is provided, the `text` argument will be ignored.
- name: hiddenText
type: string
required: false
description: Text for screenreaders only after the dropdown element.
- name: classesContainer
type: string
required: false
description: Classes to add to the container div of dropdown and tooltip elements.
- name: classesTooltip
type: string
required: false
description: Classes to add to the tooltip content.
- name: classes
type: string
required: false
description: Classes to add to the dropdown element.
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the dropdown element.
- name: contentHtml
type: string
required: true
description: Html content inside the subnav once opened.
- name: items
type: array
required: false
description: An array of navigation item objects in subnav. If no items are defined, there will be simple text instead a dropdown.
params:
- name: href
type: string
required: true
description: Item link.
- name: target
type: string
required: false
description: The target where the item should link to.
- name: text
type: string
required: true
description: If `html` is set, this is not required. Text to use within each nav item. If `html` is provided, the `text` argument will be ignored.
- name: html
type: string
required: true
description: If `text` is set, this is not required. HTML to use within each nav item. If `html` is provided, the `text` argument will be ignored.
- name: id
type: string
required: false
description: Specific id attribute for the checkbox item. If omitted, then idPrefix option will be applied.
- name: active
type: boolean
required: false
description: If true, item will be active.
- name: disabled
type: boolean
required: false
description: If true, checkbox will be disabled.
- name: divider
type: boolean
required: false
description: If true, a divider border will be shown after the item.
- name: classes
type: string
required: false
description: Classes to add to the item.
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the item.
- name: dropdown
type: object
required: false
description: Options for the dropdown at right.
params:
- name: text
type: string
required: true
description: If `html` is set, this is not required. Text for the dropdown. If `html` is provided, the `text` argument will be ignored.
- name: html
type: string
required: true
description: If `text` is set, this is not required. HTML for the dropdown. If `html` is provided, the `text` argument will be ignored.
- name: hiddenText
type: string
required: false
description: Text for screenreaders only after the dropdown element.
- name: classesContainer
type: string
required: false
description: Classes to add to the container div of dropdown and tooltip elements. Defaults to 'hidden lg:block'
- name: classesTooltip
type: string
required: false
description: Classes to add to the tooltip content.
- name: classes
type: string
required: false
description: Classes to add to the dropdown element.
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the dropdown element.
- name: contentHtml
type: string
required: true
description: Html content inside the dropdown once opened.
- name: items
type: array
required: true
description: An array of navigation item objects in subnav dropdown. If `items` is provided, the `contentHtml` argument will be ignored.
params:
- name: href
type: string
required: true
description: Item link.
- name: target
type: string
required: false
description: The target where the item should link to.
- name: text
type: string
required: true
description: If `html` is set, this is not required. Text to use within each nav item. If `html` is provided, the `text` argument will be ignored.
- name: html
type: string
required: true
description: If `text` is set, this is not required. HTML to use within each nav item. If `html` is provided, the `text` argument will be ignored.
- name: id
type: string
required: false
description: Specific id attribute for the checkbox item. If omitted, then idPrefix option will be applied.
- name: active
type: boolean
required: false
description: If true, item will be active.
- name: disabled
type: boolean
required: false
description: If true, checkbox will be disabled.
- name: divider
type: boolean
required: false
description: If true, a divider border will be shown after the item.
- name: classes
type: string
required: false
description: Classes to add to the item.
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the item.
- name: navigation
type: object
required: false
description: Options for the navigation main menu.
params:
- name: classes
type: string
required: false
description: Classes for the navigation menu component. Defaults to 'hidden lg:block'
- name: items
type: array
required: true
description: An array of navigation item objects in main menu.
params:
- name: text
type: string
required: false
description: Text for the navigation item. If `html` is provided, the `text` argument will be ignored.
- name: html
type: string
required: false
description: HTML for the navigation item. If `html` is provided, the `text` argument will be ignored.
- name: href
type: string
required: false
description: Url of the navigation item anchor. Both `href` and `text` attributes for navigation items need to be provided to create an item.
- name: target
type: string
required: false
description: The target where the item should link to.
- name: active
type: boolean
required: false
description: Flag to mark the navigation item as active or not.
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the navigation item anchor.
- name: customNavigationHtml
type: string
required: false
description: HTML for the custom navigation area. If provided there will appear an embed area where you can nest custom navigation after the default one.
- name: offcanvas
type: object
required: false
description: Options for the offcanvas menu.
params:
- name: text
type: string
required: true
description: Text for the offcanvas button.
- name: textClose
type: string
required: true
description: Text for the offcanvas button for close. Only visible in screenreaders.
- name: classes
type: string
required: false
description: Classes for the offcanvas component. Defaults to '-mr-2 flex lg:hidden'.
- name: containerClasses
type: string
required: false
description: Classes for the container, useful if you want to make the header fixed width.
- name: classes
type: string
required: false
description: Classes to add to the header container.
- name: attributes
type: object
required: false
description: HTML attributes (for example data attributes) to add to the header container.
- name: caller
type: nunjucks-block
required: false
description: Content inside the offcanvas. Not strictly a parameter but [Nunjucks code convention](https://mozilla.github.io/nunjucks/templating.html#call). Using a `call` block enables you to call a macro with all the text inside the tag. This is helpful if you want to pass a lot of content into a macro. To use it, you will need to wrap the entire header component in a `call` block.