@forge/react
11.14.2-next.211.14.2-next.3
out/components/adf-renderer.js~
out/components/adf-renderer.jsModified+11
Index: package/out/components/adf-renderer.js
===================================================================
--- package/out/components/adf-renderer.js
+++ package/out/components/adf-renderer.js
@@ -3,8 +3,19 @@
exports.AdfRenderer = void 0;
const jsx_runtime_1 = require("react/jsx-runtime");
const replaceUnsupportedDocumentNodes_1 = require("./utils/replaceUnsupportedDocumentNodes");
const PlatformAdfRenderer = 'AdfRenderer';
+/**
+ * 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
+ */
const AdfRenderer = (props) => {
const { replaceUnsupportedNode, document, ...adfRendererProps } = props;
const documentWithMedia = replaceUnsupportedNode
? (0, replaceUnsupportedDocumentNodes_1.replaceUnsupportedDocumentNodes)(document, replaceUnsupportedNode)