add methods for enabling and disabling save button

Author: bwp91

CHANGELOG.md

@@ -6,7 +6,9 @@ All notable changes to `@homebridge/plugin-ui-utils` will be documented in this
 
 ### Notable Changes
 
-- update to esm package
+- ⚠️ update to esm package
+- add methods for enabling and disabling save button
+  - requires homebridge ui `^5.0.0-beta.4`
 
 ## v1.0.3 (2024-04-06)
 

README.md

@@ -303,6 +303,26 @@ Hide the spinner / loading overlay.
 homebridge.hideSpinner()
 ```
 
+#### `homebridge.disableSaveButton`
+
+> `homebridge.disableSaveButton(): void`
+
+Disables the save button in the settings modal.
+
+```ts
+homebridge.disableSaveButton()
+```
+
+#### `homebridge.enableSaveButton`
+
+> `homebridge.enableSaveButton(): void`
+
+Enables the save button in the settings modal.
+
+```ts
+homebridge.enableSaveButton()
+```
+
 ### Forms
 
 The custom user interface allows you to create two types of forms:

package-lock.json

@@ -102,11 +102,11 @@ export declare class IHomebridgePluginUi extends EventTarget {
 
   /**
    * Show a loading spinner overlay.
-   * Prevents user input until cleared with `homebridge.hideSpinner();`
+   * Prevents user input until cleared with `homebridge.hideSpinner()`
    *
    * @example
    * ```ts
-   * homebridge.showSpinner();
+   * homebridge.showSpinner()
    * ```
    */
   public showSpinner(): void
@@ -116,18 +116,38 @@ export declare class IHomebridgePluginUi extends EventTarget {
    *
    * @example
    * ```ts
-   * homebridge.hideSpinner();
+   * homebridge.hideSpinner()
    * ```
    */
   public hideSpinner(): void
 
+  /**
+   * Disable the save button in the UI.
+   *
+   * @example
+   * ```ts
+   * homebridge.disableSaveButton()
+   * ```
+   */
+  public disableSaveButton(): void
+
+  /**
+   * Enable the save button in the UI.
+   *
+   * @example
+   * ```ts
+   * homebridge.enableSaveButton()
+   * ```
+   */
+  public enableSaveButton(): void
+
   /**
    * Show the schema-generated form below the custom UI.
    * This only works for platform plugins that have set `singular` = `true` in their config.schema.json file.
    *
    * @example
    * ```ts
-   * homebridge.showSchemaForm();
+   * homebridge.showSchemaForm()
    * ```
    */
   public showSchemaForm(): void
@@ -137,7 +157,7 @@ export declare class IHomebridgePluginUi extends EventTarget {
    *
    * @example
    * ```ts
-   * this.hideSchemaForm();
+   * this.hideSchemaForm()
    * ```
    */
   public hideSchemaForm(): void
@@ -179,7 +199,7 @@ export declare class IHomebridgePluginUi extends EventTarget {
    * });
    *
    * // stop listening / hide the form
-   * myForm.end();
+   * myForm.end()
    * ```
    */
   public createForm(schema: PluginFormSchema, data: any, submitButton?: string, cancelButton?: string): IHomebridgeUiFormHelper
@@ -196,7 +216,7 @@ export declare class IHomebridgePluginUi extends EventTarget {
    *
    * @example
    * ```ts
-   * const pluginConfigBlocks = await homebridge.getPluginConfig();
+   * const pluginConfigBlocks = await homebridge.getPluginConfig()
    * ```
    */
   public getPluginConfig(): Promise<PluginConfig[]>
@@ -227,7 +247,7 @@ export declare class IHomebridgePluginUi extends EventTarget {
    *
    * @example
    * ```ts
-   * await homebridge.savePluginConfig();
+   * await homebridge.savePluginConfig()
    * ```
    */
   public savePluginConfig(): Promise<void>
@@ -237,7 +257,7 @@ export declare class IHomebridgePluginUi extends EventTarget {
    *
    * @example
    * ```ts
-   * const schema = await homebridge.getPluginConfigSchema();
+   * const schema = await homebridge.getPluginConfigSchema()
    * ```
    */
   public getPluginConfigSchema(): Promise<PluginSchema>

src/ui.interface.ts

@@ -67,6 +67,8 @@ export class MockHomebridgePluginUi extends EventTarget implements IHomebridgePl
   public closeSettings() { }
   public showSpinner() { }
   public hideSpinner() { }
+  public disableSaveButton() {}
+  public enableSaveButton() {}
   public showSchemaForm() { }
   public hideSchemaForm() { }
   public endForm() { }

src/ui.mock.ts

@@ -203,6 +203,14 @@ class HomebridgePluginUi extends EventTargetConstructor {
     this._postMessage({ action: 'spinner.hide' })
   }
 
+  public disableSaveButton(): void {
+    this._postMessage({ action: 'button.save.disabled' })
+  }
+
+  public enableSaveButton(): void {
+    this._postMessage({ action: 'button.save.enabled' })
+  }
+
   public showSchemaForm(): void {
     this._postMessage({ action: 'schema.show' })
   }