@vef-framework/components 1.0.5

package/dist/vef-tree-select/props.d.ts

@@ -0,0 +1,142 @@
+import type { BasicSize, BiConsumer, DataOption, DataOptionConfig, Handler, IdValue, Mapper, MaybeArray, MaybeNull, MaybePromise, NormalizedDataOption, ObjectType, Provider, PureDataOption, QueryApi, QueryConfig, QueryParamsWithKeyword, QueryParamsWithValues, StringKey } from "@vef-framework/shared";
+import type { TreeSelectProps } from "antd";
+import type { EmptyObject } from "@vef-framework/shared";
+/**
+ * The instance of the VefTreeSelect component.
+ */
+export interface VefTreeSelectInstance<T extends DataOption<T> = PureDataOption> {
+    /**
+     * Focus the tree select.
+     */
+    focus: Handler;
+    /**
+     * Blur the tree select.
+     */
+    blur: Handler;
+    /**
+     * Get the data options of the tree select.
+     */
+    getDataOptions: Provider<Array<NormalizedDataOption<T>>>;
+}
+/**
+ * The base props of the VefTreeSelect component.
+ */
+interface VefBaseTreeSelectProps<T extends DataOption<T> = PureDataOption, P extends ObjectType = EmptyObject, R = T, KK extends string = "keyword", VK extends string = "ids", FP extends ObjectType = EmptyObject> extends QueryConfig<T[], QueryParamsWithKeyword<P, KK>, R[]>, DataOptionConfig<StringKey<T>>, Pick<TreeSelectProps<MaybeNull<MaybeArray<IdValue>>, NormalizedDataOption<T>>, "disabled" | "placeholder" | "variant" | "onClear" | "onBlur" | "onFocus" | "onSelect" | "onDeselect"> {
+    /**
+     * The size of the tree select.
+     */
+    size?: BasicSize;
+    /**
+     * Whether to allow clear.
+     */
+    clearable?: boolean;
+    /**
+     * Whether to allow multiple selection.
+     */
+    multiple?: boolean;
+    /**
+     * Whether to allow filter.
+     */
+    filterable?: boolean;
+    /**
+     * Whether to filter from remote.
+     */
+    filterFromRemote?: boolean;
+    /**
+     * The parameter key of keyword.
+     * Only works when `filterFromRemote` is true.
+     */
+    keywordKey?: KK;
+    /**
+     * The parameter key of values.
+     */
+    valuesKey?: VK;
+    /**
+     * The API of fallback options.
+     */
+    fallbackOptionsApi?: Readonly<QueryApi<QueryParamsWithValues<FP>, T[]>>;
+    /**
+     * The API params of fallback options.
+     */
+    fallbackOptionsApiParams?: FP;
+    /**
+     * The function to resolve fallback options.
+     */
+    resolveFallbackOptions?: Mapper<IdValue[], MaybePromise<T[]>>;
+}
+/**
+ * The default props of the single tree select.
+ */
+interface VefDefaultSingleTreeSelectProps<T extends DataOption<T> = PureDataOption, P extends ObjectType = EmptyObject, R = T[], KK extends string = "keyword", VK extends string = "ids", FP extends ObjectType = EmptyObject> extends VefBaseTreeSelectProps<T, P, R, KK, VK, FP> {
+    /**
+     * The default value of the tree select.
+     */
+    defaultValue?: IdValue;
+    /**
+     * Whether to allow clear.
+     */
+    clearable?: false;
+    /**
+     * The value of the tree select.
+     */
+    value?: MaybeNull<IdValue>;
+    /**
+     * Whether to allow multiple selection.
+     */
+    multiple?: false;
+    /**
+     * The change handler.
+     */
+    onChange?: BiConsumer<IdValue, NormalizedDataOption<T>>;
+}
+/**
+ * The clearable props of the single tree select.
+ */
+interface VefClearableSingleTreeSelectProps<T extends DataOption<T> = PureDataOption, P extends ObjectType = EmptyObject, R = T[], KK extends string = "keyword", VK extends string = "ids", FP extends ObjectType = EmptyObject> extends VefBaseTreeSelectProps<T, P, R, KK, VK, FP> {
+    /**
+     * The default value of the tree select.
+     */
+    defaultValue?: IdValue;
+    /**
+     * Whether to allow clear.
+     */
+    clearable: true;
+    /**
+     * The value of the tree select.
+     */
+    value?: MaybeNull<IdValue>;
+    /**
+     * Whether to allow multiple selection.
+     */
+    multiple?: false;
+    /**
+     * The change handler of the tree select.
+     */
+    onChange?: BiConsumer<MaybeNull<IdValue>, MaybeNull<NormalizedDataOption<T>>>;
+}
+/**
+ * The multiple selection props of the tree select.
+ */
+interface VefMultipleTreeSelectProps<T extends DataOption<T> = PureDataOption, P extends ObjectType = EmptyObject, R = T[], KK extends string = "keyword", VK extends string = "ids", FP extends ObjectType = EmptyObject> extends VefBaseTreeSelectProps<T, P, R, KK, VK, FP> {
+    /**
+     * The default value of the tree select.
+     */
+    defaultValue?: IdValue[];
+    /**
+     * The value of the tree select.
+     */
+    value?: IdValue[];
+    /**
+     * Whether to allow multiple selection.
+     */
+    multiple: true;
+    /**
+     * The change handler of the tree select.
+     */
+    onChange?: BiConsumer<IdValue[], Array<NormalizedDataOption<T>>>;
+}
+/**
+ * The props of VefTreeSelect component.
+ */
+export type VefTreeSelectProps<T extends DataOption<T> = PureDataOption, P extends ObjectType = EmptyObject, R = T[], KK extends string = "keyword", VK extends string = "ids", FP extends ObjectType = EmptyObject> = VefDefaultSingleTreeSelectProps<T, P, R, KK, VK, FP> | VefClearableSingleTreeSelectProps<T, P, R, KK, VK, FP> | VefMultipleTreeSelectProps<T, P, R, KK, VK, FP>;
+export {};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@vef-framework/components",
+  "type": "module",
+  "version": "1.0.5",
+  "private": false,
+  "description": "Components fundamental to the VEF framework",
+  "author": "Venus",
+  "keywords": [
+    "vef",
+    "vef-framework",
+    "vef-components"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "*"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "pnpm clean && tsx build.ts",
+    "clean": "rimraf dist"
+  },
+  "peerDependencies": {
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "zustand": "5.0.1"
+  },
+  "dependencies": {
+    "@emotion/cache": "11.13.5",
+    "@emotion/react": "11.13.5",
+    "@emotion/styled": "11.13.5",
+    "antd": "5.22.3",
+    "tslib": "2.8.1",
+    "@ant-design/icons": "5.5.2",
+    "@dnd-kit/core": "6.2.0",
+    "@dnd-kit/modifiers": "9.0.0",
+    "@dnd-kit/sortable": "10.0.0",
+    "@dnd-kit/utilities": "3.2.2",
+    "@radix-ui/react-scroll-area": "1.2.1",
+    "@vef-framework/core": "1.0.5",
+    "@vef-framework/hooks": "1.0.5",
+    "@vef-framework/shared": "1.0.5",
+    "clsx": "2.1.1",
+    "dayjs": "1.11.13",
+    "lucide-react": "^0.468.0",
+    "motion": "11.12.0",
+    "polished": "4.3.1",
+    "react-container-query": "0.13.0",
+    "react-error-boundary": "4.1.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}