@teambit/command-bar 0.0.554 → 0.0.555

package/dist/command-bar.ui.runtime.d.ts

@@ -10,23 +10,43 @@ export declare type CommandEntry = {
     keybinding?: Keybinding;
     displayName: string;
 };
+/** Quick launch actions. Use the `addSearcher` slot to extend the available actions */
 export declare class CommandBarUI {
     private searcherSlot;
     private commandSlot;
     private mousetrap;
     private commandSearcher;
+    /** Opens the command bar */
     open: () => boolean;
+    /** Closes the command bar */
     close: () => void;
+    /** Add and autocomplete provider. To support keyboard navigation, each result should have a props `active: boolean`, and `exectue: () => any` */
     addSearcher(commandSearcher: SearchProvider): this;
+    /**
+     * registers a command
+     */
     addCommand(...originalCommands: CommandEntry[]): ((next: CommandHandler) => void)[];
+    /**
+     * executes command by name, if exists.
+     * @param commandId
+     */
     run(commandId: CommandId): any;
+    /**
+     * executes a keyboard shortcut manually
+     */
     trigger: (key: string) => void;
     private search;
     private getCommand;
     private updateCommandsSearcher;
     private addKeybinding;
     private renderContext;
+    /**
+     * internal. Opens and closes the command bar UI.
+     */
     setVisibility?: (visible: boolean) => void;
+    /**
+     * generate the ui for command bar
+     */
     getCommandBar: () => JSX.Element;
     constructor(searcherSlot: SearcherSlot, commandSlot: CommandSlot, pubSub: PubsubUI);
     static dependencies: import("@teambit/harmony").Aspect[];

package/dist/types.d.ts

@@ -9,7 +9,9 @@ export declare type CommanderSearchResult = {
     keybinding?: Keybinding;
 };
 export interface SearchProvider {
+    /** provide completions for this search term */
     search(term: string, limit: number): CommanderSearchResult[];
+    /** determines what terms are handled by this searcher. */
     test(term: string): boolean;
 }
 export declare type Keybinding = string | string[];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/command-bar",
-  "version": "0.0.554",
+  "version": "0.0.555",
   "homepage": "https://bit.dev/teambit/explorer/command-bar",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.explorer",
     "name": "command-bar",
-    "version": "0.0.554"
+    "version": "0.0.555"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -19,14 +19,14 @@
     "core-js": "^3.0.0",
     "@teambit/base-ui.surfaces.card": "1.0.1",
     "@teambit/base-ui.text.muted-text": "1.0.1",
-    "@teambit/preview": "0.0.554",
-    "@teambit/pubsub": "0.0.554",
-    "@teambit/ui-foundation.ui.is-browser": "0.0.462",
-    "@teambit/ui": "0.0.554",
-    "@teambit/bit-error": "0.0.371",
-    "@teambit/ui-foundation.ui.constants.z-indexes": "0.0.462",
-    "@teambit/ui-foundation.ui.keycap": "0.0.462",
-    "@teambit/component": "0.0.554"
+    "@teambit/preview": "0.0.555",
+    "@teambit/pubsub": "0.0.555",
+    "@teambit/ui-foundation.ui.is-browser": "0.0.463",
+    "@teambit/ui": "0.0.555",
+    "@teambit/bit-error": "0.0.372",
+    "@teambit/ui-foundation.ui.constants.z-indexes": "0.0.463",
+    "@teambit/ui-foundation.ui.keycap": "0.0.463",
+    "@teambit/component": "0.0.555"
   },
   "devDependencies": {
     "@types/mousetrap": "1.6.5",
@@ -39,7 +39,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.171",
+    "@teambit/legacy": "1.0.172",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -67,7 +67,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.171",
+        "@teambit/legacy": "1.0.172",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }

package/tsconfig.json

@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },