@homebound/beam 4.6.0 → 4.7.0

package/dist/index.d.cts

@@ -7793,23 +7793,28 @@ declare const filterTestIdPrefix = "filter";
  * Labels are `string` so actions can collapse into a `ButtonMenu` on mobile.
  * Icon actions always render with the `outline` `IconButton` variant, so `variant` is omitted here.
  */
+type HeaderActionKeepVisible = {
+    /** At `sm`, render this action below the title instead of collapsing it into the overflow menu. */
+    keepVisible?: boolean;
+};
 type HeaderAction = ({
     kind?: "default";
-} & Omit<ButtonProps, "label"> & {
+} & HeaderActionKeepVisible & Omit<ButtonProps, "label"> & {
     label: string;
 }) | ({
     kind: "icon";
-} & Omit<IconButtonProps, "variant" | "label"> & {
+} & HeaderActionKeepVisible & Omit<IconButtonProps, "variant" | "label"> & {
     label: string;
 }) | ({
     kind: "menu";
-} & ButtonMenuProps);
+} & HeaderActionKeepVisible & ButtonMenuProps);
 
 type ContentHeaderXss = Xss<Padding>;
 type ContentHeaderLevel = 2 | 3 | 4;
 type ContentHeaderProps<X = ContentHeaderXss> = {
     title?: string;
     description?: ReactNode;
+    /** Right slot on desktop; `keepVisible` actions move to the bottom slot at `sm`. */
     actions?: HeaderAction[];
     /** When true, prepends `AutoSaveIndicator` in the actions area. */
     withAutoSave?: boolean;
@@ -10585,7 +10590,7 @@ type BaseHeaderProps = {
 };
 
 type PageHeaderProps<V extends string, X> = Omit<BaseHeaderProps, "bottomSlot"> & {
-    /** Rendered as buttons on desktop; two or more collapse into a `ButtonMenu` at `sm`. */
+    /** Buttons on desktop; two or more collapse into a overflow menu at `sm`. `keepVisible` actions stay in the bottom slot on mobile. */
     actions?: HeaderAction[];
     tabs?: Omit<TabsProps<V, X>, "contentXss" | "omitFullBleedPadding" | "includeBottomBorder"> | Omit<RouteTabsProps<V, X>, "contentXss" | "omitFullBleedPadding" | "includeBottomBorder">;
 };

package/dist/index.d.ts

@@ -7793,23 +7793,28 @@ declare const filterTestIdPrefix = "filter";
  * Labels are `string` so actions can collapse into a `ButtonMenu` on mobile.
  * Icon actions always render with the `outline` `IconButton` variant, so `variant` is omitted here.
  */
+type HeaderActionKeepVisible = {
+    /** At `sm`, render this action below the title instead of collapsing it into the overflow menu. */
+    keepVisible?: boolean;
+};
 type HeaderAction = ({
     kind?: "default";
-} & Omit<ButtonProps, "label"> & {
+} & HeaderActionKeepVisible & Omit<ButtonProps, "label"> & {
     label: string;
 }) | ({
     kind: "icon";
-} & Omit<IconButtonProps, "variant" | "label"> & {
+} & HeaderActionKeepVisible & Omit<IconButtonProps, "variant" | "label"> & {
     label: string;
 }) | ({
     kind: "menu";
-} & ButtonMenuProps);
+} & HeaderActionKeepVisible & ButtonMenuProps);
 
 type ContentHeaderXss = Xss<Padding>;
 type ContentHeaderLevel = 2 | 3 | 4;
 type ContentHeaderProps<X = ContentHeaderXss> = {
     title?: string;
     description?: ReactNode;
+    /** Right slot on desktop; `keepVisible` actions move to the bottom slot at `sm`. */
     actions?: HeaderAction[];
     /** When true, prepends `AutoSaveIndicator` in the actions area. */
     withAutoSave?: boolean;
@@ -10585,7 +10590,7 @@ type BaseHeaderProps = {
 };
 
 type PageHeaderProps<V extends string, X> = Omit<BaseHeaderProps, "bottomSlot"> & {
-    /** Rendered as buttons on desktop; two or more collapse into a `ButtonMenu` at `sm`. */
+    /** Buttons on desktop; two or more collapse into a overflow menu at `sm`. `keepVisible` actions stay in the bottom slot on mobile. */
     actions?: HeaderAction[];
     tabs?: Omit<TabsProps<V, X>, "contentXss" | "omitFullBleedPadding" | "includeBottomBorder"> | Omit<RouteTabsProps<V, X>, "contentXss" | "omitFullBleedPadding" | "includeBottomBorder">;
 };