@primer/react-brand/lib/Hero/HeroContext.d.ts

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

import React from 'react';
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];
type HeroContextType = {
    /**
     * The active variant of the Hero component
     */
    variant: HeroVariant;
    /**
     * The alignment of the Hero content
     */
    align: HeroAlign;
    /**
     * Image position within the Hero
     */
    imagePosition: HeroMediaPositions;
    /**
     * Hero.Image is an inline media position
     */
    hasInlineMedia: boolean;
    /**
     * Whether animation is enabled for the Hero
     */
    enableAnimation: boolean;
};
export declare const HeroContext: React.Context<HeroContextType | undefined>;
export declare const useHeroContext: () => HeroContextType;
export {};