bt-core-app 1.4.55 → 1.4.57

package/dist/index.d.ts

@@ -151,6 +151,13 @@ export declare interface BTCosmetics {
     undoTemporaryColor: () => void;
 }
 
+export declare interface BTCreateMenu {
+    currentGroup: Ref<string | undefined>;
+    groupOptions: Ref<MenuGroup[]>;
+    /**whether to read from vue routes or just purely the given groups */
+    useRoutes?: boolean;
+}
+
 export declare interface BTDates {
     /**returns start of day */
     getToday: () => string;
@@ -232,6 +239,10 @@ export declare interface BTStoreDefinition extends StoreDefinition<any, {}, {},
 }> {
 }
 
+export declare interface BTUseMenu extends BTCreateMenu {
+    sidebarNavItems: ComputedRef<MenuGroup[]>;
+}
+
 export declare function capitalizeWords(val?: string): string | undefined;
 
 export declare function checkImage(url?: string, goodCallback?: any, badCallback?: any): void;
@@ -294,6 +305,7 @@ export declare function createCore(options: CreateCoreOptions): CoreApp;
 export declare interface CreateCoreOptions extends UseCosmeticsOptions<BaseCosmeticTheme> {
     auth: CreateAuthOptions;
     defaultCacheExpiryHours?: number;
+    menu?: CreateMenuOptions;
     navItems?: NavigationItem[];
     presets: any;
     /**suboptions */
@@ -318,6 +330,15 @@ declare interface CreateDemoOptions {
 
 export declare function createFilters(options: UseFiltersOptions): BTFilters;
 
+export declare function createMenu(options?: CreateMenuOptions): BTCreateMenu;
+
+export declare interface CreateMenuOptions {
+    default?: string;
+    groups?: MenuGroup[];
+    /**whether to read from vue routes or just purely the given groups */
+    useRoutes?: boolean;
+}
+
 export declare function createNavigation(options: UseNavigationOptions): BTNavigation;
 
 export declare function createPresets(options: CreatePresetsOptions): BTPresets;
@@ -744,6 +765,19 @@ export declare interface LocalMeta {
     lastUpdate?: string;
 }
 
+export declare interface MenuGroup {
+    displayName: string;
+    icon?: string;
+    isGroup?: boolean;
+    items?: MenuGroup[];
+    permissions?: string[];
+    requiresAuth?: boolean;
+    sortNumber?: number;
+    subscriptions?: string[];
+    subFilters?: string[];
+    routeName?: string;
+}
+
 export declare interface NavigationItem extends AuthItem {
     /**aliases are other names that could use this navigation item's set of permissions, etc.*/
     aliases?: string[];
@@ -1307,6 +1341,8 @@ declare interface UseLocalCosmeticsOptions {
 
 export declare function useLocalDb(): LocalForage;
 
+export declare function useMenu(): BTUseMenu;
+
 export declare function useNavigation(): BTNavigation;
 
 export declare interface UseNavigationOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-core-app",
-  "version": "1.4.55",
+  "version": "1.4.57",
   "description": "Core app tools for some basic features like navigation, authentication, server apis, and cosmetics",
   "homepage": "https://github.com/BlitzItTech/bt-core",
   "bugs": {