feat(event-display): Use types for phoenix menu configuration

HSF · Feb 8, 2021 · 79e6d7c · 79e6d7c
1 parent 2219a3e
commit 79e6d7c
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/packages/phoenix-event-display/src/ui/phoenix-menu/phoenix-menu-node.ts b/packages/phoenix-event-display/src/ui/phoenix-menu/phoenix-menu-node.ts
@@ -1,3 +1,8 @@
+/**
+ * Configuration types for PhoenixMenuNode.
+ */
+export type PhoenixMenuConfig = 'checkbox' | 'slider' | 'button' | 'label' | 'color' | 'rangeSlider';
+
 /**
  * A single node of phoenix menu item.
  */
@@ -98,10 +103,11 @@ export class PhoenixMenuNode {
 
   /**
    * Add a config to the phoenix menu item.
+   * @param type Type of configuration.
    * @param options Options for the config.
    * @returns The current node.
    */
-  addConfig(type: string, options: any): PhoenixMenuNode {
+  addConfig(type: PhoenixMenuConfig, options: any): PhoenixMenuNode {
     let configOptions = { type };
     Object.assign(configOptions, options);
     const configsLength = this.configs.push(configOptions);