@antv/s2-vue 2.0.0-next.9 → 2.0.0

package/esm/hooks/useSpreadSheet.d.ts

@@ -0,0 +1,75 @@
+import { type SpreadSheet } from '@antv/s2';
+import type { BaseSheetInitEmits, EmitFn } from '../interface';
+import type { BaseSheetProps } from '../utils/initPropAndEmits';
+export declare function useSpreadSheet(props: BaseSheetProps, emit: EmitFn<BaseSheetInitEmits>): {
+    wrapperRef: import("vue").Ref<HTMLDivElement>;
+    containerRef: import("vue").Ref<HTMLDivElement>;
+    s2Ref: import("vue").ShallowRef<SpreadSheet>;
+    loading: import("vue").Ref<boolean>;
+    setLoading: (updated: boolean) => void;
+    pagination: {
+        customOptions: import("lodash").Omit<import("@antv/s2").Pagination & Partial<import("vue").ExtractPropTypes<{
+            total: NumberConstructor;
+            defaultCurrent: NumberConstructor;
+            disabled: {
+                type: BooleanConstructor;
+                default: any;
+            };
+            current: NumberConstructor;
+            defaultPageSize: NumberConstructor;
+            pageSize: NumberConstructor;
+            hideOnSinglePage: {
+                type: BooleanConstructor;
+                default: any;
+            };
+            showSizeChanger: {
+                type: BooleanConstructor;
+                default: any;
+            };
+            pageSizeOptions: import("vue").PropType<(string | number)[]>;
+            buildOptionText: import("vue").PropType<(opt: {
+                value: any;
+            }) => any>;
+            showQuickJumper: {
+                type: import("vue").PropType<boolean | {
+                    goButton?: any;
+                }>;
+                default: boolean | {
+                    goButton?: any;
+                };
+            };
+            showTotal: import("vue").PropType<(total: number, range: [number, number]) => any>;
+            size: import("vue").PropType<"small" | "default">;
+            simple: {
+                type: BooleanConstructor;
+                default: any;
+            };
+            locale: ObjectConstructor;
+            prefixCls: StringConstructor;
+            selectPrefixCls: StringConstructor;
+            totalBoundaryShowSizeChanger: NumberConstructor;
+            selectComponentClass: StringConstructor;
+            itemRender: import("vue").PropType<(opt: {
+                page: number;
+                type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
+                originalElement: any;
+            }) => any>;
+            role: StringConstructor;
+            responsive: BooleanConstructor;
+            showLessItems: {
+                type: BooleanConstructor;
+                default: any;
+            };
+            onChange: import("vue").PropType<(page: number, pageSize: number) => void>;
+            onShowSizeChange: import("vue").PropType<(current: number, size: number) => void>;
+            'onUpdate:current': import("vue").PropType<(current: number) => void>;
+            'onUpdate:pageSize': import("vue").PropType<(size: number) => void>;
+        }>>, "total" | "current" | "pageSize">;
+        visible: import("vue").ComputedRef<boolean>;
+        current: import("vue").Ref<number>;
+        pageSize: import("vue").Ref<number>;
+        total: import("vue").Ref<number>;
+        change: (nextCurrent: number) => void;
+        showSizeChange: (nextPageSize: number) => void;
+    };
+};

package/esm/hooks/useSpreadSheet.js

@@ -0,0 +1,60 @@
+import { PivotSheet, TableSheet, } from '@antv/s2';
+import { onBeforeUnmount, onMounted, ref, shallowRef, toRaw } from 'vue';
+import { getSheetComponentOptions } from '../utils/options';
+import { useEvents } from './useEvents';
+import { useLoading } from './useLoading';
+import { usePagination } from './usePagination';
+import { useResize } from './useResize';
+import { useSheetUpdate } from './useSheetUpdate';
+export function useSpreadSheet(props, emit) {
+    const { dataCfg, options, themeCfg, loading: loadingProps, sheetType, spreadsheet: customSpreadSheet, onMounted: onS2Mounted, } = props;
+    const wrapperRef = ref();
+    const containerRef = ref();
+    const s2Ref = shallowRef();
+    const { loading, setLoading } = useLoading(s2Ref, loadingProps);
+    const pagination = usePagination(s2Ref, props);
+    const renderSpreadSheet = (container) => {
+        const rawDataCfg = toRaw(dataCfg);
+        const rawOptions = toRaw(options);
+        const s2Options = getSheetComponentOptions(rawOptions);
+        if (customSpreadSheet) {
+            return customSpreadSheet(container, rawDataCfg, s2Options);
+        }
+        if (sheetType === 'table' || sheetType === 'editable') {
+            return new TableSheet(container, rawDataCfg, s2Options);
+        }
+        return new PivotSheet(container, rawDataCfg, s2Options);
+    };
+    const buildSpreadSheet = async () => {
+        setLoading(true);
+        s2Ref.value = renderSpreadSheet(containerRef.value);
+        s2Ref.value.setThemeCfg(toRaw(themeCfg));
+        await s2Ref.value.render();
+        setLoading(false);
+        onS2Mounted?.(s2Ref.value);
+    };
+    onMounted(buildSpreadSheet);
+    useEvents(s2Ref, emit);
+    useSheetUpdate(s2Ref, props, {
+        before() {
+            setLoading(true);
+        },
+        after() {
+            setLoading(false);
+        },
+    });
+    useResize(s2Ref, props, { wrapperRef, containerRef });
+    onBeforeUnmount(() => {
+        setLoading(false);
+        s2Ref.value?.destroy();
+    });
+    return {
+        wrapperRef,
+        containerRef,
+        s2Ref,
+        loading,
+        setLoading,
+        pagination,
+    };
+}
+//# sourceMappingURL=useSpreadSheet.js.map

package/esm/hooks/useSpreadSheet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSpreadSheet.js","sourceRoot":"","sources":["../../src/hooks/useSpreadSheet.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,UAAU,GAGX,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,KAAK,CAAC;AAGzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,MAAM,UAAU,cAAc,CAC5B,KAAqB,EACrB,IAAgC;IAEhC,MAAM,EACJ,OAAO,EACP,OAAO,EACP,QAAQ,EACR,OAAO,EAAE,YAAY,EACrB,SAAS,EACT,WAAW,EAAE,iBAAiB,EAC9B,SAAS,EAAE,WAAW,GACvB,GAAG,KAAK,CAAC;IACV,MAAM,UAAU,GAAG,GAAG,EAAkB,CAAC;IACzC,MAAM,YAAY,GAAG,GAAG,EAAkB,CAAC;IAE3C,MAAM,KAAK,GAAG,UAAU,EAAe,CAAC;IAExC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAChE,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAE/C,MAAM,iBAAiB,GAAG,CAAC,SAAyB,EAAE,EAAE;QACtD,MAAM,UAAU,GAAG,KAAK,CAAC,OAAQ,CAAC,CAAC;QACnC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAElC,MAAM,SAAS,GAAG,wBAAwB,CAAC,UAAuB,CAAC,CAAC;QAEpE,IAAI,iBAAiB,EAAE,CAAC;YACtB,OAAO,iBAAiB,CAAC,SAAS,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,SAAS,KAAK,OAAO,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YACtD,OAAO,IAAI,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,KAAK,IAAI,EAAE;QAClC,UAAU,CAAC,IAAI,CAAC,CAAC;QACjB,KAAK,CAAC,KAAK,GAAG,iBAAiB,CAAC,YAAY,CAAC,KAAM,CAAC,CAAC;QACrD,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzC,MAAM,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAE3B,UAAU,CAAC,KAAK,CAAC,CAAC;QAClB,WAAW,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC,CAAC;IAEF,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC5B,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvB,cAAc,CAAC,KAAK,EAAE,KAAK,EAAE;QAC3B,MAAM;YACJ,UAAU,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;QACD,KAAK;YACH,UAAU,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;KACF,CAAC,CAAC;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;IAEtD,eAAe,CAAC,GAAG,EAAE;QACnB,UAAU,CAAC,KAAK,CAAC,CAAC;QAClB,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,UAAU;QACV,YAAY;QACZ,KAAK;QACL,OAAO;QACP,UAAU;QACV,UAAU;KACX,CAAC;AACJ,CAAC"}