ui/ Grid List Image Item
Unstyled grid list image item components and behaviors to be customized by a theme or application.
import GridListImageItem from '@enact/ui/GridListImageItem';
Members
GridListImageItemComponent
A basic grid list image item without any behavior.
import GridListImageItem from '@enact/ui/GridListImageItem';
Properties
The primary caption to be displayed with the image.
The component used to render the captions
Customizes the component by mapping the supplied collection of CSS class names to the corresponding internal Elements and states of this component.
The following classes are supported:
icon
- The icon component class for default selection overlayimage
- The image component classselected
- Applied whenselected
prop istrue
caption
- The caption component classsubCaption
- The subCaption component class
The component used to render the default check icon when selected. If there is custom selectionOverlay component, this icon will not be shown.
Default: ui/Icon.IconThe component used to render the image component
Default: ui/Image.ImagePlaceholder image used while source is loaded.
Applies a selected visual effect to the image, but only if
selectionOverlayShowing
is alsotrue
.Default: falseThe custom selection overlay component to render.
A component can be a stateless functional component,
kind()
or React component. The following is an example with custom selection overlay kind.Example:
const SelectionOverlay = kind({ render: () => <div>custom overlay</div> }); <GridListImageItem selectionOverlay={SelectionOverlay} />
Shows a selection overlay with a centered icon. When
selected
is true, a check mark is shown.Default: falseThe absolute URL path to the image.
The second caption line to be displayed with the image.