Skip to main content

ResourceMetaDisplay

Configuration for how a resource should be displayed in the Ui. Used as part of ResourceMeta to control resource presentation.

Properties​

displayName​

displayName: string

The default user-friendly display name of the resource to show in Ui. This is a formatted version of the resource name intended for end users.

imageUrl?​

optional imageUrl: string

Url to an image representing this resource. When provided, the resource will be displayed with this image in the Ui.

pluralName?​

optional pluralName: string

The name of the resource in plural form. This can be set manually using the @pluralName decorator, or it will be generated automatically based on the resourceName.

preferPluralName?​

optional preferPluralName: boolean

When true, forces the use of the plural name in contexts where singular form would normally be used.

preferSingularName?​

optional preferSingularName: boolean

When true, forces the use of the singular name in contexts where plural form would normally be used.