zs_library 0.6.21 → 0.7.0

package/dist/components/tiptap-editor/simple/components/tiptap-ui/color-highlight-button/use-color-highlight.d.ts

@@ -0,0 +1,82 @@
+import { Editor } from '@tiptap/react';
+export declare const COLOR_HIGHLIGHT_SHORTCUT_KEY = "mod+shift+h";
+export declare const HIGHLIGHT_COLORS: {
+    label: string;
+    value: string;
+    border: string;
+}[];
+export type HighlightColor = (typeof HIGHLIGHT_COLORS)[number];
+export type HighlightMode = "mark" | "node";
+/**
+ * Configuration for the color highlight functionality
+ */
+export interface UseColorHighlightConfig {
+    /**
+     * The Tiptap editor instance.
+     */
+    editor?: Editor | null;
+    /**
+     * The color to apply when toggling the highlight.
+     */
+    highlightColor?: string;
+    /**
+     * Optional label to display alongside the icon.
+     */
+    label?: string;
+    /**
+     * Whether the button should hide when the mark is not available.
+     * @default false
+     */
+    hideWhenUnavailable?: boolean;
+    /**
+     * The highlighting mode to use.
+     * - "mark": Uses the highlight mark extension (default)
+     * - "node": Uses the node background extension
+     * @default "mark"
+     */
+    mode?: HighlightMode;
+    /**
+     * Called when the highlight is applied.
+     */
+    onApplied?: ({ color, label, mode }: {
+        color: string;
+        label: string;
+        mode: HighlightMode;
+    }) => void;
+}
+export declare function pickHighlightColorsByValue(values: string[]): {
+    label: string;
+    value: string;
+    border: string;
+}[];
+/**
+ * Checks if highlight can be applied based on the mode and current editor state
+ */
+export declare function canColorHighlight(editor: Editor | null, mode?: HighlightMode): boolean;
+/**
+ * Checks if highlight is currently active
+ */
+export declare function isColorHighlightActive(editor: Editor | null, highlightColor?: string, mode?: HighlightMode): boolean;
+/**
+ * Removes highlight based on the mode
+ */
+export declare function removeHighlight(editor: Editor | null, mode?: HighlightMode): boolean;
+/**
+ * Determines if the highlight button should be shown
+ */
+export declare function shouldShowButton(props: {
+    editor: Editor | null;
+    hideWhenUnavailable: boolean;
+    mode: HighlightMode;
+}): boolean;
+export declare function useColorHighlight(config: UseColorHighlightConfig): {
+    isVisible: boolean;
+    isActive: boolean;
+    handleColorHighlight: () => boolean;
+    handleRemoveHighlight: () => boolean;
+    canColorHighlight: boolean;
+    label: string;
+    shortcutKeys: string;
+    Icon: import('@remixicon/react').RemixiconComponentType;
+    mode: HighlightMode;
+};

package/dist/components/tiptap-editor/simple/components/tiptap-ui/color-highlight-popover/color-highlight-popover.d.ts

@@ -0,0 +1,25 @@
+import { Editor } from '@tiptap/react';
+import { ButtonProps } from '../../tiptap-ui-primitive/button';
+import { HighlightColor, UseColorHighlightConfig } from '../color-highlight-button';
+export interface ColorHighlightPopoverContentProps {
+    /**
+     * The Tiptap editor instance.
+     */
+    editor?: Editor | null;
+    /**
+     * Optional colors to use in the highlight popover.
+     * If not provided, defaults to a predefined set of colors.
+     */
+    colors?: HighlightColor[];
+}
+export interface ColorHighlightPopoverProps extends Omit<ButtonProps, "type">, Pick<UseColorHighlightConfig, "editor" | "hideWhenUnavailable" | "onApplied"> {
+    /**
+     * Optional colors to use in the highlight popover.
+     * If not provided, defaults to a predefined set of colors.
+     */
+    colors?: HighlightColor[];
+}
+export declare const ColorHighlightPopoverButton: import('react').ForwardRefExoticComponent<ButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
+export declare function ColorHighlightPopoverContent({ editor, colors, }: ColorHighlightPopoverContentProps): import("react/jsx-runtime").JSX.Element;
+export declare function ColorHighlightPopover({ editor: providedEditor, colors, hideWhenUnavailable, onApplied, ...props }: ColorHighlightPopoverProps): import("react/jsx-runtime").JSX.Element | null;
+export default ColorHighlightPopover;

package/dist/components/tiptap-editor/simple/components/tiptap-ui/color-highlight-popover/index.d.ts

@@ -0,0 +1 @@
+export * from './color-highlight-popover';

package/dist/components/tiptap-editor/simple/components/tiptap-ui/heading-button/heading-button.d.ts

@@ -0,0 +1,23 @@
+import { Level, UseHeadingConfig } from './use-heading';
+import { ButtonProps } from '../../tiptap-ui-primitive/button';
+export interface HeadingButtonProps extends Omit<ButtonProps, "type">, UseHeadingConfig {
+    /**
+     * Optional text to display alongside the icon.
+     */
+    text?: string;
+    /**
+     * Optional show shortcut keys in the button.
+     * @default false
+     */
+    showShortcut?: boolean;
+}
+export declare function HeadingShortcutBadge({ level, shortcutKeys, }: {
+    level: Level;
+    shortcutKeys?: string;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * Button component for toggling heading in a Tiptap editor.
+ *
+ * For custom button implementations, use the `useHeading` hook instead.
+ */
+export declare const HeadingButton: import('react').ForwardRefExoticComponent<HeadingButtonProps & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/components/tiptap-editor/simple/components/tiptap-ui/heading-button/index.d.ts

@@ -0,0 +1,2 @@
+export * from './heading-button';
+export * from './use-heading';

package/dist/components/tiptap-editor/simple/components/tiptap-ui/heading-button/use-heading.d.ts

@@ -0,0 +1,108 @@
+import { Editor } from '@tiptap/react';
+export type Level = 1 | 2 | 3 | 4 | 5 | 6;
+/**
+ * Configuration for the heading functionality
+ */
+export interface UseHeadingConfig {
+    /**
+     * The Tiptap editor instance.
+     */
+    editor?: Editor | null;
+    /**
+     * The heading level.
+     */
+    level: Level;
+    /**
+     * Whether the button should hide when heading is not available.
+     * @default false
+     */
+    hideWhenUnavailable?: boolean;
+    /**
+     * Callback function called after a successful heading toggle.
+     */
+    onToggled?: () => void;
+}
+export declare const headingIcons: {
+    1: import('@remixicon/react').RemixiconComponentType;
+    2: import('@remixicon/react').RemixiconComponentType;
+    3: import('@remixicon/react').RemixiconComponentType;
+    4: import('@remixicon/react').RemixiconComponentType;
+    5: import('@remixicon/react').RemixiconComponentType;
+    6: import('@remixicon/react').RemixiconComponentType;
+};
+export declare const HEADING_SHORTCUT_KEYS: Record<Level, string>;
+/**
+ * Checks if heading can be toggled in the current editor state
+ */
+export declare function canToggle(editor: Editor | null, level?: Level, turnInto?: boolean): boolean;
+/**
+ * Checks if heading is currently active
+ */
+export declare function isHeadingActive(editor: Editor | null, level?: Level | Level[]): boolean;
+/**
+ * Toggles heading in the editor
+ */
+export declare function toggleHeading(editor: Editor | null, level: Level | Level[]): boolean;
+/**
+ * Determines if the heading button should be shown
+ */
+export declare function shouldShowButton(props: {
+    editor: Editor | null;
+    level?: Level | Level[];
+    hideWhenUnavailable: boolean;
+}): boolean;
+/**
+ * Custom hook that provides heading functionality for Tiptap editor
+ *
+ * @example
+ * ```tsx
+ * // Simple usage
+ * function MySimpleHeadingButton() {
+ *   const { isVisible, isActive, handleToggle, Icon } = useHeading({ level: 1 })
+ *
+ *   if (!isVisible) return null
+ *
+ *   return (
+ *     <button
+ *       onClick={handleToggle}
+ *       aria-pressed={isActive}
+ *     >
+ *       <Icon />
+ *       Heading 1
+ *     </button>
+ *   )
+ * }
+ *
+ * // Advanced usage with configuration
+ * function MyAdvancedHeadingButton() {
+ *   const { isVisible, isActive, handleToggle, label, Icon } = useHeading({
+ *     level: 2,
+ *     editor: myEditor,
+ *     hideWhenUnavailable: true,
+ *     onToggled: (isActive) => console.log('Heading toggled:', isActive)
+ *   })
+ *
+ *   if (!isVisible) return null
+ *
+ *   return (
+ *     <MyButton
+ *       onClick={handleToggle}
+ *       aria-label={label}
+ *       aria-pressed={isActive}
+ *     >
+ *       <Icon />
+ *       Toggle Heading 2
+ *     </MyButton>
+ *   )
+ * }
+ * ```
+ */
+export declare function useHeading(config: UseHeadingConfig): {
+    isVisible: boolean;
+    isActive: boolean;
+    handleToggle: () => boolean;
+    canToggle: boolean;
+    label: string;
+    shortcutKeys: string;
+    Icon: import('@remixicon/react').RemixiconComponentType;
+};

package/dist/components/tiptap-editor/simple/components/tiptap-ui/heading-dropdown-menu/heading-dropdown-menu.d.ts

@@ -0,0 +1,20 @@
+import { UseHeadingDropdownMenuConfig } from './use-heading-dropdown-menu';
+import { ButtonProps } from '../../tiptap-ui-primitive/button';
+export interface HeadingDropdownMenuProps extends Omit<ButtonProps, "type">, UseHeadingDropdownMenuConfig {
+    /**
+     * Whether to render the dropdown menu in a portal
+     * @default false
+     */
+    portal?: boolean;
+    /**
+     * Callback for when the dropdown opens or closes
+     */
+    onOpenChange?: (isOpen: boolean) => void;
+}
+/**
+ * Dropdown menu component for selecting heading levels in a Tiptap editor.
+ *
+ * For custom dropdown implementations, use the `useHeadingDropdownMenu` hook instead.
+ */
+export declare const HeadingDropdownMenu: import('react').ForwardRefExoticComponent<HeadingDropdownMenuProps & import('react').RefAttributes<HTMLButtonElement>>;
+export default HeadingDropdownMenu;

package/dist/components/tiptap-editor/simple/components/tiptap-ui/heading-dropdown-menu/index.d.ts

@@ -0,0 +1,2 @@
+export * from './heading-dropdown-menu';
+export * from './use-heading-dropdown-menu';

package/dist/components/tiptap-editor/simple/components/tiptap-ui/heading-dropdown-menu/use-heading-dropdown-menu.d.ts

@@ -0,0 +1,73 @@
+import { Editor } from '@tiptap/react';
+import { Level } from '../heading-button';
+/**
+ * Configuration for the heading dropdown menu functionality
+ */
+export interface UseHeadingDropdownMenuConfig {
+    /**
+     * The Tiptap editor instance.
+     */
+    editor?: Editor | null;
+    /**
+     * Available heading levels to show in the dropdown
+     * @default [1, 2, 3, 4, 5, 6]
+     */
+    levels?: Level[];
+    /**
+     * Whether the dropdown should hide when headings are not available.
+     * @default false
+     */
+    hideWhenUnavailable?: boolean;
+}
+/**
+ * Gets the currently active heading level from the available levels
+ */
+export declare function getActiveHeadingLevel(editor: Editor | null, levels?: Level[]): Level | undefined;
+/**
+ * Custom hook that provides heading dropdown menu functionality for Tiptap editor
+ *
+ * @example
+ * ```tsx
+ * // Simple usage
+ * function MyHeadingDropdown() {
+ *   const {
+ *     isVisible,
+ *     activeLevel,
+ *     isAnyHeadingActive,
+ *     canToggle,
+ *     levels,
+ *   } = useHeadingDropdownMenu()
+ *
+ *   if (!isVisible) return null
+ *
+ *   return (
+ *     <DropdownMenu>
+ *       // dropdown content
+ *     </DropdownMenu>
+ *   )
+ * }
+ *
+ * // Advanced usage with configuration
+ * function MyAdvancedHeadingDropdown() {
+ *   const {
+ *     isVisible,
+ *     activeLevel,
+ *   } = useHeadingDropdownMenu({
+ *     editor: myEditor,
+ *     levels: [1, 2, 3],
+ *     hideWhenUnavailable: true,
+ *   })
+ *
+ *   // component implementation
+ * }
+ * ```
+ */
+export declare function useHeadingDropdownMenu(config?: UseHeadingDropdownMenuConfig): {
+    isVisible: boolean;
+    activeLevel: Level | undefined;
+    isActive: boolean;
+    canToggle: boolean;
+    levels: Level[];
+    label: string;
+    Icon: import('@remixicon/react').RemixiconComponentType;
+};

package/dist/components/tiptap-editor/simple/components/tiptap-ui/image-upload-button/image-upload-button.d.ts

@@ -0,0 +1,29 @@
+import { UseImageUploadConfig } from './use-image-upload';
+import { ButtonProps } from '../../tiptap-ui-primitive/button';
+type IconProps = React.SVGProps<SVGSVGElement>;
+type IconComponent = ({ className, ...props }: IconProps) => React.ReactElement;
+export interface ImageUploadButtonProps extends Omit<ButtonProps, "type">, UseImageUploadConfig {
+    /**
+     * Optional text to display alongside the icon.
+     */
+    text?: string;
+    /**
+     * Optional show shortcut keys in the button.
+     * @default false
+     */
+    showShortcut?: boolean;
+    /**
+     * Optional custom icon component to render instead of the default.
+     */
+    icon?: React.MemoExoticComponent<IconComponent> | React.FC<IconProps>;
+}
+export declare function ImageShortcutBadge({ shortcutKeys }: {
+    shortcutKeys?: string;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * Button component for uploading/inserting images in a Tiptap editor.
+ *
+ * For custom button implementations, use the `useImage` hook instead.
+ */
+export declare const ImageUploadButton: import('react').ForwardRefExoticComponent<ImageUploadButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
+export {};

package/dist/components/tiptap-editor/simple/components/tiptap-ui/image-upload-button/index.d.ts

@@ -0,0 +1,2 @@
+export * from './image-upload-button';
+export * from './use-image-upload';

package/dist/components/tiptap-editor/simple/components/tiptap-ui/image-upload-button/use-image-upload.d.ts

@@ -0,0 +1,84 @@
+import { Editor } from '@tiptap/react';
+export declare const IMAGE_UPLOAD_SHORTCUT_KEY = "mod+shift+i";
+/**
+ * Configuration for the image upload functionality
+ */
+export interface UseImageUploadConfig {
+    /**
+     * The Tiptap editor instance.
+     */
+    editor?: Editor | null;
+    /**
+     * Whether the button should hide when insertion is not available.
+     * @default false
+     */
+    hideWhenUnavailable?: boolean;
+    /**
+     * Callback function called after a successful image insertion.
+     */
+    onInserted?: () => void;
+}
+/**
+ * Checks if image can be inserted in the current editor state
+ */
+export declare function canInsertImage(editor: Editor | null): boolean;
+/**
+ * Checks if image is currently active
+ */
+export declare function isImageActive(editor: Editor | null): boolean;
+/**
+ * Inserts an image in the editor
+ */
+export declare function insertImage(editor: Editor | null): boolean;
+/**
+ * Determines if the image button should be shown
+ */
+export declare function shouldShowButton(props: {
+    editor: Editor | null;
+    hideWhenUnavailable: boolean;
+}): boolean;
+/**
+ * Custom hook that provides image functionality for Tiptap editor
+ *
+ * @example
+ * ```tsx
+ * // Simple usage - no params needed
+ * function MySimpleImageButton() {
+ *   const { isVisible, handleImage } = useImage()
+ *
+ *   if (!isVisible) return null
+ *
+ *   return <button onClick={handleImage}>Add Image</button>
+ * }
+ *
+ * // Advanced usage with configuration
+ * function MyAdvancedImageButton() {
+ *   const { isVisible, handleImage, label, isActive } = useImage({
+ *     editor: myEditor,
+ *     hideWhenUnavailable: true,
+ *     onInserted: () => console.log('Image inserted!')
+ *   })
+ *
+ *   if (!isVisible) return null
+ *
+ *   return (
+ *     <MyButton
+ *       onClick={handleImage}
+ *       aria-pressed={isActive}
+ *       aria-label={label}
+ *     >
+ *       Add Image
+ *     </MyButton>
+ *   )
+ * }
+ * ```
+ */
+export declare function useImageUpload(config?: UseImageUploadConfig): {
+    isVisible: boolean;
+    isActive: boolean;
+    handleImage: () => boolean;
+    canInsert: boolean;
+    label: string;
+    shortcutKeys: string;
+    Icon: import('@remixicon/react').RemixiconComponentType;
+};

package/dist/components/tiptap-editor/simple/components/tiptap-ui/link-popover/index.d.ts

@@ -0,0 +1,2 @@
+export * from './link-popover';
+export * from './use-link-popover';

package/dist/components/tiptap-editor/simple/components/tiptap-ui/link-popover/link-popover.d.ts

@@ -0,0 +1,57 @@
+import { Editor } from '@tiptap/react';
+import { UseLinkPopoverConfig } from './use-link-popover';
+import { ButtonProps } from '../../tiptap-ui-primitive/button';
+export interface LinkMainProps {
+    /**
+     * The URL to set for the link.
+     */
+    url: string;
+    /**
+     * Function to update the URL state.
+     */
+    setUrl: React.Dispatch<React.SetStateAction<string | null>>;
+    /**
+     * Function to set the link in the editor.
+     */
+    setLink: () => void;
+    /**
+     * Function to remove the link from the editor.
+     */
+    removeLink: () => void;
+    /**
+     * Function to open the link.
+     */
+    openLink: () => void;
+    /**
+     * Whether the link is currently active in the editor.
+     */
+    isActive: boolean;
+}
+export interface LinkPopoverProps extends Omit<ButtonProps, "type">, UseLinkPopoverConfig {
+    /**
+     * Callback for when the popover opens or closes.
+     */
+    onOpenChange?: (isOpen: boolean) => void;
+    /**
+     * Whether to automatically open the popover when a link is active.
+     * @default true
+     */
+    autoOpenOnLinkActive?: boolean;
+}
+/**
+ * Link button component for triggering the link popover
+ */
+export declare const LinkButton: import('react').ForwardRefExoticComponent<ButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
+/**
+ * Link content component for standalone use
+ */
+export declare const LinkContent: React.FC<{
+    editor?: Editor | null;
+}>;
+/**
+ * Link popover component for Tiptap editors.
+ *
+ * For custom popover implementations, use the `useLinkPopover` hook instead.
+ */
+export declare const LinkPopover: import('react').ForwardRefExoticComponent<LinkPopoverProps & import('react').RefAttributes<HTMLButtonElement>>;
+export default LinkPopover;

package/dist/components/tiptap-editor/simple/components/tiptap-ui/link-popover/use-link-popover.d.ts

@@ -0,0 +1,117 @@
+import { Editor } from '@tiptap/react';
+/**
+ * Configuration for the link popover functionality
+ */
+export interface UseLinkPopoverConfig {
+    /**
+     * The Tiptap editor instance.
+     */
+    editor?: Editor | null;
+    /**
+     * Whether to hide the link popover when not available.
+     * @default false
+     */
+    hideWhenUnavailable?: boolean;
+    /**
+     * Callback function called when the link is set.
+     */
+    onSetLink?: () => void;
+}
+/**
+ * Configuration for the link handler functionality
+ */
+export interface LinkHandlerProps {
+    /**
+     * The Tiptap editor instance.
+     */
+    editor: Editor | null;
+    /**
+     * Callback function called when the link is set.
+     */
+    onSetLink?: () => void;
+}
+/**
+ * Checks if a link can be set in the current editor state
+ */
+export declare function canSetLink(editor: Editor | null): boolean;
+/**
+ * Checks if a link is currently active in the editor
+ */
+export declare function isLinkActive(editor: Editor | null): boolean;
+/**
+ * Determines if the link button should be shown
+ */
+export declare function shouldShowLinkButton(props: {
+    editor: Editor | null;
+    hideWhenUnavailable: boolean;
+}): boolean;
+/**
+ * Custom hook for handling link operations in a Tiptap editor
+ */
+export declare function useLinkHandler(props: LinkHandlerProps): {
+    url: string;
+    setUrl: import('react').Dispatch<import('react').SetStateAction<string | null>>;
+    setLink: () => void;
+    removeLink: () => void;
+    openLink: (target?: string, features?: string) => void;
+};
+/**
+ * Custom hook for link popover state management
+ */
+export declare function useLinkState(props: {
+    editor: Editor | null;
+    hideWhenUnavailable: boolean;
+}): {
+    isVisible: boolean;
+    canSet: boolean;
+    isActive: boolean;
+};
+/**
+ * Main hook that provides link popover functionality for Tiptap editor
+ *
+ * @example
+ * ```tsx
+ * // Simple usage
+ * function MyLinkButton() {
+ *   const { isVisible, canSet, isActive, Icon, label } = useLinkPopover()
+ *
+ *   if (!isVisible) return null
+ *
+ *   return <button disabled={!canSet}>Link</button>
+ * }
+ *
+ * // Advanced usage with configuration
+ * function MyAdvancedLinkButton() {
+ *   const { isVisible, canSet, isActive, Icon, label } = useLinkPopover({
+ *     editor: myEditor,
+ *     hideWhenUnavailable: true,
+ *     onSetLink: () => console.log('Link set!')
+ *   })
+ *
+ *   if (!isVisible) return null
+ *
+ *   return (
+ *     <MyButton
+ *       disabled={!canSet}
+ *       aria-label={label}
+ *       aria-pressed={isActive}
+ *     >
+ *       <Icon />
+ *       {label}
+ *     </MyButton>
+ *   )
+ * }
+ * ```
+ */
+export declare function useLinkPopover(config?: UseLinkPopoverConfig): {
+    url: string;
+    setUrl: import('react').Dispatch<import('react').SetStateAction<string | null>>;
+    setLink: () => void;
+    removeLink: () => void;
+    openLink: (target?: string, features?: string) => void;
+    isVisible: boolean;
+    canSet: boolean;
+    isActive: boolean;
+    label: string;
+    Icon: import('@remixicon/react').RemixiconComponentType;
+};

package/dist/components/tiptap-editor/simple/components/tiptap-ui/list-button/index.d.ts

@@ -0,0 +1,2 @@
+export * from './list-button';
+export * from './use-list';

package/dist/components/tiptap-editor/simple/components/tiptap-ui/list-button/list-button.d.ts

@@ -0,0 +1,23 @@
+import { ButtonProps } from '../../tiptap-ui-primitive/button';
+import { ListType, UseListConfig } from './use-list';
+export interface ListButtonProps extends Omit<ButtonProps, "type">, UseListConfig {
+    /**
+     * Optional text to display alongside the icon.
+     */
+    text?: string;
+    /**
+     * Optional show shortcut keys in the button.
+     * @default false
+     */
+    showShortcut?: boolean;
+}
+export declare function ListShortcutBadge({ type, shortcutKeys, }: {
+    type: ListType;
+    shortcutKeys?: string;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * Button component for toggling lists in a Tiptap editor.
+ *
+ * For custom button implementations, use the `useList` hook instead.
+ */
+export declare const ListButton: import('react').ForwardRefExoticComponent<ListButtonProps & import('react').RefAttributes<HTMLButtonElement>>;