Skip to content

A free and open-source block-based email template builder.

Consuming @usewaypoint/block-columns-container (#34)

cohitre07f5dcae0fb4
diff --git a/packages/block-columns-container/package-lock.json b/packages/block-columns-container/package-lock.json
index a5c7143..2ca5528 100644
--- a/packages/block-columns-container/package-lock.json
+++ b/packages/block-columns-container/package-lock.json
@@ -1,11 +1,11 @@
{
- "name": "@usewaypoint/block-html",
+ "name": "@usewaypoint/block-columns-container",
"version": "0.0.1",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
- "name": "@usewaypoint/block-html",
+ "name": "@usewaypoint/block-columns-container",
"version": "0.0.1",
"license": "MIT",
"devDependencies": {
diff --git a/packages/editor-sample/package-lock.json b/packages/editor-sample/package-lock.json
index 97dce26..cb047df 100644
--- a/packages/editor-sample/package-lock.json
+++ b/packages/editor-sample/package-lock.json
@@ -14,6 +14,7 @@
"@mui/material": "^5.15.10",
"@usewaypoint/block-avatar": "^0.0.1",
"@usewaypoint/block-button": "^0.0.1",
+ "@usewaypoint/block-columns-container": "^0.0.1",
"@usewaypoint/block-container": "^0.0.1",
"@usewaypoint/block-divider": "^0.0.3",
"@usewaypoint/block-heading": "^0.0.2",
@@ -1865,6 +1866,15 @@
"zod": "^1 || ^2 || ^3"
}
},
+ "node_modules/@usewaypoint/block-columns-container": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/@usewaypoint/block-columns-container/-/block-columns-container-0.0.1.tgz",
+ "integrity": "sha512-4/N/Ne+zu6Lp773MD3D6CgEZXlpbUECzeJsMdZ1bl5EHJQQi98sWH0FtVOltcNwFORAJgQ2ABaL7B4007760vA==",
+ "peerDependencies": {
+ "react": "^16 || ^17 || ^18",
+ "zod": "^1 || ^2 || ^3"
+ }
+ },
"node_modules/@usewaypoint/block-container": {
"version": "0.0.1",
"resolved": "https://registry.npmjs.org/@usewaypoint/block-container/-/block-container-0.0.1.tgz",
diff --git a/packages/editor-sample/package.json b/packages/editor-sample/package.json
index ce187f6..970a312 100644
--- a/packages/editor-sample/package.json
+++ b/packages/editor-sample/package.json
@@ -14,6 +14,7 @@
"@mui/material": "^5.15.10",
"@usewaypoint/block-avatar": "^0.0.1",
"@usewaypoint/block-button": "^0.0.1",
+ "@usewaypoint/block-columns-container": "^0.0.1",
"@usewaypoint/block-container": "^0.0.1",
"@usewaypoint/block-divider": "^0.0.3",
"@usewaypoint/block-heading": "^0.0.2",
diff --git a/packages/editor-sample/src/documents/blocks/ColumnsContainer/ColumnsContainerPropsSchema.ts b/packages/editor-sample/src/documents/blocks/ColumnsContainer/ColumnsContainerPropsSchema.ts
index 363abfb..7e5d5cd 100644
--- a/packages/editor-sample/src/documents/blocks/ColumnsContainer/ColumnsContainerPropsSchema.ts
+++ b/packages/editor-sample/src/documents/blocks/ColumnsContainer/ColumnsContainerPropsSchema.ts
@@ -1,27 +1,22 @@
import { z } from 'zod';
-import { zColor, zPadding } from '../helpers/zod';
+import { ColumnsContainerPropsSchema as BaseColumnsContainerPropsSchema } from '@usewaypoint/block-columns-container';
+
+const BasePropsShape = BaseColumnsContainerPropsSchema.shape.props.unwrap().unwrap().shape;
const ColumnsContainerPropsSchema = z.object({
- style: z
+ style: BaseColumnsContainerPropsSchema.shape.style,
+ props: z
.object({
- backgroundColor: zColor().nullable().default(null),
- padding: zPadding().optional().default({
- top: 16,
- bottom: 16,
- left: 24,
- right: 24,
- }),
+ ...BasePropsShape,
+ columns: z.tuple([
+ z.object({ childrenIds: z.array(z.string()) }),
+ z.object({ childrenIds: z.array(z.string()) }),
+ z.object({ childrenIds: z.array(z.string()) }),
+ ]),
})
- .default({}),
- props: z.object({
- columnsCount: z.union([z.literal(2), z.literal(3)]),
- columns: z.tuple([
- z.object({ childrenIds: z.array(z.string()) }),
- z.object({ childrenIds: z.array(z.string()) }),
- z.object({ childrenIds: z.array(z.string()) }),
- ]),
- }),
+ .optional()
+ .nullable(),
});
export type ColumnsContainerProps = z.infer<typeof ColumnsContainerPropsSchema>;
diff --git a/packages/editor-sample/src/documents/blocks/ColumnsContainer/index.tsx b/packages/editor-sample/src/documents/blocks/ColumnsContainer/index.tsx
index b265a07..4952e4e 100644
--- a/packages/editor-sample/src/documents/blocks/ColumnsContainer/index.tsx
+++ b/packages/editor-sample/src/documents/blocks/ColumnsContainer/index.tsx
@@ -1,5 +1,7 @@
import React from 'react';
+import { ColumnsContainer as BaseColumnsContainer } from '@usewaypoint/block-columns-container';
+
import { TEditorBlock } from '../../editor/core';
import { useCurrentBlockId } from '../../editor/EditorBlock';
import { useEditorState } from '../../editor/EditorContext';
@@ -8,70 +10,55 @@ import EditorChildrenIds from '../helpers/EditorChildrenIds';
import ColumnsContainerPropsSchema, { ColumnsContainerProps } from './ColumnsContainerPropsSchema';
-export function ColumnsContainer({ props: { columnsCount, columns } }: ColumnsContainerProps) {
- let lastColumn = null;
- if (columnsCount === 3) {
- lastColumn = (
- <td>
- {columns[2].childrenIds.map((childId) => (
- <ReaderBlock key={childId} id={childId} />
- ))}
- </td>
- );
+export function ColumnsContainer({ style, props }: ColumnsContainerProps) {
+ const { columns, ...restProps } = props ?? {};
+ let cols = undefined;
+ if (columns) {
+ cols = columns.map((col) => col.childrenIds.map((childId) => <ReaderBlock key={childId} id={childId} />));
}
- return (
- <table
- align="center"
- width="100%"
- cellPadding="0"
- border={0}
- style={{ tableLayout: 'fixed', borderCollapse: 'collapse' }}
- >
- <tbody style={{ width: '100%' }}>
- <tr style={{ width: '100%' }}>
- <td>
- {columns[0].childrenIds.map((childId) => (
- <ReaderBlock key={childId} id={childId} />
- ))}
- </td>
- <td>
- {columns[1].childrenIds.map((childId) => (
- <ReaderBlock key={childId} id={childId} />
- ))}
- </td>
- {lastColumn}
- </tr>
- </tbody>
- </table>
- );
+
+ return <BaseColumnsContainer props={restProps} columns={cols} style={style} />;
}
-export function EditorColumnsContainer(data: ColumnsContainerProps) {
- const { columnsCount, columns } = data.props;
+const EMPTY_COLUMNS = [{ childrenIds: [] }, { childrenIds: [] }, { childrenIds: [] }];
+
+export function EditorColumnsContainer({ style, props }: ColumnsContainerProps) {
const [{ document }, setEditorState] = useEditorState();
const blockId = useCurrentBlockId();
+ const { columns, ...restProps } = props ?? {};
+ const columnsValue = columns ?? EMPTY_COLUMNS;
+
+ const renderColumn = (columnIndex: 0 | 1 | 2) => (
+ <EditorChildrenIds
+ childrenIds={columns?.[columnIndex]?.childrenIds || []}
+ insertBlock={(block, index) => {
+ insertBlock(columnIndex, block, index);
+ }}
+ />
+ );
+
const insertBlock = (columnIndex: 0 | 1 | 2, blockConfiguration: TEditorBlock, i: number | null) => {
const id = `block-${Date.now()}`;
const getColumns = () => {
- const columnsCopy: ColumnsContainerProps['props']['columns'] = [...columns];
+ const columnsCopy = [...columnsValue];
if (i === null) {
columnsCopy[columnIndex] = {
- childrenIds: [...columns[columnIndex].childrenIds, id],
+ childrenIds: [...columnsValue[columnIndex].childrenIds, id],
};
return columnsCopy;
}
columnsCopy[columnIndex] = {
childrenIds: [
- ...columns[columnIndex].childrenIds.slice(0, i),
+ ...columnsValue[columnIndex].childrenIds.slice(0, i),
id,
- ...columns[columnIndex].childrenIds.slice(i),
+ ...columnsValue[columnIndex].childrenIds.slice(i),
],
};
return columnsCopy;
};
- const data = ColumnsContainerPropsSchema.parse(document[blockId].data);
+
setEditorState({
selectedBlockId: id,
document: {
@@ -79,60 +66,23 @@ export function EditorColumnsContainer(data: ColumnsContainerProps) {
[id]: blockConfiguration,
[blockId]: {
type: 'ColumnsContainer',
- data: {
- ...data,
+ data: ColumnsContainerPropsSchema.parse({
+ style,
props: {
- ...data.props,
+ ...restProps,
columns: getColumns(),
},
- },
+ }),
},
},
});
};
- let lastColumn = null;
- if (columnsCount === 3) {
- lastColumn = (
- <td>
- <EditorChildrenIds
- childrenIds={columns[2].childrenIds}
- insertBlock={(block, index) => {
- insertBlock(2, block, index);
- }}
- />
- </td>
- );
- }
return (
- <table
- align="center"
- width="100%"
- cellPadding="0"
- border={0}
- style={{ tableLayout: 'fixed', borderCollapse: 'collapse' }}
- >
- <tbody style={{ width: '100%' }}>
- <tr style={{ width: '100%' }}>
- <td>
- <EditorChildrenIds
- childrenIds={columns[0].childrenIds}
- insertBlock={(block, index) => {
- insertBlock(0, block, index);
- }}
- />
- </td>
- <td>
- <EditorChildrenIds
- childrenIds={columns[1].childrenIds}
- insertBlock={(block, index) => {
- insertBlock(1, block, index);
- }}
- />
- </td>
- {lastColumn}
- </tr>
- </tbody>
- </table>
+ <BaseColumnsContainer
+ props={restProps}
+ style={style}
+ columns={[renderColumn(0), renderColumn(1), renderColumn(2)]}
+ />
);
}
diff --git a/packages/editor-sample/src/documents/blocks/helpers/block-wrappers/index.tsx b/packages/editor-sample/src/documents/blocks/helpers/block-wrappers/index.tsx
deleted file mode 100644
index e41c581..0000000
--- a/packages/editor-sample/src/documents/blocks/helpers/block-wrappers/index.tsx
+++ /dev/null
@@ -1,31 +0,0 @@
-import React from 'react';
-
-import EditorBlockWrapper from './EditorBlockWrapper';
-import ReaderBlockWrapper from './ReaderBlockWrapper';
-
-type TCommonProps = {
- props: Record<string, unknown>;
- style: Record<string, unknown>;
-};
-
-export function addReaderBlockWrapper<TProps extends TCommonProps>(ChildComponent: (props: TProps) => JSX.Element) {
- return (props: TProps) => {
- return (
- <ReaderBlockWrapper style={props.style}>
- <ChildComponent {...props} />
- </ReaderBlockWrapper>
- );
- };
-}
-
-export function addEditorBlockWrapper<TProps extends TCommonProps>(ChildComponent: (props: TProps) => JSX.Element) {
- return (props: TProps) => {
- return (
- <EditorBlockWrapper>
- <ReaderBlockWrapper style={props.style}>
- <ChildComponent {...props} />
- </ReaderBlockWrapper>
- </EditorBlockWrapper>
- );
- };
-}
diff --git a/packages/editor-sample/src/documents/editor/core.tsx b/packages/editor-sample/src/documents/editor/core.tsx
index fc00a8b..1d8574d 100644
--- a/packages/editor-sample/src/documents/editor/core.tsx
+++ b/packages/editor-sample/src/documents/editor/core.tsx
@@ -12,12 +12,13 @@ import { Text, TextProps, TextPropsSchema } from '@usewaypoint/block-text';
import { buildBlockComponent, buildBlockConfigurationSchema } from '@usewaypoint/document-core';
import { EditorColumnsContainer } from '../blocks/ColumnsContainer';
-import ColumnsContainerPropsSchema from '../blocks/ColumnsContainer/ColumnsContainerPropsSchema';
+import ColumnsContainerPropsSchema, {
+ ColumnsContainerProps,
+} from '../blocks/ColumnsContainer/ColumnsContainerPropsSchema';
import { EditorContainer } from '../blocks/Container';
import { ContainerProps, ContainerPropsSchema } from '../blocks/Container/ContainerPropsSchema';
import { EditorEmailLayout, EmailLayoutProps } from '../blocks/EmailLayout';
import { EmailLayoutPropsSchema } from '../blocks/EmailLayout/EmailLayoutPropsSchema';
-import { addEditorBlockWrapper } from '../blocks/helpers/block-wrappers';
import EditorBlockWrapper from '../blocks/helpers/block-wrappers/EditorBlockWrapper';
const EDITOR_DICTIONARY = {
@@ -47,7 +48,11 @@ const EDITOR_DICTIONARY = {
},
ColumnsContainer: {
schema: ColumnsContainerPropsSchema,
- Component: addEditorBlockWrapper(EditorColumnsContainer),
+ Component: (props: ColumnsContainerProps) => (
+ <EditorBlockWrapper>
+ <EditorColumnsContainer {...props} />
+ </EditorBlockWrapper>
+ ),
},
Heading: {
schema: HeadingPropsSchema,
diff --git a/packages/editor-sample/src/documents/reader/core.tsx b/packages/editor-sample/src/documents/reader/core.tsx
index 95c1916..fad1659 100644
--- a/packages/editor-sample/src/documents/reader/core.tsx
+++ b/packages/editor-sample/src/documents/reader/core.tsx
@@ -16,7 +16,6 @@ import { Container } from '../blocks/Container';
import { ContainerPropsSchema } from '../blocks/Container/ContainerPropsSchema';
import { EmailLayout } from '../blocks/EmailLayout';
import { EmailLayoutPropsSchema } from '../blocks/EmailLayout/EmailLayoutPropsSchema';
-import { addReaderBlockWrapper } from '../blocks/helpers/block-wrappers';
const READER_DICTIONARY = {
Avatar: {
@@ -29,7 +28,7 @@ const READER_DICTIONARY = {
},
ColumnsContainer: {
schema: ColumnsContainerPropsSchema,
- Component: addReaderBlockWrapper(ColumnsContainer),
+ Component: ColumnsContainer,
},
Container: {
schema: ContainerPropsSchema,