@activecollab/components
Version:
ActiveCollab Components
24 lines • 1.22 kB
TypeScript
import React from "react";
import { PortableTextComponents, PortableTextContent } from "./types";
import { Space } from "../LayoutTokens";
export interface IPortableTextProps extends Omit<React.ComponentPropsWithoutRef<"div">, "content"> {
/** The message body: the node list an API returns under `content`. */
content: PortableTextContent;
/**
* Application-injected renderers: catalog marks and objects, optional
* default-block overrides, and the unknown-type hook. See README.md.
*/
components?: PortableTextComponents;
/** Vertical rhythm between top-level nodes. */
space?: Space;
}
/**
* The Portable Text engine: walks a {@link PortableTextContent} envelope and
* renders it with the default renderers for the universal set, plus whatever
* the application injects through `components`. The engine itself is hollow —
* it knows no product element; an unknown block or object renders nothing and
* is reported once per type through `onUnknownType` (console.warn when the
* hook is absent).
*/
export declare const PortableText: React.ForwardRefExoticComponent<IPortableTextProps & React.RefAttributes<HTMLDivElement>>;
//# sourceMappingURL=PortableText.d.ts.map