@primer/react-brand 0.17.0-rc.c0b291e → 0.17.0

package/lib/Card/Card.d.ts

@@ -7,11 +7,14 @@ import type { BaseProps } from '../component-helpers';
  */
 import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/card/base.css';
 import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/card/colors-with-modes.css';
+import { Icon as IconProps } from '@primer/octicons-react';
+export declare const CardIconColors: readonly ["default", "blue", "coral", "green", "gray", "indigo", "lemon", "lime", "orange", "pink", "purple", "red", "teal", "yellow"];
+export declare const defaultCardIconColor: "default";
 export declare type CardProps = {
     /**
      * Valid children include Card.Image, Card.Heading, and Card.Description
      */
-    children: React.ReactNode | React.ReactElement<CardLabelProps> | React.ReactElement<CardHeadingProps> | React.ReactElement<CardDescriptionProps>;
+    children: React.ReactNode | React.ReactElement<CardIconProps> | React.ReactElement<CardLabelProps> | React.ReactElement<CardHeadingProps> | React.ReactElement<CardDescriptionProps>;
     /**
      * The href of the link
      * */
@@ -21,6 +24,12 @@ export declare type CardProps = {
      * */
     ctaText?: string;
 } & BaseProps<HTMLAnchorElement> & React.ComponentPropsWithoutRef<'a'>;
+declare type CardIconProps = BaseProps<HTMLSpanElement> & {
+    icon: React.ReactNode | IconProps;
+    color?: typeof CardIconColors[number];
+    hasBackground?: boolean;
+};
+declare function CardIcon({ icon: Icon, className, color, hasBackground, ...rest }: CardIconProps): JSX.Element;
 declare type CardLabelProps = BaseProps<HTMLSpanElement> & {
     children: React.ReactNode | React.ReactNode[];
     color?: typeof LabelColors[number];
@@ -38,6 +47,7 @@ declare type CardDescriptionProps = BaseProps<HTMLParagraphElement> & {
  */
 export declare const Card: React.ForwardRefExoticComponent<Pick<CardProps, "children" | "aria-labelledby" | "className" | "id" | "slot" | "style" | "title" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "href" | "type" | "download" | "hrefLang" | "media" | "ping" | "rel" | "target" | "referrerPolicy" | "key" | "ctaText"> & React.RefAttributes<HTMLAnchorElement>> & {
     Label: React.ForwardRefExoticComponent<Pick<CardLabelProps, "children" | "className" | "id" | "color"> & React.RefAttributes<HTMLSpanElement>>;
+    Icon: typeof CardIcon;
     Heading: React.ForwardRefExoticComponent<Pick<CardHeadingProps, "children" | "className" | "id" | "as"> & React.RefAttributes<HTMLHeadingElement>>;
     Description: React.ForwardRefExoticComponent<Pick<CardDescriptionProps, "children" | "className" | "id"> & React.RefAttributes<HTMLParagraphElement>>;
 };

package/lib/Grid/Grid.d.ts

@@ -0,0 +1,69 @@
+import React, { PropsWithChildren } from 'react';
+import type { BaseProps } from '../component-helpers';
+/**
+ * Design tokens
+ */
+import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/grid/grid.css';
+import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/grid/colors-with-modes.css';
+declare type ResponsiveMap = {
+    xsmall?: GridColumnIndex;
+    small?: GridColumnIndex;
+    medium?: GridColumnIndex;
+    large?: GridColumnIndex;
+    xlarge?: GridColumnIndex;
+    xxlarge?: GridColumnIndex;
+};
+export declare type GridColumnIndex = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+export declare type GridProps<T extends keyof JSX.IntrinsicElements = 'div'> = React.HTMLAttributes<T> & {
+    /**
+     * The HTML element used to render the grid.
+     */
+    as?: T | 'div' | 'span' | 'section';
+    /**
+     * Visual aid to help with alignment.
+     */
+    enableOverlay?: boolean;
+    /**
+     * Test id for the root element.
+     */
+    ['data-testid']?: string;
+} & (T extends 'span' ? BaseProps<HTMLSpanElement> : T extends 'section' ? BaseProps<HTMLElement> : BaseProps<HTMLDivElement>);
+declare type GridColumnProps<T extends keyof JSX.IntrinsicElements = 'div'> = {
+    as?: T | 'div' | 'span' | 'section';
+    span?: GridColumnIndex | ResponsiveMap;
+    start?: GridColumnIndex | ResponsiveMap;
+} & (T extends 'span' ? BaseProps<HTMLSpanElement> : T extends 'section' ? BaseProps<HTMLElement> : BaseProps<HTMLDivElement>);
+/**
+ * Use Grid to create flexible and responsive grid-based layouts
+ * @see https://primer.style/brand/components/Grid
+ * @example
+ *   <Grid>
+ *     <Grid.Column span="6">
+ *       ...
+ *     </Grid.Column>
+ *   </Grid>
+ */
+export declare const Grid: React.NamedExoticComponent<React.HTMLAttributes<"div"> & {
+    /**
+     * The HTML element used to render the grid.
+     */
+    as?: "div" | "section" | "span" | undefined;
+    /**
+     * Visual aid to help with alignment.
+     */
+    enableOverlay?: boolean | undefined;
+    /**
+     * Test id for the root element.
+     */
+    "data-testid"?: string | undefined;
+} & BaseProps<HTMLDivElement> & {
+    children?: React.ReactNode;
+}> & {
+    readonly type: ({ className, children, as, enableOverlay, ["data-testid"]: testId, ...rest }: PropsWithChildren<GridProps>) => JSX.Element;
+} & {
+    Column: React.MemoExoticComponent<({ children, as, span, start, className, ...rest }: PropsWithChildren<GridColumnProps>) => JSX.Element>;
+    testIds: {
+        root: string;
+    };
+};
+export {};

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

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

package/lib/Grid/index.d.ts

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

package/lib/Image/Image.d.ts

@@ -6,15 +6,17 @@ export declare type ImageProps = React.ImgHTMLAttributes<HTMLImageElement> & Bas
     alt: string;
     aspectRatio?: AspectRatio;
     media?: string;
+    srcSet?: Pick<React.ImgHTMLAttributes<HTMLImageElement>, 'srcSet'>;
 } & ({
     as?: 'img';
-    srcSet?: 'string';
+    srcSet?: Pick<React.ImgHTMLAttributes<HTMLImageElement>, 'srcSet'>;
 } | {
     as: 'picture';
     sources?: {
         srcset: string;
         media: string;
     }[];
+    srcSet?: undefined;
 });
 export declare const Image: ({ className, aspectRatio, as, ref, alt, width, height, media, srcSet, ...rest }: ImageProps) => JSX.Element;
 export {};

package/lib/Label/Label.d.ts

@@ -4,7 +4,7 @@ import type { BaseProps } from '../component-helpers';
  * Design tokens
  */
 import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/label/colors-with-modes.css';
-export declare const LabelColors: readonly ["default", "blue", "blue-purple", "coral", "green", "green-blue", "gray", "indigo", "lemon", "lime", "orange", "pink", "pink-blue", "purple", "purple-red", "red", "red-orange", "teal", "yellow"];
+export declare const LabelColors: readonly ["default", "blue", "coral", "green", "gray", "indigo", "lemon", "lime", "orange", "pink", "purple", "red", "teal", "yellow", "blue-purple", "green-blue", "pink-blue", "purple-red", "red-orange"];
 export declare const LabelSizes: readonly ["small", "medium", "large"];
 export declare const defaultLabelColor: "default";
 export declare const defaultLabelSize: "medium";

package/lib/SubdomainNavBar/SubdomainNavBar.d.ts

@@ -59,7 +59,7 @@ declare type SearchProps = {
 };
 declare type CTAActionProps = {
     href: string;
-};
+} & React.HTMLAttributes<HTMLAnchorElement>;
 declare function PrimaryAction({ children, href, ...rest }: PropsWithChildren<CTAActionProps>): JSX.Element;
 declare function SecondaryAction({ children, href, ...rest }: PropsWithChildren<CTAActionProps>): JSX.Element;
 export declare const SubdomainNavBar: typeof Root & {

package/lib/Testimonial/Testimonial.d.ts

@@ -2,6 +2,7 @@ import React, { HTMLAttributes, SVGProps } from 'react';
 import { BaseProps } from '../component-helpers';
 import type { AvatarProps } from '../';
 declare type TestimonialAlignment = 'start' | 'center';
+declare type TestimonialSize = 'small' | 'large';
 export declare type TestimonialProps = {
     /**
      * Valid children include Testimonial.Name, Testimonial.Avatar, and Testimonial.Name
@@ -11,6 +12,10 @@ export declare type TestimonialProps = {
      * Aligns the testimonial content
      */
     align?: TestimonialAlignment;
+    /**
+     * Sets the testimonial text size
+     */
+    size?: TestimonialSize;
 } & BaseProps<HTMLElement>;
 /**
  * Testimonial quote child element
@@ -42,7 +47,7 @@ declare function _Avatar({ size, ...rest }: AvatarProps): JSX.Element;
  * Use Testimonial to display a quote from a customer or user.
  * @see https://primer.style/brand/components/Testimonial
  */
-export declare const Testimonial: React.ForwardRefExoticComponent<Pick<TestimonialProps, "children" | "className" | "align" | "id"> & React.RefAttributes<unknown>> & {
+export declare const Testimonial: React.ForwardRefExoticComponent<Pick<TestimonialProps, "children" | "className" | "align" | "id" | "size"> & React.RefAttributes<unknown>> & {
     Quote: React.ForwardRefExoticComponent<Pick<{
         children: string;
     } & React.HTMLAttributes<HTMLElement> & BaseProps<HTMLElement>, "children" | "aria-labelledby" | "className" | "id" | "slot" | "style" | "title" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture"> & React.RefAttributes<unknown>>;

package/lib/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const Colors: readonly ["default", "blue", "coral", "green", "gray", "indigo", "lemon", "lime", "orange", "pink", "purple", "red", "teal", "yellow"];
+export declare const Gradients: readonly ["blue-purple", "green-blue", "pink-blue", "purple-red", "red-orange"];