react-use-echarts 0.0.11 → 1.0.0

package/dist/index.d.ts

@@ -1,131 +1,32 @@
-import { ECharts } from 'echarts';
-import { EChartsOption } from 'echarts';
-import { SetOptionOpts } from 'echarts';
-
-/**
- * Event configuration interface for ECharts
- * ECharts 事件配置接口
- * @example
- * ```typescript
- * const events: EChartsEvents = {
- *   'click': {
- *     handler: (params) => console.log('clicked', params),
- *     query: '.series-name',
- *     context: this
- *   }
- * }
- * ```
- */
-export declare interface EChartsEvents {
-    /**
-     * Event name as key
-     * 事件名称作为键
-     */
-    [eventName: string]: {
-        /**
-         * Event handler function
-         * 事件处理函数
-         */
-        handler: (params: unknown) => void;
-        /**
-         * Query condition for the event
-         * 事件的查询条件
-         */
-        query?: string | object;
-        /**
-         * Context for the event handler
-         * 事件处理函数的上下文
-         */
-        context?: object;
-    };
-}
-
-/**
- * Theme type for ECharts
- * ECharts 的主题类型
- */
-export declare type Theme = string | object | null;
-
-/**
- * React hook for Apache ECharts integration
- * @param options Configuration object
- * @param options.option Chart configuration
- * @param options.theme Chart theme name
- * @param options.notMerge Skip merging with previous options
- * @param options.lazyUpdate Enable lazy update mode
- * @param options.showLoading Display loading animation
- * @param options.loadingOption Loading animation config
- * @param options.onEvents Event handlers map
- * @returns Chart control methods and ref
- */
-export declare const useEcharts: ({ option, theme, notMerge, lazyUpdate, showLoading, loadingOption, onEvents, }: UseEchartsOptions) => UseEchartsReturn;
-
-/**
- * Configuration options for useEcharts hook
- * useEcharts hook 的配置选项
- */
-export declare interface UseEchartsOptions {
-    /**
-     * ECharts configuration options
-     * ECharts 的配置项
-     */
-    option: EChartsOption;
-    /**
-     * Theme to be applied
-     * 要应用的主题
-     */
-    theme?: Theme;
-    /**
-     * Whether to not merge with previous options
-     * 是否不合并之前的配置项
-     * @default false
-     */
-    notMerge?: boolean;
-    /**
-     * Whether to update chart in lazy mode
-     * 是否在懒加载模式下更新图表
-     * @default false
-     */
-    lazyUpdate?: boolean;
-    /**
-     * Whether to show loading state
-     * 是否显示加载状态
-     * @default false
-     */
-    showLoading?: boolean;
-    /**
-     * Loading options
-     * 加载配置项
-     */
-    loadingOption?: object;
-    /**
-     * Event configurations
-     * 事件配置
-     */
-    onEvents?: EChartsEvents;
-}
-
-/**
- * Return type for useEcharts hook
- * useEcharts hook 的返回类型
- */
-export declare interface UseEchartsReturn {
-    /**
-     * Reference to the chart container element
-     * 图表容器元素的引用
-     */
-    chartRef: React.RefObject<HTMLDivElement | null>;
-    /**
-     * Function to update chart options
-     * 更新图表配置的函数
-     */
-    setOption: (option: EChartsOption, opts?: SetOptionOpts) => void;
-    /**
-     * Function to get the ECharts instance
-     * 获取 ECharts 实例的函数
-     * @returns Returns the current ECharts instance, or undefined if not initialized
-     */
-    getInstance: () => ECharts | undefined;
-}
-
-export { }
+/**
+ * react-use-echarts
+ * A React hook library for Apache ECharts with TypeScript support
+ * 基于 TypeScript 的 Apache ECharts React Hook 库
+ *
+ * @packageDocumentation
+ */
+/**
+ * Main hook for using ECharts in React components
+ * 在 React 组件中使用 ECharts 的主要 Hook
+ */
+export { default as useEcharts } from './hooks/use-echarts';
+/**
+ * Lazy initialization hook
+ * 懒加载初始化 Hook
+ */
+export { useLazyInit } from './hooks/use-lazy-init';
+/**
+ * Type definitions for the library
+ * 库的类型定义
+ */
+export type { UseEchartsOptions, UseEchartsReturn, EChartsEvents, BuiltinTheme, } from './types';
+/**
+ * Theme utilities
+ * 主题工具函数
+ */
+export { registerBuiltinThemes, getBuiltinTheme, isBuiltinTheme, registerCustomTheme, getAvailableThemes, } from './themes';
+/**
+ * Utility functions for ECharts
+ * ECharts 工具函数
+ */
+export * from './utils';