@contensis/canvas-react 1.0.1 → 1.0.3

package/README.md

@@ -120,7 +120,7 @@ type Book = { cover: string; name: string };
 // Render a "book" component within the canvas data
 const MyBookComponent = (props: RenderBlockProps<ComponentBlock<Book>) => {
   const book = props.block?.value;
-  if (!book) return <></>;
+  if (!book) return null;
   return (
     <div className="card mb-3">
       <div className="row g-0">

package/dist/canvas-react.d.mts

@@ -1,4 +1,4 @@
-import * as react from 'react';
+import React, { FunctionComponent, ClassType, Component as Component$1, ComponentClass } from 'react';
 
 type InlineBlock = FragmentBlock | AnchorBlock | LinkBlock | InlineEntryBlock;
 type InlineChildren = string | InlineBlock[];
@@ -297,7 +297,7 @@ type TableRowBlock = {
 
 type Attributes = Record<string, any>;
 type WithChildren = {
-    children?: JSX.Element;
+    children?: JSX.Element | undefined;
 };
 type RendererProps = {
     data: Block[];
@@ -309,7 +309,7 @@ type RenderBlockPropsWithChildren<T extends Block> = RenderBlockProps<T> & WithC
 type TypedBlock<TType extends Block['type']> = Extract<Block, {
     type: TType;
 }>;
-type BlockRenderer<T extends Block> = (props: RenderBlockPropsWithChildren<T>) => JSX.Element;
+type BlockRenderer<T extends Block> = Renderer<RenderBlockPropsWithChildren<T>>;
 type BlockRenderers = {
     [TType in Block['type']]: BlockRenderer<TypedBlock<TType>>;
 };
@@ -319,9 +319,9 @@ type RenderDecoratorProps = {
     otherDecorators: undefined | DecoratorType[];
 };
 type RenderDecoratorPropsWithChildren = RenderDecoratorProps & WithChildren & Attributes;
-type DecoratorRenderer = (props: RenderDecoratorPropsWithChildren) => JSX.Element;
+type DecoratorRenderer = Renderer<RenderDecoratorPropsWithChildren>;
 type DecoratorRenderers = Record<DecoratorType, DecoratorRenderer>;
-type ComponentRenderer = (props: RenderBlockPropsWithChildren<ComponentBlock>) => JSX.Element;
+type ComponentRenderer = Renderer<RenderBlockPropsWithChildren<ComponentBlock>>;
 type ComponentRenderers = Record<string, ComponentRenderer>;
 type RendererContextValue = {
     blocks?: BlockRenderers;
@@ -333,12 +333,34 @@ type RendererOverridesContextValue = {
     decorators?: Partial<DecoratorRenderers>;
     components?: ComponentRenderers;
 };
-type RendererContextProviderProps = {
-    children: JSX.Element;
-} & RendererOverridesContextValue;
+type RendererContextProviderProps = WithChildren & RendererOverridesContextValue;
 
-declare const RendererContext: react.Context<RendererContextValue>;
+declare const RendererContext: React.Context<RendererContextValue>;
+/**
+ * Provides context to the <Renderer> component to return Canvas data as React components
+ *
+ *  @link https://www.npmjs.com/package/@contensis/canvas-react#usage
+ *
+ * @param blocks - Override the default rendering of Canvas content blocks
+ * @param components - Render method for Contensis Components within the Canvas field
+ * @param decorators - Override the rendering of HTML elements within a text field
+ *
+ * @example
+ * <RenderContextProvider blocks={{ _table: Table }} components={{ banner: Banner }} decorators={{ strong: Strong }}>
+ *      <Renderer data={data} />
+ * </RenderContextProvider>
+ *
+ */
 declare function RenderContextProvider(props: RendererContextProviderProps): JSX.Element;
+type Renderer<TProps> = FunctionComponent<TProps> | ClassType<TProps, Component$1<TProps>, ComponentClass<TProps>>;
+/**
+ * The default render method for processing Canvas data
+ *
+ * @link https://www.npmjs.com/package/@contensis/canvas-react#usage
+ *
+ * @param data - Accepts Canvas data
+ *
+ * */
 declare function Renderer(props: RendererProps): JSX.Element;
 declare function Anchor(props: RenderBlockPropsWithChildren<AnchorBlock>): JSX.Element;
 declare namespace Anchor {
@@ -392,6 +414,10 @@ declare function Paragraph(props: RenderBlockPropsWithChildren<ParagraphBlock>):
 declare namespace Paragraph {
     var Children: (props: RenderBlockProps<ParagraphBlock>) => JSX.Element;
 }
+declare function Quote(props: RenderBlockPropsWithChildren<QuoteBlock>): JSX.Element;
+declare namespace Quote {
+    var Children: (props: RenderBlockProps<QuoteBlock>) => JSX.Element;
+}
 declare function Table(props: RenderBlockPropsWithChildren<TableBlock>): JSX.Element;
 declare namespace Table {
     var Children: (props: RenderBlockProps<TableBlock>) => JSX.Element;
@@ -478,4 +504,4 @@ declare namespace Variable {
     var Children: typeof DecoratorChildren;
 }
 
-export { Anchor, type AnchorBlock, type Block, type BlockRenderer, Code, type CodeBlock, Component, type ComponentBlock, type DecoratorType, Delete, Divider, type DividerBlock, Emphasis, Fragment, type FragmentBlock, Heading, type HeadingBlock, Image, type ImageBlock, InlineCode, InlineEntry, type InlineEntryBlock, Insert, Keyboard, LineBreak, Link, type LinkBlock, List, type ListBlock, ListItem, type ListItemBlock, Mark, Panel, type PanelBlock, Paragraph, type ParagraphBlock, type QuoteBlock, type RenderBlockProps, type RenderBlockPropsWithChildren, RenderContextProvider, type RenderDecoratorProps, type RenderDecoratorPropsWithChildren, Renderer, RendererContext, Strikethrough, Strong, Subscript, Superscript, Table, type TableBlock, TableBody, type TableBodyBlock, TableCaption, type TableCaptionBlock, TableCell, type TableCellBlock, TableFooter, type TableFooterBlock, TableHeader, type TableHeaderBlock, TableHeaderCell, type TableHeaderCellBlock, TableRow, type TableRowBlock, Underline, Variable };
+export { Anchor, type AnchorBlock, type Block, type BlockRenderer, Code, type CodeBlock, Component, type ComponentBlock, type DecoratorType, Delete, Divider, type DividerBlock, Emphasis, Fragment, type FragmentBlock, Heading, type HeadingBlock, Image, type ImageBlock, InlineCode, InlineEntry, type InlineEntryBlock, Insert, Keyboard, LineBreak, Link, type LinkBlock, List, type ListBlock, ListItem, type ListItemBlock, Mark, Panel, type PanelBlock, Paragraph, type ParagraphBlock, Quote, type QuoteBlock, type RenderBlockProps, type RenderBlockPropsWithChildren, RenderContextProvider, type RenderDecoratorProps, type RenderDecoratorPropsWithChildren, Renderer, RendererContext, Strikethrough, Strong, Subscript, Superscript, Table, type TableBlock, TableBody, type TableBodyBlock, TableCaption, type TableCaptionBlock, TableCell, type TableCellBlock, TableFooter, type TableFooterBlock, TableHeader, type TableHeaderBlock, TableHeaderCell, type TableHeaderCellBlock, TableRow, type TableRowBlock, Underline, Variable };

package/dist/canvas-react.d.ts

@@ -1,4 +1,4 @@
-import * as react from 'react';
+import React, { FunctionComponent, ClassType, Component as Component$1, ComponentClass } from 'react';
 
 type InlineBlock = FragmentBlock | AnchorBlock | LinkBlock | InlineEntryBlock;
 type InlineChildren = string | InlineBlock[];
@@ -297,7 +297,7 @@ type TableRowBlock = {
 
 type Attributes = Record<string, any>;
 type WithChildren = {
-    children?: JSX.Element;
+    children?: JSX.Element | undefined;
 };
 type RendererProps = {
     data: Block[];
@@ -309,7 +309,7 @@ type RenderBlockPropsWithChildren<T extends Block> = RenderBlockProps<T> & WithC
 type TypedBlock<TType extends Block['type']> = Extract<Block, {
     type: TType;
 }>;
-type BlockRenderer<T extends Block> = (props: RenderBlockPropsWithChildren<T>) => JSX.Element;
+type BlockRenderer<T extends Block> = Renderer<RenderBlockPropsWithChildren<T>>;
 type BlockRenderers = {
     [TType in Block['type']]: BlockRenderer<TypedBlock<TType>>;
 };
@@ -319,9 +319,9 @@ type RenderDecoratorProps = {
     otherDecorators: undefined | DecoratorType[];
 };
 type RenderDecoratorPropsWithChildren = RenderDecoratorProps & WithChildren & Attributes;
-type DecoratorRenderer = (props: RenderDecoratorPropsWithChildren) => JSX.Element;
+type DecoratorRenderer = Renderer<RenderDecoratorPropsWithChildren>;
 type DecoratorRenderers = Record<DecoratorType, DecoratorRenderer>;
-type ComponentRenderer = (props: RenderBlockPropsWithChildren<ComponentBlock>) => JSX.Element;
+type ComponentRenderer = Renderer<RenderBlockPropsWithChildren<ComponentBlock>>;
 type ComponentRenderers = Record<string, ComponentRenderer>;
 type RendererContextValue = {
     blocks?: BlockRenderers;
@@ -333,12 +333,34 @@ type RendererOverridesContextValue = {
     decorators?: Partial<DecoratorRenderers>;
     components?: ComponentRenderers;
 };
-type RendererContextProviderProps = {
-    children: JSX.Element;
-} & RendererOverridesContextValue;
+type RendererContextProviderProps = WithChildren & RendererOverridesContextValue;
 
-declare const RendererContext: react.Context<RendererContextValue>;
+declare const RendererContext: React.Context<RendererContextValue>;
+/**
+ * Provides context to the <Renderer> component to return Canvas data as React components
+ *
+ *  @link https://www.npmjs.com/package/@contensis/canvas-react#usage
+ *
+ * @param blocks - Override the default rendering of Canvas content blocks
+ * @param components - Render method for Contensis Components within the Canvas field
+ * @param decorators - Override the rendering of HTML elements within a text field
+ *
+ * @example
+ * <RenderContextProvider blocks={{ _table: Table }} components={{ banner: Banner }} decorators={{ strong: Strong }}>
+ *      <Renderer data={data} />
+ * </RenderContextProvider>
+ *
+ */
 declare function RenderContextProvider(props: RendererContextProviderProps): JSX.Element;
+type Renderer<TProps> = FunctionComponent<TProps> | ClassType<TProps, Component$1<TProps>, ComponentClass<TProps>>;
+/**
+ * The default render method for processing Canvas data
+ *
+ * @link https://www.npmjs.com/package/@contensis/canvas-react#usage
+ *
+ * @param data - Accepts Canvas data
+ *
+ * */
 declare function Renderer(props: RendererProps): JSX.Element;
 declare function Anchor(props: RenderBlockPropsWithChildren<AnchorBlock>): JSX.Element;
 declare namespace Anchor {
@@ -392,6 +414,10 @@ declare function Paragraph(props: RenderBlockPropsWithChildren<ParagraphBlock>):
 declare namespace Paragraph {
     var Children: (props: RenderBlockProps<ParagraphBlock>) => JSX.Element;
 }
+declare function Quote(props: RenderBlockPropsWithChildren<QuoteBlock>): JSX.Element;
+declare namespace Quote {
+    var Children: (props: RenderBlockProps<QuoteBlock>) => JSX.Element;
+}
 declare function Table(props: RenderBlockPropsWithChildren<TableBlock>): JSX.Element;
 declare namespace Table {
     var Children: (props: RenderBlockProps<TableBlock>) => JSX.Element;
@@ -478,4 +504,4 @@ declare namespace Variable {
     var Children: typeof DecoratorChildren;
 }
 
-export { Anchor, type AnchorBlock, type Block, type BlockRenderer, Code, type CodeBlock, Component, type ComponentBlock, type DecoratorType, Delete, Divider, type DividerBlock, Emphasis, Fragment, type FragmentBlock, Heading, type HeadingBlock, Image, type ImageBlock, InlineCode, InlineEntry, type InlineEntryBlock, Insert, Keyboard, LineBreak, Link, type LinkBlock, List, type ListBlock, ListItem, type ListItemBlock, Mark, Panel, type PanelBlock, Paragraph, type ParagraphBlock, type QuoteBlock, type RenderBlockProps, type RenderBlockPropsWithChildren, RenderContextProvider, type RenderDecoratorProps, type RenderDecoratorPropsWithChildren, Renderer, RendererContext, Strikethrough, Strong, Subscript, Superscript, Table, type TableBlock, TableBody, type TableBodyBlock, TableCaption, type TableCaptionBlock, TableCell, type TableCellBlock, TableFooter, type TableFooterBlock, TableHeader, type TableHeaderBlock, TableHeaderCell, type TableHeaderCellBlock, TableRow, type TableRowBlock, Underline, Variable };
+export { Anchor, type AnchorBlock, type Block, type BlockRenderer, Code, type CodeBlock, Component, type ComponentBlock, type DecoratorType, Delete, Divider, type DividerBlock, Emphasis, Fragment, type FragmentBlock, Heading, type HeadingBlock, Image, type ImageBlock, InlineCode, InlineEntry, type InlineEntryBlock, Insert, Keyboard, LineBreak, Link, type LinkBlock, List, type ListBlock, ListItem, type ListItemBlock, Mark, Panel, type PanelBlock, Paragraph, type ParagraphBlock, Quote, type QuoteBlock, type RenderBlockProps, type RenderBlockPropsWithChildren, RenderContextProvider, type RenderDecoratorProps, type RenderDecoratorPropsWithChildren, Renderer, RendererContext, Strikethrough, Strong, Subscript, Superscript, Table, type TableBlock, TableBody, type TableBodyBlock, TableCaption, type TableCaptionBlock, TableCell, type TableCellBlock, TableFooter, type TableFooterBlock, TableHeader, type TableHeaderBlock, TableHeaderCell, type TableHeaderCellBlock, TableRow, type TableRowBlock, Underline, Variable };