@ecl-twig/ec-component-site-header v2.39.0

ECL-Twig Site Header component

npm package: @ecl-twig/ec-component-site-header

npm install --save @ecl-twig/ec-component-site-header

Parameters

• "icon_file_path" (string) (default: ''): file containing the svg icons
• "logo" (associative array) (default: predefined structure): Logo image settings. format:
  • "title" (string) (default: ''): Logo title attribute.
  • "alt" (string) (default: ''): Logo alt attribute.
  • "href" (string) (default: ''): Logo URL.
  • "src" (string) (default: ''): Logo image file path.
• "language_selector" (associative array) (default: predefined structure): Language switcher settings. format:
  • "href" (string) (default: ''): URL for switcher
  • "name" (string) (default: ''): Switcher language label, eg. 'English', 'Français', etc.
  • "code" (string) (default: ''): Switcher language code, eg. 'en', 'fr', etc.
  • "overlay" (associative array) (default: predefined structure): Overlay language switcher settings. format:
    • "close_label" (string) (default: ''): Close button label eg. 'Close'.
    • "title" (string) (default: ''): Overlay title, eg. 'Select your language'.
    • "items" (array) (default: []): (array) (default: []): format:
      • "lang" (string) (default: '') Item language code, eg. 'en', 'fr', etc.
      • "label" (string) (default: '') Item language label, eg. 'English', 'Français', etc.
      • "path" (string) (default: '') Item language URL eg. '/example#language_en'.
      • "active" (boolean) (default: false) define if item is the active language.
• "search_form" (associative array) (default: predefined structure): EC Search Form component structure
• "auto_init" (boolean) (default: false)
• "extra_classes" (optional) (string) (default: '') Extra classes (space separated)
• "extra_attributes" (optional) (array) (default: []) Extra attributes
  • "name" (string) Attribute name, eg. 'data-test'
  • "value" (string) Attribute value, eg: 'data-test-1'
• "_compliance_" (boolean) (default: false) Activates debug

Example :

{% include '@ecl-twig/ec-component-site-header/ecl-site-header.html.twig' with { 
  icon_file_path: '/path-to-the-icons-file', 
  logo: { 
    title: 'European Commission', 
    alt: 'European Commission logo', 
    href: '/example', 
    src: 'dist/images/logo--en.svg', 
  }, 
  language_selector: { 
    href: '/example', 
    name: 'English', 
    code: 'en', 
    overlay: { 
      close_label: 'Close', 
      title: 'Select your language', 
      items: [ 
        { lang: 'bg', label: 'български', path: '/example#language_bg' }, 
        { lang: 'es', label: 'español', path: '/example#language_es', active: true }, 
        ... 
      ], 
    }, 
  }, 
  searchForm: { 
    text_input: { 
      id: 'input-search', 
      name: 'search', 
    }, 
    button: { 
      label: 'Search', 
    }, 
  }, 
  extra_classes: 'my-extra-class-1 my-extra-class-2', 
  extra_attributes: [ 
    { name: 'data-test', value: 'data-test-value' }, 
    { name: 'data-test-1', value: 'data-test-value-1' } 
  ] 
} %}