react-pdf-html/dist/types/render.d.ts

Html component for react-pdf with CSS support

import * as React from 'react';
import renderers from './renderers.js';
import { HtmlContent, HtmlElement } from './parse.js';
import { HtmlStyle, HtmlStyles } from './styles.js';
import { Style } from '@react-pdf/types';
import { Tag } from './tags.js';
export type HtmlRendererProps = {
    element: HtmlElement;
    style: Style[];
    children: React.ReactNode;
    stylesheets: HtmlStyles[];
};
export type HtmlRenderer = React.FC<React.PropsWithChildren<HtmlRendererProps>>;
export type WrapperRenderer = (Wrapper: React.ElementType, renderer: HtmlRendererProps) => React.ReactElement;
export type HtmlRenderers = Record<Tag | string, HtmlRenderer>;
export type HtmlRenderOptions = {
    collapse: boolean;
    renderers: HtmlRenderers;
    stylesheets: HtmlStyles[];
    resetStyles: boolean;
};
type ContentBucket = {
    hasBlock: boolean;
    content: HtmlContent;
};
export declare const isBlockStyle: (style: HtmlStyle) => boolean;
export declare const hasBlockContent: (element: HtmlElement | string) => boolean;
/**
 * Groups all block and non-block elements into buckets so that all non-block elements can be rendered in a parent Text element
 * @param elements Elements to place in buckets of block and non-block content
 * @param collapse
 * @param parentTag
 */
export declare const bucketElements: (elements: HtmlContent, collapse: boolean, parentTag?: Tag | string) => ContentBucket[];
type RenderedContent = React.ReactElement | React.ReactElement[] | string | string[];
export declare const renderElement: (element: HtmlElement | string, stylesheets: HtmlStyles[], renderers: HtmlRenderers, children?: any, index?: number) => RenderedContent;
export declare const collapseWhitespace: (string: any) => string;
export declare const renderBucketElement: (element: HtmlElement | string, options: HtmlRenderOptions, index: number) => RenderedContent;
export declare const renderElements: (elements: HtmlContent, options: HtmlRenderOptions, parent?: HtmlElement) => RenderedContent | RenderedContent[];
export declare const applyStylesheets: (stylesheets: HtmlStyles[], rootElement: HtmlElement) => void;
declare const renderHtml: (text: string, options?: {
    collapse?: boolean;
    renderers?: HtmlRenderers;
    style?: Style | Style[];
    stylesheet?: HtmlStyles | HtmlStyles[];
    resetStyles?: boolean;
}) => React.ReactElement;
export default renderHtml;