esender-email-editor 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -8
- package/dist/index.cjs +6 -6
- package/dist/index.js +6 -6
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# esender-email-editor
|
|
2
2
|
|
|
3
3
|
A drag-and-drop **MJML email editor** for React 18 + Ant Design 5. The editor renders inside a single `<Package />` component, exposes a small imperative API for getting / loading / saving templates, and gates access behind the **eSender license** system.
|
|
4
4
|
|
|
@@ -11,7 +11,7 @@ A drag-and-drop **MJML email editor** for React 18 + Ant Design 5. The editor re
|
|
|
11
11
|
The package is published on the public **npm registry**.
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
npm install
|
|
14
|
+
npm install esender-email-editor --legacy-peer-deps
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
> `--legacy-peer-deps` is required because a transitive dep (`react-giphy-searchbox`) still declares a `react@16` peer range. The runtime works on React 18 — only the peer declaration is stale.
|
|
@@ -44,8 +44,8 @@ npm install --legacy-peer-deps \
|
|
|
44
44
|
|
|
45
45
|
```tsx
|
|
46
46
|
import { useRef } from 'react';
|
|
47
|
-
import Package, { type EditorHandle, type LicenseError } from '
|
|
48
|
-
import '
|
|
47
|
+
import Package, { type EditorHandle, type LicenseError } from 'esender-email-editor';
|
|
48
|
+
import 'esender-email-editor/styles.css';
|
|
49
49
|
|
|
50
50
|
export const Composer = () => {
|
|
51
51
|
const ref = useRef<EditorHandle>(null);
|
|
@@ -119,7 +119,7 @@ No further token management is required from the host.
|
|
|
119
119
|
Import the bundled stylesheet once at your app root:
|
|
120
120
|
|
|
121
121
|
```ts
|
|
122
|
-
import '
|
|
122
|
+
import 'esender-email-editor/styles.css';
|
|
123
123
|
```
|
|
124
124
|
|
|
125
125
|
The package depends on Ant Design 5. Antd v5's runtime CSS-in-JS handles its own component styles, so you do **not** need a separate antd reset. The bundled `styles.css` only contains editor chrome overrides (CKEditor 5, Quill, antd tweaks).
|
|
@@ -132,7 +132,7 @@ The package depends on Ant Design 5. Antd v5's runtime CSS-in-JS handles its own
|
|
|
132
132
|
// Next.js (app/ or pages/)
|
|
133
133
|
import dynamic from 'next/dynamic';
|
|
134
134
|
|
|
135
|
-
const Package = dynamic(() => import('
|
|
135
|
+
const Package = dynamic(() => import('esender-email-editor'), { ssr: false });
|
|
136
136
|
```
|
|
137
137
|
|
|
138
138
|
Module-level code in the package is SSR-safe (all `window` / `document` / `localStorage` access is `typeof`-guarded), so importing it on the server will not crash — only mounting it will.
|
|
@@ -155,7 +155,7 @@ export default defineConfig({
|
|
|
155
155
|
},
|
|
156
156
|
optimizeDeps: {
|
|
157
157
|
include: [
|
|
158
|
-
'
|
|
158
|
+
'esender-email-editor',
|
|
159
159
|
'mjml-browser', 'cheerio',
|
|
160
160
|
'antd', '@ant-design/icons', '@ant-design/pro-components',
|
|
161
161
|
'react-is', 'react-redux',
|
|
@@ -198,7 +198,7 @@ import Package, {
|
|
|
198
198
|
type RefreshTokenResponse,
|
|
199
199
|
type TemplateApiResponse,
|
|
200
200
|
type TemplateDocument,
|
|
201
|
-
} from '
|
|
201
|
+
} from 'esender-email-editor';
|
|
202
202
|
```
|
|
203
203
|
|
|
204
204
|
## Troubleshooting
|
|
@@ -244,6 +244,12 @@ Strict semver:
|
|
|
244
244
|
- **MINOR** — additive features, no breakage.
|
|
245
245
|
- **MAJOR** — breaking changes to `<Package />` props or `EditorHandle`.
|
|
246
246
|
|
|
247
|
+
## Author
|
|
248
|
+
|
|
249
|
+
bitbeast private limited
|
|
250
|
+
|
|
247
251
|
## License
|
|
248
252
|
|
|
249
253
|
MIT — see [LICENSE](LICENSE).
|
|
254
|
+
|
|
255
|
+
Copyright (c) bitbeast private limited
|