Class UIMediaGallery

Fullscreen viewer for registered UIImage and UIMediaPlayer collections.

Constructors

constructor

new UIMediaGallery(): UIMediaGallery
Returns UIMediaGallery
- Defined in packages/ui-kit/src/lib/media-gallery/media-gallery.component.ts:150

Properties

`Protected` `Readonly`activeIndex

activeIndex: Signal<number> = ...

`Protected` `Readonly`activeItem

activeItem: Signal<MediaGalleryItem> = ...

`Protected` `Readonly`activeItems

activeItems: Signal<readonly MediaGalleryItem[]> = ...

`Readonly`ariaLabel

ariaLabel: InputSignal<string> = ...

Accessible label for the fullscreen viewer.

`Protected` `Readonly`canNext

canNext: Signal<boolean> = ...

`Protected` `Readonly`canPrevious

canPrevious: Signal<boolean> = ...

`Readonly`closeOnBackdropClick

closeOnBackdropClick: InputSignal<boolean> = ...

Whether backdrop clicks close the viewer.

`Readonly`closePosition

closePosition: InputSignal<MediaGalleryClosePosition> = ...

Placement of the close button.

`Protected` `Readonly`controlsVisible

controlsVisible: WritableSignal<boolean> = ...

`Protected` `Readonly`cursorHidden

cursorHidden: WritableSignal<boolean> = ...

`Protected` `Readonly`expanded

expanded: WritableSignal<boolean> = ...

`Protected` `Readonly`fittedImageHeight

fittedImageHeight: WritableSignal<number | null> = ...

`Protected` `Readonly`fittedImageWidth

fittedImageWidth: WritableSignal<number | null> = ...

`Protected` `Readonly`gallery

gallery: MediaGalleryService = ...

Shared gallery state.

`Protected` `Readonly`hasNavigated

hasNavigated: WritableSignal<boolean> = ...

`Protected` `Readonly`icons

icons: {
    close: "<path d=\"M18 6 6 18\" /><path d=\"m6 6 12 12\" />";
    next: "<path d=\"m9 18 6-6-6-6\" />";
    previous: "<path d=\"m15 18-6-6 6-6\" />";
} = ...

`Readonly`idleDelay

idleDelay: InputSignal<number> = ...

Milliseconds of pointer inactivity before controls and cursor hide.

`Readonly`inline

inline: InputSignal<boolean> = ...

Render the supplied items directly on the page instead of fullscreen.

`Protected` `Readonly`inlineIndex

inlineIndex: WritableSignal<number> = ...

`Protected` `Readonly`isFullscreen

isFullscreen: Signal<boolean> = ...

`Protected` `Readonly`isInlineView

isInlineView: Signal<boolean> = ...

`Protected` `Readonly`isInteractiveImage

isInteractiveImage: Signal<boolean> = ...

`Protected` `Readonly`isVisible

isVisible: Signal<boolean> = ...

`Readonly`items

items: InputSignal<readonly MediaGalleryItem[]> = ...

Media items for constrained inline mode.

`Protected` `Readonly`panX

panX: WritableSignal<number> = ...

`Protected` `Readonly`panY

panY: WritableSignal<number> = ...

`Readonly`showFilmstrip

showFilmstrip: InputSignal<boolean> = ...

Whether the gallery should show the filmstrip.

`Readonly`startIndex

startIndex: InputSignal<number> = ...

Initial item index for inline mode.

`Protected` `Readonly`transform

transform: Signal<string> = ...

`Readonly`transition

transition: InputSignal<MediaGalleryTransition> = ...

Animation used when navigating between media items.

`Protected` `Readonly`transitionDirection

transitionDirection: WritableSignal<"forward" | "backward"> = ...

`Protected` `Readonly`zoom

zoom: WritableSignal<number> = ...

Class UIMediaGallery

Index

Constructors

Properties

Constructors

constructor

Returns UIMediaGallery

Properties

Protected ReadonlyactiveIndex

Protected ReadonlyactiveItem

Protected ReadonlyactiveItems

ReadonlyariaLabel

Protected ReadonlycanNext

Protected ReadonlycanPrevious

ReadonlycloseOnBackdropClick

ReadonlyclosePosition

Protected ReadonlycontrolsVisible

Protected ReadonlycursorHidden

Protected Readonlyexpanded

Protected ReadonlyfittedImageHeight

Protected ReadonlyfittedImageWidth

Protected Readonlygallery

Protected ReadonlyhasNavigated

Protected Readonlyicons

ReadonlyidleDelay

Readonlyinline

Protected ReadonlyinlineIndex

Protected ReadonlyisFullscreen

Protected ReadonlyisInlineView

Protected ReadonlyisInteractiveImage

Protected ReadonlyisVisible

Readonlyitems

Protected ReadonlypanX

Protected ReadonlypanY

ReadonlyshowFilmstrip

ReadonlystartIndex

Protected Readonlytransform

Readonlytransition

Protected ReadonlytransitionDirection

Protected Readonlyzoom

Settings

On This Page

`Protected` `Readonly`activeIndex

`Protected` `Readonly`activeItem

`Protected` `Readonly`activeItems

`Readonly`ariaLabel

`Protected` `Readonly`canNext

`Protected` `Readonly`canPrevious

`Readonly`closeOnBackdropClick

`Readonly`closePosition

`Protected` `Readonly`controlsVisible

`Protected` `Readonly`cursorHidden

`Protected` `Readonly`expanded

`Protected` `Readonly`fittedImageHeight

`Protected` `Readonly`fittedImageWidth

`Protected` `Readonly`gallery

`Protected` `Readonly`hasNavigated

`Protected` `Readonly`icons

`Readonly`idleDelay

`Readonly`inline

`Protected` `Readonly`inlineIndex

`Protected` `Readonly`isFullscreen

`Protected` `Readonly`isInlineView

`Protected` `Readonly`isInteractiveImage

`Protected` `Readonly`isVisible

`Readonly`items

`Protected` `Readonly`panX

`Protected` `Readonly`panY

`Readonly`showFilmstrip

`Readonly`startIndex

`Protected` `Readonly`transform

`Readonly`transition

`Protected` `Readonly`transitionDirection

`Protected` `Readonly`zoom