Class AcApI18n

constructor

• new AcApI18n(): AcApI18n

  Returns AcApI18n

Static Readonlyevents

StaticcurrentLocale

• get currentLocale(): AcApLocale

  Get the currently active locale.

  Returns AcApLocale

  The locale currently used for translation.

  Example

  console.log(AcApI18n.currentLocale)  // "en" or "zh"
  Copy

Staticmessages

• get messages(): Readonly<AcApLocaleMessages>

  Return the whole messages map (for vue-i18n initialisation).

  Returns Readonly<AcApLocaleMessages>

StaticcmdDescription

• cmdDescription(groupName: string, cmdName: string): string

  Get localized command description

  Parameters

  • groupName: string

    Command group name

  • cmdName: string

    Global command name

  Returns string

  • The localized command description.

StaticcmdPrompt

• cmdPrompt(groupName: string, cmdName: string): string

  Get localized command prommpt message

  Parameters

  • groupName: string

    Command group name

  • cmdName: string

    Global command name

  Returns string

  • The localized command prompt message.

StaticgetLocaleMessage

• getLocaleMessage(locale: AcApLocale): Readonly<AcApLocaleMessage>

  Return the messages object for a single locale.

  Parameters

  • locale: AcApLocale

  Returns Readonly<AcApLocaleMessage>

StaticmergeLocaleMessage

• mergeLocaleMessage<L extends AcApLocale>(
      locale: L,
      messages: AcApLocaleMessage,
  ): void

  Deep-merge a message dictionary into an existing locale.

  Type Parameters

  • L extends AcApLocale

  Parameters

  • locale: L
  • messages: AcApLocaleMessage

  Returns void

StaticregisterMessage

• registerMessage<L extends AcApLocale>(
      locale: L,
      messages: AcApLocaleMessage,
  ): void

  Register a plugin's messages. Alias for mergeLocaleMessage for consistency with vue-i18n.

  Type Parameters

  • L extends AcApLocale

  Parameters

  • locale: L
  • messages: AcApLocaleMessage

  Returns void

StaticsetCurrentLocale

• setCurrentLocale(locale: AcApLocale): void

  Set the current active locale for translation.

  Parameters

  • locale: AcApLocale

    Locale to activate ("en" or "zh")

  Returns void

  Remarks

  This method updates the internal locale state used by all future calls to t(key, options). After calling this method, the entire application will use the new locale automatically.

  Example

  AcApI18n.setCurrentLocale('zh')
  console.log(AcApI18n.t('core.start'))   // uses Chinese messages
  Copy

StaticsysCmdDescription

• sysCmdDescription(name: string): string

  Tries to find command in system group and gets its localized command description

  Parameters

  • name: string

  Returns string

  • The localized command description

StaticsysCmdPrompt

• sysCmdPrompt(name: string): string

  Tries to find command in system group and gets its localized command prompt message

  Parameters

  • name: string

  Returns string

  • The localized command prompt message

Statict

• t(key: string, options?: AcApTranslateOptions): string

  Translate a dotted key path using the registry (no Vue required).

  Parameters

  • key: string

    dotted path, e.g. "core.start" or "pluginX.button.ok"

  • Optionaloptions: AcApTranslateOptions

    optional fallback

  Returns string

  translated string or fallback/key if not found

StaticuserCmdDescription

• userCmdDescription(name: string): string

  Tries to find command in user group and gets its localized command description

  Parameters

  • name: string

  Returns string

  • The localized command description

StaticuserCmdPrompt

• userCmdPrompt(name: string): string

  Tries to find command in user group and gets its localized command prompt message

  Parameters

  • name: string

  Returns string

  • The localized command prompt message