@esri/hub.js
@esri/hub.js

IGalleryDisplayConfig

Interface

Configuration for how to display a gallery. This can apply to a catalog's display, a collection's display, the gallery-card's display, etc.

Properties

Property Type Notes
cardTitleTag Optional CARD_TITLE_TAGS

header tag for the gallery card titles - needed for a11y
corners Optional CORNERS

card corner appearance
customFiltersEnabled Optional boolean

Whether to apply a standard set of filters (that will update automatically as defaults evolve), or elect to manually reorder, show/hide, etc. filters to create a "custom" set.
filters Optional Array<{
hidden:
boolean
key:
"location" | "type" | "source" | "event-occurrence" | "event-from" | "event-attendance" | "tags" | "categories" | "license" | "modified" | "access" | "group-role" | "group-type" | "group-access" | "event-access" | "event-date"
label:
string
}>
hidden Optional boolean

s Used for collections to determine if the collection should be hidden in the gallery. If this is true on a collection's display config, that collection will not be shown in the gallery.
imageType Optional "thumbnail" | "icon"

Type of media to render in the layout card
layout Optional "list" | "grid" | "map" | "table" | "calendar" | "compact" | "grid-filled"

default layout
layouts Optional Array<"list" | "grid" | "map" | "table" | "calendar" | "compact" | "grid-filled">

Gallery layout options to expose in the layout switcher
linkButtonStyle Optional "solid" | "outline" | "outline-fill" | "transparent"

button style if showLinkButton = true
linkButtonText Optional string

button text rendered if showLinkButton = true
shadow Optional DROP_SHADOWS

card drop shadow
showLinkButton Optional boolean

whether to show a button on the gallery card linking out to the content - redundant with the title link, but it's currently supported/desired
showThumbnail Optional "show" | "hide" | "grid"

Indicates whether the card render show a thumbnail. "grid" means the card will only render a thumbnail if the layout is set to "grid"
sort Optional "relevance" | "title" | "created" | "modified"
Interface defined in packages/common/src/search/types/IHubCatalog.ts:176