@forge/react
11.14.2-next.211.14.2-next.3
out/components/adf-renderer.d.ts~
out/components/adf-renderer.d.tsModified+11
Index: package/out/components/adf-renderer.d.ts
===================================================================
--- package/out/components/adf-renderer.d.ts
+++ package/out/components/adf-renderer.d.ts
@@ -2,7 +2,18 @@
import type { Visitor } from '@atlaskit/adf-utils';
declare type AdfRendererProps = Omit<PlatformAdfRendererProps, 'documentWithoutMedia'> & {
replaceUnsupportedNode?: Visitor;
};
+/**
+ * The AdfRenderer component provides a way to render a valid ADF document, using the same renderer that Atlassian uses internally to render ADF content in Confluence pages, Jira work items, and so on.
+ * It allows you to replace node types that are unsupported in the context of a Forge app with replacement content, or remove them entirely.
+ * See [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/) for information on valid nodes.
+ *
+ * This component uses [@atlaskit/renderer](https://www.npmjs.com/package/@atlaskit/renderer) under the hood.
+ *
+ * Visit [Renderer editor](https://atlaskit.atlassian.com/examples/editor/renderer/basic) for a comprehensive list of different ADF document examples
+ *
+ * @see [AdfRenderer](https://developer.atlassian.com/platform/forge/ui-kit/components/adfRenderer/) in UI Kit documentation for more information
+ */
export declare const AdfRenderer: (props: AdfRendererProps) => import("react/jsx-runtime").JSX.Element;
export {};
//# sourceMappingURL=adf-renderer.d.ts.map
\ No newline at end of file