Interface IPlaceholderItemData

A structure defining the default parameters of image placeholders.

Inheritance

IItemData

IShapeItemData

IPlaceholderItemData

Package: @aurigma/design-atoms-interfaces

Remarks

You can apply these parameters to the placeholder object through either **clientConfig.json** or IConfiguration.

Examples

The following example shows how you can allow your users to select images only from the **europe_photos** subfolder of the public folder and disable the cover mode.

{
   "defaultItemsConfig": {
       "placeholder": {
           "allowedSubfolder": "europe_photos",
           "isCoverMode": false
       }
   }
}

Properties

allowedSubfolder

Defines a subfolder of /assets/images/ from which the user can select images for placeholders. When you specify this property, the gallery shows images only from the corresponding public subfolder. By default, your users can select images from any gallery tab or public subfolder.

Declaration

allowedSubfolder?: string;

Property Value

Type	Description
string	Defines a subfolder of /assets/images/ from which the user can select images for placeholders. When you specify this property, the gallery shows images only from the corresponding public subfolder. By default, your users can select images from any gallery tab or public subfolder.

allowedTabs

Defines an array of gallery tab names from which the user can select images for placeholders. For example, to open only the **Public files** and **My files** tabs for image placeholders, set **allowedTabs** to ["Public files", "My files"]. By default, your users can select images from any gallery tab.

Declaration

allowedTabs?: string[];

Property Value

Type	Description
string[]	Defines an array of gallery tab names from which the user can select images for placeholders. For example, to open only the **Public files** and **My files** tabs for image placeholders, set **allowedTabs** to ["Public files", "My files"]. By default, your users can select images from any gallery tab.

barcodeContent

Defines the barcode content type.

Declaration

barcodeContent?: BarcodeContentType<TBarcodeFormat, TBarcodeSubType>;

Property Value

Type	Description
BarcodeContentType<TBarcodeFormat, TBarcodeSubType>	Defines the barcode content type.

barcodeFormat

Defines the barcode format.

Declaration

barcodeFormat?: TBarcodeFormat;

Property Value

Type	Description
TBarcodeFormat	Defines the barcode format.

contentBarcodeColor

Defines the barcode color. The default value is "rgb(0, 0, 0)".

Declaration

contentBarcodeColor?: string;

Property Value

Type	Description
string	Defines the barcode color. The default value is "rgb(0, 0, 0)".

contentBarcodeOptions

Declaration

contentBarcodeOptions?: IBarcodeOptions;

Property Value

Type	Description
IBarcodeOptions

contentImageUrl

Defines a link to an image used as the placeholder's content. You can define URLs, links to private images ("user:someprivateimage.png"), and images from the public gallery ("public:logos/logo.png").

Declaration

contentImageUrl?: string;

Property Value

Type	Description
string	Defines a link to an image used as the placeholder's content. You can define URLs, links to private images ("user:someprivateimage.png"), and images from the public gallery ("public:logos/logo.png").

contentOverlayEffect

Declaration

contentOverlayEffect?: TOverlayEffect;

Property Value

Type	Description
TOverlayEffect

contentPermissions

Defines permissions for the content of placeholders.

Declaration

contentPermissions?: IContentPermissionsData;

Property Value

Type	Description
IContentPermissionsData	Defines permissions for the content of placeholders.

contentResizeMode

Defines the resize mode for image placeholders. It can be either fill, fit, or original. The default value is fill.

Declaration

contentResizeMode?: ContentResizeMode;

Property Value

Type	Description
ContentResizeMode	Defines the resize mode for image placeholders. It can be either fill, fit, or original. The default value is fill.

fixedStubContentSize

Maintains the size of stub images while resizing image placeholders. The default value is false.

Declaration

fixedStubContentSize?: boolean;

Property Value

Type	Description
boolean	Maintains the size of stub images while resizing image placeholders. The default value is false.

isCoverMode

Enables the cover mode for image placeholders. The default value is true.

Declaration

isCoverMode?: boolean;

Property Value

Type	Description
boolean	Enables the cover mode for image placeholders. The default value is true.

isStubContent

Defines whether this is a stub placeholder. The default value is false.

Declaration

isStubContent?: boolean;

Property Value

Type	Description
boolean	Defines whether this is a stub placeholder. The default value is false.

placeholderPermissions

Defines permissions for placeholders.

Declaration

placeholderPermissions?: IPlaceholderPermissionsData;

Property Value

Type	Description
IPlaceholderPermissionsData	Defines permissions for placeholders.