@editora/plugins 1.2.7 → 1.2.8

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.
Files changed (2) hide show
  1. package/README.md +14 -12
  2. package/package.json +6 -3
package/README.md CHANGED
@@ -90,18 +90,20 @@ Create the plugins once, outside the component or with `useMemo`, so the editor
90
90
 
91
91
  ## Choose an entry point
92
92
 
93
- | Import from | You get | Cost of importing one plugin from it |
94
- | --- | --- | --- |
95
- | `@editora/plugins/<subpath>` | One plugin, such as `@editora/plugins/bold`. | `BoldPlugin`: 3 KB (1 KB gzipped)<br>`TrackChangesPlugin`: 20 KB (5 KB gzipped) |
96
- | `@editora/plugins/lite` | The 27 common plugins: formatting, lists, links, tables, colours, fonts, history. | `BoldPlugin`: 83 KB (24 KB gzipped) |
97
- | `@editora/plugins/enterprise` | The 22 advanced plugins: review, workflow, structured authoring, import and export. | `TrackChangesPlugin`: 256 KB (77 KB gzipped) |
98
- | `@editora/plugins` | All 56 plugins. | `BoldPlugin`: 447 KB (125 KB gzipped)<br>`TrackChangesPlugin`: 467 KB (129 KB gzipped) |
99
-
100
- The last column is measured with esbuild, as minified ES modules, importing that one plugin and nothing else; a
101
- bundler of your own may differ a little. The point is that **the entry points do not tree-shake**: importing one plugin
102
- from `@editora/plugins`, `lite` or `enterprise` bundles everything that entry exports. Six common plugins (bold, italic,
103
- headings, lists, links, history) cost 127 KB gzipped from the root and 27 KB from `lite`. Import from `lite` for the
104
- common ones, and from a subpath for anything else.
93
+ | Import from | You get |
94
+ | --- | --- |
95
+ | `@editora/plugins` | All 56 plugins. |
96
+ | `@editora/plugins/lite` | The 27 common plugins: formatting, lists, links, tables, colours, fonts, history. |
97
+ | `@editora/plugins/enterprise` | The 22 advanced plugins: review, workflow, structured authoring, import and export. |
98
+ | `@editora/plugins/<subpath>` | One plugin, such as `@editora/plugins/bold`. |
99
+
100
+ Every entry point tree-shakes: your bundle gets the plugins you import and what they use, whichever entry you import
101
+ them from. `BoldPlugin` costs 3.5 KB (1.5 KB gzipped) from any of them, `TrackChangesPlugin` 20 KB (5.5 KB gzipped), and
102
+ six common plugins (bold, italic, headings, lists, links, history) 42 KB (12.5 KB gzipped). These are measured with
103
+ esbuild and Vite as minified ES modules; a bundler of your own may differ a little. It needs a bundler that reads the
104
+ `sideEffects` field of `package.json` (Vite, Rollup, webpack, esbuild and Parcel do); 1.2.7 and earlier had none, and one
105
+ plugin from the root cost 40 KB gzipped. A plugin's load-time code (global listeners, for example) runs when you import
106
+ that plugin, not when you import another one from the same entry.
105
107
 
106
108
  ## Plugin catalog
107
109
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@editora/plugins",
3
- "version": "1.2.7",
3
+ "version": "1.2.8",
4
4
  "description": "Enterprise plugin suite for Editora rich text editor in React and web apps, including tables, media, workflow, and compliance tooling.",
5
5
  "author": "Ajay Kumar <ajaykr089@gmail.com>",
6
6
  "license": "MIT",
@@ -47,6 +47,9 @@
47
47
  "module": "dist/index.esm.js",
48
48
  "types": "index.d.ts",
49
49
  "style": "dist/plugins.css",
50
+ "sideEffects": [
51
+ "*.css"
52
+ ],
50
53
  "exports": {
51
54
  ".": {
52
55
  "types": "./index.d.ts",
@@ -437,7 +440,7 @@
437
440
  "verify:citations": "npm run typecheck:build && npm run test:citations && npm run test:content-rules && npm run test:approval-workflow && npm run test:pii-redaction && npm run test:smart-paste && npm run test:blocks-library && npm run test:doc-schema && npm run test:translation-workflow && npm run test:format-painter && npm run test:toolbar-icons && npm run test:dom && npm run build"
438
441
  },
439
442
  "peerDependencies": {
440
- "@editora/core": "^1.0.33"
443
+ "@editora/core": "^1.1.0"
441
444
  },
442
445
  "dependencies": {
443
446
  "@editora/light-code-editor": "^1.0.19",
@@ -445,7 +448,7 @@
445
448
  "mathjax": "^3.2.2"
446
449
  },
447
450
  "devDependencies": {
448
- "@editora/core": "^1.0.33",
451
+ "@editora/core": "^1.1.0",
449
452
  "@types/katex": "^0.16.8",
450
453
  "dompurify": "^3.4.16",
451
454
  "typescript": "^5.0.0",