@primer/react-brand
Version:
Primer Brand is a GitHub's design system for creating React-based marketing websites and digital experiences.
21 lines • 1.12 kB
TypeScript
import React from 'react';
import { RiverProps } from '../River';
import { type RiverVisualBaseProps } from '../River/River';
export declare const RiverBreakoutVariants: readonly ["default", "gridline"];
export type RiverBreakoutVariant = (typeof RiverBreakoutVariants)[number];
type RiverBreakoutProps = Omit<RiverProps, 'align' | 'imageTextRatio'> & {
/**
* Apply a visual variant. The default is `default`.
* `gridline` adds horizontal border lines and lateral spacing.
*/
variant?: RiverBreakoutVariant;
};
export declare const RiverBreakout: React.ForwardRefExoticComponent<Omit<RiverBreakoutProps, "ref"> & React.RefAttributes<HTMLElement>> & {
Visual: React.ForwardRefExoticComponent<Omit<RiverVisualBaseProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
Content: React.ForwardRefExoticComponent<Omit<import("..").RiverContentProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
A11yHeading: ({ as, children }: React.PropsWithChildren<{
as?: "h2" | "h3";
}>) => import("react/jsx-runtime").JSX.Element;
};
export {};
//# sourceMappingURL=RiverBreakout.d.ts.map