XpmInitTemplatePropertiesDefinitions type alias

Represents a map of xpm init template property definitions.

Signature

export type XpmInitTemplatePropertiesDefinitions = Record<string, XpmInitTemplatePropertiesDefinition>;

References: XpmInitTemplatePropertiesDefinition

Remarks

Template properties define the interactive configuration interface for xpm init command, allowing templates to collect user input before generating project files.

Each property key becomes accessible in template files via Liquid syntax as {{ properties.key }}. Property definitions control the prompt type, validation, default values, and available options.

Example usage in template metadata:

{
  language: {
    label: 'Programming language',
    description: 'Select the preferred programming language',
    type: 'select',
    items: {
      c: 'C for the application files',
      cpp: 'C++ for the application files'
    },
    default: 'cpp',
    isMandatory: true
  }
}

---

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