@primer/react-brand/lib/Hero/sub-components/HeroVideo.d.ts

Primer Brand is a GitHub's design system for creating React-based marketing websites and digital experiences.

import React, { PropsWithChildren } from 'react';
import type { BaseProps } from '../../component-helpers';
import type { HeroMediaPadding, HeroMediaPosition } from '../HeroContext';
type HeroVideoBaseProps = {
    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>>;
type PosterProps = {
    poster?: never;
    posterAltText?: never;
    posterTitle?: never;
} | {
    poster: string;
    posterAltText: string;
    posterTitle: string;
};
export type HeroVideoProps = HeroVideoBaseProps & PosterProps;
export declare const HeroVideo: React.ForwardRefExoticComponent<(Omit<{
    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> & {
    children?: React.ReactNode | undefined;
} & {
    poster?: never;
    posterAltText?: never;
    posterTitle?: never;
}, "ref"> | Omit<{
    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> & {
    children?: React.ReactNode | undefined;
} & {
    poster: string;
    posterAltText: string;
    posterTitle: string;
}, "ref">) & React.RefAttributes<HTMLDivElement>>;
export {};