ECL Banner

npm package: @ecl/banner

npm install --save @ecl/banner

Parameters

• "id" (string) (default: random): unique id of the banner
• "color_mode" (string) (default: '') Name of the color mode
• "size" (string) (default: 'm') Size of the banner (can be 's', 'm', 'l')
• "font_size" (string) (default: 'm') Size of the title and description (can be 's', 'm', 'l')
• "font_color" (string) (default: 'dark') Color of the title and description (can be 'dark', 'light')
• "box_background" (string) (default: 'light') Color of the box background (can be 'dark', 'light', 'none')
• "title" (string or Link) (default: '') Title of banner
• "picture" (object) (default: {}): Image for the banner, following ECL Picture structure
• "video" (object) (default: {}): Video for the banner
  • "poster" (string) (default: ''): Image to be used as the video placeholder
  • "sources" (array) (default: []): format: [ { "src" (string) (default: ''), "type" (string) (default: ''), }, ... ],
  • "tracks" (array) (default: []): format: [ { "src" (string) (default: ''), "kind" (string) (default: ''), "src_lang" (string) (default: ''), "label" (string) (default: ''), }, ... ],
• "sr_play" (string) (default: '') screen reader label for the play button
• "sr_pause" (string) (default: '') screen reader label for the pause button
• "credit" (string) (default: '') Credit for the image
• "description" (string or Link) (default: '') Description of the banner
• "horizontal" (string) (default: 'left') Horizontal box alignment (can be 'left', 'center', 'right')
• "vertical" (string) (default: 'center') Vertical box alignment (can be 'top', 'center', 'bottom')
• "full_width" (bool) (default: false) Extends the banner to whole viewport when used inside the grid
• "link" (object) (default: predefined structure) predefined structure for the Link component
• "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'

Example:

{% include '@ecl/banner/banner.html.twig' with {  
  title: {
    link: {
      label: 'Lorem ipsum dolor sit amet consectetuer adipiscin',
      path: '#example',
    },
  },
  description:
    'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.',
  picture: {
    img: {
      src: 'url/path-to-image',
      alt: 'alternative text',
    },
  },
  credit: '© Copyright',
} %}