react-dockable-desktop 5.3.5 → 5.4.0

package/dist/index.d.cts

@@ -1479,7 +1479,16 @@ declare const ConfirmationForm: React$1.FC<ConfirmationFormProps>;
 interface SidebarTab {
     id: string;
     label: string;
-    icon: React$1.ReactNode;
+    /** Required unless `hidden` is true — a hidden tab never renders a rail button, so it has no icon to show. */
+    icon?: React$1.ReactNode;
+    /**
+     * Omit this tab's rail button entirely — no icon, no click target — while it
+     * remains fully openable via `openTab()` / `useSidebar().openTab()` / a controlled
+     * `activeTabId`. Use for menu-driven panels with no persistent icon (e.g. a
+     * Google-Maps-style hamburger that opens content not otherwise pinned to the rail).
+     * Default: false
+     */
+    hidden?: boolean;
     /**
      * Mount immediately when the Sidebar first renders, not on first user click.
      * Implies `preserveState: true`.
@@ -1582,9 +1591,40 @@ interface SidebarProps {
     onStripVisibilityChange?: (visible: boolean) => void;
     /**
      * Show an "X" close button in the expanded drawer's header, as an additional way to collapse
-     * the sidebar (equivalent to clicking the active tab's own icon again). Opt-in. Default: false
+     * the sidebar (equivalent to clicking the active tab's own icon again). Opt-in. Default: false.
+     * Has no effect once the default header is suppressed — via `hideDefaultHeader`, or simply by
+     * passing `renderHeader` (either one is sufficient) — since the entire default header, this
+     * button included, is skipped for every tab in that case.
      */
     showCloseButton?: boolean;
+    /**
+     * Suppress the library's own drawer header (title + `showCloseButton`'s close
+     * button) for every tab, so `renderHeader` (or each tab's own `renderContent`)
+     * can supply a header, border, and styling instead. Applies uniformly across
+     * all tabs — there's no per-tab override. Passing `renderHeader` by itself has
+     * the same suppressing effect even if this is left unset — the two conditions
+     * are combined with OR, precisely so that supplying `renderHeader` alone is
+     * never a silent no-op. The close mechanism is unaffected either way: the
+     * `onClose` parameter passed to `renderContent`/`renderHeader`, or
+     * `useSidebarTab().onClose` from anywhere in a tab's content tree.
+     * Default: false
+     */
+    hideDefaultHeader?: boolean;
+    /**
+     * Custom header renderer used in place of the library's own drawer header.
+     * Passing `renderHeader` is by itself sufficient to suppress the default
+     * header, whether or not `hideDefaultHeader` is also set — the two props are
+     * combined with OR. Called once for whichever tab is currently active, so
+     * the same header markup (e.g. a hamburger icon, a search field, a close
+     * button) is shared uniformly across every tab instead of being repeated
+     * inside each tab's own `renderContent`. Omit `renderHeader` and set
+     * `hideDefaultHeader: true` to render no header at all and let each tab's
+     * `renderContent` supply its own instead.
+     * @param tab     - the currently active tab
+     * @param onClose - call to collapse the sidebar drawer
+     * @param onOpen  - call to (re-)select this tab
+     */
+    renderHeader?: (tab: SidebarTab, onClose: () => void, onOpen: () => void) => React$1.ReactNode;
     /** Main workspace content rendered alongside the sidebar. */
     children?: React$1.ReactNode;
 }
@@ -2240,7 +2280,8 @@ declare function usePanelContribution(contribution: PanelContribution): void;
 declare function useActivePanelContribution(): PanelContribution | null;
 /**
  * Converts a contributed sidebar section into a `SidebarTab` for `<Sidebar tabs={...}>`.
- * `SidebarTab.icon` is required, so supply `fallbackIcon` for sections that omit one.
+ * `SidebarTab.icon` is optional but recommended unless the tab is `hidden`; supply
+ * `fallbackIcon` for sections that omit one.
  * `eagerMount`/`preserveState` have no contribution-side equivalent — a contribution
  * only exists while its owning panel is mounted and active, so both are left unset.
  */

package/dist/index.d.ts

@@ -1479,7 +1479,16 @@ declare const ConfirmationForm: React$1.FC<ConfirmationFormProps>;
 interface SidebarTab {
     id: string;
     label: string;
-    icon: React$1.ReactNode;
+    /** Required unless `hidden` is true — a hidden tab never renders a rail button, so it has no icon to show. */
+    icon?: React$1.ReactNode;
+    /**
+     * Omit this tab's rail button entirely — no icon, no click target — while it
+     * remains fully openable via `openTab()` / `useSidebar().openTab()` / a controlled
+     * `activeTabId`. Use for menu-driven panels with no persistent icon (e.g. a
+     * Google-Maps-style hamburger that opens content not otherwise pinned to the rail).
+     * Default: false
+     */
+    hidden?: boolean;
     /**
      * Mount immediately when the Sidebar first renders, not on first user click.
      * Implies `preserveState: true`.
@@ -1582,9 +1591,40 @@ interface SidebarProps {
     onStripVisibilityChange?: (visible: boolean) => void;
     /**
      * Show an "X" close button in the expanded drawer's header, as an additional way to collapse
-     * the sidebar (equivalent to clicking the active tab's own icon again). Opt-in. Default: false
+     * the sidebar (equivalent to clicking the active tab's own icon again). Opt-in. Default: false.
+     * Has no effect once the default header is suppressed — via `hideDefaultHeader`, or simply by
+     * passing `renderHeader` (either one is sufficient) — since the entire default header, this
+     * button included, is skipped for every tab in that case.
      */
     showCloseButton?: boolean;
+    /**
+     * Suppress the library's own drawer header (title + `showCloseButton`'s close
+     * button) for every tab, so `renderHeader` (or each tab's own `renderContent`)
+     * can supply a header, border, and styling instead. Applies uniformly across
+     * all tabs — there's no per-tab override. Passing `renderHeader` by itself has
+     * the same suppressing effect even if this is left unset — the two conditions
+     * are combined with OR, precisely so that supplying `renderHeader` alone is
+     * never a silent no-op. The close mechanism is unaffected either way: the
+     * `onClose` parameter passed to `renderContent`/`renderHeader`, or
+     * `useSidebarTab().onClose` from anywhere in a tab's content tree.
+     * Default: false
+     */
+    hideDefaultHeader?: boolean;
+    /**
+     * Custom header renderer used in place of the library's own drawer header.
+     * Passing `renderHeader` is by itself sufficient to suppress the default
+     * header, whether or not `hideDefaultHeader` is also set — the two props are
+     * combined with OR. Called once for whichever tab is currently active, so
+     * the same header markup (e.g. a hamburger icon, a search field, a close
+     * button) is shared uniformly across every tab instead of being repeated
+     * inside each tab's own `renderContent`. Omit `renderHeader` and set
+     * `hideDefaultHeader: true` to render no header at all and let each tab's
+     * `renderContent` supply its own instead.
+     * @param tab     - the currently active tab
+     * @param onClose - call to collapse the sidebar drawer
+     * @param onOpen  - call to (re-)select this tab
+     */
+    renderHeader?: (tab: SidebarTab, onClose: () => void, onOpen: () => void) => React$1.ReactNode;
     /** Main workspace content rendered alongside the sidebar. */
     children?: React$1.ReactNode;
 }
@@ -2240,7 +2280,8 @@ declare function usePanelContribution(contribution: PanelContribution): void;
 declare function useActivePanelContribution(): PanelContribution | null;
 /**
  * Converts a contributed sidebar section into a `SidebarTab` for `<Sidebar tabs={...}>`.
- * `SidebarTab.icon` is required, so supply `fallbackIcon` for sections that omit one.
+ * `SidebarTab.icon` is optional but recommended unless the tab is `hidden`; supply
+ * `fallbackIcon` for sections that omit one.
  * `eagerMount`/`preserveState` have no contribution-side equivalent — a contribution
  * only exists while its owning panel is mounted and active, so both are left unset.
  */