diff --git a/src/implementations/twig/components/banner/README.md b/src/implementations/twig/components/banner/README.md index cc228969be9..c3f3f37e35c 100644 --- a/src/implementations/twig/components/banner/README.md +++ b/src/implementations/twig/components/banner/README.md @@ -8,7 +8,8 @@ npm install --save @ecl/twig-component-banner ### Parameters -- **"variant"** (string) (default: 'primary') Variant of banner (can be 'primary', 'image','image-shade','image-gradient') +- **"variant"** (string) (default: 'plain-background') Variant of banner + (can be 'plain-background', 'text-box', 'text-highlight', 'image-overlay') - **"size"** (string) (default: 'm') Size of the banner (can be 's', 'm', 'l') - **"title"** (string) (default: '') Title of banner - **"image"** (string) (default: '') Image for banner (required for image banner type) diff --git a/src/implementations/twig/components/banner/__snapshots__/banner.test.js.snap b/src/implementations/twig/components/banner/__snapshots__/banner.test.js.snap index 206a0691818..82d4e880660 100644 --- a/src/implementations/twig/components/banner/__snapshots__/banner.test.js.snap +++ b/src/implementations/twig/components/banner/__snapshots__/banner.test.js.snap @@ -1,9 +1,9 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`Banner Primary renders correctly 1`] = ` +exports[`Banner Plain background renders correctly 1`] = `
`; -exports[`Banner Primary renders correctly with extra attributes 1`] = ` +exports[`Banner Plain background renders correctly with extra attributes 1`] = `
@@ -128,10 +128,10 @@ exports[`Banner Primary renders correctly with extra attributes 1`] = ` `; -exports[`Banner Primary renders correctly with extra class names 1`] = ` +exports[`Banner Plain background renders correctly with extra class names 1`] = `
`; -exports[`Banner image - gradient renders correctly 1`] = ` +exports[`Banner image - image overlay renders correctly 1`] = `
`; -exports[`Banner image - shade renders correctly 1`] = ` +exports[`Banner image - text highlight renders correctly 1`] = `
@@ -484,7 +484,7 @@ exports[`Banner image renders correctly with extra attributes 1`] = ` exports[`Banner image renders correctly with extra class names 1`] = `
-{% if _image is not empty and _variant in ['image', 'image-shade', 'image-gradient'] %} +{% if _image is not empty and _variant != 'plain-background' %}
{% endif %} -{% if _credit is not empty and _variant in ['image', 'image-shade', 'image-gradient'] %} +{% if _credit is not empty and _variant != 'plain-background' %}
{{ _credit }}
{% endif %}
diff --git a/src/implementations/twig/components/banner/banner.story.js b/src/implementations/twig/components/banner/banner.story.js index aedcd3b80ff..d98ccf3218c 100644 --- a/src/implementations/twig/components/banner/banner.story.js +++ b/src/implementations/twig/components/banner/banner.story.js @@ -3,14 +3,14 @@ import withCode from '@ecl/storybook-addon-code'; import { correctPaths } from '@ecl/story-utils'; // Import data for demos -import bannerDataPrimary from '@ecl/specs-component-banner/demo/data--primary'; -import bannerDataImage from '@ecl/specs-component-banner/demo/data--image-box'; -import bannerDataImageShade from '@ecl/specs-component-banner/demo/data--image-shade'; -import bannerDataImageGradient from '@ecl/specs-component-banner/demo/data--image-gradient'; +import bannerDataPlainBackground from '@ecl/specs-component-banner/demo/data--plain-background'; +import bannerDataTextBox from '@ecl/specs-component-banner/demo/data--text-box'; +import bannerDataImageOverlay from '@ecl/specs-component-banner/demo/data--image-overlay'; +import bannerDataTextHighlight from '@ecl/specs-component-banner/demo/data--text-highlight'; import banner from './banner.html.twig'; import notes from './README.md'; -const cta = { ...bannerDataPrimary.link }; +const cta = { ...bannerDataPlainBackground.link }; const getArgs = (data) => { const args = { show_title: true, @@ -230,37 +230,38 @@ export default { parameters: { layout: 'fullscreen' }, }; -export const Primary = (args) => renderStory(bannerDataPrimary, args); +export const PlainBackground = (args) => + renderStory(bannerDataPlainBackground, args); -Primary.storyName = 'primary'; -Primary.args = getArgs(bannerDataPrimary); -Primary.argTypes = getArgTypes(bannerDataPrimary); -Primary.parameters = { - notes: { markdown: notes, json: bannerDataPrimary }, +PlainBackground.storyName = 'plain background'; +PlainBackground.args = getArgs(bannerDataPlainBackground); +PlainBackground.argTypes = getArgTypes(bannerDataPlainBackground); +PlainBackground.parameters = { + notes: { markdown: notes, json: bannerDataPlainBackground }, }; -export const Image = (args) => renderStory(bannerDataImage, args); +export const TextBox = (args) => renderStory(bannerDataTextBox, args); -Image.storyName = 'image - text-block'; -Image.args = getArgs(bannerDataImage); -Image.argTypes = getArgTypes(bannerDataImage); -Image.parameters = { notes: { markdown: notes, json: bannerDataImage } }; +TextBox.storyName = 'text box'; +TextBox.args = getArgs(bannerDataTextBox); +TextBox.argTypes = getArgTypes(bannerDataTextBox); +TextBox.parameters = { notes: { markdown: notes, json: bannerDataTextBox } }; -export const ImageGradient = (args) => - renderStory(bannerDataImageGradient, args); +export const TextHighlight = (args) => + renderStory(bannerDataTextHighlight, args); -ImageGradient.storyName = 'image - gradient'; -ImageGradient.args = getArgs(bannerDataImageGradient); -ImageGradient.argTypes = getArgTypes(bannerDataImageGradient); -ImageGradient.parameters = { - notes: { markdown: notes, json: bannerDataImageGradient }, +TextHighlight.storyName = 'text highlight'; +TextHighlight.args = getArgs(bannerDataTextHighlight); +TextHighlight.argTypes = getArgTypes(bannerDataTextHighlight); +TextHighlight.parameters = { + notes: { markdown: notes, json: bannerDataTextHighlight }, }; -export const ImageShade = (args) => renderStory(bannerDataImageShade, args); +export const ImageOverlay = (args) => renderStory(bannerDataImageOverlay, args); -ImageShade.storyName = 'image - shade'; -ImageShade.args = getArgs(bannerDataImageShade); -ImageShade.argTypes = getArgTypes(bannerDataImageShade); -ImageShade.parameters = { - notes: { markdown: notes, json: bannerDataImageShade }, +ImageOverlay.storyName = 'image overlay'; +ImageOverlay.args = getArgs(bannerDataImageOverlay); +ImageOverlay.argTypes = getArgTypes(bannerDataImageOverlay); +ImageOverlay.parameters = { + notes: { markdown: notes, json: bannerDataImageOverlay }, }; diff --git a/src/implementations/twig/components/banner/banner.test.js b/src/implementations/twig/components/banner/banner.test.js index 6f3c4fed5f5..e694b225ad5 100644 --- a/src/implementations/twig/components/banner/banner.test.js +++ b/src/implementations/twig/components/banner/banner.test.js @@ -5,10 +5,10 @@ import { } from '@ecl/test-utils'; import { axe, toHaveNoViolations } from 'jest-axe'; -import bannerDataPrimary from '@ecl/specs-component-banner/demo/data--primary'; -import bannerDataImage from '@ecl/specs-component-banner/demo/data--image-box'; -import bannerDataImageShade from '@ecl/specs-component-banner/demo/data--image-shade'; -import bannerDataImageGradient from '@ecl/specs-component-banner/demo/data--image-gradient'; +import bannerDataPlainBackground from '@ecl/specs-component-banner/demo/data--plain-background'; +import bannerDataTextBox from '@ecl/specs-component-banner/demo/data--text-box'; +import bannerDataImageOverlay from '@ecl/specs-component-banner/demo/data--image-overlay'; +import bannerDataTextHighlight from '@ecl/specs-component-banner/demo/data--text-highlight'; expect.extend(toHaveNoViolations); @@ -16,8 +16,8 @@ describe('Banner', () => { const template = '@ecl/banner/banner.html.twig'; const render = (params) => renderTwigFileAsNode(template, params); - describe('Primary', () => { - const data = bannerDataPrimary; + describe('Plain background', () => { + const data = bannerDataPlainBackground; test(`renders correctly`, () => { expect.assertions(1); @@ -59,25 +59,25 @@ describe('Banner', () => { test(`- text-box renders correctly`, () => { expect.assertions(1); - return expect(render(bannerDataImage)).resolves.toMatchSnapshot(); + return expect(render(bannerDataTextBox)).resolves.toMatchSnapshot(); }); - test(`- gradient renders correctly`, () => { + test(`- text highlight renders correctly`, () => { expect.assertions(1); - return expect(render(bannerDataImageGradient)).resolves.toMatchSnapshot(); + return expect(render(bannerDataTextHighlight)).resolves.toMatchSnapshot(); }); - test(`- shade renders correctly`, () => { + test(`- image overlay renders correctly`, () => { expect.assertions(1); - return expect(render(bannerDataImageShade)).resolves.toMatchSnapshot(); + return expect(render(bannerDataImageOverlay)).resolves.toMatchSnapshot(); }); test('renders correctly with extra class names', () => { expect.assertions(1); - const withExtraClasses = merge(bannerDataImage, { + const withExtraClasses = merge(bannerDataTextBox, { extra_classes: 'custom-class custom-class--test', }); @@ -87,7 +87,7 @@ describe('Banner', () => { test('renders correctly with extra attributes', () => { expect.assertions(1); - const withExtraAttributes = merge(bannerDataImage, { + const withExtraAttributes = merge(bannerDataTextBox, { extra_attributes: [ { name: 'data-test', value: 'data-test-value' }, { name: 'data-test-1', value: 'data-test-value-1' }, @@ -99,7 +99,7 @@ describe('Banner', () => { test(`passes the accessibility tests`, async () => { expect( - await axe(renderTwigFileAsHtml(template, bannerDataImage, true)) + await axe(renderTwigFileAsHtml(template, bannerDataTextBox, true)) ).toHaveNoViolations(); }); }); diff --git a/src/implementations/twig/components/carousel/README.md b/src/implementations/twig/components/carousel/README.md index 17b1f38145d..b7e7f0284dc 100644 --- a/src/implementations/twig/components/carousel/README.md +++ b/src/implementations/twig/components/carousel/README.md @@ -8,7 +8,7 @@ npm install --save @ecl/twig-component-carousel ### Parameters -- **"items"** (array) (default: []): List of page-banner compatible with EC page-banner component structure +- **"items"** (array) (default: []): List of page-banner compatible with EC banner component structure - **"counter_label"** (string) (default: 'of') - **"sr_previous"** (string) (default: 'Previous slides') screen reader label for previous button - **"sr_next"** (string) (default: 'Next slides') screen reader label for next button diff --git a/src/implementations/twig/components/carousel/__snapshots__/carousel.test.js.snap b/src/implementations/twig/components/carousel/__snapshots__/carousel.test.js.snap index e0d5655a112..b934292cc7d 100644 --- a/src/implementations/twig/components/carousel/__snapshots__/carousel.test.js.snap +++ b/src/implementations/twig/components/carousel/__snapshots__/carousel.test.js.snap @@ -19,7 +19,7 @@ exports[`Carousel Default renders correctly 1`] = ` role="group" >
- + + -### Shaded image banner +### Image overlay banner - + -### Gradient image banner +### Text highlight banner - + -## Primary banner +## Plain background banner - + ## Other variants diff --git a/src/website/src/pages/eu/components/banner/demo/index.js b/src/website/src/pages/eu/components/banner/demo/index.js index 09056599cef..93ba841dfc7 100644 --- a/src/website/src/pages/eu/components/banner/demo/index.js +++ b/src/website/src/pages/eu/components/banner/demo/index.js @@ -1,16 +1,20 @@ -import demoContentImageBox from '@ecl/specs-component-banner/demo/data--image-box'; -import demoContentImageShade from '@ecl/specs-component-banner/demo/data--image-shade'; -import demoContentImageGradient from '@ecl/specs-component-banner/demo/data--image-gradient'; -import demoContentPrimary from '@ecl/specs-component-banner/demo/data--primary'; +import demoContentTextBox from '@ecl/specs-component-banner/demo/data--text-box'; +import demoContentImageOverlay from '@ecl/specs-component-banner/demo/data--image-overlay'; +import demoContentTextHighlight from '@ecl/specs-component-banner/demo/data--text-highlight'; +import demoContentPlainBackground from '@ecl/specs-component-banner/demo/data--plain-background'; import template from '@ecl/twig-component-banner/banner.html.twig'; import { correctSvgPath } from '@ecl/website-utils'; -export const bannerImageBox = template( - correctSvgPath(correctSvgPath(demoContentImageBox)) +export const bannerTextBox = template( + correctSvgPath(correctSvgPath(demoContentTextBox)) ); -export const bannerImageShade = template(correctSvgPath(demoContentImageShade)); -export const bannerImageGradient = template( - correctSvgPath(demoContentImageGradient) +export const bannerImageOverlay = template( + correctSvgPath(demoContentImageOverlay) +); +export const bannerTextHighlight = template( + correctSvgPath(demoContentTextHighlight) +); +export const bannerPlainBackground = template( + correctSvgPath(demoContentPlainBackground) ); -export const bannerPrimary = template(correctSvgPath(demoContentPrimary)); diff --git a/src/website/src/pages/eu/components/banner/docs/code.mdx b/src/website/src/pages/eu/components/banner/docs/code.mdx index b43ce859e82..bb5f513c5d1 100644 --- a/src/website/src/pages/eu/components/banner/docs/code.mdx +++ b/src/website/src/pages/eu/components/banner/docs/code.mdx @@ -5,56 +5,56 @@ order: 2 import { Html, Playground } from '@ecl/website-components'; import { - bannerImageBox, - bannerImageShade, - bannerImageGradient, - bannerPrimary, + bannerTextBox, + bannerImageOverlay, + bannerTextHighlight, + bannerPlainBackground, } from '../demo'; ## Image banners -### Text box image banner +### Text box banner - + -### Shaded image banner +### Image overlay banner - + -### Gradient image banner +### Text highlight banner - + -## Primary banner +## Plain background banner - + ## Other variants