@primer/react-brand/lib/Prose/Prose.d.ts

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

import React from 'react';
import type { BaseProps } from '../component-helpers';
import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/prose/base.css';
import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/prose/colors-with-modes.css';
import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/inline-link/base.css';
export type ProseProps = {
    /**
     * Valid children include string encapsulated HTML elements such as `<h1>`, `<h2>`, `<h3>`, `<h4>`, `<h5>`, `<h6>`, `<p>`, `<strong>`, `<em>`, `<a>`, `<ul>`, `<ol>`, `<li>`, `<img>`, and `<div>`.
     */
    html: string;
    /**
     * The presentational variant of the prose.
     */
    variant?: 'default' | 'editorial';
    /**
     * Whether to enable full width prose or not.
     */
    enableFullWidth?: boolean;
} & Omit<BaseProps<HTMLDivElement>, 'animate' | 'children'> & Omit<React.ComponentPropsWithoutRef<'div'>, 'children'>;
export declare const Prose: React.ForwardRefExoticComponent<Omit<ProseProps, "ref"> & React.RefAttributes<HTMLDivElement>>;