Mirakl Design
Mirakl Design
  • Getting started
    • Welcome to Roma
      • Design principles
  • Design
    • Components
      • Actions
        • Action menu
        • Buttons
        • Button group
        • File download
        • Save bar
        • Tasklist
        • Contextual Toolbar
      • Datalist
      • Datatable
      • Feedback
        • Alerts
        • Activity Loader
        • Badge (status)
        • Empty state
        • Snackbar
      • Form
        • Fields
        • Pickers
        • Selection controls
        • Tree
      • Images
        • Illustrations
        • Icons
        • Media
      • Navigation
        • Hyperlink
        • Page title
        • Sidebar
        • Top bar
      • Overlays
        • Modal
        • Popover
        • Tooltip
        • Side Drawer
      • Structure
        • Global layout
        • Panel
          • Activable Panel
          • Clickable Panel
          • Expandable Panel
          • Panel tabs
          • Totalizer Panel
        • Card
    • Patterns
      • Advanced selection
      • Configure options
      • Displaying data
      • Displaying history
      • Errors
      • Forms
        • Form - Creation mode
        • Form - Edition mode
        • Form - In a modal
        • Error Management
        • Stepper form
        • Onboarding form
      • Loading
      • Progressive disclosure
  • content
    • Writing for Mirakl
      • Grammar and formatting
    • Vocabulary
      • Mirakl products
      • Which verb to use
Powered by GitBook
On this page
  • Overview
  • Size and formats
  • Technical specifications
  • Lightbox
  • Avatar
  • Guidelines
  • How to use
  • How to not use
  • Accessibility
  • Key takeaways

Was this helpful?

  1. Design
  2. Components
  3. Images

Media

The Media component is designed to display images or videos, enhancing interfaces by providing graphic or video representations.

Last updated 7 months ago

Was this helpful?

Overview

Use the Media component to add graphics into the interface like image, illustrations, videos, flags, icons or avatars to the interface.

Size and formats

The component can adapt from very small (siez 5) to extra extra large (size 11) sizes, allowing flexibility in design and layout. In total 7 sizes are available.

The component adjusts its design to adapt for differents formats :

  • Square Images: Fill the entire space.

  • Landscape Images: Fit to height.

  • Portrait Images: Fit to width.

  • Custom Sizing: Media dimensions can be customized with specific max and min widths and heights, ensuring optimal display across devices.

Technical specifications

Media comes with an empty state, to be used when no media has been provided. It is also used for loading state.

Hovering over the media reveals a preview icon. Media is clickable, triggering a Lightbox for preview.

Lightbox

Media appears as a thumbnail image, providing a clean and uniform look across the platform. When a user clicks on the thumbnail, the media opens in a dedicated overlay (called a Lightbox). This Lightbox focuses the viewer’s attention by dimming the rest of the website and presenting the media in a larger, central frame. This feature is especially useful for videos but also allows users to view images in a larger format.

Avatar

The Avatar component adapts to show users or entities. It can display initials, icons, or images, with the name shown when you hover. Clicking triggers actions.

To display multiple avatars, uses component Avatars it automatically handles different colors and spacing.

Disabled avatars show that the user or entity is no longer active.

Guidelines

How to use

  • Enhance content by adding visual representation : Use Media to add value to the content, aiding in user navigation and comprehension without overwhelming the text content.

  • Media to the second plan : Media should never dominate the page or replace textual information, it always has to be used as a complementary source of knowlegde.

How to not use

  • Decorative purpose only: Do not use Media component if it does not add informational value or if it overly clutters the interface.

Accessibility

  • Screen Reader Support: All media must have alt text for screen readers, enhancing accessibility for visually impaired users. For videos, use video tracks with captions. Avoid repeating information already present on the page visually.

  • Captions and Tracks: Adding captions to images and providing track support for videos (with captions, subtitles) is crucial for accessibility and compliance with web standards.

Key takeaways

  • Context is crucial: media should add value to the related content.

  • Use the right component size considering the whole page design

  • Provide descriptive Alt-text for screen readers and captions for all other users

  • Use Media with no context to it

  • Repeat information in your alt text that is already on the page.

Illustration of Media Component
How various media format are displayed
Hovering a media
Lightbox