@farmzone/fz-react-ui 1.1.0 → 1.1.1

package/dist/index.d.cts

@@ -11,6 +11,8 @@ import * as zustand_middleware from 'zustand/middleware';
 import * as zustand from 'zustand';
 import { Address } from 'react-daum-postcode';
 import { LucideIcon } from 'lucide-react';
+import * as _tiptap_core from '@tiptap/core';
+import { Extensions, Editor } from '@tiptap/core';
 import { Location } from 'react-router';
 import { ClassValue } from 'clsx';
 import * as PopoverPrimitive from '@radix-ui/react-popover';
@@ -1189,6 +1191,137 @@ interface SidebarProps {
 }
 declare function Sidebar(props: SidebarProps): react.JSX.Element;
 
+type RichEditorTheme = "light" | "dark";
+interface RichEditorThemeTokens {
+    toolbar: {
+        wrapper: string;
+        btnIdle: string;
+        btnActive: string;
+        btnDestructive: string;
+        divider: string;
+        rText: string;
+    };
+    fileList: {
+        wrapper: string;
+        label: string;
+        item: string;
+        itemName: string;
+        itemSize: string;
+        removeBtn: string;
+    };
+    dropZone: {
+        overlay: string;
+        subText: string;
+    };
+    mention: {
+        container: string;
+        emptyText: string;
+        btnIdle: string;
+        btnSelected: string;
+        badgeIdle: string;
+        badgeSelected: string;
+    };
+}
+interface RichEditorThemeOverride {
+    toolbar?: Partial<RichEditorThemeTokens["toolbar"]>;
+    mention?: Partial<RichEditorThemeTokens["mention"]>;
+}
+
+type RichEditorHeadingLevel = 1 | 2 | 3 | 4;
+interface MentionItem {
+    id: string;
+    label: string;
+    [key: string]: unknown;
+}
+interface RichEditorToolbarConfig {
+    heading?: boolean | ReadonlyArray<RichEditorHeadingLevel>;
+    bold?: boolean;
+    italic?: boolean;
+    strike?: boolean;
+    code?: boolean;
+    bulletList?: boolean;
+    orderedList?: boolean;
+    blockquote?: boolean;
+    codeBlock?: boolean;
+    textAlign?: boolean;
+    image?: boolean;
+    mention?: boolean;
+    mentionAll?: boolean;
+    table?: boolean;
+    placeholder?: string;
+}
+interface RichEditorHandle {
+    getHTML: () => string;
+    getJSON: () => unknown;
+    setContent: (html: string) => void;
+    clearContent: () => void;
+    focus: () => void;
+    isEmpty: boolean;
+    editor: _tiptap_core.Editor | null;
+}
+interface RichEditorProps {
+    value?: string;
+    defaultValue?: string;
+    onChange?: (html: string) => void;
+    toolbar?: boolean | RichEditorToolbarConfig;
+    mentionUsers?: MentionItem[];
+    onMentionSearch?: (query: string) => MentionItem[] | Promise<MentionItem[]>;
+    additionalExtensions?: Extensions;
+    theme?: RichEditorTheme;
+    themeTokens?: RichEditorThemeOverride;
+    placeholder?: string;
+    minHeight?: string | number;
+    maxHeight?: string | number;
+    className?: string;
+    bodyClassName?: string;
+    editorClassName?: string;
+    mentionClassName?: string;
+    editable?: boolean;
+    autofocus?: boolean | "start" | "end" | "all" | null;
+    onSubmit?: () => void;
+}
+interface UseRichEditorOptions {
+    defaultValue?: string;
+    toolbar?: RichEditorToolbarConfig;
+    mentionUsers?: MentionItem[];
+    onMentionSearch?: (query: string) => MentionItem[] | Promise<MentionItem[]>;
+    mentionClassName?: string;
+    editable?: boolean;
+    autofocus?: boolean | "start" | "end" | "all" | null;
+    editorClassName?: string;
+    additionalExtensions?: Extensions;
+    onChange?: (html: string) => void;
+    onSubmit?: () => void;
+}
+interface RichEditorContentProps {
+    editor: _tiptap_core.Editor | null;
+    className?: string;
+    editorClassName?: string;
+    minHeight?: string | number;
+    maxHeight?: string | number;
+}
+interface RichEditorToolbarProps {
+    editor: _tiptap_core.Editor | null;
+    toolbar?: RichEditorToolbarConfig;
+    className?: string;
+}
+
+interface UseRichEditorReturn {
+    editor: Editor | null;
+    getHTML: () => string;
+    getJSON: () => unknown;
+    setContent: (html: string) => void;
+    clearContent: () => void;
+    focus: () => void;
+    isEmpty: boolean;
+}
+declare function useRichEditor(options?: UseRichEditorOptions): UseRichEditorReturn;
+
+declare function RichEditorToolbar(props: RichEditorToolbarProps): react.JSX.Element | null;
+
+declare function RichEditorContent(props: RichEditorContentProps): react.JSX.Element;
+declare const RichEditor: react.ForwardRefExoticComponent<RichEditorProps & react.RefAttributes<RichEditorHandle>>;
+
 type DetailMode = "read" | "edit";
 type DetailFieldType = "text" | "badge" | "tag" | "link" | "image" | "date" | "number" | "boolean";
 type BadgeTone = "success" | "warning" | "error" | "info" | "default";
@@ -1439,4 +1572,4 @@ declare const Z_INDEX: {
 };
 type ZIndexKey = keyof typeof Z_INDEX;
 
-export { ArrowIcon, Badge, type BadgeProps, type BaseParams, BaseUploader, type BaseUploaderProps, BreadCrumb, type BreadCrumbItem, type BreadCrumbMenuItem, type BreadCrumbProps, type BreadCrumbRoot, Button, type ButtonProps, type ButtonSize, type ButtonVariant, type CalendarYearRange, Carousel, type CarouselProps, type CarouselRef, Checkbox, type CheckboxProps, type Column, type ConfirmOptions, DatePicker, DebouncedButton, type DebouncedButtonProps, DetailContent, type DetailContentProps, type DetailField, type DetailFieldOrSection, DetailModalFrame, type DetailMode, DetailPageFrame, Empty, ExcelUploader, FilePreviewViewer, FileUploader, type FilterRow, type FormFieldConfig, Input, type InputProps, Loading, LoadingOverlay, type LoadingOverlayProps, type LoadingProps, type MenuChild, type MenuGrandchild, type MenuItem, type MenuSection, Modal, ModalBody, ModalContent, ModalFooter, ModalHeader, ModalIconHeader, type ModalIconHeaderProps, ModalOverlay, type ModalProps, type ModalType, MultiTabBar as MultiTab, type MultiTab as MultiTabItem, PageFilter, type PageParams, Pagination, type PaginationProps, Popover, type PopoverAlign, PopoverAnchor, PopoverClose, PopoverContent, type PopoverContentProps, PopoverDescription, PopoverFooter, PopoverHeader, type PopoverPosition, PopoverTitle, PopoverTrigger, Radio, RadioGroup, type RadioGroupProps, type RadioOptionType, type RadioProps, ScrollArea, ScrollBar, SearchAddress, type SearchAddressProps, SearchBar, type SearchBarProps, Select, Select$1 as SelectBase, SelectContent, SelectGroup, SelectItem, SelectLabel, type SelectOptionType, type SelectProps, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue, Sidebar, type SidebarHeaderRenderProps, type SidebarProps, SimplePopover, type SimplePopoverProps, Skeleton, type SkeletonProps, Slider, type SliderProps, type SortOption, type SortOrder, type SortParams, Spinner, type SpinnerColor, type SpinnerProps, type SpinnerSize, SubmitForm, Switch, type SwitchProps, Tab, type TabItem, type TabProps, Table, Textarea, type TextareaProps, type ToastPosition, type ToastProps, ToastProvider, type ToastType, ToggleSwitch, Tooltip, type TooltipProps, type UseParams, type YmdDateString, type ZIndexKey, Z_INDEX, buildBreadCrumbItems, buttonVariants, cn, confirmModal, findParentMenuItem, findParentMenuName, formatDate, getFileLabel, getPreviewFileType, isCalendarDayAfterMax, isDateInRange, switchTrackSizes, textVariants, toast, useBlockModalConfirm, useBreadCrumbItems, useCustomBlocker, useDetailController, useFilePreviewViewer, useModal, useMultiTabStore, useParams, useScrollToTop, useStableImageSrc, useToast, validateAndFormatInput };
+export { ArrowIcon, Badge, type BadgeProps, type BaseParams, BaseUploader, type BaseUploaderProps, BreadCrumb, type BreadCrumbItem, type BreadCrumbMenuItem, type BreadCrumbProps, type BreadCrumbRoot, Button, type ButtonProps, type ButtonSize, type ButtonVariant, type CalendarYearRange, Carousel, type CarouselProps, type CarouselRef, Checkbox, type CheckboxProps, type Column, type ConfirmOptions, DatePicker, DebouncedButton, type DebouncedButtonProps, DetailContent, type DetailContentProps, type DetailField, type DetailFieldOrSection, DetailModalFrame, type DetailMode, DetailPageFrame, Empty, ExcelUploader, FilePreviewViewer, FileUploader, type FilterRow, type FormFieldConfig, Input, type InputProps, Loading, LoadingOverlay, type LoadingOverlayProps, type LoadingProps, type MentionItem, type MenuChild, type MenuGrandchild, type MenuItem, type MenuSection, Modal, ModalBody, ModalContent, ModalFooter, ModalHeader, ModalIconHeader, type ModalIconHeaderProps, ModalOverlay, type ModalProps, type ModalType, MultiTabBar as MultiTab, type MultiTab as MultiTabItem, PageFilter, type PageParams, Pagination, type PaginationProps, Popover, type PopoverAlign, PopoverAnchor, PopoverClose, PopoverContent, type PopoverContentProps, PopoverDescription, PopoverFooter, PopoverHeader, type PopoverPosition, PopoverTitle, PopoverTrigger, Radio, RadioGroup, type RadioGroupProps, type RadioOptionType, type RadioProps, RichEditor, RichEditorContent, type RichEditorContentProps, type RichEditorHeadingLevel, type RichEditorProps, type RichEditorThemeOverride, RichEditorToolbar, type RichEditorToolbarConfig, type RichEditorToolbarProps, ScrollArea, ScrollBar, SearchAddress, type SearchAddressProps, SearchBar, type SearchBarProps, Select, Select$1 as SelectBase, SelectContent, SelectGroup, SelectItem, SelectLabel, type SelectOptionType, type SelectProps, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue, Sidebar, type SidebarHeaderRenderProps, type SidebarProps, SimplePopover, type SimplePopoverProps, Skeleton, type SkeletonProps, Slider, type SliderProps, type SortOption, type SortOrder, type SortParams, Spinner, type SpinnerColor, type SpinnerProps, type SpinnerSize, SubmitForm, Switch, type SwitchProps, Tab, type TabItem, type TabProps, Table, Textarea, type TextareaProps, type ToastPosition, type ToastProps, ToastProvider, type ToastType, ToggleSwitch, Tooltip, type TooltipProps, type UseParams, type UseRichEditorOptions, type UseRichEditorReturn, type YmdDateString, type ZIndexKey, Z_INDEX, buildBreadCrumbItems, buttonVariants, cn, confirmModal, findParentMenuItem, findParentMenuName, formatDate, getFileLabel, getPreviewFileType, isCalendarDayAfterMax, isDateInRange, switchTrackSizes, textVariants, toast, useBlockModalConfirm, useBreadCrumbItems, useCustomBlocker, useDetailController, useFilePreviewViewer, useModal, useMultiTabStore, useParams, useRichEditor, useScrollToTop, useStableImageSrc, useToast, validateAndFormatInput };

package/dist/index.d.ts

@@ -11,6 +11,8 @@ import * as zustand_middleware from 'zustand/middleware';
 import * as zustand from 'zustand';
 import { Address } from 'react-daum-postcode';
 import { LucideIcon } from 'lucide-react';
+import * as _tiptap_core from '@tiptap/core';
+import { Extensions, Editor } from '@tiptap/core';
 import { Location } from 'react-router';
 import { ClassValue } from 'clsx';
 import * as PopoverPrimitive from '@radix-ui/react-popover';
@@ -1189,6 +1191,137 @@ interface SidebarProps {
 }
 declare function Sidebar(props: SidebarProps): react.JSX.Element;
 
+type RichEditorTheme = "light" | "dark";
+interface RichEditorThemeTokens {
+    toolbar: {
+        wrapper: string;
+        btnIdle: string;
+        btnActive: string;
+        btnDestructive: string;
+        divider: string;
+        rText: string;
+    };
+    fileList: {
+        wrapper: string;
+        label: string;
+        item: string;
+        itemName: string;
+        itemSize: string;
+        removeBtn: string;
+    };
+    dropZone: {
+        overlay: string;
+        subText: string;
+    };
+    mention: {
+        container: string;
+        emptyText: string;
+        btnIdle: string;
+        btnSelected: string;
+        badgeIdle: string;
+        badgeSelected: string;
+    };
+}
+interface RichEditorThemeOverride {
+    toolbar?: Partial<RichEditorThemeTokens["toolbar"]>;
+    mention?: Partial<RichEditorThemeTokens["mention"]>;
+}
+
+type RichEditorHeadingLevel = 1 | 2 | 3 | 4;
+interface MentionItem {
+    id: string;
+    label: string;
+    [key: string]: unknown;
+}
+interface RichEditorToolbarConfig {
+    heading?: boolean | ReadonlyArray<RichEditorHeadingLevel>;
+    bold?: boolean;
+    italic?: boolean;
+    strike?: boolean;
+    code?: boolean;
+    bulletList?: boolean;
+    orderedList?: boolean;
+    blockquote?: boolean;
+    codeBlock?: boolean;
+    textAlign?: boolean;
+    image?: boolean;
+    mention?: boolean;
+    mentionAll?: boolean;
+    table?: boolean;
+    placeholder?: string;
+}
+interface RichEditorHandle {
+    getHTML: () => string;
+    getJSON: () => unknown;
+    setContent: (html: string) => void;
+    clearContent: () => void;
+    focus: () => void;
+    isEmpty: boolean;
+    editor: _tiptap_core.Editor | null;
+}
+interface RichEditorProps {
+    value?: string;
+    defaultValue?: string;
+    onChange?: (html: string) => void;
+    toolbar?: boolean | RichEditorToolbarConfig;
+    mentionUsers?: MentionItem[];
+    onMentionSearch?: (query: string) => MentionItem[] | Promise<MentionItem[]>;
+    additionalExtensions?: Extensions;
+    theme?: RichEditorTheme;
+    themeTokens?: RichEditorThemeOverride;
+    placeholder?: string;
+    minHeight?: string | number;
+    maxHeight?: string | number;
+    className?: string;
+    bodyClassName?: string;
+    editorClassName?: string;
+    mentionClassName?: string;
+    editable?: boolean;
+    autofocus?: boolean | "start" | "end" | "all" | null;
+    onSubmit?: () => void;
+}
+interface UseRichEditorOptions {
+    defaultValue?: string;
+    toolbar?: RichEditorToolbarConfig;
+    mentionUsers?: MentionItem[];
+    onMentionSearch?: (query: string) => MentionItem[] | Promise<MentionItem[]>;
+    mentionClassName?: string;
+    editable?: boolean;
+    autofocus?: boolean | "start" | "end" | "all" | null;
+    editorClassName?: string;
+    additionalExtensions?: Extensions;
+    onChange?: (html: string) => void;
+    onSubmit?: () => void;
+}
+interface RichEditorContentProps {
+    editor: _tiptap_core.Editor | null;
+    className?: string;
+    editorClassName?: string;
+    minHeight?: string | number;
+    maxHeight?: string | number;
+}
+interface RichEditorToolbarProps {
+    editor: _tiptap_core.Editor | null;
+    toolbar?: RichEditorToolbarConfig;
+    className?: string;
+}
+
+interface UseRichEditorReturn {
+    editor: Editor | null;
+    getHTML: () => string;
+    getJSON: () => unknown;
+    setContent: (html: string) => void;
+    clearContent: () => void;
+    focus: () => void;
+    isEmpty: boolean;
+}
+declare function useRichEditor(options?: UseRichEditorOptions): UseRichEditorReturn;
+
+declare function RichEditorToolbar(props: RichEditorToolbarProps): react.JSX.Element | null;
+
+declare function RichEditorContent(props: RichEditorContentProps): react.JSX.Element;
+declare const RichEditor: react.ForwardRefExoticComponent<RichEditorProps & react.RefAttributes<RichEditorHandle>>;
+
 type DetailMode = "read" | "edit";
 type DetailFieldType = "text" | "badge" | "tag" | "link" | "image" | "date" | "number" | "boolean";
 type BadgeTone = "success" | "warning" | "error" | "info" | "default";
@@ -1439,4 +1572,4 @@ declare const Z_INDEX: {
 };
 type ZIndexKey = keyof typeof Z_INDEX;
 
-export { ArrowIcon, Badge, type BadgeProps, type BaseParams, BaseUploader, type BaseUploaderProps, BreadCrumb, type BreadCrumbItem, type BreadCrumbMenuItem, type BreadCrumbProps, type BreadCrumbRoot, Button, type ButtonProps, type ButtonSize, type ButtonVariant, type CalendarYearRange, Carousel, type CarouselProps, type CarouselRef, Checkbox, type CheckboxProps, type Column, type ConfirmOptions, DatePicker, DebouncedButton, type DebouncedButtonProps, DetailContent, type DetailContentProps, type DetailField, type DetailFieldOrSection, DetailModalFrame, type DetailMode, DetailPageFrame, Empty, ExcelUploader, FilePreviewViewer, FileUploader, type FilterRow, type FormFieldConfig, Input, type InputProps, Loading, LoadingOverlay, type LoadingOverlayProps, type LoadingProps, type MenuChild, type MenuGrandchild, type MenuItem, type MenuSection, Modal, ModalBody, ModalContent, ModalFooter, ModalHeader, ModalIconHeader, type ModalIconHeaderProps, ModalOverlay, type ModalProps, type ModalType, MultiTabBar as MultiTab, type MultiTab as MultiTabItem, PageFilter, type PageParams, Pagination, type PaginationProps, Popover, type PopoverAlign, PopoverAnchor, PopoverClose, PopoverContent, type PopoverContentProps, PopoverDescription, PopoverFooter, PopoverHeader, type PopoverPosition, PopoverTitle, PopoverTrigger, Radio, RadioGroup, type RadioGroupProps, type RadioOptionType, type RadioProps, ScrollArea, ScrollBar, SearchAddress, type SearchAddressProps, SearchBar, type SearchBarProps, Select, Select$1 as SelectBase, SelectContent, SelectGroup, SelectItem, SelectLabel, type SelectOptionType, type SelectProps, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue, Sidebar, type SidebarHeaderRenderProps, type SidebarProps, SimplePopover, type SimplePopoverProps, Skeleton, type SkeletonProps, Slider, type SliderProps, type SortOption, type SortOrder, type SortParams, Spinner, type SpinnerColor, type SpinnerProps, type SpinnerSize, SubmitForm, Switch, type SwitchProps, Tab, type TabItem, type TabProps, Table, Textarea, type TextareaProps, type ToastPosition, type ToastProps, ToastProvider, type ToastType, ToggleSwitch, Tooltip, type TooltipProps, type UseParams, type YmdDateString, type ZIndexKey, Z_INDEX, buildBreadCrumbItems, buttonVariants, cn, confirmModal, findParentMenuItem, findParentMenuName, formatDate, getFileLabel, getPreviewFileType, isCalendarDayAfterMax, isDateInRange, switchTrackSizes, textVariants, toast, useBlockModalConfirm, useBreadCrumbItems, useCustomBlocker, useDetailController, useFilePreviewViewer, useModal, useMultiTabStore, useParams, useScrollToTop, useStableImageSrc, useToast, validateAndFormatInput };
+export { ArrowIcon, Badge, type BadgeProps, type BaseParams, BaseUploader, type BaseUploaderProps, BreadCrumb, type BreadCrumbItem, type BreadCrumbMenuItem, type BreadCrumbProps, type BreadCrumbRoot, Button, type ButtonProps, type ButtonSize, type ButtonVariant, type CalendarYearRange, Carousel, type CarouselProps, type CarouselRef, Checkbox, type CheckboxProps, type Column, type ConfirmOptions, DatePicker, DebouncedButton, type DebouncedButtonProps, DetailContent, type DetailContentProps, type DetailField, type DetailFieldOrSection, DetailModalFrame, type DetailMode, DetailPageFrame, Empty, ExcelUploader, FilePreviewViewer, FileUploader, type FilterRow, type FormFieldConfig, Input, type InputProps, Loading, LoadingOverlay, type LoadingOverlayProps, type LoadingProps, type MentionItem, type MenuChild, type MenuGrandchild, type MenuItem, type MenuSection, Modal, ModalBody, ModalContent, ModalFooter, ModalHeader, ModalIconHeader, type ModalIconHeaderProps, ModalOverlay, type ModalProps, type ModalType, MultiTabBar as MultiTab, type MultiTab as MultiTabItem, PageFilter, type PageParams, Pagination, type PaginationProps, Popover, type PopoverAlign, PopoverAnchor, PopoverClose, PopoverContent, type PopoverContentProps, PopoverDescription, PopoverFooter, PopoverHeader, type PopoverPosition, PopoverTitle, PopoverTrigger, Radio, RadioGroup, type RadioGroupProps, type RadioOptionType, type RadioProps, RichEditor, RichEditorContent, type RichEditorContentProps, type RichEditorHeadingLevel, type RichEditorProps, type RichEditorThemeOverride, RichEditorToolbar, type RichEditorToolbarConfig, type RichEditorToolbarProps, ScrollArea, ScrollBar, SearchAddress, type SearchAddressProps, SearchBar, type SearchBarProps, Select, Select$1 as SelectBase, SelectContent, SelectGroup, SelectItem, SelectLabel, type SelectOptionType, type SelectProps, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue, Sidebar, type SidebarHeaderRenderProps, type SidebarProps, SimplePopover, type SimplePopoverProps, Skeleton, type SkeletonProps, Slider, type SliderProps, type SortOption, type SortOrder, type SortParams, Spinner, type SpinnerColor, type SpinnerProps, type SpinnerSize, SubmitForm, Switch, type SwitchProps, Tab, type TabItem, type TabProps, Table, Textarea, type TextareaProps, type ToastPosition, type ToastProps, ToastProvider, type ToastType, ToggleSwitch, Tooltip, type TooltipProps, type UseParams, type UseRichEditorOptions, type UseRichEditorReturn, type YmdDateString, type ZIndexKey, Z_INDEX, buildBreadCrumbItems, buttonVariants, cn, confirmModal, findParentMenuItem, findParentMenuName, formatDate, getFileLabel, getPreviewFileType, isCalendarDayAfterMax, isDateInRange, switchTrackSizes, textVariants, toast, useBlockModalConfirm, useBreadCrumbItems, useCustomBlocker, useDetailController, useFilePreviewViewer, useModal, useMultiTabStore, useParams, useRichEditor, useScrollToTop, useStableImageSrc, useToast, validateAndFormatInput };