@npm-questionpro/wick-ui-editor 2.1.1 → 2.1.2

package/dist/WuContentEditor.d.ts

@@ -0,0 +1,47 @@
+import React from 'react';
+import { type IToolbarExtensionKey } from './internal/Toolbar';
+/** Props received by the injected HTML Source view (see the `./html` subpath export). */
+export interface IWuHtmlSourceProps {
+    /** Initial raw HTML to populate the source view. */
+    defaultValue?: string;
+    /** Fires on every keystroke with the current raw HTML. */
+    onUpdate?: (content: string) => void;
+    /** When `true`, the textarea is disabled. */
+    readonly?: boolean;
+}
+export interface IWuContentEditorProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Initial HTML content (auto-sanitized on mount). */
+    defaultValue?: string;
+    /** Fires on every editor change with the sanitized HTML output. */
+    onUpdate?: (content: string) => void;
+    /** Extra font-family names appended to the font-family picker. */
+    customFonts?: string[];
+    /** Sticky toolbar placement relative to the content area. @default 'top' */
+    toolbarPosition?: 'top' | 'bottom';
+    /** Additional React nodes appended inside the toolbar. */
+    customToolbarChildren?: React.ReactNode;
+    /** Subset of toolbar items to render; defaults to all items. */
+    toolbarItems?: IToolbarExtensionKey[];
+    /** Hides the toolbar entirely. */
+    hideToolbar?: boolean;
+    /** Disables editing; content is display-only. */
+    readonly?: boolean;
+    /** Moves focus into the editor on mount. */
+    autoFocus?: boolean;
+    /**
+     * HTML Source view component, e.g. `WuHtmlSource` from
+     * `@npm-questionpro/wick-ui-editor/html`. When omitted, HTML Source Mode
+     * and its toolbar button are disabled.
+     */
+    htmlSource?: React.ComponentType<IWuHtmlSourceProps>;
+    /** Controlled HTML Source Mode state. Only meaningful when `htmlSource` is provided. */
+    isHtml?: boolean;
+    /** Setter for controlled `isHtml`. Only meaningful when `htmlSource` is provided. */
+    setIsHtml?: (isHtml: boolean) => void;
+}
+/**
+ * Rich-text editing surface with a configurable toolbar, backed by TipTap.
+ *
+ * @summary content creation — reach for this when users need to compose or edit formatted HTML content
+ */
+export declare function WuContentEditor({ defaultValue, onUpdate, className, toolbarPosition, customToolbarChildren, toolbarItems, hideToolbar, readonly, autoFocus, customFonts, htmlSource: HtmlSourceView, isHtml: isHtmlProp, setIsHtml: setIsHtmlProp, ...props }: IWuContentEditorProps): React.JSX.Element;

package/dist/html/WuHtmlSource.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import type { IWuHtmlSourceProps } from '../WuContentEditor';
+export declare function WuHtmlSource({ defaultValue, onUpdate, readonly }: IWuHtmlSourceProps): React.JSX.Element;

package/dist/html/index.d.ts

@@ -0,0 +1,2 @@
+export { WuHtmlSource } from './WuHtmlSource';
+export type { IWuHtmlSourceProps } from '../WuContentEditor';

package/dist/index.d.ts

@@ -1 +1,2 @@
-export { }
+export { WuContentEditor } from './WuContentEditor';
+export type { IWuContentEditorProps, IWuHtmlSourceProps } from './WuContentEditor';

package/dist/internal/Button.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+export interface IButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
+    variant?: 'primary' | 'secondary';
+    color?: 'primary' | 'error';
+    icon?: React.ReactNode;
+}
+export declare const Button: React.ForwardRefExoticComponent<IButtonProps & React.RefAttributes<HTMLButtonElement>>;

package/dist/internal/Dropdown.d.ts

@@ -0,0 +1,22 @@
+import React from 'react';
+export interface IDropdownItemProps {
+    id: string;
+    icon?: React.ReactElement;
+    label?: string;
+    event: () => boolean | void;
+    tooltip?: string;
+    active?: boolean;
+    style?: React.CSSProperties;
+}
+interface IDropdownProps {
+    trigger: React.ReactElement;
+    triggerTitle?: string;
+    active?: boolean;
+    items: IDropdownItemProps[];
+    align?: 'start' | 'center' | 'end';
+    direction?: 'inline' | 'block';
+}
+export declare const DropdownPopup: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
+export declare const DropdownItem: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
+export declare function Dropdown({ trigger, triggerTitle, active, items, align, direction, }: IDropdownProps): React.JSX.Element;
+export {};

package/dist/internal/Input.d.ts

@@ -0,0 +1,5 @@
+interface IInputProps extends React.InputHTMLAttributes<HTMLInputElement> {
+    label?: string;
+}
+export declare function Input({ label, id, ...rest }: IInputProps): React.JSX.Element;
+export {};

package/dist/internal/Item.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface IItemProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
+    Icon?: React.ReactElement;
+}
+export declare const Item: React.ForwardRefExoticComponent<IItemProps & React.RefAttributes<HTMLButtonElement>>;
+export {};

package/dist/internal/Modal.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { type IButtonProps } from './Button';
+interface IModalProps {
+    Trigger: React.ReactElement;
+    children?: React.ReactNode;
+    maxWidth?: string;
+    footer?: React.ReactNode;
+    onOpenChange?: (open: boolean) => void;
+}
+export declare function Modal({ Trigger, children, maxWidth, onOpenChange, footer }: IModalProps): React.JSX.Element;
+type IModalCloseProps = Omit<IButtonProps, 'ref'>;
+export declare function ModalClose({ children, variant, color, icon, ...rest }: IModalCloseProps): React.JSX.Element;
+export {};

package/dist/internal/Switch.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+interface ISwitchProps {
+    checked: boolean;
+    onCheckedChange: (checked: boolean) => void;
+    label: string;
+}
+export declare function Switch({ checked, onCheckedChange, label }: ISwitchProps): React.JSX.Element;
+export {};

package/dist/internal/Toolbar.d.ts

@@ -0,0 +1,35 @@
+import { Editor } from '@tiptap/react';
+declare const TOOLBAR_EXTENSIONS: {
+    block: import("react/jsx-runtime").JSX.Element;
+    fontFamily: import("react/jsx-runtime").JSX.Element;
+    fontSize: import("react/jsx-runtime").JSX.Element;
+    bold: import("react/jsx-runtime").JSX.Element;
+    italic: import("react/jsx-runtime").JSX.Element;
+    underline: import("react/jsx-runtime").JSX.Element;
+    strike: import("react/jsx-runtime").JSX.Element;
+    color: import("react/jsx-runtime").JSX.Element;
+    bgColor: import("react/jsx-runtime").JSX.Element;
+    list: import("react/jsx-runtime").JSX.Element;
+    alignment: import("react/jsx-runtime").JSX.Element;
+    image: import("react/jsx-runtime").JSX.Element;
+    link: import("react/jsx-runtime").JSX.Element;
+    table: import("react/jsx-runtime").JSX.Element;
+    blockquote: import("react/jsx-runtime").JSX.Element;
+    superscript: import("react/jsx-runtime").JSX.Element;
+    subscript: import("react/jsx-runtime").JSX.Element;
+    codeline: import("react/jsx-runtime").JSX.Element;
+    clear: import("react/jsx-runtime").JSX.Element;
+    '|': import("react/jsx-runtime").JSX.Element;
+    html: import("react/jsx-runtime").JSX.Element;
+};
+export type IToolbarExtensionKey = keyof typeof TOOLBAR_EXTENSIONS;
+export interface IToolbarProps extends React.HTMLAttributes<HTMLDivElement> {
+    editor: Editor;
+    customFonts?: string[];
+    items?: IToolbarExtensionKey[];
+    isHtml: boolean;
+    setIsHtml: (isHtml: boolean) => void;
+    htmlSourceEnabled: boolean;
+}
+export declare const Toolbar: React.FC<IToolbarProps>;
+export {};

package/dist/internal/extensions/Alignment.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Alignment: React.FC;

package/dist/internal/extensions/BgColor.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const BgColor: React.FC;

package/dist/internal/extensions/Block.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Block: React.FC;

package/dist/internal/extensions/Blockquote.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Blockquote: React.FC;

package/dist/internal/extensions/Bold.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Bold: React.FC;

package/dist/internal/extensions/ClearFormat.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const ClearFormat: React.FC;

package/dist/internal/extensions/CodeLine.d.ts

@@ -0,0 +1 @@
+export declare const CodeLine: React.FC;

package/dist/internal/extensions/EmbedImage.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Image: React.FC;

package/dist/internal/extensions/EmbedLink.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Link: React.FC;

package/dist/internal/extensions/EmbedTable.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Table: React.FC;

package/dist/internal/extensions/Family.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const FontFamily: React.FC;

package/dist/internal/extensions/HtmlSource.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare function HtmlSource(): React.JSX.Element | null;

package/dist/internal/extensions/Italic.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Italic: React.FC;

package/dist/internal/extensions/List.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const List: React.FC;

package/dist/internal/extensions/Size.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const FontSize: React.FC;

package/dist/internal/extensions/Strikethrough.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Strikethrough: React.FC;

package/dist/internal/extensions/Subscript.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Subscript: React.FC;

package/dist/internal/extensions/Superscript.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Superscript: React.FC;

package/dist/internal/extensions/TextColor.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const TextColor: React.FC;

package/dist/internal/extensions/Underline.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Underline: React.FC;

package/dist/internal/extensions/index.d.ts

@@ -0,0 +1,2 @@
+import { type Extensions } from '@tiptap/react';
+export declare const extensionConfig: Extensions;

package/dist/utils/cx.d.ts

@@ -0,0 +1 @@
+export declare function cx(...parts: Array<string | false | null | undefined>): string;

package/dist/utils/icons.d.ts

@@ -0,0 +1,33 @@
+import React from 'react';
+export type IIconProps = React.SVGProps<SVGSVGElement>;
+export declare const BoldIcon: React.FC<IIconProps>;
+export declare const ItalicIcon: React.FC<IIconProps>;
+export declare const UnderlineIcon: React.FC<IIconProps>;
+export declare const StrikethroughIcon: React.FC<IIconProps>;
+export declare const TextColorIcon: React.FC<IIconProps>;
+export declare const BgColorIcon: React.FC<IIconProps>;
+export declare const QuoteIcon: React.FC<IIconProps>;
+export declare const CodeIcon: React.FC<IIconProps>;
+export declare const HtmlIcon: React.FC<IIconProps>;
+export declare const DataObjectIcon: React.FC<IIconProps>;
+export declare const SubscriptIcon: React.FC<IIconProps>;
+export declare const SuperscriptIcon: React.FC<IIconProps>;
+export declare const ImageIcon: React.FC<IIconProps>;
+export declare const LinkIcon: React.FC<IIconProps>;
+export declare const TableIcon: React.FC<IIconProps>;
+export declare const ClearFormatIcon: React.FC<IIconProps>;
+export declare const AlignLeftIcon: React.FC<IIconProps>;
+export declare const AlignCenterIcon: React.FC<IIconProps>;
+export declare const AlignRightIcon: React.FC<IIconProps>;
+export declare const AlignJustifyIcon: React.FC<IIconProps>;
+export declare const ParagraphIcon: React.FC<IIconProps>;
+export declare const H1Icon: React.FC<IIconProps>;
+export declare const H2Icon: React.FC<IIconProps>;
+export declare const H3Icon: React.FC<IIconProps>;
+export declare const H4Icon: React.FC<IIconProps>;
+export declare const ListBulletedIcon: React.FC<IIconProps>;
+export declare const ListNumberedIcon: React.FC<IIconProps>;
+export declare const ChecklistIcon: React.FC<IIconProps>;
+export declare const AddIcon: React.FC<IIconProps>;
+export declare const CloseIcon: React.FC<IIconProps>;
+export declare const DeleteIcon: React.FC<IIconProps>;

package/dist/utils/sanitize.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Sanitize HTML content for the editor
+ */
+export declare function sanitizeHtml(html: string): string;
+/**
+ * Check if HTML is already safe
+ */
+export declare function isHtmlSafe(html: string): boolean;

package/dist/utils/useToolbar.d.ts

@@ -0,0 +1,22 @@
+import type { Editor } from '@tiptap/react';
+import React from 'react';
+export interface IToolbarContextProps {
+    editor: Editor;
+    customFonts?: string[];
+    isHtml: boolean;
+    setIsHtml: (isHtml: boolean) => void;
+    /** Whether an HTML source view is provided via the `htmlSource` prop. */
+    htmlSourceEnabled: boolean;
+}
+export declare const ToolbarContext: React.Context<IToolbarContextProps | null>;
+interface IToolbarProviderProps {
+    editor: Editor;
+    children: React.ReactNode;
+    customFonts?: string[];
+    isHtml: boolean;
+    setIsHtml: (isHtml: boolean) => void;
+    htmlSourceEnabled: boolean;
+}
+export declare const ToolbarProvider: ({ editor, children, customFonts, isHtml, setIsHtml, htmlSourceEnabled, }: IToolbarProviderProps) => React.JSX.Element;
+export declare const useToolbar: () => IToolbarContextProps;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npm-questionpro/wick-ui-editor",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "Wick Editor is a powerful and intuitive content editing component built with React. It provides a rich set of features for creating and managing content, making it ideal for applications that require dynamic and interactive content creation.",
   "keywords": [
     "react",
@@ -29,7 +29,7 @@
       "import": "./dist/wick-ui-editor/es/index.js"
     },
     "./html": {
-      "types": "./dist/html.d.ts",
+      "types": "./dist/html/index.d.ts",
       "import": "./dist/wick-ui-editor/es/html.js"
     },
     "./dist/style.css": "./dist/style.css"
@@ -98,11 +98,11 @@
     "vite-plugin-dts": "^4.5.4",
     "vitest": "^4.1.8",
     "@npm-questionpro/wick-ui-eslint-config": "1.0.0",
-    "@npm-questionpro/wick-ui-lib": "2.1.1",
+    "@npm-questionpro/wick-ui-lib": "2.1.2",
     "@wick-ui/tsconfig": "1.0.0"
   },
   "scripts": {
-    "build": "tsc --noEmit && vite build",
+    "build": "tsc --noEmit && vite build && tsc -p tsconfig.types.json",
     "lint": "eslint ./src --fix",
     "lint:ci": "tsc --noEmit && eslint --max-warnings 0 ./src",
     "test": "vitest run",

package/dist/html.d.ts

@@ -1 +0,0 @@
-export { }