@acrolinx/sidebar-interface
Options
All
  • Public
  • Public/Protected
  • All
Menu

Provide information about your integration and other client software components for the about dialog and analytics.

Hierarchy

  • SoftwareComponent

Index

Properties

Properties

Optional category

category: undefined | string

Check SoftwareComponentCategory to choose the right value for your component. By default value this value will be set to 'DEFAULT'.

id

id: string

The id of the software component. Examples: 'com.acrolinx.win.word.32bit', 'com.acrolinx.mac.word'

name

name: string

The name if the software component. This name will be displayed in the sidebars about dialog.

version

version: string

The version of the software component.

format:

${major}.${minor}.${patch}.${buildNumber}

example:

'1.2.3.574'

Legend

  • Object literal
  • Type alias
  • Interface
  • Property
  • Enumeration

Generated using TypeDoc