XpmInitTemplateItems type alias

Represents the available items for a select type property in xpm init templates.

Signature

export type XpmInitTemplateItems = Record<string, string | XpmInitTemplateItemValue>;

References: XpmInitTemplateItemValue

Remarks

Items define the options users can choose from when a property uses the select type. Each key represents the value stored when that option is selected, whilst the value provides the description shown to the user.

Item values can be either:

Simple string: A description shown to all users regardless of platform.
XpmInitTemplateItemValue: A platform-specific item that only appears when the current platform matches the platforms constraint.

Example:

{
  gcc: 'The GCC compiler',
  clang: {
    platforms: ['darwin'],
    message: 'The Clang compiler (macOS only)'
  }
}

Generated via tsdoc2docusaurus 1.3.0-pre by API Extractor/Documenter 7.55.2.

Signature​

Remarks​

Signature

Remarks