commspliant-html-editor 0.0.1

package/dist/toolbar/useIconNavOverflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useIconNavOverflow.d.ts","sourceRoot":"","sources":["../../src/toolbar/useIconNavOverflow.ts"],"names":[],"mappings":"AAKA,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,OAAO;;;;;;;EAqDrD"}

package/dist/types.d.ts

@@ -0,0 +1,186 @@
+import { ComponentType } from 'react';
+import { FontSizeUnit } from './core/fontSizeUnits';
+import { FontFace } from './core/fontFamily';
+import { ListType } from './core/lists';
+import { FontMarkState } from './core/marks';
+import { BoxSides, CssLength, LineHeightValue, ParagraphBorder, ParagraphShadow } from './core/paragraphBox';
+import { TextAlign } from './core/textAlign';
+import { Locale } from './i18n/types';
+import { IconProps } from './icons';
+export type { BoxSides, CssLength, LineHeightValue, ParagraphBorder, ParagraphShadow, };
+export type CustomFont = FontFace;
+export type { Locale };
+export type EditorMode = 'visual' | 'html';
+export type CustomActionShowIn = 'menu' | 'toolbar' | 'both';
+export type CustomActionSelection = {
+    /** Selected plain text, or an empty string when the caret is collapsed */
+    text: string;
+    collapsed: boolean;
+    /** Visual: offset in `textContent`. HTML: textarea index. */
+    start: number;
+    end: number;
+};
+export type CustomActionApi = {
+    mode: EditorMode;
+    selection: CustomActionSelection;
+    getHtml: () => string;
+    /** Replace the entire document */
+    setHtml: (html: string) => void;
+    /**
+     * Insert HTML at the caret, or replace the selection.
+     * Pass `formattedText` to insert visible text instead of parsing markup.
+     */
+    insertHtml: (html: string, formattedText?: string) => void;
+    /** Insert formatted text at the caret, or replace the selection */
+    insertText: (text: string) => void;
+};
+export type CustomAction = {
+    id: string;
+    /** Visible name (menu item text; also tooltip and aria fallback) */
+    label: string;
+    /** Toolbar tooltip. Defaults to `label`. */
+    tooltip?: string;
+    /** Optional icon. Defaults to the built-in custom-action icon. */
+    icon?: ComponentType<IconProps>;
+    showIn: CustomActionShowIn;
+    /**
+     * Menu placement. Ignored when `showIn` is `'toolbar'`.
+     * Built-in ids: `'file'` | `'edit'` | `'view'`. Other ids create a new top-level menu.
+     * Default: `'custom'`.
+     */
+    menu?: {
+        id?: string;
+        label?: string;
+    };
+    /**
+     * Toolbar group. Ignored when `showIn` is `'menu'`.
+     * Built-in ids: `'file'` | `'edit'` | `'view'`. Other ids create a group at the end.
+     * Default: `'custom'`.
+     */
+    toolbarGroup?: string;
+    onAction: (api: CustomActionApi) => void | Promise<void>;
+};
+export type EditorBorder = {
+    /** CSS border-width. Default `1px`. */
+    width?: string;
+    /** CSS border-color. Default `#d0d0d0`. */
+    color?: string;
+    /** CSS border-radius. Default `6px`. */
+    radius?: string;
+    /** CSS box-shadow, or `'none'`. Default none. */
+    shadow?: string | 'none';
+};
+export type CustomParagraphStyleFont = {
+    size: number | null;
+    unit: FontSizeUnit;
+    marks: FontMarkState;
+    fontFamily: string | null;
+    fontColor: string | null;
+    highlightColor: string | null;
+};
+export type CustomParagraphStyleParagraph = {
+    align?: TextAlign;
+    list?: ListType | null;
+    margin?: BoxSides;
+    padding?: BoxSides;
+    lineHeight?: LineHeightValue | null;
+    border?: ParagraphBorder;
+    borderRadius?: CssLength | null;
+    boxShadow?: ParagraphShadow | null;
+    backgroundColor?: string | null;
+    opacity?: number | null;
+};
+export type CustomParagraphStyle = {
+    id: string;
+    name: string;
+    font: CustomParagraphStyleFont;
+    paragraph?: CustomParagraphStyleParagraph;
+};
+export type CustomImageInsert = {
+    /** http(s), relative path, or raster data URL */
+    src: string;
+    alt?: string;
+    title?: string;
+    /** Extra inline CSS on the inserted `<img>` */
+    css?: string;
+};
+export type CustomImagePicker = {
+    /** Third source / navigation button label (host copy) */
+    text: string;
+    description: string;
+    buttonCaption: string;
+    /**
+     * Called when the custom source button is clicked, or when
+     * `disableBuiltinImageInsert` is set and Insert → Image runs.
+     * Call `insertImage` when the host picker finishes.
+     */
+    onPick: (insertImage: (image: CustomImageInsert) => void) => void;
+};
+export type EditorProps = {
+    value?: string;
+    defaultValue?: string;
+    onChange?: (html: string) => void;
+    mode?: EditorMode;
+    defaultMode?: EditorMode;
+    onModeChange?: (mode: EditorMode) => void;
+    fullscreen?: boolean;
+    defaultFullscreen?: boolean;
+    onFullscreenChange?: (fullscreen: boolean) => void;
+    placeholder?: string;
+    disabled?: boolean;
+    className?: string;
+    locale?: Locale;
+    toolbarBackground?: string;
+    /** CSS color for menu bar text and dropdown items. Default `#444`. */
+    menuColor?: string;
+    /** CSS color for the menu bar row and dropdown panel. Default `#fff`. */
+    menuBackground?: string;
+    /** CSS font-size for menu bar triggers and dropdown items. Default `0.875rem`. */
+    menuFontSize?: string;
+    /**
+     * CSS font-family for menus. Default inherits `system-ui, sans-serif`.
+     * The host must load any webfont before passing its family name.
+     */
+    menuFontFamily?: string;
+    /**
+     * Outer border of the editor box. `'none'` removes width, radius, and shadow.
+     * Object fields are independent; omitted fields keep library defaults.
+     * Ignored while the editor is in fullscreen overlay.
+     */
+    border?: 'none' | EditorBorder;
+    menuVisible?: boolean;
+    toolbarVisible?: boolean;
+    customActions?: CustomAction[];
+    /**
+     * Extra document font faces appended after the built-in web-safe list.
+     * Duplicate `family` values are ignored. Optional `css` stylesheet URLs are
+     * loaded in the editor and prepended to exported HTML when that face is used.
+     */
+    customFonts?: CustomFont[];
+    /**
+     * Optional map over document HTML before it is stored and passed to `onChange`.
+     * Runs on every edit (visual, HTML source, open, insert, `setHtml`).
+     * Does not run for the inbound `value` / `defaultValue`.
+     */
+    transformHtml?: (html: string) => string;
+    /**
+     * Load host-persisted custom paragraph styles. Called on mount and after save/delete.
+     * Custom styles and “Add new” stay hidden unless this and `onSaveCustomParagraphStyle` are both set.
+     */
+    loadCustomParagraphStyles?: () => CustomParagraphStyle[] | Promise<CustomParagraphStyle[]>;
+    /** Persist a created or edited custom paragraph style. Name is always trimmed and non-empty. */
+    onSaveCustomParagraphStyle?: (style: CustomParagraphStyle) => void | Promise<void>;
+    /** Persist deletion of a custom paragraph style. The Delete button is shown only when this is set. */
+    onDeleteCustomParagraphStyle?: (id: string) => void | Promise<void>;
+    /**
+     * Optional third Insert image source. Omit to keep File and URL only.
+     * Host copy (`text`, `description`, `buttonCaption`) is not translated.
+     */
+    customImagePicker?: CustomImagePicker;
+    /**
+     * Skip the Insert image dialog and call `customImagePicker.onPick` from the
+     * toolbar or Insert menu. Has no effect unless `customImagePicker` is set.
+     */
+    disableBuiltinImageInsert?: boolean;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,EACV,QAAQ,EACR,SAAS,EACT,eAAe,EACf,eAAe,EACf,eAAe,EAChB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAExC,YAAY,EACV,QAAQ,EACR,SAAS,EACT,eAAe,EACf,eAAe,EACf,eAAe,GAChB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAA;AAEjC,YAAY,EAAE,MAAM,EAAE,CAAA;AAEtB,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAA;AAE1C,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,CAAA;AAE5D,MAAM,MAAM,qBAAqB,GAAG;IAClC,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,OAAO,CAAA;IAClB,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,UAAU,CAAA;IAChB,SAAS,EAAE,qBAAqB,CAAA;IAChC,OAAO,EAAE,MAAM,MAAM,CAAA;IACrB,kCAAkC;IAClC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IAC/B;;;OAGG;IACH,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IAC1D,mEAAmE;IACnE,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAA;IACb,4CAA4C;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,kEAAkE;IAClE,IAAI,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,CAAA;IAC/B,MAAM,EAAE,kBAAkB,CAAA;IAC1B;;;;OAIG;IACH,IAAI,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACtC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACzD,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,IAAI,EAAE,YAAY,CAAA;IAClB,KAAK,EAAE,aAAa,CAAA;IACpB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG;IAC1C,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAA;IACtB,MAAM,CAAC,EAAE,QAAQ,CAAA;IACjB,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,UAAU,CAAC,EAAE,eAAe,GAAG,IAAI,CAAA;IACnC,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB,YAAY,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IAC/B,SAAS,CAAC,EAAE,eAAe,GAAG,IAAI,CAAA;IAClC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,wBAAwB,CAAA;IAC9B,SAAS,CAAC,EAAE,6BAA6B,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,iDAAiD;IACjD,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,KAAK,IAAI,CAAA;CAClE,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IACjC,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,WAAW,CAAC,EAAE,UAAU,CAAA;IACxB,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,IAAI,CAAA;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,CAAA;IAClD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,yEAAyE;IACzE,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,kFAAkF;IAClF,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,YAAY,CAAA;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,aAAa,CAAC,EAAE,YAAY,EAAE,CAAA;IAC9B;;;;OAIG;IACH,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;IAC1B;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;IACxC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,oBAAoB,EAAE,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAC1F,gGAAgG;IAChG,0BAA0B,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAClF,sGAAsG;IACtG,4BAA4B,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACnE;;;OAGG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IACrC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;CACpC,CAAA"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "commspliant-html-editor",
+  "version": "0.0.1",
+  "description": "Reusable React WYSIWYG editor with visual and HTML modes",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./styles.css": "./dist/commspliant-html-editor.css"
+  },
+  "files": ["dist"],
+  "sideEffects": ["**/*.css"],
+  "scripts": {
+    "dev": "vite --config playground/vite.config.ts",
+    "build": "vite build --config playground/vite.config.ts",
+    "build:lib": "vite build",
+    "build:playground": "vite build --config playground/vite.config.ts",
+    "preview": "vite preview --config playground/vite.config.ts",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  },
+  "devDependencies": {
+    "@storybook/react": "^8.6.14",
+    "@storybook/react-vite": "^8.6.14",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^16.2.0",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/node": "^22.13.10",
+    "@types/react": "^18.3.18",
+    "@types/react-dom": "^18.3.5",
+    "@vitejs/plugin-react": "^4.3.4",
+    "jsdom": "^26.0.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "storybook": "^8.6.14",
+    "typescript": "^5.7.3",
+    "vite": "^6.2.2",
+    "vite-plugin-dts": "^4.5.3",
+    "vitest": "^3.0.8"
+  }
+}