@ecl/twig-component-media-container

4.1.2 • Public • Published

ECL Media container component

npm package: @ecl/twig-component-media-container

npm install --save @ecl/twig-component-media-container

Parameters

  • "description" (string) (default: '') - A caption to be shown under the media,
  • "picture" (associative array) (default: {}): Image for the media container, following ECL Picture structure
  • "full_width": (bool) (default: false) Full width media container (inside the grid container)
  • "sources" (array) (default: []) Array of Video sources with this structure:
    • "src" (string) (default: ''),
    • "type" (string) (default: ''),
  • "tracks" (array) (default: []): Array of Video tracks with this structure:
    • "src" (string) (default: ''),
    • "kind" (string) (default: ''),
    • "src_lang" (string) (default: ''),
    • "label" (string) (default: ''),
    • "description" (string) (default: ''),
  • "image": (string) (default: '') Path or url to the image used as the video placeholder
  • "ratio" (string) ('') Ratio of the embedded media, if empty the ratio will be set by the js
  • "expandable" (associative array) (default: {}): Optional expandable block, following ECL Expandable structure
  • "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'.

Blocks:

  • "embedded_media" (optional) (string) (default: '') A block where to set an embed code

Example for media container image:

{% include '@ecl/media-container/media-container.html.twig' with { 
  description: 'A description for this image', 
  extra_classes: 'my-extra-class-1 my-extra-class-2', 
  picture: {
    img: {
      src: '/path/to/your/image',
      alt: 'An alternate text',
    },
  },
  extra_attributes: [ 
    { name: 'data-test', value: 'data-test-value' }, 
    { name: 'data-test-1', value: 'data-test-value-1' } 
  ] 
} %} 

Package Sidebar

Install

npm i @ecl/twig-component-media-container

Weekly Downloads

108

Version

4.1.2

License

EUPL-1.2

Unpacked Size

20.9 kB

Total Files

4

Last publish

Collaborators

  • papegaill
  • yhuard
  • kalin.chernev
  • weslito
  • emeryro
  • planctus