@xinghunm/compass-ui 0.8.0 → 0.8.2

package/dist/index.d.mts

@@ -808,6 +808,108 @@ interface DropdownProps {
 
 declare const Dropdown: React__default.FC<DropdownProps>;
 
+type TooltipPlacement = 'top' | 'top-start' | 'top-end' | 'right' | 'right-start' | 'right-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end';
+interface TooltipClassNames {
+    /**
+     * Custom class name for the trigger root.
+     */
+    root?: string;
+    /**
+     * Custom class name for the floating overlay container.
+     */
+    overlay?: string;
+    /**
+     * Custom class name for the tooltip content node.
+     */
+    content?: string;
+    /**
+     * Custom class name for the tooltip arrow node.
+     */
+    arrow?: string;
+}
+interface TooltipStyles {
+    /**
+     * Inline style applied to the trigger root.
+     */
+    root?: React__default.CSSProperties;
+    /**
+     * Inline style applied to the floating overlay container.
+     */
+    overlay?: React__default.CSSProperties;
+    /**
+     * Inline style applied to the tooltip content node.
+     */
+    content?: React__default.CSSProperties;
+    /**
+     * Inline style applied to the tooltip arrow node.
+     */
+    arrow?: React__default.CSSProperties;
+}
+interface TooltipProps {
+    /**
+     * Tooltip content
+     */
+    content?: React__default.ReactNode;
+    /**
+     * Trigger element. Fragment and non-element nodes will be wrapped with a span.
+     */
+    children: React__default.ReactNode;
+    /**
+     * Trigger mode
+     * @default 'hover'
+     */
+    trigger?: 'hover' | 'click';
+    /**
+     * Tooltip placement
+     * @default 'top'
+     */
+    placement?: TooltipPlacement;
+    /**
+     * Controlled open state
+     */
+    open?: boolean;
+    /**
+     * Default open state
+     */
+    defaultOpen?: boolean;
+    /**
+     * Callback when open state changes
+     */
+    onOpenChange?: (open: boolean) => void;
+    /**
+     * Whether the tooltip is disabled
+     */
+    disabled?: boolean;
+    /**
+     * Mouse enter delay in ms
+     * @default 0
+     */
+    mouseEnterDelay?: number;
+    /**
+     * Mouse leave delay in ms
+     * @default 100
+     */
+    mouseLeaveDelay?: number;
+    /**
+     * Custom root element class name
+     */
+    className?: string;
+    /**
+     * Custom root element style
+     */
+    style?: React__default.CSSProperties;
+    /**
+     * Semantic class names
+     */
+    classNames?: TooltipClassNames;
+    /**
+     * Semantic styles
+     */
+    styles?: TooltipStyles;
+}
+
+declare const Tooltip: React__default.FC<TooltipProps>;
+
 interface InputFieldProps extends Omit<React__default.InputHTMLAttributes<HTMLInputElement>, 'size' | 'prefix'> {
     /**
      * The type of input.
@@ -1059,7 +1161,7 @@ interface ModalBaseProps {
     };
 }
 
-declare const Modal: (props: ModalBaseProps) => React__default.ReactPortal;
+declare const Modal: (props: ModalBaseProps) => React__default.ReactPortal | null;
 
 interface ModalFuncProps extends Omit<ModalBaseProps, 'isOpen' | 'children'> {
     title?: React__default.ReactNode;
@@ -1322,6 +1424,7 @@ interface Theme {
         progress: ProgressTheme;
         steps: StepsTheme;
         input: InputTheme;
+        tooltip: TooltipTheme;
         dropdown: DropdownTheme;
         menu: MenuTheme;
         datePicker: DatePickerTheme;
@@ -1540,6 +1643,16 @@ interface InputTheme {
     activeBorderColor: string;
     hoverBorderColor: string;
 }
+interface TooltipTheme {
+    zIndex: number;
+    backgroundColor: string;
+    contentColor: string;
+    boxShadow: string;
+    borderRadius: string;
+    padding: string;
+    maxWidth: string;
+    fontSize: string;
+}
 interface DropdownTheme {
     zIndex: number;
     backgroundColor: string;
@@ -1551,6 +1664,15 @@ type ThemeMode = 'light' | 'dark';
 type DeepPartial<T> = {
     [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
 };
+interface ThemeProviderProps {
+    children: React__default.ReactNode;
+    theme?: DeepPartial<Theme>;
+    lightTheme?: DeepPartial<Theme>;
+    darkTheme?: DeepPartial<Theme>;
+    defaultMode?: ThemeMode;
+    /** Whether to inject CSS variables to :root. Defaults to true. */
+    global?: boolean;
+}
 
 interface ModalLocale {
     okText: string;
@@ -1642,6 +1764,15 @@ interface ConfigProviderProps {
 
 declare const ConfigProvider: React__default.FC<ConfigProviderProps>;
 
+interface ThemeContextType {
+    mode: ThemeMode;
+    setMode: (mode: ThemeMode) => void;
+    toggleTheme: () => void;
+    theme: Theme;
+}
+declare const ThemeProvider: React__default.FC<ThemeProviderProps>;
+declare const useTheme: () => ThemeContextType;
+
 interface InputNumberProps extends Omit<InputFieldProps, 'onChange' | 'value' | 'defaultValue' | 'type' | 'allowClear'> {
     /**
      * The current value.
@@ -1953,4 +2084,4 @@ type TabsComponent = typeof Tabs & {
 };
 declare const _default: TabsComponent;
 
-export { AutoComplete, type AutoCompleteOption, type AutoCompleteProps, Button, type ButtonProps, type ColumnType, ConfigProvider, type ConfigProviderProps, type DataNode, DatePicker, type DatePickerProps, type DateRangePickerProps, Dropdown, type DropdownProps, type FieldData, Form, type FormInstance, type FormItemProps, type FormProps, InputField, type InputFieldProps, InputNumber, type InputNumberProps, type ItemType, Menu, type MenuItemProps, type MenuProps, messageWithHook as Message, type MessageProps, ModalWithStatics as Modal, type ModalBaseProps as ModalProps, type NamePath, Pagination, type PaginationProps, Progress, type ProgressProps, type RowSelection, Select, type SelectOption, type SelectProps, type SelectValue, Steps, type StepsProps, type TabItem, type TabPaneProps, Table, type TableProps, _default as Tabs, type TabsProps, Tree, type TreeNodeProps, type TreeProps, TreeSelect, type TreeSelectProps, type ValidateErrorEntity };
+export { AutoComplete, type AutoCompleteOption, type AutoCompleteProps, Button, type ButtonProps, type ColumnType, ConfigProvider, type ConfigProviderProps, type DataNode, DatePicker, type DatePickerProps, type DateRangePickerProps, type DeepPartial, Dropdown, type DropdownProps, type FieldData, Form, type FormInstance, type FormItemProps, type FormProps, InputField, type InputFieldProps, InputNumber, type InputNumberProps, type ItemType, Menu, type MenuItemProps, type MenuProps, messageWithHook as Message, type MessageProps, ModalWithStatics as Modal, type ModalBaseProps as ModalProps, type NamePath, Pagination, type PaginationProps, Progress, type ProgressProps, type RowSelection, Select, type SelectOption, type SelectProps, type SelectValue, Steps, type StepsProps, type TabItem, type TabPaneProps, Table, type TableProps, _default as Tabs, type TabsProps, type Theme, type ThemeMode, ThemeProvider, type ThemeProviderProps, Tooltip, type TooltipPlacement, type TooltipProps, Tree, type TreeNodeProps, type TreeProps, TreeSelect, type TreeSelectProps, type ValidateErrorEntity, useTheme };

package/dist/index.d.ts

@@ -808,6 +808,108 @@ interface DropdownProps {
 
 declare const Dropdown: React__default.FC<DropdownProps>;
 
+type TooltipPlacement = 'top' | 'top-start' | 'top-end' | 'right' | 'right-start' | 'right-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end';
+interface TooltipClassNames {
+    /**
+     * Custom class name for the trigger root.
+     */
+    root?: string;
+    /**
+     * Custom class name for the floating overlay container.
+     */
+    overlay?: string;
+    /**
+     * Custom class name for the tooltip content node.
+     */
+    content?: string;
+    /**
+     * Custom class name for the tooltip arrow node.
+     */
+    arrow?: string;
+}
+interface TooltipStyles {
+    /**
+     * Inline style applied to the trigger root.
+     */
+    root?: React__default.CSSProperties;
+    /**
+     * Inline style applied to the floating overlay container.
+     */
+    overlay?: React__default.CSSProperties;
+    /**
+     * Inline style applied to the tooltip content node.
+     */
+    content?: React__default.CSSProperties;
+    /**
+     * Inline style applied to the tooltip arrow node.
+     */
+    arrow?: React__default.CSSProperties;
+}
+interface TooltipProps {
+    /**
+     * Tooltip content
+     */
+    content?: React__default.ReactNode;
+    /**
+     * Trigger element. Fragment and non-element nodes will be wrapped with a span.
+     */
+    children: React__default.ReactNode;
+    /**
+     * Trigger mode
+     * @default 'hover'
+     */
+    trigger?: 'hover' | 'click';
+    /**
+     * Tooltip placement
+     * @default 'top'
+     */
+    placement?: TooltipPlacement;
+    /**
+     * Controlled open state
+     */
+    open?: boolean;
+    /**
+     * Default open state
+     */
+    defaultOpen?: boolean;
+    /**
+     * Callback when open state changes
+     */
+    onOpenChange?: (open: boolean) => void;
+    /**
+     * Whether the tooltip is disabled
+     */
+    disabled?: boolean;
+    /**
+     * Mouse enter delay in ms
+     * @default 0
+     */
+    mouseEnterDelay?: number;
+    /**
+     * Mouse leave delay in ms
+     * @default 100
+     */
+    mouseLeaveDelay?: number;
+    /**
+     * Custom root element class name
+     */
+    className?: string;
+    /**
+     * Custom root element style
+     */
+    style?: React__default.CSSProperties;
+    /**
+     * Semantic class names
+     */
+    classNames?: TooltipClassNames;
+    /**
+     * Semantic styles
+     */
+    styles?: TooltipStyles;
+}
+
+declare const Tooltip: React__default.FC<TooltipProps>;
+
 interface InputFieldProps extends Omit<React__default.InputHTMLAttributes<HTMLInputElement>, 'size' | 'prefix'> {
     /**
      * The type of input.
@@ -1059,7 +1161,7 @@ interface ModalBaseProps {
     };
 }
 
-declare const Modal: (props: ModalBaseProps) => React__default.ReactPortal;
+declare const Modal: (props: ModalBaseProps) => React__default.ReactPortal | null;
 
 interface ModalFuncProps extends Omit<ModalBaseProps, 'isOpen' | 'children'> {
     title?: React__default.ReactNode;
@@ -1322,6 +1424,7 @@ interface Theme {
         progress: ProgressTheme;
         steps: StepsTheme;
         input: InputTheme;
+        tooltip: TooltipTheme;
         dropdown: DropdownTheme;
         menu: MenuTheme;
         datePicker: DatePickerTheme;
@@ -1540,6 +1643,16 @@ interface InputTheme {
     activeBorderColor: string;
     hoverBorderColor: string;
 }
+interface TooltipTheme {
+    zIndex: number;
+    backgroundColor: string;
+    contentColor: string;
+    boxShadow: string;
+    borderRadius: string;
+    padding: string;
+    maxWidth: string;
+    fontSize: string;
+}
 interface DropdownTheme {
     zIndex: number;
     backgroundColor: string;
@@ -1551,6 +1664,15 @@ type ThemeMode = 'light' | 'dark';
 type DeepPartial<T> = {
     [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
 };
+interface ThemeProviderProps {
+    children: React__default.ReactNode;
+    theme?: DeepPartial<Theme>;
+    lightTheme?: DeepPartial<Theme>;
+    darkTheme?: DeepPartial<Theme>;
+    defaultMode?: ThemeMode;
+    /** Whether to inject CSS variables to :root. Defaults to true. */
+    global?: boolean;
+}
 
 interface ModalLocale {
     okText: string;
@@ -1642,6 +1764,15 @@ interface ConfigProviderProps {
 
 declare const ConfigProvider: React__default.FC<ConfigProviderProps>;
 
+interface ThemeContextType {
+    mode: ThemeMode;
+    setMode: (mode: ThemeMode) => void;
+    toggleTheme: () => void;
+    theme: Theme;
+}
+declare const ThemeProvider: React__default.FC<ThemeProviderProps>;
+declare const useTheme: () => ThemeContextType;
+
 interface InputNumberProps extends Omit<InputFieldProps, 'onChange' | 'value' | 'defaultValue' | 'type' | 'allowClear'> {
     /**
      * The current value.
@@ -1953,4 +2084,4 @@ type TabsComponent = typeof Tabs & {
 };
 declare const _default: TabsComponent;
 
-export { AutoComplete, type AutoCompleteOption, type AutoCompleteProps, Button, type ButtonProps, type ColumnType, ConfigProvider, type ConfigProviderProps, type DataNode, DatePicker, type DatePickerProps, type DateRangePickerProps, Dropdown, type DropdownProps, type FieldData, Form, type FormInstance, type FormItemProps, type FormProps, InputField, type InputFieldProps, InputNumber, type InputNumberProps, type ItemType, Menu, type MenuItemProps, type MenuProps, messageWithHook as Message, type MessageProps, ModalWithStatics as Modal, type ModalBaseProps as ModalProps, type NamePath, Pagination, type PaginationProps, Progress, type ProgressProps, type RowSelection, Select, type SelectOption, type SelectProps, type SelectValue, Steps, type StepsProps, type TabItem, type TabPaneProps, Table, type TableProps, _default as Tabs, type TabsProps, Tree, type TreeNodeProps, type TreeProps, TreeSelect, type TreeSelectProps, type ValidateErrorEntity };
+export { AutoComplete, type AutoCompleteOption, type AutoCompleteProps, Button, type ButtonProps, type ColumnType, ConfigProvider, type ConfigProviderProps, type DataNode, DatePicker, type DatePickerProps, type DateRangePickerProps, type DeepPartial, Dropdown, type DropdownProps, type FieldData, Form, type FormInstance, type FormItemProps, type FormProps, InputField, type InputFieldProps, InputNumber, type InputNumberProps, type ItemType, Menu, type MenuItemProps, type MenuProps, messageWithHook as Message, type MessageProps, ModalWithStatics as Modal, type ModalBaseProps as ModalProps, type NamePath, Pagination, type PaginationProps, Progress, type ProgressProps, type RowSelection, Select, type SelectOption, type SelectProps, type SelectValue, Steps, type StepsProps, type TabItem, type TabPaneProps, Table, type TableProps, _default as Tabs, type TabsProps, type Theme, type ThemeMode, ThemeProvider, type ThemeProviderProps, Tooltip, type TooltipPlacement, type TooltipProps, Tree, type TreeNodeProps, type TreeProps, TreeSelect, type TreeSelectProps, type ValidateErrorEntity, useTheme };