markdown-text-editor 1.9.0 → 2.0.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-text-editor",
-  "version": "1.9.0",
+  "version": "2.0.0-beta.1",
   "type": "module",
   "description": "A markdown editor that enhances your textarea instead of replacing it, so form submission, validation and required fields keep working. WYSIWYG hybrid mode, live preview, find and replace, RTL, TypeScript types. Works with any backend.",
   "funding": "https://ko-fi.com/nezanuha",
@@ -15,11 +15,23 @@
       "import": "./dist/markdown-text-editor.es.js",
       "require": "./dist/markdown-text-editor.umd.js",
       "default": "./dist/markdown-text-editor.umd.js"
-    }
+    },
+    "./style.css": "./dist/markdown-text-editor.css",
+    "./locale/*.js": {
+      "types": "./locale/locale.d.ts",
+      "default": "./locale/*.js"
+    },
+    "./locale/*": {
+      "types": "./locale/locale.d.ts",
+      "default": "./locale/*.js"
+    },
+    "./dist/*": "./dist/*",
+    "./package.json": "./package.json"
   },
   "files": [
     "dist/",
     "types/",
+    "locale/",
     "README.md",
     "LICENSE"
   ],
@@ -32,9 +44,11 @@
     "build": "vite build",
     "preview": "vite preview",
     "prepublishOnly": "npm run build",
+    "locale:extract": "node scripts/locale-extract.mjs",
+    "locale:check": "node scripts/locale-check.mjs",
     "version": "node scripts/check-changelog.mjs",
     "postversion": "git push origin HEAD --follow-tags",
-    "test": "node test/smoke.mjs",
+    "test": "node test/smoke.mjs && node scripts/locale-check.mjs",
     "typecheck": "tsc --noEmit --strict --lib es2020,dom --moduleResolution bundler --module esnext test/types.test.ts"
   },
   "publishConfig": {
@@ -76,20 +90,19 @@
   },
   "dependencies": {
     "dompurify": "^3.4.16",
-    "marked": "~18.0.14"
+    "marked": "~18.1.0"
   },
   "devDependencies": {
     "@tailwindcss/postcss": "^4.3.3",
     "@tailwindcss/typography": "^0.5.20",
     "@tailwindcss/vite": "^4.3.3",
     "diff": "^9.0.0",
-    "frutjam": "^2.2.6",
-    "happy-dom": "^20.14.5",
-    "postcss": "^8.5.28",
+    "frutjam": "^2.3.0",
+    "happy-dom": "^20.14.6",
+    "postcss": "^8.5.29",
     "tailwindcss": "^4.3.3",
     "typescript": "^7.0.2",
-    "vite": "^8.3.1",
-    "vite-plugin-css-injected-by-js": "^5.0.2"
+    "vite": "^8.3.4"
   },
   "types": "./types/index.d.ts"
 }

package/types/index.d.ts

@@ -52,6 +52,24 @@ export interface VariablesTool {
     variables: Array<Variable | VariableGroup>;
 }
 
+export interface HeadingTool {
+    heading: {
+        /**
+         * Which heading levels the dropdown offers, in the order 1-6 regardless
+         * of how you list them. Defaults to all six. Useful where H1 belongs to
+         * the page rather than the content, e.g. `[2, 3, 4]`.
+         *
+         * `Ctrl+1`, `Ctrl+2` and `Ctrl+3` follow this list, so a level you leave
+         * out cannot be inserted from the keyboard either.
+         *
+         * This restricts the toolbar, not the document: someone can still type
+         * `# Title` by hand and it renders as a heading. Enforce the rule on the
+         * server if it has to hold.
+         */
+        levels?: Array<1 | 2 | 3 | 4 | 5 | 6>;
+    };
+}
+
 export interface ImageTool {
     image: {
         fileInput?: {
@@ -96,7 +114,7 @@ export type CustomTool = new (editor: MarkdownEditor, config?: any) => {
  */
 export interface DeclarativeTool {
     custom: {
-        /** Tooltip, and the source of the button's CSS class. Translatable via `labels`. */
+        /** Tooltip, and the source of the button's CSS class. Translatable via `locale`. */
         title: string;
         /** Inline SVG for the button face. */
         icon?: string;
@@ -114,6 +132,7 @@ export type ToolbarEntry =
     | ToolName
     | VariablesTool
     | ImageTool
+    | HeadingTool
     | DeclarativeTool
     | CustomTool
     | { tool: CustomTool; config?: any };
@@ -166,11 +185,22 @@ export interface MarkdownEditorOptions {
 
     /**
      * Translations for the editor's own interface, keyed by the English text:
-     * tooltips, menu items, modal fields and buttons. Anything not listed stays
-     * in English. CSS class names are unaffected.
+     * tooltips, menu items, modal fields, buttons and screen reader names.
+     * Anything not listed stays in English. CSS class names are unaffected.
+     *
+     * Takes the strings themselves, not a language code. Import the one you want
+     * so nobody pays for the languages they do not use.
+     * `locale/template.js` lists every key.
      *
-     * @example labels: { Bold: 'Negrita', 'Insert variable': 'Insertar variable' }
+     * @example
+     * import es from 'markdown-text-editor/locale/es.js';
+     * new MarkdownEditor('#editor', { locale: es });
+     *
+     * @example locale: { Bold: 'Negrita', '{n} words': '{n} palabras' }
      */
+    locale?: Record<string, string>;
+
+    /** @deprecated Renamed to `locale` in 2.0.0. Still works. */
     labels?: Record<string, string>;
 
     /**
@@ -239,7 +269,7 @@ export default class MarkdownEditor {
     /**
      * Builds a small toolbar bound to another textarea, for a custom tool that
      * collects rich text in its own dialog. The tools are the real ones, and
-     * `labels` are inherited. Returns the element; append it where you like.
+     * `locale` is inherited. Returns the element; append it where you like.
      *
      * No preview button is added, whatever you pass.
      */