@excellore/ui 0.0.9 → 0.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -62
- package/fesm2022/excellore-ui.mjs +391 -165
- package/fesm2022/excellore-ui.mjs.map +1 -1
- package/package.json +4 -3
- package/types/excellore-ui.d.ts +101 -4
package/types/excellore-ui.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import * as _angular_core from '@angular/core';
|
|
2
|
+
import { OnDestroy } from '@angular/core';
|
|
2
3
|
|
|
3
4
|
interface User {
|
|
4
5
|
id: string;
|
|
@@ -33,6 +34,28 @@ interface SidebarMenuItem {
|
|
|
33
34
|
children?: SidebarMenuItem[];
|
|
34
35
|
disabled?: boolean;
|
|
35
36
|
exact?: boolean;
|
|
37
|
+
/** Small trailing value, for example an unread task count. */
|
|
38
|
+
badge?: string | number;
|
|
39
|
+
}
|
|
40
|
+
interface SidebarWorkspace {
|
|
41
|
+
id: string;
|
|
42
|
+
name: string;
|
|
43
|
+
plan?: string;
|
|
44
|
+
initials?: string;
|
|
45
|
+
}
|
|
46
|
+
interface SidebarUserAction {
|
|
47
|
+
id: string;
|
|
48
|
+
label: string;
|
|
49
|
+
icon?: string;
|
|
50
|
+
danger?: boolean;
|
|
51
|
+
}
|
|
52
|
+
interface SidebarCommand<T = unknown> {
|
|
53
|
+
id: string;
|
|
54
|
+
label: string;
|
|
55
|
+
category?: string;
|
|
56
|
+
icon?: string;
|
|
57
|
+
disabled?: boolean;
|
|
58
|
+
payload?: T;
|
|
36
59
|
}
|
|
37
60
|
interface Notification {
|
|
38
61
|
id: string;
|
|
@@ -48,23 +71,29 @@ interface Application {
|
|
|
48
71
|
url: string;
|
|
49
72
|
available?: boolean;
|
|
50
73
|
initials?: string;
|
|
74
|
+
/** Optional library icon name. Initials remain the fallback. */
|
|
75
|
+
iconColor?: string;
|
|
76
|
+
iconBackground?: string;
|
|
51
77
|
}
|
|
52
78
|
type Theme = 'light' | 'dark' | 'system';
|
|
53
79
|
|
|
54
|
-
declare class ThemeService {
|
|
80
|
+
declare class ThemeService implements OnDestroy {
|
|
55
81
|
private readonly platformId;
|
|
56
82
|
private readonly isBrowser;
|
|
57
83
|
readonly theme: _angular_core.WritableSignal<Theme>;
|
|
58
84
|
readonly resolvedTheme: _angular_core.WritableSignal<"light" | "dark">;
|
|
59
85
|
private mediaQueryListener?;
|
|
86
|
+
private mediaQuery?;
|
|
60
87
|
constructor();
|
|
61
88
|
setTheme(theme: Theme): void;
|
|
62
89
|
getTheme(): Theme;
|
|
90
|
+
ngOnDestroy(): void;
|
|
63
91
|
toggleTheme(): void;
|
|
64
92
|
private initializeTheme;
|
|
65
93
|
private saveThemeToStorage;
|
|
66
94
|
private applyTheme;
|
|
67
95
|
private updateDocumentClass;
|
|
96
|
+
private removeMediaQueryListener;
|
|
68
97
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<ThemeService, never>;
|
|
69
98
|
static ɵprov: _angular_core.ɵɵInjectableDeclaration<ThemeService>;
|
|
70
99
|
}
|
|
@@ -108,18 +137,86 @@ declare class HeaderComponent {
|
|
|
108
137
|
static ɵcmp: _angular_core.ɵɵComponentDeclaration<HeaderComponent, "lib-header", never, { "user": { "alias": "user"; "required": true; "isSignal": true; }; "permissions": { "alias": "permissions"; "required": false; "isSignal": true; }; "navigationItems": { "alias": "navigationItems"; "required": false; "isSignal": true; }; "applications": { "alias": "applications"; "required": false; "isSignal": true; }; "notifications": { "alias": "notifications"; "required": false; "isSignal": true; }; "notificationCount": { "alias": "notificationCount"; "required": false; "isSignal": true; }; "logoUrl": { "alias": "logoUrl"; "required": false; "isSignal": true; }; "appName": { "alias": "appName"; "required": false; "isSignal": true; }; "currentAppName": { "alias": "currentAppName"; "required": false; "isSignal": true; }; "showSearch": { "alias": "showSearch"; "required": false; "isSignal": true; }; "showNotifications": { "alias": "showNotifications"; "required": false; "isSignal": true; }; "showAppSwitcher": { "alias": "showAppSwitcher"; "required": false; "isSignal": true; }; "showThemeSwitcher": { "alias": "showThemeSwitcher"; "required": false; "isSignal": true; }; }, { "search": "search"; "applicationSelected": "applicationSelected"; "notificationClick": "notificationClick"; "markRead": "markRead"; "clearAll": "clearAll"; "menuAction": "menuAction"; }, never, never, true, never>;
|
|
109
138
|
}
|
|
110
139
|
|
|
111
|
-
|
|
140
|
+
type RailCommand = SidebarCommand & {
|
|
141
|
+
kind: 'menu' | 'application' | 'action';
|
|
142
|
+
source: SidebarMenuItem | Application | SidebarCommand;
|
|
143
|
+
};
|
|
144
|
+
declare class SidebarComponent implements OnDestroy {
|
|
145
|
+
private readonly host;
|
|
146
|
+
private readonly menu;
|
|
147
|
+
readonly themeService: ThemeService;
|
|
112
148
|
readonly menuItems: _angular_core.InputSignal<SidebarMenuItem[]>;
|
|
113
149
|
readonly menuError: _angular_core.InputSignal<string | null>;
|
|
114
150
|
readonly showMobileToggle: _angular_core.InputSignal<boolean>;
|
|
151
|
+
readonly workspace: _angular_core.InputSignal<SidebarWorkspace>;
|
|
152
|
+
readonly workspaces: _angular_core.InputSignal<SidebarWorkspace[]>;
|
|
153
|
+
readonly user: _angular_core.InputSignal<User | null>;
|
|
154
|
+
readonly applications: _angular_core.InputSignal<Application[]>;
|
|
155
|
+
readonly quickActions: _angular_core.InputSignal<SidebarCommand<unknown>[]>;
|
|
156
|
+
readonly userActions: _angular_core.InputSignal<SidebarUserAction[]>;
|
|
157
|
+
readonly collapsible: _angular_core.InputSignal<boolean>;
|
|
158
|
+
readonly showSearch: _angular_core.InputSignal<boolean>;
|
|
159
|
+
readonly showAppLauncher: _angular_core.InputSignal<boolean>;
|
|
160
|
+
readonly showNotifications: _angular_core.InputSignal<boolean>;
|
|
161
|
+
readonly showThemeToggle: _angular_core.InputSignal<boolean>;
|
|
162
|
+
readonly hasUnreadNotifications: _angular_core.InputSignal<boolean>;
|
|
115
163
|
readonly menuItemSelected: _angular_core.OutputEmitterRef<SidebarMenuItem>;
|
|
164
|
+
readonly workspaceSelected: _angular_core.OutputEmitterRef<SidebarWorkspace>;
|
|
165
|
+
readonly applicationSelected: _angular_core.OutputEmitterRef<Application>;
|
|
166
|
+
readonly userActionSelected: _angular_core.OutputEmitterRef<SidebarUserAction>;
|
|
167
|
+
readonly quickActionSelected: _angular_core.OutputEmitterRef<SidebarCommand<unknown>>;
|
|
168
|
+
readonly notificationActivated: _angular_core.OutputEmitterRef<void>;
|
|
169
|
+
readonly collapsedChange: _angular_core.OutputEmitterRef<boolean>;
|
|
116
170
|
readonly isOpen: _angular_core.WritableSignal<boolean>;
|
|
171
|
+
readonly collapsed: _angular_core.WritableSignal<boolean>;
|
|
172
|
+
readonly workspaceMenuOpen: _angular_core.WritableSignal<boolean>;
|
|
173
|
+
readonly profileMenuOpen: _angular_core.WritableSignal<boolean>;
|
|
174
|
+
readonly appLauncherOpen: _angular_core.WritableSignal<boolean>;
|
|
175
|
+
readonly commandOpen: _angular_core.WritableSignal<boolean>;
|
|
176
|
+
readonly appQuery: _angular_core.WritableSignal<string>;
|
|
177
|
+
readonly commandQuery: _angular_core.WritableSignal<string>;
|
|
178
|
+
readonly activeCommandIndex: _angular_core.WritableSignal<number>;
|
|
179
|
+
private returnFocus;
|
|
180
|
+
readonly filteredApplications: _angular_core.Signal<Application[]>;
|
|
181
|
+
readonly allCommands: _angular_core.Signal<RailCommand[]>;
|
|
182
|
+
readonly filteredCommands: _angular_core.Signal<RailCommand[]>;
|
|
183
|
+
readonly commandGroups: _angular_core.Signal<{
|
|
184
|
+
category: string;
|
|
185
|
+
commands: RailCommand[];
|
|
186
|
+
}[]>;
|
|
187
|
+
onDocumentKeydown(event: KeyboardEvent): void;
|
|
188
|
+
onDocumentPointer(event: MouseEvent): void;
|
|
189
|
+
ngOnDestroy(): void;
|
|
117
190
|
toggleSidebar(): void;
|
|
118
191
|
closeSidebar(): void;
|
|
192
|
+
toggleCollapsed(): void;
|
|
193
|
+
toggleWorkspaceMenu(event?: Event): void;
|
|
194
|
+
toggleProfileMenu(event?: Event): void;
|
|
195
|
+
openAppLauncher(event?: Event): void;
|
|
196
|
+
openCommandPalette(event?: Event): void;
|
|
197
|
+
closeAppLauncher(): void;
|
|
198
|
+
closeCommandPalette(): void;
|
|
199
|
+
closeAllOverlays(restoreFocus: boolean): void;
|
|
200
|
+
closeMenuFlyouts(): void;
|
|
119
201
|
onMenuItemSelected(item: SidebarMenuItem): void;
|
|
202
|
+
selectWorkspace(item: SidebarWorkspace): void;
|
|
203
|
+
selectApplication(app: Application): void;
|
|
204
|
+
selectUserAction(action: SidebarUserAction): void;
|
|
205
|
+
activateNotifications(event?: Event): void;
|
|
206
|
+
toggleTheme(): void;
|
|
207
|
+
updateCommandQuery(value: string): void;
|
|
208
|
+
runCommand(command: RailCommand): void;
|
|
209
|
+
commandIndex(command: RailCommand): number;
|
|
210
|
+
initials(name: string): string;
|
|
211
|
+
private filterApplications;
|
|
212
|
+
private flattenMenu;
|
|
213
|
+
private captureTrigger;
|
|
214
|
+
private focusSoon;
|
|
215
|
+
private restoreFocus;
|
|
216
|
+
private trapDialogFocus;
|
|
120
217
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<SidebarComponent, never>;
|
|
121
|
-
static ɵcmp: _angular_core.ɵɵComponentDeclaration<SidebarComponent, "lib-sidebar", never, { "menuItems": { "alias": "menuItems"; "required": false; "isSignal": true; }; "menuError": { "alias": "menuError"; "required": false; "isSignal": true; }; "showMobileToggle": { "alias": "showMobileToggle"; "required": false; "isSignal": true; }; }, { "menuItemSelected": "menuItemSelected"; }, never, never, true, never>;
|
|
218
|
+
static ɵcmp: _angular_core.ɵɵComponentDeclaration<SidebarComponent, "lib-sidebar", never, { "menuItems": { "alias": "menuItems"; "required": false; "isSignal": true; }; "menuError": { "alias": "menuError"; "required": false; "isSignal": true; }; "showMobileToggle": { "alias": "showMobileToggle"; "required": false; "isSignal": true; }; "workspace": { "alias": "workspace"; "required": false; "isSignal": true; }; "workspaces": { "alias": "workspaces"; "required": false; "isSignal": true; }; "user": { "alias": "user"; "required": false; "isSignal": true; }; "applications": { "alias": "applications"; "required": false; "isSignal": true; }; "quickActions": { "alias": "quickActions"; "required": false; "isSignal": true; }; "userActions": { "alias": "userActions"; "required": false; "isSignal": true; }; "collapsible": { "alias": "collapsible"; "required": false; "isSignal": true; }; "showSearch": { "alias": "showSearch"; "required": false; "isSignal": true; }; "showAppLauncher": { "alias": "showAppLauncher"; "required": false; "isSignal": true; }; "showNotifications": { "alias": "showNotifications"; "required": false; "isSignal": true; }; "showThemeToggle": { "alias": "showThemeToggle"; "required": false; "isSignal": true; }; "hasUnreadNotifications": { "alias": "hasUnreadNotifications"; "required": false; "isSignal": true; }; }, { "menuItemSelected": "menuItemSelected"; "workspaceSelected": "workspaceSelected"; "applicationSelected": "applicationSelected"; "userActionSelected": "userActionSelected"; "quickActionSelected": "quickActionSelected"; "notificationActivated": "notificationActivated"; "collapsedChange": "collapsedChange"; }, never, never, true, never>;
|
|
122
219
|
}
|
|
123
220
|
|
|
124
221
|
export { HeaderComponent, SidebarComponent, ThemeService };
|
|
125
|
-
export type { Application, NavigationItem, Notification, Organization, SidebarMenuItem, Theme, User };
|
|
222
|
+
export type { Application, NavigationItem, Notification, Organization, SidebarCommand, SidebarMenuItem, SidebarUserAction, SidebarWorkspace, Theme, User };
|