@sassoftware/vi-api 1.40.4 → 1.44.0

package/shell-tabs/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/shell-tabs/shell-tabs-api.d.ts

@@ -19,7 +19,7 @@ export interface INavigationBarTab<D = {
     /** label for the tab, can be String or the resource.key (if .isLabelResourceKey:true) */
     label: string;
     /** a weight used during .sort to order the tabs; will default to the order the tabs came as
-     * doesnt mean their array index, as many can be the same, negatives, fractions
+     * doesn't mean their array index, as many can be the same, negatives, fractions
      * */
     sortIndex?: number;
     /** when true, will use resourceService.get to resolve INavigationBarTab.label */
@@ -115,14 +115,18 @@ export interface ExternalTabConfig<T = SviShellTabData, P = any> {
 }
 /**
  * This API provides functionality relating to the shell tabs.
- * Accessed from the window at window.sas.vi.shellTabs.
+ *
+ * Accessed from the window at `window.sas.vi.shellTabs`.
+ *
+ * @example window.sas.vi.shellTabs.getSelectedTab();
+ * @category API
  */
 export interface ShellTabsApi<T = SviShellTabData> {
     /**
      * @method
      * @description This is used to expose any {@link PotentialTabItem} hooks on a component up to the Tab Service.
-     * @param [context] {this} pass "this"
-     * @param [elRef] {HTMLElement} This will pass the ElementRef for the component
+     * @param {any} context pass "this"
+     * @param {HTMLElement} nativeElement This will pass the ElementRef for the component
      *
      *  onTabClose {@link OnTabClose}, optional, can be used to prevent closing of a tab or close async
      *  onAttachTab {@link OnAttachTab}, will always trigger when currentNavigationBarTab has set
@@ -135,13 +139,13 @@ export interface ShellTabsApi<T = SviShellTabData> {
     /**
      * @method
      * @description Use this function to register new routes for tabs.
-     * @param [tabsToAdd] {ExternalTabConfig[]} - See {@link ExternalTabConfig}
+     * @param {ExternalTabConfig[]} tab See {@link ExternalTabConfig}
      */
     registerExternalTabs: (tab: Array<ExternalTabConfig<T>>) => void;
     /**
      * @method
      * @description Use this function to remove routes added via registerTabFn.
-     * @param [tabsToRemove] {ExternalTabConfig[]} - See {@link ExternalTabConfig}
+     * @param {ExternalTabConfig[]} tabsToRemove See {@link ExternalTabConfig}
      */
     unregisterExternalTabs: (tabsToRemove: Array<ExternalTabConfig<T>>) => void;
     /**
@@ -213,7 +217,7 @@ export interface ShellTabsApi<T = SviShellTabData> {
      * @method
      * @description This will remove an application tab, if allowed, and will trigger any closing and saving logic beforehand.
      * @param [tabIdToRemove] {string} This will be ID of an existing tab.
-     * @param [suppressNavigation] {boolean} Set supressNavigation to true if you want to close a tab that isn't open.
+     * @param [suppressNavigation] {boolean} Set suppressNavigation to true if you want to close a tab that isn't open.
      */
     removeApplicationTabById: (tabIdToRemove: string, suppressNavigation?: boolean) => Promise<boolean>;
     /**