@springernature/springer-media

7.0.0 • Public • Published

Springer Media

NPM version

The Springer Media component is derived from the media object pattern we see all over the web. Named by Nicole Sullivan. It describes a two-column box with an image on one side and descriptive content on the other.

It consists of:

  • a figure(optional) that is or contains the media element
  • a body that contains a heading(optional), often clickable, and some text

Note: Styles have also been included to add a play button for things like videos.

When to use this component

Use the Springer Media component to display a text block accompanied by an illustration to be positioned at its sides or stacked.

Installation

To use the Media component, enter the following command in your Terminal:

npm install @springernature/springer-media

Import the Sass:

@import '@springernature/springer-media/scss/10-settings/media';
@import '@springernature/springer-media/scss/50-components/media';

@import '@springernature/brand-context/default/scss/60-utilities/hiding.scss';

How it works

Stacked

It is possible to have the figure and text shown as one column. In order to do that add c-media--stacked to the element carrying the c-media class.

Figure placement

The figure can be displayed on the left or the right of the text.

To display it on the left, the element carrying the c-media__figure class should be positioned right before the element carrying thec-media__body class.

To display it on the right, the element carrying the c-media__figure class should be positioned right after the element carrying thec-media__body class.

When the component is stacked, left figure is shown above the text and right figure is shown below.

To display the text only, omit the element carrying the c-media__figure class.

Play icon

The component provides an option to show a play icon (triangle) on the figure, which can be used to link to video material. In order to do that, mark up the figure as shown in the code snippet below:

<div class="c-media__figure">
	<img src="{{src}}" alt="{{alt}}">
		<div class="c-media__play">
			<span class="u-visually-hidden">Video</span>
		</div>
</div>

Template

Find a configurable template in the view folder.

You can see an example in the demo folder.

Help improve this page

If you’ve got a question, idea or suggestion about how to improve this component or guidance, post in the #design-systems Slack channel.

Readme

Keywords

none

Package Sidebar

Install

npm i @springernature/springer-media

Weekly Downloads

0

Version

7.0.0

License

MIT

Unpacked Size

495 kB

Total Files

11

Last publish

Collaborators

  • ndv3997
  • sndigital
  • rseidelsohn
  • testingsabrina
  • roshandeorukhkar-sn
  • benjclark
  • sonniesedge
  • rlau
  • dotcode
  • joseluisbolos
  • hollsk
  • moddular
  • jpw
  • nickcall
  • howlingmad
  • davidpauljunior
  • morgaan