@primer/react-brand 0.34.4-rc.d299effb → 0.35.0-rc.1d6a1bdd

package/lib/CTABanner/CTABanner.d.ts

@@ -25,10 +25,10 @@ export declare const CTABanner: React.ForwardRefExoticComponent<Omit<BaseProps<H
     } & {
         as?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | undefined;
         size?: "display" | "1" | "2" | "3" | "4" | "5" | "6" | "subhead-large" | "subhead-medium" | undefined;
-        weight?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | {
-            narrow?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | undefined;
-            regular?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | undefined;
-            wide?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | undefined;
+        weight?: "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "light" | "extralight" | {
+            narrow?: "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "light" | "extralight" | undefined;
+            regular?: "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "light" | "extralight" | undefined;
+            wide?: "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "light" | "extralight" | undefined;
         } | undefined;
         stretch?: "normal" | "condensed" | "expanded" | {
             narrow?: "normal" | "condensed" | "expanded" | undefined;

package/lib/Hero/Hero.d.ts

@@ -17,7 +17,9 @@ export type HeroProps = BaseProps<HTMLElement> & {
      */
     trailingComponent?: React.FunctionComponent;
 };
-type HeroHeadingProps = Omit<HeadingProps, 'as'>;
+type HeroHeadingProps = Omit<HeadingProps, 'as'> & {
+    fullWidth?: boolean;
+};
 type HeroDescriptionProps = {
     size?: (typeof TextSizes)[number];
     weight?: TextWeightVariants | ResponsiveWeightMap;

package/lib/LogoSuite/LogoSuite.d.ts

@@ -36,7 +36,7 @@ export declare const LogoSuite: (({ align, children, className, hasDivider, "dat
         font?: "mona-sans" | "hubot-sans" | "monospace" | undefined;
         size?: "700" | "600" | "500" | "400" | "300" | "200" | "100" | undefined;
         variant?: "default" | "muted" | undefined;
-        weight?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | import("../").ResponsiveWeightMap | undefined;
+        weight?: "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "light" | "extralight" | import("../").ResponsiveWeightMap | undefined;
         align?: "start" | "center" | "end" | undefined;
     } & {
         as?: "span" | "div" | "em" | "p" | "strong" | undefined;
@@ -48,7 +48,7 @@ export declare const LogoSuite: (({ align, children, className, hasDivider, "dat
         font?: "mona-sans" | "hubot-sans" | "monospace" | undefined;
         size?: "700" | "600" | "500" | "400" | "300" | "200" | "100" | undefined;
         variant?: "default" | "muted" | undefined;
-        weight?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | import("../").ResponsiveWeightMap | undefined;
+        weight?: "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "light" | "extralight" | import("../").ResponsiveWeightMap | undefined;
         align?: "start" | "center" | "end" | undefined;
     } & {
         as?: "span" | "div" | "em" | "p" | "strong" | undefined;
@@ -60,7 +60,7 @@ export declare const LogoSuite: (({ align, children, className, hasDivider, "dat
         font?: "mona-sans" | "hubot-sans" | "monospace" | undefined;
         size?: "700" | "600" | "500" | "400" | "300" | "200" | "100" | undefined;
         variant?: "default" | "muted" | undefined;
-        weight?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | import("../").ResponsiveWeightMap | undefined;
+        weight?: "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "light" | "extralight" | import("../").ResponsiveWeightMap | undefined;
         align?: "start" | "center" | "end" | undefined;
     } & {
         as?: "span" | "div" | "em" | "p" | "strong" | undefined;
@@ -72,7 +72,7 @@ export declare const LogoSuite: (({ align, children, className, hasDivider, "dat
         font?: "mona-sans" | "hubot-sans" | "monospace" | undefined;
         size?: "700" | "600" | "500" | "400" | "300" | "200" | "100" | undefined;
         variant?: "default" | "muted" | undefined;
-        weight?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | import("../").ResponsiveWeightMap | undefined;
+        weight?: "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "light" | "extralight" | import("../").ResponsiveWeightMap | undefined;
         align?: "start" | "center" | "end" | undefined;
     } & {
         as?: "span" | "div" | "em" | "p" | "strong" | undefined;
@@ -84,7 +84,7 @@ export declare const LogoSuite: (({ align, children, className, hasDivider, "dat
         font?: "mona-sans" | "hubot-sans" | "monospace" | undefined;
         size?: "700" | "600" | "500" | "400" | "300" | "200" | "100" | undefined;
         variant?: "default" | "muted" | undefined;
-        weight?: "light" | "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "extralight" | import("../").ResponsiveWeightMap | undefined;
+        weight?: "heavy" | "extrabold" | "bold" | "semibold" | "medium" | "normal" | "light" | "extralight" | import("../").ResponsiveWeightMap | undefined;
         align?: "start" | "center" | "end" | undefined;
     } & {
         as?: "span" | "div" | "em" | "p" | "strong" | undefined;

package/lib/VideoPlayer/VideoPlayer.d.ts

@@ -1,19 +1,40 @@
-import React from 'react';
-import type { BaseProps } from '../component-helpers';
+import React, { type HTMLProps } from 'react';
+import { type AnimateProps } from '../animation';
 /**
  * Design tokens
  */
 import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/video-player/base.css';
 import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/video-player/colors-with-modes.css';
 type VideoPlayerProps = {
-    poster?: string;
     title: string;
-    branding?: boolean;
-    children: React.ReactElement | React.ReactElement[];
-    ref?: React.RefObject<HTMLVideoElement>;
-} & React.HTMLProps<HTMLVideoElement> & BaseProps<HTMLVideoElement>;
-export declare const VideoPlayer: (({ poster, title, branding, children, className, onPlay, onPause, onLoadedMetadata, onPlaying, onTimeUpdate, ref, ...rest }: VideoPlayerProps) => JSX.Element) & {
+    visuallyHiddenTitle?: boolean;
+    showBranding?: boolean;
+    animate?: AnimateProps;
+    showControlsWhenPaused?: boolean;
+    showPlayPauseButton?: boolean;
+    showSeekControl?: boolean;
+    showCCButton?: boolean;
+    showMuteButton?: boolean;
+    showVolumeControl?: boolean;
+    showFullScreenButton?: boolean;
+} & HTMLProps<HTMLVideoElement>;
+export declare const VideoPlayer: React.ForwardRefExoticComponent<Omit<VideoPlayerProps, "ref"> & React.RefAttributes<HTMLVideoElement>> & {
     Source: (props: React.HTMLProps<HTMLSourceElement>) => JSX.Element;
     Track: ({ kind, ...rest }: React.HTMLProps<HTMLTrackElement>) => JSX.Element;
+    Captions: ({ className, ...props }: React.HTMLAttributes<HTMLDivElement>) => JSX.Element | null;
+    CCButton: ({ className, ...props }: React.HTMLAttributes<HTMLButtonElement>) => JSX.Element;
+    Controls: ({ isSmall, ...rest }: import("./components").ControlsProps) => JSX.Element;
+    ControlsBar: ({ className, ...rest }: import("./components").ControlsBarProps) => JSX.Element;
+    FullScreenButton: (props: React.HTMLAttributes<HTMLButtonElement>) => JSX.Element;
+    IconControl: ({ tooltip, children, className, ...rest }: {
+        tooltip: string;
+    } & React.HTMLAttributes<HTMLButtonElement>) => JSX.Element;
+    MuteButton: (props: React.HTMLAttributes<HTMLButtonElement>) => JSX.Element;
+    PauseIcon: (props: React.SVGAttributes<SVGSVGElement>) => JSX.Element;
+    PlayIcon: (props: React.SVGAttributes<SVGSVGElement>) => JSX.Element;
+    PlayPauseButton: (props: React.HTMLAttributes<HTMLButtonElement>) => JSX.Element;
+    Range: ({ className, onChange, value: startValue, max, onKeyDown, a11yStep, tooltip, tooltipFormatter, name, id, ...props }: import("./components").RangeProps) => JSX.Element;
+    SeekControl: ({ className, ...rest }: React.HTMLAttributes<HTMLDivElement>) => JSX.Element;
+    VolumeControl: (props: import("./components").RangeProps) => JSX.Element;
 };
 export {};

package/lib/VideoPlayer/components/CCButton/CCButton.d.ts

@@ -0,0 +1,2 @@
+import { type HTMLAttributes } from 'react';
+export declare const CCButton: ({ className, ...props }: HTMLAttributes<HTMLButtonElement>) => JSX.Element;

package/lib/VideoPlayer/components/CCButton/index.d.ts

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

package/lib/VideoPlayer/components/Captions/Captions.d.ts

@@ -0,0 +1,2 @@
+import { type HTMLAttributes } from 'react';
+export declare const Captions: ({ className, ...props }: HTMLAttributes<HTMLDivElement>) => JSX.Element | null;

package/lib/VideoPlayer/components/Controls/Controls.d.ts

@@ -0,0 +1,6 @@
+import { type HTMLAttributes } from 'react';
+export type ControlsProps = {
+    isSmall?: boolean;
+    showControlsWhenPaused?: boolean;
+} & HTMLAttributes<HTMLDivElement>;
+export declare const Controls: ({ isSmall, ...rest }: ControlsProps) => JSX.Element;

package/lib/VideoPlayer/components/ControlsBar/ControlsBar.d.ts

@@ -0,0 +1,3 @@
+import { type HTMLAttributes } from 'react';
+export type ControlsBarProps = HTMLAttributes<HTMLDivElement>;
+export declare const ControlsBar: ({ className, ...rest }: ControlsBarProps) => JSX.Element;

package/lib/VideoPlayer/components/ControlsBar/index.d.ts

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

package/lib/VideoPlayer/components/FullScreenButton/FullScreenButton.d.ts

@@ -0,0 +1,2 @@
+import { type HTMLAttributes } from 'react';
+export declare const FullScreenButton: (props: HTMLAttributes<HTMLButtonElement>) => JSX.Element;

package/lib/VideoPlayer/components/FullScreenButton/index.d.ts

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

package/lib/VideoPlayer/components/{icon-control → IconControl}/IconControl.d.ts

@@ -1,6 +1,6 @@
-import React from 'react';
+import { type HTMLAttributes } from 'react';
 type IconControlProps = {
     tooltip: string;
-} & React.HTMLAttributes<HTMLButtonElement>;
+} & HTMLAttributes<HTMLButtonElement>;
 export declare const IconControl: ({ tooltip, children, className, ...rest }: IconControlProps) => JSX.Element;
 export {};

package/lib/VideoPlayer/components/MuteButton/MuteButton.d.ts

@@ -0,0 +1,2 @@
+import { type HTMLAttributes } from 'react';
+export declare const MuteButton: (props: HTMLAttributes<HTMLButtonElement>) => JSX.Element;

package/lib/VideoPlayer/components/MuteButton/index.d.ts

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

package/lib/VideoPlayer/components/PauseIcon/PauseIcon.d.ts

@@ -0,0 +1,2 @@
+import { type SVGAttributes } from 'react';
+export declare const PauseIcon: (props: SVGAttributes<SVGSVGElement>) => JSX.Element;

package/lib/VideoPlayer/components/PauseIcon/index.d.ts

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

package/lib/VideoPlayer/components/PlayIcon/PlayIcon.d.ts

@@ -0,0 +1,2 @@
+import { type SVGAttributes } from 'react';
+export declare const PlayIcon: (props: SVGAttributes<SVGSVGElement>) => JSX.Element;

package/lib/VideoPlayer/components/PlayIcon/index.d.ts

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

package/lib/VideoPlayer/components/PlayPauseButton/PlayPauseButton.d.ts

@@ -0,0 +1,2 @@
+import { type HTMLAttributes } from 'react';
+export declare const PlayPauseButton: (props: HTMLAttributes<HTMLButtonElement>) => JSX.Element;

package/lib/VideoPlayer/components/PlayPauseButton/index.d.ts

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

package/lib/VideoPlayer/components/{range → Range}/Range.d.ts

@@ -1,9 +1,8 @@
 import React from 'react';
-type RangeProps = {
+export type RangeProps = {
     tooltip?: boolean;
-    tooltipFormatter?: (value: number | string | readonly string[]) => string;
+    tooltipFormatter?: (value: number) => string;
     max?: number;
     a11yStep?: number;
 } & React.HTMLProps<HTMLInputElement>;
 export declare const Range: ({ className, onChange, value: startValue, max, onKeyDown, a11yStep, tooltip, tooltipFormatter, name, id, ...props }: RangeProps) => JSX.Element;
-export {};

package/lib/VideoPlayer/components/SeekControl/SeekControl.d.ts

@@ -0,0 +1,4 @@
+import { type HTMLAttributes } from 'react';
+type SeekControlProps = HTMLAttributes<HTMLDivElement>;
+export declare const SeekControl: ({ className, ...rest }: SeekControlProps) => JSX.Element;
+export {};

package/lib/VideoPlayer/components/SeekControl/index.d.ts

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

package/lib/VideoPlayer/components/VideoTooltip/VideoTooltip.d.ts

@@ -0,0 +1,4 @@
+import { type HTMLAttributes } from 'react';
+type VideoTooltipProps = HTMLAttributes<HTMLDivElement>;
+export declare const VideoTooltip: ({ children, className, ...rest }: VideoTooltipProps) => JSX.Element;
+export {};

package/lib/VideoPlayer/components/VideoTooltip/index.d.ts

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

package/lib/VideoPlayer/components/VolumeControl/VolumeControl.d.ts

@@ -0,0 +1,2 @@
+import { type RangeProps } from '../';
+export declare const VolumeControl: (props: RangeProps) => JSX.Element;

package/lib/VideoPlayer/components/VolumeControl/index.d.ts

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

package/lib/VideoPlayer/components/index.d.ts

@@ -1,5 +1,14 @@
-export * from './captions';
-export * from './controls';
-export * from './range';
-export * from './tooltip';
-export * from './icon-control';
+export * from './Captions';
+export * from './CCButton';
+export * from './Controls';
+export * from './ControlsBar';
+export * from './FullScreenButton';
+export * from './IconControl';
+export * from './MuteButton';
+export * from './PauseIcon';
+export * from './PlayIcon';
+export * from './PlayPauseButton';
+export * from './Range';
+export * from './SeekControl';
+export * from './VideoTooltip';
+export * from './VolumeControl';

package/lib/VideoPlayer/hooks/index.d.ts

@@ -0,0 +1,4 @@
+export * from './useIsElementFullScreen';
+export * from './useVideo';
+export * from './useVideoKeypressHandlers';
+export * from './useVideoResizeObserver';

package/lib/VideoPlayer/hooks/useIsElementFullScreen.d.ts

@@ -0,0 +1,2 @@
+import { type Dispatch, type SetStateAction } from 'react';
+export declare const useIsElementFullScreen: (element?: HTMLElement | null) => [boolean, Dispatch<SetStateAction<boolean>>];

package/lib/VideoPlayer/hooks/useVideo.d.ts

@@ -0,0 +1,34 @@
+import React, { type PropsWithChildren, type SetStateAction, type RefObject } from 'react';
+type VideoState = {
+    ref: RefObject<HTMLVideoElement>;
+    isPlaying: boolean;
+    isMuted: boolean;
+    volume: number;
+    volumeBeforeMute: number | null;
+    ccEnabled: boolean;
+    duration: number;
+};
+export type UseVideoContext = VideoState & {
+    play: () => void;
+    pause: () => void;
+    togglePlaying: () => void;
+    mute: () => void;
+    unmute: () => void;
+    toggleMute: () => void;
+    setVolume: (volumeValOrFn: SetStateAction<number>) => void;
+    seek: (time: number) => void;
+    seekToPercent: (percent: number) => void;
+    seekRelative: (secondsValOrFn: SetStateAction<number>) => void;
+    enableCC: () => void;
+    disableCC: () => void;
+    toggleCC: () => void;
+    enterFullScreen: () => void;
+    exitFullScreen: () => void;
+    toggleFullScreen: () => void;
+    setDuration: (duration: number) => void;
+    isFullScreen: boolean;
+};
+export declare const useVideo: () => UseVideoContext;
+type VideoProviderProps = PropsWithChildren<Record<string, unknown>>;
+export declare const VideoProvider: React.ForwardRefExoticComponent<Omit<VideoProviderProps, "ref"> & React.RefAttributes<HTMLVideoElement>>;
+export {};

package/lib/VideoPlayer/hooks/useVideoKeypressHandlers.d.ts

@@ -0,0 +1,3 @@
+import { type RefObject } from 'react';
+export type KeypressHandler = [KeyboardEvent['key'], (e: KeyboardEvent) => void];
+export declare const useVideoKeypressHandlers: (videoWrapperRef: RefObject<HTMLElement>) => void;

package/lib/VideoPlayer/hooks/useVideoResizeObserver.d.ts

@@ -0,0 +1,5 @@
+import { type RefObject } from 'react';
+export declare const useVideoResizeObserver: ({ videoWrapperRef, className, }: {
+    videoWrapperRef: RefObject<HTMLElement>;
+    className: string;
+}) => boolean;