@primer/react-brand 0.72.0-rc.f273f08b → 0.72.0

package/lib/Hero/Hero.d.ts

@@ -105,6 +105,11 @@ export declare const Hero: React.ForwardRefExoticComponent<Omit<React.PropsWithC
     } & {
         children?: React.ReactNode | undefined;
     }, "ref">) & React.RefAttributes<HTMLParagraphElement>>;
+    ButtonGroup: React.ForwardRefExoticComponent<Omit<Omit<import("..").ButtonGroupProps, "ref"> & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
+    /**
+     * @deprecated Use `Hero.ButtonGroup` with `Button` or `ActionMenu` children instead.
+     * This component will be removed in a future release.
+     */
     PrimaryAction: React.ForwardRefExoticComponent<(Omit<{
         as?: "a" | "button";
         href: string;
@@ -120,6 +125,10 @@ export declare const Hero: React.ForwardRefExoticComponent<Omit<React.PropsWithC
     } & {
         children?: React.ReactNode | undefined;
     }, "ref">) & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
+    /**
+     * @deprecated Use `Hero.ButtonGroup` with `Button` or `ActionMenu` children instead.
+     * This component will be removed in a future release.
+     */
     SecondaryAction: React.ForwardRefExoticComponent<(Omit<{
         as?: "a" | "button";
         href: string;
@@ -136,7 +145,8 @@ export declare const Hero: React.ForwardRefExoticComponent<Omit<React.PropsWithC
         children?: React.ReactNode | undefined;
     }, "ref">) & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
     Image: React.ForwardRefExoticComponent<(Omit<{
-        position?: import("./HeroContext").HeroMediaPositions;
+        position?: import("./HeroContext").HeroMediaPosition;
+        padding?: import("./HeroContext").HeroMediaPadding;
         enableBorder?: boolean;
     } & React.ImgHTMLAttributes<HTMLImageElement> & BaseProps<HTMLImageElement> & {
         src: string;
@@ -149,7 +159,8 @@ export declare const Hero: React.ForwardRefExoticComponent<Omit<React.PropsWithC
         as?: "img";
         srcSet?: Pick<React.ImgHTMLAttributes<HTMLImageElement>, "srcSet">;
     }, "ref"> | Omit<{
-        position?: import("./HeroContext").HeroMediaPositions;
+        position?: import("./HeroContext").HeroMediaPosition;
+        padding?: import("./HeroContext").HeroMediaPadding;
         enableBorder?: boolean;
     } & React.ImgHTMLAttributes<HTMLImageElement> & BaseProps<HTMLImageElement> & {
         src: string;
@@ -167,7 +178,8 @@ export declare const Hero: React.ForwardRefExoticComponent<Omit<React.PropsWithC
         srcSet?: undefined;
     }, "ref">) & React.RefAttributes<HTMLImageElement>>;
     Video: React.ForwardRefExoticComponent<(Omit<{
-        position?: import("./HeroContext").HeroMediaPositions;
+        position?: import("./HeroContext").HeroMediaPosition;
+        padding?: import("./HeroContext").HeroMediaPadding;
         enableBorder?: boolean;
         'data-testid'?: string;
     } & BaseProps<HTMLDivElement> & {
@@ -177,7 +189,8 @@ export declare const Hero: React.ForwardRefExoticComponent<Omit<React.PropsWithC
         posterAltText?: never;
         posterTitle?: never;
     }, "ref"> | Omit<{
-        position?: import("./HeroContext").HeroMediaPositions;
+        position?: import("./HeroContext").HeroMediaPosition;
+        padding?: import("./HeroContext").HeroMediaPadding;
         enableBorder?: boolean;
         'data-testid'?: string;
     } & BaseProps<HTMLDivElement> & {

package/lib/Hero/HeroContext.d.ts

@@ -3,10 +3,12 @@ export declare const HeroAlignOptions: readonly ["start", "center"];
 export type HeroAlign = (typeof HeroAlignOptions)[number];
 export declare const HeroVariantOptions: readonly ["default", "gridline", "gridline-expressive"];
 export type HeroVariant = (typeof HeroVariantOptions)[number];
-export declare const heroMediaPositions: readonly ["block-end", "block-end-padded", "inline-start", "inline-end", "inline-end-padded", "inline-start-padded"];
-export declare const heroMediaInlinePositions: ("inline-end" | "inline-start" | "block-end" | "block-end-padded" | "inline-end-padded" | "inline-start-padded")[];
-export type HeroMediaPositions = (typeof heroMediaPositions)[number];
-export type HeroMediaInlinePositions = (typeof heroMediaInlinePositions)[number];
+export declare const HeroMediaPaddingOptions: readonly ["default", "none", "all"];
+export type HeroMediaPadding = (typeof HeroMediaPaddingOptions)[number];
+export declare const HeroMediaPositionOptions: readonly ["block-end", "inline-start", "inline-end"];
+export declare const HeroMediaInlinePositionOptions: readonly ["inline-start", "inline-end"];
+export type HeroMediaPosition = (typeof HeroMediaPositionOptions)[number];
+export type HeroMediaInlinePosition = (typeof HeroMediaInlinePositionOptions)[number];
 type HeroContextType = {
     /**
      * The active variant of the Hero component
@@ -19,7 +21,7 @@ type HeroContextType = {
     /**
      * Image position within the Hero
      */
-    imagePosition: HeroMediaPositions;
+    imagePosition: HeroMediaPosition;
     /**
      * Hero.Image is an inline media position
      */

package/lib/Hero/sub-components/HeroButtonGroup.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { ButtonGroup } from '../../ButtonGroup';
+export type HeroButtonGroupProps = React.ComponentProps<typeof ButtonGroup>;
+export declare const HeroButtonGroup: React.ForwardRefExoticComponent<Omit<Omit<import("../..").ButtonGroupProps, "ref"> & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;

package/lib/Hero/sub-components/HeroImage.d.ts

@@ -1,12 +1,14 @@
 import { ImageProps } from '../../Image';
 import type { BaseProps } from '../../component-helpers';
-import { type HeroMediaPositions } from '../HeroContext';
+import { type HeroMediaPadding, type HeroMediaPosition } from '../HeroContext';
 export type HeroImageProps = {
-    position?: HeroMediaPositions;
+    position?: HeroMediaPosition;
+    padding?: HeroMediaPadding;
     enableBorder?: boolean;
 } & ImageProps & BaseProps<HTMLImageElement>;
 export declare const HeroImage: import("react").ForwardRefExoticComponent<(Omit<{
-    position?: HeroMediaPositions;
+    position?: HeroMediaPosition;
+    padding?: HeroMediaPadding;
     enableBorder?: boolean;
 } & import("react").ImgHTMLAttributes<HTMLImageElement> & BaseProps<HTMLImageElement> & {
     src: string;
@@ -19,7 +21,8 @@ export declare const HeroImage: import("react").ForwardRefExoticComponent<(Omit<
     as?: "img";
     srcSet?: Pick<React.ImgHTMLAttributes<HTMLImageElement>, "srcSet">;
 }, "ref"> | Omit<{
-    position?: HeroMediaPositions;
+    position?: HeroMediaPosition;
+    padding?: HeroMediaPadding;
     enableBorder?: boolean;
 } & import("react").ImgHTMLAttributes<HTMLImageElement> & BaseProps<HTMLImageElement> & {
     src: string;

package/lib/Hero/sub-components/HeroVideo.d.ts

@@ -1,8 +1,12 @@
 import React, { PropsWithChildren } from 'react';
 import type { BaseProps } from '../../component-helpers';
-import type { HeroMediaPositions } from '../HeroContext';
+import type { HeroMediaPadding, HeroMediaPosition } from '../HeroContext';
 type HeroVideoBaseProps = {
-    position?: HeroMediaPositions;
+    position?: HeroMediaPosition;
+    /**
+     * Controls the padding around media in gridline layouts. `default` preserves the padding recommended for the position.
+     */
+    padding?: HeroMediaPadding;
     enableBorder?: boolean;
     'data-testid'?: string;
 } & PropsWithChildren<BaseProps<HTMLDivElement>>;
@@ -17,7 +21,11 @@ type PosterProps = {
 };
 export type HeroVideoProps = HeroVideoBaseProps & PosterProps;
 export declare const HeroVideo: React.ForwardRefExoticComponent<(Omit<{
-    position?: HeroMediaPositions;
+    position?: HeroMediaPosition;
+    /**
+     * Controls the padding around media in gridline layouts. `default` preserves the padding recommended for the position.
+     */
+    padding?: HeroMediaPadding;
     enableBorder?: boolean;
     'data-testid'?: string;
 } & BaseProps<HTMLDivElement> & {
@@ -27,7 +35,11 @@ export declare const HeroVideo: React.ForwardRefExoticComponent<(Omit<{
     posterAltText?: never;
     posterTitle?: never;
 }, "ref"> | Omit<{
-    position?: HeroMediaPositions;
+    position?: HeroMediaPosition;
+    /**
+     * Controls the padding around media in gridline layouts. `default` preserves the padding recommended for the position.
+     */
+    padding?: HeroMediaPadding;
     enableBorder?: boolean;
     'data-testid'?: string;
 } & BaseProps<HTMLDivElement> & {

package/lib/Hero/sub-components/index.d.ts

@@ -4,6 +4,8 @@ export { HeroHeading } from './HeroHeading';
 export type { HeroHeadingProps } from './HeroHeading';
 export { HeroDescription } from './HeroDescription';
 export type { HeroDescriptionProps } from './HeroDescription';
+export { HeroButtonGroup } from './HeroButtonGroup';
+export type { HeroButtonGroupProps } from './HeroButtonGroup';
 export { HeroImage } from './HeroImage';
 export type { HeroImageProps } from './HeroImage';
 export { HeroVideo } from './HeroVideo';