nexus-shell 0.2.3 → 0.2.4

package/README.md

@@ -133,7 +133,8 @@ shell's own frame and keep every registration working.
 
 ## Theming
 
-Three themes ship in the stylesheet: `theme-light`, `theme-dark`, `theme-gt`.
+Four themes ship in the stylesheet: `theme-light`, `theme-dark`, `theme-gt`
+(Georgia Tech) and `theme-tamu` (Texas A&M).
 Colors are CSS custom properties scoped to those classes, so switching themes is
 a class on an ancestor — no React context, no provider.
 

package/dist/components/widgets/SettingsPanel.d.ts

@@ -6,13 +6,18 @@ export interface ISettingsThemeOption<T extends string = string> {
     label: string;
     icon: LucideIcon;
 }
+/**
+ * The themes bundled in the library stylesheet, with their full labels.
+ * Derived from the theme registry, so a new bundled theme appears here without
+ * a code change.
+ */
 export declare const DEFAULT_SETTINGS_THEMES: ISettingsThemeOption[];
 export interface SettingsPanelProps<T extends string = string> {
     /** Currently selected theme id. */
     theme: T;
     /** Called with the newly selected theme id. */
     onThemeChange: (theme: T) => void;
-    /** Theme choices to offer. Defaults to the three bundled themes. */
+    /** Theme choices to offer. Defaults to every bundled theme. */
     themes?: ISettingsThemeOption<T>[];
     /** Extra classes merged onto the root element. */
     className?: string;

package/dist/components/widgets/ThemeSwitcher.d.ts

@@ -5,6 +5,11 @@ export interface IThemeOption<T extends string = string> {
     /** Short label shown on the segment. Kept terse — segments are compact. */
     label: string;
 }
+/**
+ * The themes bundled in the library stylesheet, using their abbreviated labels
+ * because the segments are narrow. Derived from the theme registry, so a new
+ * bundled theme appears here without a code change.
+ */
 export declare const DEFAULT_THEME_OPTIONS: IThemeOption[];
 export interface ThemeSwitcherProps<T extends string = string> {
     /** Currently selected theme id. */
@@ -12,8 +17,8 @@ export interface ThemeSwitcherProps<T extends string = string> {
     /** Called with the newly selected theme id. */
     onChange: (theme: T) => void;
     /**
-     * Selectable themes. Defaults to Light / Dark / Georgia Tech, matching the
-     * themes shipped in the library's stylesheet.
+     * Selectable themes. Defaults to every theme bundled in the library's
+     * stylesheet. Supply your own to offer a different set.
      */
     options?: IThemeOption<T>[];
     /** Extra classes merged onto the root element. */

package/dist/core/Boot.d.ts

@@ -31,7 +31,7 @@ export interface InitializeShellOptions {
     defaultMenus?: boolean;
 }
 /** The command ids `initializeShell` registers unless told not to. */
-export declare const DEFAULT_COMMAND_IDS: readonly ["view.toggleTerminal", "view.toggleChat", "view.toggleSidebar", "theme.light", "theme.dark", "theme.gt"];
+export declare const DEFAULT_COMMAND_IDS: readonly ["view.toggleTerminal", "view.toggleChat", "view.toggleSidebar", ...string[]];
 /**
  * Boot the shell: register commands, menus, panels and status bar items into
  * the shell registries and stores.

package/dist/core/services/ThemeService.d.ts

@@ -1,4 +1,13 @@
-export type ThemeType = 'light' | 'dark' | 'gt';
+import { BundledThemeId } from '../../lib/themes';
+
+/**
+ * A theme id.
+ *
+ * The bundled ids are suggested by autocomplete, but any string is accepted:
+ * define a `.theme-yourname` block with the same custom properties and it works
+ * exactly like the built-ins.
+ */
+export type ThemeType = BundledThemeId | (string & {});
 interface ThemeState {
     theme: ThemeType;
     setTheme: (theme: ThemeType) => void;

package/dist/index.d.ts

@@ -57,3 +57,4 @@ export { ThemeSwitcher, type ThemeSwitcherProps, type IThemeOption, DEFAULT_THEM
 export { TreeWidget, type TreeWidgetProps, type ITreeNode, type ITreeAction, type ITreeContext } from './components/widgets/TreeWidget';
 export { UserProfile, type UserProfileProps, type IUserProfile, type IUserProfileAction } from './components/widgets/UserProfile';
 export { cn } from './lib/cn';
+export { BUNDLED_THEMES, BUNDLED_THEME_CLASSES, themeClass, type IBundledTheme, type BundledThemeId, } from './lib/themes';

package/dist/lib/themes.d.ts

@@ -0,0 +1,57 @@
+/**
+ * The themes bundled in the library's stylesheet.
+ *
+ * This is the single source of truth. `ThemeService` derives its union type and
+ * its class-swapping from it, `ThemeSwitcher` and `SettingsPanel` derive their
+ * default options, `initializeShell` derives its theme commands and View menu,
+ * and Storybook derives its toolbar. Adding a theme is a block in `index.css`
+ * plus one entry here.
+ *
+ * It lives in `lib/` rather than `core/services/` because the presentational
+ * components need it, and they are forbidden from importing stores.
+ *
+ * Themes are not a closed set — see {@link ThemeSwitcher}'s `options` prop and
+ * {@link SettingsPanel}'s `themes` prop for supplying your own.
+ */
+export interface IBundledTheme {
+    /** Matches the `.theme-<id>` class in the stylesheet. */
+    id: string;
+    /** Full name, for menus and the settings panel. */
+    label: string;
+    /** Abbreviated name, for the compact segmented switcher. */
+    shortLabel: string;
+    /** One line on what the theme is, used in documentation. */
+    description: string;
+}
+export declare const BUNDLED_THEMES: readonly [{
+    readonly id: "light";
+    readonly label: "Light";
+    readonly shortLabel: "Light";
+    readonly description: "Neutral light theme. The default.";
+}, {
+    readonly id: "dark";
+    readonly label: "Dark";
+    readonly shortLabel: "Dark";
+    readonly description: "Low-glare dark theme on a soft grey base.";
+}, {
+    readonly id: "gt";
+    readonly label: "Georgia Tech";
+    readonly shortLabel: "GT";
+    readonly description: "Buzz Gold (#EAAA00) on Tech Tower White.";
+}, {
+    readonly id: "tamu";
+    readonly label: "Texas A&M";
+    readonly shortLabel: "TAMU";
+    readonly description: "Aggie Maroon (#500000) on white.";
+}];
+/** Ids of the themes that ship in the stylesheet. */
+export type BundledThemeId = (typeof BUNDLED_THEMES)[number]['id'];
+/** Every bundled theme's class name, e.g. `["theme-light", …]`. */
+export declare const BUNDLED_THEME_CLASSES: string[];
+/**
+ * The class name for a theme id.
+ *
+ * Accepts any string, not just a bundled id, so an app that defines its own
+ * `.theme-*` block can use it too.
+ */
+export declare const themeClass: (id: string) => string;