@primer/react-brand
Version:
Primer Brand is a GitHub's design system for creating React-based marketing websites and digital experiences.
32 lines (31 loc) • 1.35 kB
TypeScript
import React from 'react';
import type { BaseProps } from '../component-helpers';
export declare const FootnotesTags: readonly ["div", "ol"];
type FootnotesRestrictedPolymorphism = (React.HTMLAttributes<HTMLDivElement> & BaseProps<HTMLDivElement> & {
as?: 'div';
}) | (React.HTMLAttributes<HTMLParagraphElement> & BaseProps<HTMLOListElement> & {
as?: 'ol';
});
type FootnotesProps = {
as?: (typeof FootnotesTags)[number];
visuallyHiddenHeading?: string;
} & FootnotesRestrictedPolymorphism;
declare function Root({ as, className, children, visuallyHiddenHeading, ...rest }: FootnotesProps): import("react/jsx-runtime").JSX.Element;
export declare const FootnotesItemTags: readonly ["a", "p"];
type DefaultFootnotesItemProps = {
_variant?: 'disclaimer';
};
type CitationFootnotesItemProps = {
_variant?: 'citation';
href?: string;
};
type FootnotesItemProps = (DefaultFootnotesItemProps | CitationFootnotesItemProps) & React.HTMLAttributes<HTMLParagraphElement> & BaseProps<HTMLParagraphElement>;
declare function Item({ className, children, _variant, ...rest }: FootnotesItemProps): import("react/jsx-runtime").JSX.Element;
/**
* Footnotes component
* {@link https://primer.style/brand/components/Footnotes/ See usage examples}.
*/
export declare const Footnotes: typeof Root & {
Item: typeof Item;
};
export {};