@primer/react-brand 0.34.2 → 0.34.3-rc.150e58e9

package/lib/CTABanner/CTABanner.d.ts

@@ -35,10 +35,10 @@ export declare const CTABanner: React.ForwardRefExoticComponent<Omit<BaseProps<H
             regular?: "normal" | "condensed" | "expanded" | undefined;
             wide?: "normal" | "condensed" | "expanded" | undefined;
         } | undefined;
-        letterSpacing?: "normal" | "condensed" | "none" | {
-            narrow?: "normal" | "condensed" | "none" | undefined;
-            regular?: "normal" | "condensed" | "none" | undefined;
-            wide?: "normal" | "condensed" | "none" | undefined;
+        letterSpacing?: "normal" | "none" | "condensed" | {
+            narrow?: "normal" | "none" | "condensed" | undefined;
+            regular?: "normal" | "none" | "condensed" | undefined;
+            wide?: "normal" | "none" | "condensed" | undefined;
         } | undefined;
         font?: "mona-sans" | "hubot-sans" | "monospace" | undefined;
     } & React.HTMLAttributes<HTMLHeadingElement>, "ref"> & React.RefAttributes<HTMLHeadingElement>>;

package/lib/Hero/Hero.d.ts

@@ -58,7 +58,7 @@ export declare const Hero: React.ForwardRefExoticComponent<Omit<React.PropsWithC
         children?: React.ReactNode;
     }, "ref">) & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement>>;
     Image: React.ForwardRefExoticComponent<(Omit<{
-        position?: "inline-end" | "block-end" | undefined;
+        position?: "block-end" | "inline-end" | undefined;
     } & React.ImgHTMLAttributes<HTMLImageElement> & BaseProps<HTMLImageElement> & {
         src: string;
         alt: string;
@@ -70,7 +70,7 @@ export declare const Hero: React.ForwardRefExoticComponent<Omit<React.PropsWithC
         as?: "img" | undefined;
         srcSet?: Pick<React.ImgHTMLAttributes<HTMLImageElement>, "srcSet"> | undefined;
     }, "ref"> | Omit<{
-        position?: "inline-end" | "block-end" | undefined;
+        position?: "block-end" | "inline-end" | undefined;
     } & React.ImgHTMLAttributes<HTMLImageElement> & BaseProps<HTMLImageElement> & {
         src: string;
         alt: string;

package/lib/LogoSuite/LogoSuite.d.ts

@@ -39,7 +39,7 @@ export declare const LogoSuite: (({ align, children, className, hasDivider, "dat
         weight?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | import("../").ResponsiveWeightMap | undefined;
         align?: "start" | "center" | "end" | undefined;
     } & {
-        as?: "span" | "div" | "em" | "p" | "strong" | undefined;
+        as?: "p" | "span" | "div" | "strong" | "em" | undefined;
     } & React.HTMLAttributes<HTMLParagraphElement> & {
         as?: "p" | undefined;
     } & {
@@ -51,7 +51,7 @@ export declare const LogoSuite: (({ align, children, className, hasDivider, "dat
         weight?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | import("../").ResponsiveWeightMap | undefined;
         align?: "start" | "center" | "end" | undefined;
     } & {
-        as?: "span" | "div" | "em" | "p" | "strong" | undefined;
+        as?: "p" | "span" | "div" | "strong" | "em" | undefined;
     } & React.HTMLAttributes<HTMLSpanElement> & BaseProps<HTMLSpanElement> & {
         as?: "span" | undefined;
     } & {
@@ -63,7 +63,7 @@ export declare const LogoSuite: (({ align, children, className, hasDivider, "dat
         weight?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | import("../").ResponsiveWeightMap | undefined;
         align?: "start" | "center" | "end" | undefined;
     } & {
-        as?: "span" | "div" | "em" | "p" | "strong" | undefined;
+        as?: "p" | "span" | "div" | "strong" | "em" | undefined;
     } & React.HTMLAttributes<HTMLDivElement> & BaseProps<HTMLDivElement> & {
         as?: "div" | undefined;
     } & {
@@ -75,7 +75,7 @@ export declare const LogoSuite: (({ align, children, className, hasDivider, "dat
         weight?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | import("../").ResponsiveWeightMap | undefined;
         align?: "start" | "center" | "end" | undefined;
     } & {
-        as?: "span" | "div" | "em" | "p" | "strong" | undefined;
+        as?: "p" | "span" | "div" | "strong" | "em" | undefined;
     } & React.HTMLAttributes<HTMLElement> & BaseProps<HTMLElement> & {
         as?: "strong" | undefined;
     } & {
@@ -87,7 +87,7 @@ export declare const LogoSuite: (({ align, children, className, hasDivider, "dat
         weight?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | import("../").ResponsiveWeightMap | undefined;
         align?: "start" | "center" | "end" | undefined;
     } & {
-        as?: "span" | "div" | "em" | "p" | "strong" | undefined;
+        as?: "p" | "span" | "div" | "strong" | "em" | undefined;
     } & React.HTMLAttributes<HTMLElement> & BaseProps<HTMLElement> & {
         as?: "em" | undefined;
     } & {

package/lib/Stack/Stack.d.ts

@@ -96,7 +96,7 @@ export declare const Stack: React.ForwardRefExoticComponent<Omit<BaseProps<HTMLE
      * A string value will be applied to all viewports.
      * An object can be used to define different values for different viewports.
      */
-    gap?: "normal" | 8 | 4 | "condensed" | "none" | 12 | "spacious" | 16 | 20 | 24 | 28 | 32 | 36 | 40 | 44 | 48 | 64 | 80 | 96 | 112 | 128 | ResponsiveSpacingMap | undefined;
+    gap?: "normal" | 8 | 4 | "none" | "condensed" | 12 | "spacious" | 16 | 20 | 24 | 28 | 32 | 36 | 40 | 44 | 48 | 64 | 80 | 96 | 112 | 128 | ResponsiveSpacingMap | undefined;
     /**
      * Applies vertical alignment to child elements relative to the Stack, using the align-items CSS property.
      * A string value will be applied to all viewports.
@@ -108,7 +108,7 @@ export declare const Stack: React.ForwardRefExoticComponent<Omit<BaseProps<HTMLE
      * A string value will be applied to all viewports.
      * An object can be used to define different values for different viewports.
      */
-    padding?: "normal" | 8 | 4 | "condensed" | "none" | 12 | "spacious" | 16 | 20 | 24 | 28 | 32 | 36 | 40 | 44 | 48 | 64 | 80 | 96 | 112 | 128 | ResponsiveSpacingMap | undefined;
+    padding?: "normal" | 8 | 4 | "none" | "condensed" | 12 | "spacious" | 16 | 20 | 24 | 28 | 32 | 36 | 40 | 44 | 48 | 64 | 80 | 96 | 112 | 128 | ResponsiveSpacingMap | undefined;
     /**
      * Applies horizontal alignment to child elements relative to the Stack, using the justify-content CSS property.
      * A string value will be applied to all viewports.

package/lib/Statistic/Statistic.d.ts

@@ -0,0 +1,63 @@
+import React from 'react';
+import { HeadingProps, TextProps } from '../';
+import type { BaseProps } from '../component-helpers';
+/**
+ * Design tokens
+ */
+import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/statistic/base.css';
+export declare const StatisticSizes: readonly ["small", "medium", "large"];
+export declare const StatisticSpacingValues: readonly ["none", "condensed", "normal", "spacious"];
+type StatisticSpacingValues = (typeof StatisticSpacingValues)[number];
+export type StatisticSize = (typeof StatisticSizes)[number];
+type ResponsiveMap<T> = {
+    narrow?: T;
+    regular?: T;
+    wide?: T;
+};
+export type StatisticProps = BaseProps<HTMLAnchorElement> & {
+    /**
+     * The size of the Statistic
+     */
+    size?: StatisticSize;
+    /**
+     * Adding padding to all internal sides of the component
+     */
+    padding?: StatisticSpacingValues | ResponsiveMap<StatisticSpacingValues>;
+    /**
+     * Specify alternative  appearance
+     */
+    variant?: 'default' | 'boxed';
+    /**
+     * Escape-hatch for inserting custom React components.
+     * Warning:
+     *   This prop isn't advertised in our docs but remains part of the public API for edge-cases.
+     *   Need to use this prop? Please check in with #primer-brand first to confirm correct usage.
+     */
+    leadingComponent?: React.FunctionComponent;
+    /**
+     * Escape-hatch for inserting custom React components.
+     * Warning:
+     *   This prop isn't advertised in our docs but remains part of the public API for edge-cases.
+     *   Need to use this prop? Please check in with #primer-brand first to confirm correct usage.
+     */
+    trailingComponent?: React.FunctionComponent;
+    /**
+     * Optional attirbute for testing
+     */
+    ['data-testid']?: string;
+} & BaseProps<HTMLDivElement> & React.HTMLAttributes<HTMLDivElement>;
+type StatisticDescriptionProps = BaseProps<HTMLSpanElement> & Omit<TextProps, 'variant' | 'as'> & {
+    variant?: 'default' | 'muted' | 'accent';
+};
+/**
+ * Use the statistic component display concise numerical information
+ * @see https://primer.style/brand/components/Statistic
+ */
+export declare const Statistic: React.ForwardRefExoticComponent<Omit<React.PropsWithChildren<StatisticProps>, "ref"> & React.RefAttributes<HTMLDivElement>> & {
+    Heading: React.ForwardRefExoticComponent<Omit<HeadingProps, "ref"> & React.RefAttributes<HTMLHeadingElement>>;
+    Description: React.ForwardRefExoticComponent<Omit<React.PropsWithChildren<StatisticDescriptionProps>, "ref"> & React.RefAttributes<HTMLSpanElement>>;
+    testIds: {
+        root: string;
+    };
+};
+export {};

package/lib/Statistic/Statistic.visual.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/Statistic/index.d.ts

@@ -0,0 +1 @@
+export * from './Statistic';