@primer/react-brand/lib/FAQ/FAQ.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 { HeadingProps } from '..';
import type { BaseProps } from '../component-helpers';
/**
 * Design tokens
 */
import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/faq/base.css';
import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/faq/colors-with-modes.css';
import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/faq/faq.css';
export type FAQRootProps = PropsWithChildren<BaseProps<HTMLElement>> & React.HTMLAttributes<HTMLElement>;
type FAQHeadingProps = BaseProps<HTMLHeadingElement> & {
    align?: 'start' | 'center';
    children: React.ReactNode | React.ReactNode[];
    as?: HeadingProps['as'];
} & HeadingProps;
export type FAQSubheadingProps = BaseProps<HTMLHeadingElement> & {
    align?: 'start' | 'center';
    children: React.ReactNode | React.ReactNode[];
    as?: Exclude<HeadingProps['as'], 'h1'>;
} & HeadingProps;
declare function FAQSubheading({ children, className, as, size, weight, ...rest }: FAQSubheadingProps): import("react/jsx-runtime").JSX.Element;
/**
 * FAQ component:
 * {@link https://primer.style/brand/components/FAQ/ See usage examples}.
 */
export declare const FAQ: React.ForwardRefExoticComponent<Omit<FAQRootProps, "ref"> & React.RefAttributes<HTMLElement>> & {
    Subheading: typeof FAQSubheading;
    Heading: React.ForwardRefExoticComponent<Omit<FAQHeadingProps, "ref"> & React.RefAttributes<HTMLHeadingElement>>;
    Item: React.ForwardRefExoticComponent<React.DetailsHTMLAttributes<HTMLDetailsElement> & {
        children: React.ReactElement<import("..").AccordionHeadingProps | import("..").AccordionContentProps>[];
        variant?: "default" | "emphasis";
        handleOpen?: (isOpen: boolean) => void;
    } & React.RefAttributes<HTMLDetailsElement>>;
    Question: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLElement> & {
        as?: HeadingProps["as"];
        reversedToggles?: boolean;
        toggleColor?: typeof import("..").AccordionToggleColors[number];
    } & React.RefAttributes<HTMLHeadingElement>>;
    Answer: ({ className, ...rest }: import("..").AccordionContentProps) => import("react/jsx-runtime").JSX.Element;
};
export {};