Media Gallery

Overview

Media galleries are ideal for showcasing multiple images or other media related to a single product or topic. They provide an interactive way to browse through content with thumbnail previews that update the primary display when selected.

Best practices

When to use

• Showcasing multiple related images for a product or topic
• Providing an interactive way to browse through visual content

When not to use

• You only have one image (use an Image instead)
• The images are unrelated to each other

Usage

Within a standalone component

To use media gallery in a standalone component, import DAFF_MEDIA_GALLERY_COMPONENTS into your custom component:

import { DAFF_MEDIA_GALLERY_COMPONENTS } from '@daffodil/design/media-gallery';

@Component({
  selector: 'custom-component',
  templateUrl: './custom-component.component.html',
  imports: [
    DAFF_MEDIA_GALLERY_COMPONENTS,
  ],
})
export class CustomComponent {}

Within a module (deprecated)

To use media gallery in a module, import DaffMediaGalleryModule into your custom module:

import { NgModule } from '@angular/core';
import { DaffMediaGalleryModule } from '@daffodil/design/media-gallery';
import { CustomComponent } from './custom.component';

@NgModule({
    declarations: [
    CustomComponent,
  ],
  exports: [
    CustomComponent,
  ],
  imports: [
    DaffMediaGalleryModule,
  ],
})
export class CustomComponentModule { }

This method is deprecated. It's recommended to update all custom components to standalone.

Anatomy

A media gallery consists of the following components:

Container

<daff-media-gallery>: The wrapper component that contains all thumbnails and manages the display area.

Thumbnail

[daffThumbnail]: A structural directive that defines both the preview image and the content to display when selected. Thumbnails can contain any content type, not just images.

Basic structure

<daff-media-gallery>
  <ng-template daffThumbnail thumbnailSrc="/thumbnail-path.jpg" label="Your description">
    <daff-image src="/image-path.jpg" alt="Your description" width="500" height="500"></daff-image>
  </ng-template>
</daff-media-gallery>

Thumbnail configuration

• thumbnailSrc is used for the preview image rendered in the thumbnail strip.
• The content inside the template will be shown as the primary view when selected.
• You must include the full content for each thumbnail inside the template, even if it appears to duplicate the thumbnail image since this is what renders in the main display area when selected.
• Always provide an accessible label for a thumbnail using label.
• The isVideo property can be used to display a video icon on the thumbnail.
• The first thumbnail is selected by default.

Never use [daffThumbnail] as a standalone element. It must be placed within a <daff-media-gallery>.

Aspect ratio

Use a consistent aspect ratio across all content to avoid layout shifts. Mismatched content sizes can cause the primary content area to shift as different thumbnails are selected.

Thumbnails are rendered in a square by default, so a 1:1 ratio is recommended, but not required since thumbnails are automatically centered horizontally and vertically.

Accessibility

• Always provide an accessible label for each thumbnail using the label attribute.
• Each thumbnail is rendered as a button with an autogenerated aria-controls value that matches the id of the content container displayed when the thumbnail is selected.
• These id values are autogenerated but can be overridden by providing a custom id to the <daff-media-gallery> element.