@aiquants/menu-bar 1.18.1 → 1.18.3

package/dist/MenuBar.d.ts

@@ -1,47 +1,20 @@
-import { IMenu, MenuNavigationPayload } from './contents/MenuList';
-import { Theme } from './types';
-
-/**
- * Props interface for the MenuBar component.
- * MenuBar コンポーネントのプロップスインターフェース。
- */
+import { IMenu, MenuNavigationPayload } from "./contents/MenuList";
+import { Theme } from "./types";
 export interface IMenuBarProps {
-    /** List of menu items. メニュー項目のリスト。 */
     menuList: IMenu[];
-    /** Optional header content rendered at top of menu drawer. メニューヘッダー要素。 */
     menuHeader?: React.ReactNode;
-    /** Callback handler for sign out button click. サインアウト処理ハンドラー。 */
     onClickSignout(): void;
-    /** Whether to hide the menu bar (legacy camelCase). メニュー非表示フラグ（旧表記）。 */
     isMenuhide?: boolean;
-    /** Whether to hide the menu bar. メニュー非表示フラグ。 */
     isMenuHide?: boolean;
-    /** Current active color theme. 現在のテーマ。 */
     theme: Theme;
-    /** Toggle handler for switching color theme. テーマ切り替えハンドラー。 */
     toggleTheme: () => void;
-    /** Navigation callback when a menu item is selected. メニュー遷移ハンドラー。 */
     onMenuNavigate?(payload: MenuNavigationPayload): void;
-    /** Controlled pinning state (optional). ピン留め状態制御プロップ。 */
     isPinned?: boolean;
-    /** Custom width in pixels when menu is pinned (default: 240). ピン留め時の幅(px)。 */
     pinnedWidth?: number;
-    /** Callback invoked when menu pin state changes. ピン留め状態変更時のコールバック。 */
     onPinChange?(pinned: boolean, widthPx: number): void;
-    /** Controlled list of pinned submenu IDs. ピン留めサブメニューIDリスト（制御）。 */
     pinnedSubmenuIds?: number[];
-    /** Initial list of pinned submenu IDs for uncontrolled mode. ピン留めサブメニューID初期リスト。 */
     initialPinnedSubmenuIds?: number[];
-    /** Callback invoked when submenu pin state changes. サブメニューピン留め変更時コールバック。 */
     onSubmenuPinChange?(pinnedIds: number[]): void;
-    /** Controls whether the Escape key closes the menu drawer. Escape キーによるメニュー閉鎖制御。 */
     closeOnEscape?: boolean | "auto";
 }
-/**
- * Renders the primary collapsible and pinnable menu bar with drawer navigation.
- * 折りたたみ・ピン留め対応のプライマリメニューバーコンポーネント。
- *
- * @param props - MenuBarProps configuration.
- * @returns Rendered JSX element or null.
- */
 export declare const MenuBar: (props: IMenuBarProps) => React.JSX.Element | null;

package/dist/components/SessionInfo.d.ts

@@ -1,37 +1,12 @@
-import { UserProfile } from '../types/user';
-
-/**
- * Link component props interface.
- * リンクコンポーネントのプロパティ。
- */
+import { UserProfile } from "../types/user";
 export interface LinkProps {
-    /** Link destination URL */
     to: string;
-    /** CSS class name */
     className?: string;
-    /** Link content */
     children: React.ReactNode;
 }
-/**
- * Generic Link component that can be replaced with router-specific implementation.
- * ルーター固有の実装で置き換え可能な汎用リンクコンポーネント。
- */
 export declare const DefaultLink: ({ to, className, children }: LinkProps) => React.JSX.Element;
-/**
- * SessionInfo component props interface.
- * ユーザーセッション情報を表示するコンポーネントのプロパティ。
- */
 export interface SessionInfoProps {
-    /** User profile information from Google OAuth */
     user: UserProfile | null;
-    /** Custom Link component (optional, defaults to DefaultLink) */
     LinkComponent?: React.ComponentType<LinkProps>;
 }
-/**
- * SessionInfo component for displaying user session information.
- * Displays user profile photo, navigation links, and user name when authenticated.
- *
- * ユーザーセッション情報を表示するコンポーネント。
- * 認証時にプロフィール写真、ナビゲーションリンク、ユーザー名を表示する。
- */
 export declare const SessionInfo: (props: SessionInfoProps) => React.JSX.Element;

package/dist/contents/MenuContent.d.ts

@@ -1,11 +1,5 @@
-import { Theme } from '../types';
-import { IMenu, MenuNavigationPayload } from './MenuList';
-
-/**
- * @interface IMenuContentProps
- * @description Props for the MenuContent component.
- * @description MenuContent コンポーネントの Props。
- */
+import { Theme } from "../types";
+import { IMenu, MenuNavigationPayload } from "./MenuList";
 interface IMenuContentProps {
     menuList: IMenu[];
     menuHeader?: React.ReactNode;
@@ -19,11 +13,5 @@ interface IMenuContentProps {
     pinnedSubmenuIds: number[];
     onToggleSubmenuPin(id: number): void;
 }
-/**
- * Renders the content of the menu bar.
- * メニューバーのコンテンツを描画します。
- * @param {IMenuContentProps} props - The properties for the MenuContent component.
- * @returns {React.JSX.Element} The rendered menu content.
- */
 export declare const MenuContent: (props: IMenuContentProps) => React.JSX.Element;
 export {};

package/dist/contents/MenuList.d.ts

@@ -1,18 +1,3 @@
-/**
- * @module MenuList
- * @description This module provides the list of menu items.
- * @description このモジュールは、メニュー項目のリストを提供します。
- */
-/**
- * @interface ISubmenu
- * @description Interface for a submenu item.
- * @description サブメニュー項目のインターフェース。
- * @property {number} subid - The unique ID of the submenu item. サブメニュー項目の一意の ID。
- * @property {string} [title] - The title of the submenu item. サブメニュー項目のタイトル。
- * @property {string} href - The URL for the submenu item. サブメニュー項目の URL。
- * @property {string} [mark] - The type of mark to display next to the item. 項目の横に表示するマークの種類。
- * @property {boolean} [new] - Whether the item is a new link. 新しいリンクかどうか。
- */
 export interface ISubmenu {
     subid: number;
     title?: string;
@@ -20,39 +5,16 @@ export interface ISubmenu {
     mark?: string;
     new?: boolean;
 }
-/**
- * @interface IMenu
- * @description Interface for a menu item.
- * @description メニュー項目のインターフェース。
- * @property {number} id - The unique ID of the menu item. メニュー項目の一意の ID。
- * @property {string} title - The title of the menu item. メニュー項目のタイトル。
- * @property {string} [href] - The URL for the menu item. メニュー項目の URL。
- * @property {ISubmenu[]} submenu - The list of submenu items. サブメニュー項目のリスト。
- */
 export interface IMenu {
     id: number;
     title: string;
     href?: string;
     submenu: ISubmenu[];
 }
-/**
- * @typedef MenuNavigationPayload
- * @description Payload emitted when a menu or submenu item is selected.
- * @description メニューまたはサブメニューが選択された際に発火するペイロード。
- * @property {{ id: number; title: string; href?: string }} menu - Selected menu metadata.
- * @property {{ subid: number; title?: string; href: string; mark?: string; new?: boolean }} [submenu] - Selected submenu metadata.
- */
 export type MenuNavigationPayload = {
     menu: Pick<IMenu, "id" | "title" | "href">;
     submenu?: Pick<ISubmenu, "subid" | "title" | "href" | "mark" | "new">;
 };
-/**
- * @interface IMenuListProps
- * @description Props for the MenuList component.
- * @description MenuList コンポーネントの Props。
- * @property {IMenu[]} menuList - The list of menu items. メニュー項目のリスト。
- * @property {(payload: MenuNavigationPayload) => void} [onMenuSelected] - Function to handle menu item selection. メニュー項目選択を処理する関数。
- */
 interface IMenuListProps {
     menuList: IMenu[];
     onMenuSelected?(payload: MenuNavigationPayload): void;

package/dist/contents/OverlayShadow.d.ts

@@ -1,25 +1,6 @@
-/**
- * @module OverlayShadow
- * @description This module provides an overlay shadow component.
- * @description このモジュールは、オーバーレイシャドウコンポーネントを提供します。
- */
-/**
- * @interface IOverlayProps
- * @description Props for the OverlayShadow component.
- * @description OverlayShadow コンポーネントの Props。
- * @property {boolean} isOverlay - Whether the overlay is visible. オーバーレイが表示されているかどうか。
- * @property {() => void} [onOverlayClick] - Function to handle overlay click. オーバーレイのクリックを処理する関数。
- */
 interface IOverlayProps {
     isOverlay: boolean;
     onOverlayClick?(): void;
 }
-/**
- * @function OverlayShadow
- * @description A component that renders an overlay shadow.
- * @description オーバーレイシャドウを描画するコンポーネント。
- * @param {IOverlayProps} props - The props for the component.
- * @returns {React.JSX.Element} The rendered overlay shadow.
- */
 export declare const OverlayShadow: (props: IOverlayProps) => React.JSX.Element;
 export {};

package/dist/elements/MenuSwitch.d.ts

@@ -1,14 +1,13 @@
-import { Theme } from '../types';
-
-interface IMenuSwitchProps {
-    open: boolean;
+import { Theme } from "../types";
+export interface IMenuSwitchProps {
+    open?: boolean;
+    isOpen?: boolean;
     onMenuOpen?: () => void;
     onMenuClose?: () => void;
-    theme: Theme;
+    onToggle?: (nextOpen: boolean) => void;
+    theme?: Theme;
+    pinned?: boolean;
+    isPinned?: boolean;
+    className?: string;
 }
-/**
- * Renders the toggle button that switches the main menu visibility.
- * メインメニューの表示状態を切り替えるトグルボタンを描画。
- */
 export declare const MenuSwitch: (props: IMenuSwitchProps) => React.JSX.Element;
-export {};

package/dist/events/pinEvent.d.ts

@@ -1,44 +1,9 @@
-import { MenuPinChangeDetail } from '../types';
-
-/**
- * Canonical Window CustomEvent name for menu pin state changes.
- * メニューのピン留め状態変更を通知する正準 CustomEvent 名。
- */
+import { MenuPinChangeDetail } from "../types";
 export declare const MENU_PIN_CHANGE_EVENT = "aiquants-menu-pin-change";
-/**
- * Reads initial pin state safely from document CSS variable or localStorage.
- * document の CSS 変数または localStorage から初期のピン留め状態を安全に読み取ります。
- *
- * @param defaultPinnedWidth - Default width in pixels when pinned (default: 240).
- * @returns Current MenuPinChangeDetail object.
- */
 export declare const getInitialPinState: (defaultPinnedWidth?: number) => MenuPinChangeDetail;
-/**
- * Dispatches a CustomEvent on window with menu pin state details.
- * window に対してメニューピン留め状態変更カスタムイベントを発行します。
- *
- * @param pinned - Whether the menu is pinned.
- * @param width - The pinned width in pixels.
- */
-export declare const dispatchMenuPinChange: (pinned: boolean, width: number) => void;
-/**
- * Options for subscribing to menu pin state changes.
- * メニューピン留め状態購読時のオプション。
- */
+export declare const dispatchMenuPinChange: (pinned: boolean, width: number, active?: boolean) => void;
 export interface SubscribeMenuPinOptions {
-    /** Whether to immediately invoke the listener with the current state upon subscription (default: true). 購読開始時に即座に現在の状態を通知するかどうか。 */
     immediate?: boolean;
-    /** Default width when pinned (default: 240). ピン留め時のデフォルト幅。 */
     defaultPinnedWidth?: number;
 }
-/**
- * Subscribes a listener to menu pin state changes on window.
- * Returns an unsubscription cleanup function.
- * window 上のメニューピン留め状態変更イベントを購読します。
- * クリーンアップ関数を返します。
- *
- * @param listener - Callback invoked on pin state changes.
- * @param options - Subscription options (e.g. immediate notification).
- * @returns Cleanup function to unsubscribe.
- */
 export declare const subscribeMenuPinChange: (listener: (detail: MenuPinChangeDetail) => void, options?: SubscribeMenuPinOptions) => (() => void);

package/dist/hooks/useMenuPinState.d.ts

@@ -1,21 +1,6 @@
-import { MenuPinChangeDetail } from '../types';
-
-/**
- * Options for the useMenuPinState hook.
- * useMenuPinState フックのオプション。
- */
+import { MenuPinChangeDetail } from "../types";
 export interface UseMenuPinStateOptions {
-    /** Initial pinned state for server-side rendering (default: false). SSR 時の初期ピン留め状態。 */
     initialPinned?: boolean;
-    /** Default width when pinned in pixels (default: 240). デフォルトのピン留め幅。 */
     defaultPinnedWidth?: number;
 }
-/**
- * React hook for consuming components to seamlessly subscribe to menu pin state changes.
- * Hydration-safe, re-render optimized via React 18 useSyncExternalStore.
- * 利用側 React コンポーネントがメニューのピン留め状態および幅をシームレスに購読するためのカスタムフック。
- *
- * @param options - Optional initial pin state and width configuration.
- * @returns Current MenuPinChangeDetail ({ pinned: boolean, width: number }).
- */
 export declare const useMenuPinState: (options?: UseMenuPinStateOptions) => MenuPinChangeDetail;

package/dist/index.d.ts

@@ -1,21 +1,11 @@
-/**
- * @module index
- * @description Entry point for @aiquants/menu-bar package exports.
- * @description @aiquants/menu-bar パッケージのエクスポートエントリーポイント。
- */
-/** @deprecated Use MenuBarLinkProps instead to avoid namespace collisions. */
-export type { LinkProps as MenuBarLinkProps, LinkProps, SessionInfoProps as MenuBarSessionInfoProps, SessionInfoProps } from './components/SessionInfo';
-export { DefaultLink, SessionInfo } from './components/SessionInfo';
-/** @deprecated Use IMenuBarMenu instead to avoid namespace collisions. */
-/** @deprecated Use IMenuBarSubmenu instead to avoid namespace collisions. */
-export type { IMenu as IMenuBarMenu, IMenu, ISubmenu as IMenuBarSubmenu, ISubmenu, MenuNavigationPayload } from './contents/MenuList';
-export type { SubscribeMenuPinOptions } from './events/pinEvent';
-export { dispatchMenuPinChange, getInitialPinState, MENU_PIN_CHANGE_EVENT, subscribeMenuPinChange, } from './events/pinEvent';
-export type { UseMenuPinStateOptions } from './hooks/useMenuPinState';
-export { useMenuPinState } from './hooks/useMenuPinState';
-export type { IMenuBarProps } from './MenuBar';
-export { MenuBar } from './MenuBar';
-/** @deprecated Use MenuBarTheme instead to avoid namespace collisions. */
-export type { MenuPinChangeDetail, MenuPinCustomEvent, Theme as MenuBarTheme, Theme } from './types';
-/** @deprecated Use MenuBarUserProfile instead to avoid namespace collisions. */
-export type { UserProfile as MenuBarUserProfile, UserProfile } from './types/user';
+export type { LinkProps as MenuBarLinkProps, LinkProps, SessionInfoProps as MenuBarSessionInfoProps, SessionInfoProps } from "./components/SessionInfo";
+export { DefaultLink, SessionInfo } from "./components/SessionInfo";
+export type { IMenu as IMenuBarMenu, IMenu, ISubmenu as IMenuBarSubmenu, ISubmenu, MenuNavigationPayload } from "./contents/MenuList";
+export type { SubscribeMenuPinOptions } from "./events/pinEvent";
+export { dispatchMenuPinChange, getInitialPinState, MENU_PIN_CHANGE_EVENT, subscribeMenuPinChange, } from "./events/pinEvent";
+export type { UseMenuPinStateOptions } from "./hooks/useMenuPinState";
+export { useMenuPinState } from "./hooks/useMenuPinState";
+export type { IMenuBarProps } from "./MenuBar";
+export { MenuBar } from "./MenuBar";
+export type { MenuPinChangeDetail, MenuPinCustomEvent, Theme as MenuBarTheme, Theme } from "./types";
+export type { UserProfile as MenuBarUserProfile, UserProfile } from "./types/user";