Plugin Property Inspector (UI)

Property inspectors within your Stream Deck plugin play an integral role in allowing users to configure and customize your plugin's actions. Property inspectors must adhere to the following guidelines.

Requirements

• Do:use checkbox for boolean settings.
• Do:use select or radio for single-select settings.
• Do:provide validation feedback.
• Do:automatically save settings on change.
• Do:provide setup help — where necessary, provide links to support pages.
• Don't:

  include donation or sponsor links — prefer "Additional Links" in your product's page on Marketplace.

• Don't:list copyright — prefer description, or "Additional Links", in your product's page on Marketplace
• Don't:have a "Save" button for action settings.

Recommendations

• Recommended:

  hidden by default — to prevent flickering, when using a single property inspector file, hide components by default, and show only necessary components on DOM ready.

• Not recommended:

  complex configuration — avoid using "lots" of components; prefer splitting the action into smaller actions if necessary.

• Not recommended:large paragraphs — space is limited, and should be reserved for configuration.