Represents an entry in the asset library, combining data and view configurations.
Extends#
Properties#
| Property | Type | Description | Inherited from |
|---|---|---|---|
id | string | - | AssetLibraryEntryData.id |
sourceIds | string[] | (context) => string[] | - |
sceneMode? | SceneMode | "All" | |
excludeGroups? | string[] | - | AssetLibraryEntryData.excludeGroups |
includeGroups? | string[] | - | AssetLibraryEntryData.includeGroups |
title? | string | (options) => string | - |
canAdd? | boolean | (sourceId) => boolean | If true an upload button will be shown and the uploaded file will be added to the source. If a function is used it will be called with the current asset source id. The asset source needs to support addAsset. |
canRemove? | boolean | (sourceId) => boolean | If true the asset can be removed from the asset source. If a function is used it will be called with the current asset source id. The asset source needs to support removeAsset. |
showGroupOverview? | boolean | - | AssetLibraryEntryView.showGroupOverview |
promptBeforeApply? | boolean | { show: boolean; sourceIds?: string[]; } | |
icon? | CustomIcon | - | AssetLibraryEntryView.icon |
previewLength? | number | Determines how many asset results will be show in an overview or section overview. | AssetLibraryEntryView.previewLength |
previewBackgroundType? | "cover" | "contain" | Determines if the thumbUri is set as a background that will be contained or covered by the card in an overview or section overview. |
gridBackgroundType? | "cover" | "contain" | Determines if the thumbUri is set as a background that will be contained or covered by the card in the grid view |
gridColumns? | number | Number of columns in the grid view | AssetLibraryEntryView.gridColumns |
gridItemHeight? | "auto" | "square" | Determines the height of an item in the grid view. - auto automatically determine height yielding a masonry-like grid view - square every card will have the same square size |
cardBackgroundPreferences? | CardBackground[] | (asset) => CustomCardBackground | |
cardBorder? | boolean | Draws a border around the card if set to true | AssetLibraryEntryView.cardBorder |
cardLabel? | (assetResult) => string | Overwrite the label of a card for a specific asset result | AssetLibraryEntryView.cardLabel |
cardStyle? | (assetResult) => Record<string, string> | Add custom styles to a card for a specific asset result | AssetLibraryEntryView.cardStyle |
cardLabelStyle? | (assetResult) => Record<string, string> | Add custom styles to a label for a specific asset result | AssetLibraryEntryView.cardLabelStyle |
cardLabelPosition? | (assetResult) => "inside" | "below" | Position the label inside or below the card. Defaults to ‘inside’. |
cardLabelTruncateLines? | (assetResult) => "single" | "multi" | Control label truncation to occur at end of first line (‘single’), or at end of second line (‘multi’). Defaults to ‘multi’. |
disableTooltips? | boolean | Control whether tooltips should be disabled for asset library cards. When set to true, tooltips will not be shown on cards. Defaults to false (tooltips are shown). | AssetLibraryEntryView.disableTooltips |
sortBy? | SortingOrder | { sortKey?: string; sortingOrder?: SortingOrder; } |