From b3a9990b625de4fbad8cc54d7b7a445e34ca29b0 Mon Sep 17 00:00:00 2001 From: planctus Date: Wed, 15 Feb 2023 09:20:20 +0200 Subject: [PATCH] fix(media-container): Better describing the way to use the ratio parameter - FRONT-3864 (#2769) Co-authored-by: Romain Emery --- src/implementations/twig/components/media-container/README.md | 2 +- .../twig/components/media-container/media-container.html.twig | 2 +- .../twig/components/media-container/media-container.story.js | 3 ++- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/implementations/twig/components/media-container/README.md b/src/implementations/twig/components/media-container/README.md index a60c588bc7b..b70dd8f7f4b 100644 --- a/src/implementations/twig/components/media-container/README.md +++ b/src/implementations/twig/components/media-container/README.md @@ -21,7 +21,7 @@ npm install --save @ecl/twig-component-media-container - "label" (string) (default: ''), - "description" (string) (default: ''), - **"alt"** (string) (default: '') The alternate text foher the image, -- **"ratio"** (string) (default: 16-9) The ratio of the embedded media, if any, +- **"ratio"** (string) ('') Ratio of the embedded media, if empty the ratio will be set by the js - **"extra_classes"** (optional) (string) (default: '') Extra classes (space separated) - **"extra_attributes"** (optional) (array) (default: []) Extra attributes - "name" (string) Attribute name, eg. 'data-test' diff --git a/src/implementations/twig/components/media-container/media-container.html.twig b/src/implementations/twig/components/media-container/media-container.html.twig index 6ce62b2a10a..1a0bacfd98b 100644 --- a/src/implementations/twig/components/media-container/media-container.html.twig +++ b/src/implementations/twig/components/media-container/media-container.html.twig @@ -29,7 +29,7 @@ }, ... ] - - "ratio" (string) (default: 16-9) + - "ratio" (string) ('') Blocks: - "embedded_media" diff --git a/src/implementations/twig/components/media-container/media-container.story.js b/src/implementations/twig/components/media-container/media-container.story.js index 03c86e6d1c6..854af7d71e6 100644 --- a/src/implementations/twig/components/media-container/media-container.story.js +++ b/src/implementations/twig/components/media-container/media-container.story.js @@ -59,7 +59,7 @@ const getArgTypes = (data) => { argTypes.ratio = { name: 'ratio', type: { name: 'select' }, - description: 'Media ratio', + description: 'Media ratio (if empty the ratio will be set by the js)', options: { auto: '', '16/9': '16-9', @@ -69,6 +69,7 @@ const getArgTypes = (data) => { }, table: { type: { summary: 'string' }, + defaultValue: { summary: '' }, category: 'Display', }, };