@nice2dev/ui 1.3.16 → 1.3.18

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.
Files changed (38) hide show
  1. package/CHANGELOG.md +138 -0
  2. package/README.md +2 -2
  3. package/dist/{NiceDataGrid-aNPAHsWy.cjs → NiceDataGrid-CFibAGHt.cjs} +1 -1
  4. package/dist/NiceEventOrchestrator.doc-Dwtq2s_L.cjs +6 -0
  5. package/dist/NiceForm-ChRj4r3f.cjs +1 -0
  6. package/dist/{NiceMention-CMqAGvO0.cjs → NiceMention-DNx3d9L7.cjs} +1 -1
  7. package/dist/NiceModuleLifecyclePanel-D8Q081R6.cjs +1 -0
  8. package/dist/{NiceSavedQueryPanel-JHrSlHAV.cjs → NiceSavedQueryPanel-BuRAgrBk.cjs} +1 -1
  9. package/dist/{NiceScheduler-2TwOZq-y.cjs → NiceScheduler-DAoo1eyo.cjs} +1 -1
  10. package/dist/{core-lazy-Cda-D35m.cjs → core-lazy-DohJQ33c.cjs} +1 -1
  11. package/dist/data/treeDragSession.mjs +52 -46
  12. package/dist/data.cjs +1 -1
  13. package/dist/docs/NiceEventOrchestrator.doc.json.mjs +19 -19
  14. package/dist/editors/inputs/NiceAutocomplete.mjs +44 -46
  15. package/dist/editors/pickers/NiceDateTimePicker.mjs +1 -1
  16. package/dist/editors.cjs +1 -1
  17. package/dist/index.cjs +216 -216
  18. package/dist/index.d.ts +192 -69
  19. package/dist/index.mjs +933 -926
  20. package/dist/navigation/NiceIconRail.mjs +74 -53
  21. package/dist/navigation/NiceNavShell.mjs +855 -807
  22. package/dist/navigation/NiceSetupWizard.mjs +287 -278
  23. package/dist/navigation/NiceSidebarNav.mjs +1487 -1144
  24. package/dist/navigation/navItemDrag.mjs +42 -0
  25. package/dist/navigation/navShellPane.mjs +16 -11
  26. package/dist/navigation/sidebarNavTypes.mjs +1 -0
  27. package/dist/navigation/sidebarSearch.mjs +28 -0
  28. package/dist/navigation.cjs +1 -1
  29. package/dist/navigation.d.ts +63 -21
  30. package/dist/style.css +2 -2
  31. package/dist/tools/NiceThemeDesigner.mjs +1359 -900
  32. package/dist/tools/NiceThemePreview.mjs +18 -18
  33. package/dist/tools/themeCatalog.mjs +50 -0
  34. package/dist/workflow/NiceWorkflowDesigner.mjs +452 -898
  35. package/package.json +4 -4
  36. package/dist/NiceEventOrchestrator.doc-CxjsLxBG.cjs +0 -6
  37. package/dist/NiceForm-BtRBLffD.cjs +0 -1
  38. package/dist/NiceModuleLifecyclePanel-ugNtHimh.cjs +0 -1
package/dist/index.d.ts CHANGED
@@ -5201,6 +5201,13 @@ export { filterGroupToWhere }
5201
5201
 
5202
5202
  export { filterNiceThemePacksByTag }
5203
5203
 
5204
+ /**
5205
+ * The items narrowed to `query` (already normalised): a matching item keeps everything under it, a
5206
+ * branch stays only when something below it matches. The ids of the branches above a match go into
5207
+ * `open` — they show open while the search lasts, whatever their stored state.
5208
+ */
5209
+ export declare function filterSidebarItems<T extends SearchableItem<T>>(items: T[], query: string, open: Set<string>): T[];
5210
+
5204
5211
  export { FilterToSqlOptions }
5205
5212
 
5206
5213
  export declare type FilterType = 'brightness' | 'contrast' | 'saturation' | 'hue' | 'blur' | 'sharpen' | 'grayscale' | 'sepia' | 'invert' | 'vignette' | 'chromaKey' | 'colorCorrection';
@@ -7324,6 +7331,16 @@ export { NICE_INTENT_EVENT }
7324
7331
 
7325
7332
  export { NICE_INTENTS }
7326
7333
 
7334
+ /**
7335
+ * Every built-in theme in categories: Theme Packs, Theme Packs Vol. 2, Core, then the gallery's
7336
+ * eleven groups. A theme can sit in more than one category (a pack's theme is often a gallery theme
7337
+ * too); {@link NICE_THEME_CATALOG_ENTRIES} lists each once.
7338
+ */
7339
+ export declare const NICE_THEME_CATALOG: NiceThemeCatalogCategory[];
7340
+
7341
+ /** Every catalog theme once, by name — a pack wins over a plain theme of the same name. */
7342
+ export declare const NICE_THEME_CATALOG_ENTRIES: NiceThemeCatalogEntry[];
7343
+
7327
7344
  export { NICE_THEME_GALLERY }
7328
7345
 
7329
7346
  export { NICE_THEME_PACK_FONT_LINKS }
@@ -14705,6 +14722,8 @@ export declare interface NiceIconRailItem {
14705
14722
  /** A route the host opens when the button is pressed (no `onClick`). */
14706
14723
  route?: string;
14707
14724
  onClick?: () => void;
14725
+ /** A menu on right-click, the menu key or Shift+F10 (1.3.18) — e.g. moving or removing it. */
14726
+ menu?: NiceMenuItem[];
14708
14727
  }
14709
14728
 
14710
14729
  /** Props for the {@link NiceIconRail} component — a bar of icon buttons with captions. */
@@ -16238,9 +16257,11 @@ export declare type NiceLogoSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl' | number;
16238
16257
  /**
16239
16258
  * Brand mark variant.
16240
16259
  * - `mark` (default): symbol only — diamond + triangle (NtdOmniVerk).
16241
- * - `badge`: rounded-square enclosed mark (NtdOmniVerkBadge), good for favicons / chips.
16242
- * - `spinner`: animated rotating mark (NtdOmniVerkSpinner) — use for loading states.
16243
- * - `logo`: full mark + wordmark side-by-side (NtdOmniVerkLogo).
16260
+ * - `badge`: rounded-square enclosed mark, good for favicons / chips.
16261
+ * - `spinner`: animated rotating mark — use for loading states.
16262
+ * - `logo`: full mark + wordmark side-by-side.
16263
+ *
16264
+ * Drawn inline here; @nice2dev/icons keeps only NtdOmniVerk and NtdOmniVerkAnimated since 1.3.17.
16244
16265
  */
16245
16266
  export declare type NiceLogoVariant = 'mark' | 'badge' | 'spinner' | 'logo';
16246
16267
 
@@ -17631,6 +17652,16 @@ export declare function NiceNavShellPaneFooter({ children }: {
17631
17652
  children?: ReactNode;
17632
17653
  }): default_2.JSX.Element | null;
17633
17654
 
17655
+ /**
17656
+ * A header row of the page's own (1.3.18): in a merged tab it goes under this page's pane header and
17657
+ * stays put while the pane scrolls; anywhere else the children render where they stand. A host whose
17658
+ * pages publish into the shell's sticky header renders them here instead when
17659
+ * `useNiceNavShellPane()?.inSplit` — the mirror of {@link NiceNavShellPaneFooter}.
17660
+ */
17661
+ export declare function NiceNavShellPaneHeader({ children }: {
17662
+ children?: ReactNode;
17663
+ }): default_2.JSX.Element | null;
17664
+
17634
17665
  /** What a page rendered by NiceNavShell knows about its place. */
17635
17666
  export declare interface NiceNavShellPaneInfo {
17636
17667
  /** The route this content is rendered for. */
@@ -17644,6 +17675,12 @@ export declare interface NiceNavShellPaneInfo {
17644
17675
  * renders into; `null` elsewhere (and before the pane has mounted).
17645
17676
  */
17646
17677
  footerSlot: HTMLElement | null;
17678
+ /**
17679
+ * In a merged tab, the row under this pane's header that {@link NiceNavShellPaneHeader} renders
17680
+ * into — it stays put while the pane's content scrolls (1.3.18); `null` elsewhere (and before the
17681
+ * pane has mounted).
17682
+ */
17683
+ headerSlot: HTMLElement | null;
17647
17684
  }
17648
17685
 
17649
17686
  export declare type NiceNavShellPersistence = 'memory' | 'localStorage' | 'session';
@@ -21272,26 +21309,6 @@ export declare interface NiceSensorGaugePanelProps extends NiceBaseProps {
21272
21309
  animate?: boolean;
21273
21310
  }
21274
21311
 
21275
- /**
21276
- * {@link NiceSetupWizard} — Advanced multi-step setup wizard with branching, quick mode, and schema-driven forms.
21277
- *
21278
- * @example
21279
- * ```tsx
21280
- * <NiceSetupWizard
21281
- * layout="vertical"
21282
- * steps={[
21283
- * { id: 'welcome', title: 'Welcome', content: <WelcomeScreen /> },
21284
- * { id: 'account', title: 'Account', fields: [
21285
- * { id: 'email', type: 'email', label: 'Email', required: true },
21286
- * { id: 'password', type: 'password', label: 'Password', required: true },
21287
- * ]},
21288
- * { id: 'preferences', title: 'Preferences', optional: true, quickModeSkip: true },
21289
- * { id: 'done', title: 'Complete', content: <CompleteScreen /> },
21290
- * ]}
21291
- * onComplete={(values) => saveUser(values)}
21292
- * />
21293
- * ```
21294
- */
21295
21312
  export declare const NiceSetupWizard: default_2.ForwardRefExoticComponent<NiceSetupWizardProps & default_2.RefAttributes<HTMLDivElement>> & {
21296
21313
  displayName: string;
21297
21314
  };
@@ -21416,7 +21433,8 @@ export declare interface NiceSetupWizardProps {
21416
21433
  loadingText?: default_2.ReactNode;
21417
21434
  /**
21418
21435
  * The loading indicator — e.g. your brand's looping mark. Default: a spinner. It stops moving
21419
- * for users who ask for reduced motion (the default spinner does it itself).
21436
+ * for users who ask for reduced motion: CSS animations stop, and since 1.3.18 SVG (SMIL)
21437
+ * animations are paused too (the `Ntd*` icons hold still on their own).
21420
21438
  */
21421
21439
  loadingIndicator?: default_2.ReactNode;
21422
21440
  id?: string;
@@ -21500,6 +21518,11 @@ export declare type NiceShowcaseTab = 'about' | 'dashboard' | 'users' | 'data' |
21500
21518
  /** Context-menu / gesture actions that can be selectively disabled (e.g. for guests). */
21501
21519
  declare type NiceSidebarContextMenuAction = 'hide' | 'reorder' | 'rename' | 'newGroup' | 'collapseToggle';
21502
21520
 
21521
+ /**
21522
+ * NiceSidebarNav — the multi-mode navigation sidebar. Rows carried to the shortcuts or the
21523
+ * favourites (1.3.18) travel through a drag session: NiceNavShell's, which its tabs share, or —
21524
+ * on its own — one of the sidebar's.
21525
+ */
21503
21526
  export declare const NiceSidebarNav: ForwardRefExoticComponent<NiceSidebarNavProps & RefAttributes<HTMLDivElement>>;
21504
21527
 
21505
21528
  export declare interface NiceSidebarNavProps {
@@ -21657,6 +21680,33 @@ export declare interface NiceSidebarNavProps {
21657
21680
  railWidth?: number;
21658
21681
  /** The bar's button of the page in view; default the one whose `route` is `activeRoute`. */
21659
21682
  railActiveId?: string;
21683
+ /**
21684
+ * A last collapse level (1.3.18): past icons only, the sidebar folds to a column of the
21685
+ * shortcuts — `predefinedShortcuts`, then the user's (`shortcuts` in the preferences), which an
21686
+ * item's star and menu add and the button's own menu moves or removes. The footer then has two
21687
+ * buttons, a level down and a level up. Default `false`.
21688
+ */
21689
+ shortcutsRail?: boolean;
21690
+ /**
21691
+ * The host's shortcuts (e.g. an administrator's), first on the shortcuts rail; the user cannot
21692
+ * remove or move them.
21693
+ */
21694
+ predefinedShortcuts?: Omit<SidebarNavFavorite, 'addedAt'>[];
21695
+ /**
21696
+ * Whether users keep shortcuts of their own (default `true`). `false` — e.g. an administrator's
21697
+ * choice — leaves the rail to `predefinedShortcuts`: nothing offers to add one, and the stored ones
21698
+ * do not show.
21699
+ */
21700
+ allowUserShortcuts?: boolean;
21701
+ /**
21702
+ * How far the sidebar is folded (controlled, 1.3.18). `collapsed` / `onCollapsedChange` keep
21703
+ * working: `'icons'` and `'rail'` are collapsed. `'rail'` needs `shortcutsRail`.
21704
+ */
21705
+ collapseLevel?: SidebarNavCollapseLevel;
21706
+ /** How far the sidebar is folded at mount (uncontrolled; default `'expanded'`). */
21707
+ defaultCollapseLevel?: SidebarNavCollapseLevel;
21708
+ /** Called when the sidebar folds or unfolds a level. */
21709
+ onCollapseLevelChange?: (level: SidebarNavCollapseLevel) => void;
21660
21710
  /**
21661
21711
  * By role / By unit with two or more roles / units (1.3.13): a bar under the mode icons picks
21662
21712
  * one and the tree shows its modules (`activeGroupId` in the preferences). `false` lists them
@@ -21675,6 +21725,21 @@ export declare interface NiceSidebarNavProps {
21675
21725
  * `data` (By module first). Labels and icons of the parents come from `data` when they are in it.
21676
21726
  */
21677
21727
  getFavoritePath?: (favorite: SidebarNavFavorite) => SidebarNavPathEntry[] | undefined;
21728
+ /**
21729
+ * A search box above the tree (1.3.18) that narrows whatever the current mode shows — the tree of
21730
+ * All / By role / By unit, the Favourites list. Empty, everything shows; typing hides what does not
21731
+ * match (label or tooltip, case and diacritics ignored) and opens the branches above each match,
21732
+ * whatever their stored state. The Search mode leaves the mode icons then. Default `false`.
21733
+ */
21734
+ inlineSearch?: boolean;
21735
+ /** The search text (controlled). */
21736
+ searchText?: string;
21737
+ /** The search text at mount (uncontrolled). */
21738
+ defaultSearchText?: string;
21739
+ /** Called with the text as the user types it. */
21740
+ onSearchChange?: (text: string) => void;
21741
+ /** The box's placeholder. */
21742
+ searchPlaceholder?: string;
21678
21743
  /** Extra CSS class on the root element */
21679
21744
  className?: string;
21680
21745
  /** Size variant */
@@ -23198,6 +23263,26 @@ export { niceThemeBootstrap }
23198
23263
 
23199
23264
  export { NiceThemeBorders }
23200
23265
 
23266
+ /** A category of the {@link NICE_THEME_CATALOG}. `label` is English; i18n key `theme.category.<id>`. */
23267
+ export declare interface NiceThemeCatalogCategory {
23268
+ id: string;
23269
+ label: string;
23270
+ entries: NiceThemeCatalogEntry[];
23271
+ }
23272
+
23273
+ /** One theme of the {@link NICE_THEME_CATALOG}, and the curated pack it comes from. */
23274
+ export declare interface NiceThemeCatalogEntry {
23275
+ /** The theme's name — unique across the catalog's entries. */
23276
+ name: string;
23277
+ theme: NiceTheme;
23278
+ /** The pack it comes from: a pack also brings a display style and variants. */
23279
+ pack?: NiceThemePack;
23280
+ /** Which pack collection (`NICE_THEME_PACK_LIST` or `NICE_THEME_PACK_LIST_EXTENDED`). */
23281
+ packList?: 'base' | 'extended';
23282
+ /** The id of its category. */
23283
+ category: string;
23284
+ }
23285
+
23201
23286
  export { NiceThemeColors }
23202
23287
 
23203
23288
  export { NiceThemeContext }
@@ -23233,15 +23318,49 @@ export declare const NiceThemeDesigner: default_2.ForwardRefExoticComponent<Nice
23233
23318
  displayName: string;
23234
23319
  };
23235
23320
 
23236
- /** Props for the {@link NiceThemeDesigner} component — an advanced visual theme editor with section pickers, presets, live preview, and export. */
23321
+ /**
23322
+ * Props for the {@link NiceThemeDesigner} component — a themes tree (favourites, own themes, the
23323
+ * built-in catalog) and a full-window visual editor with undo, live preview, and export.
23324
+ */
23237
23325
  export declare interface NiceThemeDesignerProps extends NiceBaseProps {
23238
- /** Initial theme to edit (defaults to Light) */
23326
+ /**
23327
+ * The theme selected in the tree — or edited, with `startScreen="edit"` (defaults to Light). Read
23328
+ * once, at mount.
23329
+ */
23239
23330
  theme?: NiceTheme;
23240
- /** Preset themes to offer in the picker */
23331
+ /**
23332
+ * Built-in themes for the tree (default: the whole {@link NICE_THEME_CATALOG}). A list is grouped
23333
+ * by its themes' catalog categories; themes the catalog doesn't know go under "Presets".
23334
+ */
23241
23335
  presets?: NiceTheme[];
23336
+ /**
23337
+ * Own themes — the "My themes" group (controlled). Without it the designer keeps them itself, in
23338
+ * `localStorage` under `storageKey`.
23339
+ */
23340
+ themes?: NiceTheme[];
23341
+ /** Called with the new list when a theme is created, saved, imported, duplicated or deleted. */
23342
+ onThemesChange?: (themes: NiceTheme[]) => void;
23343
+ /** Names of the favourite themes (controlled). Without it the designer keeps them itself. */
23344
+ favorites?: string[];
23345
+ /** Called when a theme's star is toggled. */
23346
+ onFavoritesChange?: (names: string[]) => void;
23347
+ /**
23348
+ * The `localStorage` key prefix for the own themes and favourites the designer keeps itself
23349
+ * (default `'nice-theme-designer'`); `false` keeps them in memory only.
23350
+ */
23351
+ storageKey?: string | false;
23352
+ /**
23353
+ * Show Delete for own themes (default false). Tie it to the user's permission — built-in themes
23354
+ * can never be deleted.
23355
+ */
23356
+ allowDelete?: boolean;
23357
+ /** The screen it opens on (default `'browser'`); `'edit'` opens the editor on `theme`. */
23358
+ startScreen?: NiceThemeDesignerScreen;
23359
+ /** Called with the saved theme on Save and Save as copy. */
23360
+ onSave?: (theme: NiceTheme) => void;
23242
23361
  /** Sections to show (default: all) */
23243
23362
  sections?: NiceThemeDesignerSection[];
23244
- /** Called when theme changes */
23363
+ /** Called when the edited theme changes — every edit, undo and redo. */
23245
23364
  onChange?: (theme: NiceTheme) => void;
23246
23365
  /**
23247
23366
  * Called when user clicks Apply, after the theme went to the page: the enclosing
@@ -23265,6 +23384,9 @@ export declare interface NiceThemeDesignerProps extends NiceBaseProps {
23265
23384
  tutorial?: NiceComponentTutorial;
23266
23385
  }
23267
23386
 
23387
+ /** The two screens of the {@link NiceThemeDesigner}: the themes tree and the editor. */
23388
+ export declare type NiceThemeDesignerScreen = 'browser' | 'edit';
23389
+
23268
23390
  /** Editable sections in the {@link NiceThemeDesigner}. */
23269
23391
  export declare type NiceThemeDesignerSection = 'general' | 'colors' | 'backgrounds' | 'background-image' | 'text' | 'borders' | 'spacing' | 'typography' | 'shadows' | 'transitions' | 'nesting';
23270
23392
 
@@ -26033,50 +26155,14 @@ export declare interface NiceWorkflowDefinition {
26033
26155
  bpmn?: BPMNProcessDefinition;
26034
26156
  }
26035
26157
 
26036
- export declare const NiceWorkflowDesigner: default_2.FC<NiceWorkflowDesignerProps>;
26037
-
26038
- export declare interface NiceWorkflowDesignerProps extends NiceBaseProps {
26039
- workflow?: NiceWorkflowDefinition;
26040
- /** Convenience: flat node list mapped into `workflow.states` when `workflow` is omitted. */
26041
- nodes?: Array<{
26042
- id: string;
26043
- type?: string;
26044
- label?: string;
26045
- name?: string;
26046
- x?: number;
26047
- y?: number;
26048
- }>;
26049
- /** Convenience: flat edge list mapped into `workflow.transitions` when `workflow` is omitted. */
26050
- edges?: Array<{
26051
- id?: string;
26052
- from?: string;
26053
- to?: string;
26054
- source?: string;
26055
- target?: string;
26056
- fromStateId?: string;
26057
- toStateId?: string;
26058
- name?: string;
26059
- label?: string;
26060
- }>;
26061
- onChange?: (workflow: NiceWorkflowDefinition) => void;
26062
- entityFields?: NiceFieldDescriptor[];
26063
- availableActions?: NiceWorkflowActionType[];
26064
- availableUsers?: NiceUserInfo[];
26065
- availableRoles?: NiceRoleInfo[];
26066
- readOnly?: boolean;
26067
- showMinimap?: boolean;
26068
- showToolbar?: boolean;
26069
- showValidation?: boolean;
26070
- onTest?: (workflow: NiceWorkflowDefinition) => void;
26071
- onPublish?: (workflow: NiceWorkflowDefinition) => void;
26072
- /** Optional "?" guided tour. Off by default; `true` uses the built-in tour. */
26073
- tutorial?: NiceComponentTutorial;
26074
- }
26075
-
26076
26158
  export declare interface NiceWorkflowState {
26077
26159
  id: string;
26078
26160
  name: string;
26079
- type: NiceWorkflowStateType;
26161
+ /**
26162
+ * One of the designer's step kinds (`NiceWorkflowDesigner` of `@nice2dev/ui-diagrams`,
26163
+ * `stepTypes`): the five built-in ones or an id of your own (1.3.17).
26164
+ */
26165
+ type: NiceWorkflowStateType | (string & {});
26080
26166
  color?: string;
26081
26167
  icon?: string;
26082
26168
  position: {
@@ -26151,6 +26237,12 @@ export declare type NodeShape = 'rectangle' | 'rounded-rectangle' | 'circle' | '
26151
26237
  /** Prevent importing entire library — enforce tree-shaking. */
26152
26238
  export declare const noFullImport: ESLintRule;
26153
26239
 
26240
+ /**
26241
+ * Text as the search compares it: lower case, without diacritics (NFD, combining marks dropped).
26242
+ * "ł" has no decomposition in Unicode, so it is mapped by hand — "lodz" finds "Łódź".
26243
+ */
26244
+ export declare function normalizeSidebarSearch(text: string): string;
26245
+
26154
26246
  /**
26155
26247
  * usePushNotifications — Push notification subscription management
26156
26248
  *
@@ -27825,6 +27917,13 @@ export declare interface ScorecardCharacteristic {
27825
27917
 
27826
27918
  export { ScreenOrientation_2 as ScreenOrientation }
27827
27919
 
27920
+ declare interface SearchableItem<T> {
27921
+ id: string;
27922
+ label: ReactNode;
27923
+ tooltip?: ReactNode;
27924
+ children?: T[];
27925
+ }
27926
+
27828
27927
  /**
27829
27928
  * Search documentation content
27830
27929
  */
@@ -28144,6 +28243,12 @@ export declare interface SidebarFavoriteTreeNode {
28144
28243
  children: SidebarFavoriteTreeNode[];
28145
28244
  }
28146
28245
 
28246
+ /** Whether an item's label or tooltip contains `query` (already normalised). */
28247
+ export declare function sidebarItemMatches(item: {
28248
+ label: ReactNode;
28249
+ tooltip?: ReactNode;
28250
+ }, query: string): boolean;
28251
+
28147
28252
  declare type SidebarLevelShading = 'tint' | 'shade';
28148
28253
 
28149
28254
  /**
@@ -28161,6 +28266,12 @@ export declare interface SidebarNavBranchColors {
28161
28266
  levelColors?: string[];
28162
28267
  }
28163
28268
 
28269
+ /**
28270
+ * How far NiceSidebarNav is folded (1.3.18): `'expanded'` — the tree; `'icons'` — icons only;
28271
+ * `'rail'` — only the shortcuts, as a column of buttons (with `shortcutsRail`).
28272
+ */
28273
+ export declare type SidebarNavCollapseLevel = 'expanded' | 'icons' | 'rail';
28274
+
28164
28275
  /** How the sidebar tree and NavShell's tabs show colour — see {@link SidebarNavUserPrefs.colorStyle}. */
28165
28276
  export declare type SidebarNavColorStyle = 'theme' | 'bar' | 'fill';
28166
28277
 
@@ -28245,6 +28356,12 @@ export declare interface SidebarNavHelpers {
28245
28356
  removeFavoriteList: (id: string) => void;
28246
28357
  /** The list the Favourites view shows (1.3.13). */
28247
28358
  setActiveFavoriteList: (id: string) => void;
28359
+ /** Puts an item on the user's shortcuts (1.3.18), at `index` (default the end); once only. */
28360
+ addShortcut: (fav: SidebarNavFavorite, index?: number) => void;
28361
+ /** Takes an item off the user's shortcuts (1.3.18). */
28362
+ removeShortcut: (id: string) => void;
28363
+ /** Moves one of the user's shortcuts to `index` (1.3.18). */
28364
+ moveShortcut: (id: string, index: number) => void;
28248
28365
  /** The role / unit By role / By unit shows (1.3.13). */
28249
28366
  setActiveGroup: (mode: 'by-role' | 'by-unit', id: string) => void;
28250
28367
  setMaxDepth: (mode: SidebarNavMode, depth: number) => void;
@@ -28376,6 +28493,12 @@ export declare interface SidebarNavUserPrefs {
28376
28493
  favoriteLists?: SidebarNavFavoriteList[];
28377
28494
  /** The list the Favourites view shows (1.3.13); default the default list. */
28378
28495
  activeFavoriteListId?: string;
28496
+ /**
28497
+ * The user's shortcuts (1.3.18): the buttons of the shortcuts rail, the sidebar's last collapse
28498
+ * level (`shortcutsRail`), after the host's `predefinedShortcuts`. Added from an item's star or
28499
+ * menu; kept as plain data — an icon only as an icon name.
28500
+ */
28501
+ shortcuts?: SidebarNavFavorite[];
28379
28502
  /**
28380
28503
  * The user's answer to the first-run preferences (1.3.14): `'done'` (saved) or `'skipped'`.
28381
28504
  * No default — absent means "not asked yet".