@vef-framework/components 1.0.135 → 2.0.0

package/types/vef-table/props.d.ts

@@ -1,152 +0,0 @@
-import type { ActionButton, BasicSize, BiConsumer, BiMapper, ColorType, EmptyObject, IdValue, Mapper, ObjectType, ObjectValue, PaginationParams, PaginationResult, Provider, QueryConfig, StringKey } from "@vef-framework/shared";
-import type { TableProps } from "antd";
-import type { ReactNode } from "react";
-import type { BatchActionButtonContext, OperationButtonContext, TableHeight, TableSchema } from "./types";
-/**
- * The instance of VefTable component.
- */
-export interface VefTableInstance<T extends ObjectType> {
-    /**
-     * Get the table data.
-     */
-    getData: Provider<T[]>;
-    /**
-     * Refetch the table data.
-     */
-    refetch: Provider<Promise<void>>;
-}
-/**
- * The onChange handler type of table.
- */
-export type OnChangeHandler<T extends ObjectType> = NonNullable<TableProps<T>["onChange"]>;
-/**
- * The props of VefTable component.
- */
-export type VefTableProps<T extends ObjectType = ObjectValue, P extends ObjectType = EmptyObject, R = T, C extends ObjectType = EmptyObject> = VefDefaultTableProps<T, P, R, C> | VefPaginatedTableProps<T, P, R, C>;
-/**
- * The base props of VefTable component.
- */
-interface VefBaseTableProps<T extends ObjectType = ObjectValue, C extends ObjectType = EmptyObject> extends Pick<TableProps<T>, "bordered"> {
-    /**
-     * The schema of the table.
-     */
-    schema: TableSchema<T>;
-    /**
-     * The key of the row.
-     */
-    rowKey?: StringKey<T> | Mapper<T, string>;
-    /**
-     * The size of the table.
-     */
-    size?: BasicSize;
-    /**
-     * The height of the table.
-     */
-    height?: TableHeight;
-    /**
-     * Whether to enable virtual scrolling.
-     * Only works when `height` is number and greater than 0.
-     */
-    virtual?: boolean;
-    /**
-     * Whether to allow pagination.
-     */
-    paginated?: boolean;
-    /**
-     * Whether to show the row number.
-     */
-    showRowNumber?: boolean;
-    /**
-     * Whether to allow selection.
-     */
-    selectable?: boolean;
-    /**
-     * Whether to allow multiple selection.
-     */
-    multipleSelection?: boolean;
-    /**
-     * Whether to show the select all checkbox.
-     * Only works when `allowSelect` is true and `multipleSelection` is true.
-     */
-    showSelectAllCheckbox?: boolean;
-    /**
-     * Whether to disable selection.
-     */
-    disabledSelection?: Mapper<T, boolean>;
-    /**
-     * The text of the selection summary.
-     */
-    selectionSummary?: false | Mapper<T[], ReactNode>;
-    /**
-     * Whether to enable row click event.
-     */
-    enableRowClick?: boolean;
-    /**
-     * Whether to click row for selection.
-     */
-    enableRowClickForSelection?: boolean;
-    /**
-     * The background color of the row.
-     */
-    rowBackgroundColor?: BiMapper<T, number, ColorType>;
-    /**
-     * The operation buttons of the table.
-     */
-    operationButtons?: Array<ActionButton<OperationButtonContext<T, C>>>;
-    /**
-     * The maximum number of visible operation buttons.
-     */
-    maxVisibleOperationButtons?: number;
-    /**
-     * The batch action buttons of the table.
-     */
-    batchActionButtons?: Array<ActionButton<BatchActionButtonContext<T, C>>>;
-    /**
-     * The external context of the table.
-     */
-    externalContext?: C;
-    /**
-     * The value of the table.
-     */
-    selectedKeys?: IdValue[];
-    /**
-     * The default selected keys of the table.
-     */
-    defaultSelectedKeys?: IdValue[];
-    /**
-     * The callback function when the selected keys is changed.
-     */
-    onRowSelectionChange?: BiConsumer<IdValue[], T[]>;
-    /**
-     * The callback function when the row is selected.
-     */
-    onRowSelect?: BiConsumer<IdValue, T>;
-    /**
-     * The callback function when the row is deselected.
-     */
-    onRowDeselect?: BiConsumer<IdValue, T>;
-    /**
-     * The callback function when the row is clicked.
-     * Only works when `enableRowClick` is true and `enableRowClickForSelection` is false.
-     */
-    onRowClick?: BiConsumer<T, number>;
-}
-/**
- * The props of VefTable component without pagination.
- */
-interface VefDefaultTableProps<T extends ObjectType = ObjectValue, P extends ObjectType = EmptyObject, R = T, C extends ObjectType = EmptyObject> extends VefBaseTableProps<T, C>, QueryConfig<T[], P, R[]> {
-    /**
-     * Whether to allow pagination.
-     */
-    paginated?: false;
-}
-/**
- * The props of VefTable component with pagination.
- */
-interface VefPaginatedTableProps<T extends ObjectType = ObjectValue, P extends ObjectType = EmptyObject, R = T, C extends ObjectType = EmptyObject> extends VefBaseTableProps<T, C>, QueryConfig<PaginationResult<T>, P & PaginationParams, PaginationResult<R>> {
-    /**
-     * Whether to allow pagination.
-     */
-    paginated: true;
-}
-export {};

package/types/vef-table/store.d.ts

@@ -1,29 +0,0 @@
-import type { Consumer, Size } from "@vef-framework/shared";
-import type { TableColumnConfig } from "./types";
-/**
- * The state of the table component.
- */
-export interface TableState {
-    /**
-     * The size of the table.
-     */
-    size: Size;
-    /**
-     * The callback function when the size is changed.
-     */
-    changeSize: Consumer<Size>;
-    /**
-     * The map of the column configs.
-     */
-    columnConfigMap: Map<string, TableColumnConfig>;
-}
-declare const TableStoreProvider: import("react").FC<import("@vef-framework/shared").StoreProviderProps<Pick<TableState, "size">>>, useTableStore: <State extends TableState, U>(selector: import("@vef-framework/shared").Mapper<State, U>) => U, useTableStoreApi: <State extends TableState>() => Omit<import("zustand").StoreApi<State>, "subscribe"> & {
-    subscribe: {
-        (listener: (selectedState: State, previousSelectedState: State) => void): () => void;
-        <U>(selector: (state: State) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
-            equalityFn?: ((a: U, b: U) => boolean) | undefined;
-            fireImmediately?: boolean;
-        } | undefined): () => void;
-    };
-};
-export { TableStoreProvider, useTableStore, useTableStoreApi, };

package/types/vef-table/types.d.ts

@@ -1,481 +0,0 @@
-import type { Align, ColorType, Consumer, Dimensions, EmptyObject, Expression, IdValue, LengthValue, LiteralUnion, Mapper, MaybeComputed, MaybeUndefined, NonEmptyArray, ObjectType, ObjectValue, Provider, QueryRefetchResult, StringKey, TriMapper } from "@vef-framework/shared";
-import type { ReactNode } from "react";
-/**
- * The fixed type of the column.
- */
-export type TableColumnFixed = "left" | "right";
-/**
- * The height type of the table.
- */
-export type TableHeight = LiteralUnion<"auto", LengthValue>;
-/**
- * The context of the table.
- */
-export interface TableContext<T extends ObjectType> {
-    /**
-     * Whether the table is fetching.
-     */
-    isFetching: boolean;
-    /**
-     * The refetch handler.
-     */
-    refetch: Provider<Promise<QueryRefetchResult<T>>>;
-    /**
-     * The selected keys of the table.
-     */
-    selectedKeys: IdValue[];
-    /**
-     * The selected records of the table.
-     */
-    selectedRecords: T[];
-}
-/**
- * The internal context of the table.
- * Note that the internal context is only used for the table component itself.
- */
-export interface InternalTableContext<T extends ObjectType, C extends ObjectType = EmptyObject> extends TableContext<T> {
-    /**
-     * The external context.
-     */
-    externalContext?: C;
-    /**
-     * The default column configs.
-     */
-    defaultColumnConfigMap: Map<string, TableColumnConfig>;
-    /**
-     * The map of the column configs.
-     */
-    columnConfigMap: Map<string, TableColumnConfig>;
-    /**
-     * The set column config handler.
-     */
-    setColumnConfigMap: Consumer<Map<string, TableColumnConfig> | Mapper<Map<string, TableColumnConfig>, Map<string, TableColumnConfig>>>;
-    /**
-     * Whether the column configs have changed.
-     */
-    columnConfigMapHasChanged: boolean;
-}
-/**
- * The context of the table row.
- */
-export interface TableRowContext<T extends ObjectType> extends TableContext<T> {
-    /**
-     * The index of the row.
-     */
-    rowIndex: number;
-    /**
-     * The record of the row.
-     */
-    record: T;
-}
-/**
- * The context of the operation button.
- */
-export type OperationButtonContext<T extends ObjectType, C extends ObjectType = EmptyObject> = TableRowContext<T> & C;
-/**
- * The context of the batch action button.
- */
-export type BatchActionButtonContext<T extends ObjectType, C extends ObjectType = EmptyObject> = TableContext<T> & C;
-/**
- * The config of the column.
- */
-export interface TableColumnConfig {
-    /**
-     * The title of the column.
-     */
-    title: ReactNode;
-    /**
-     * Whether to show the column.
-     */
-    show: boolean;
-    /**
-     * Whether to fix the column.
-     */
-    fixed: MaybeUndefined<TableColumnFixed>;
-    /**
-     * The order of the column.
-     */
-    order: number;
-    /**
-     * Whether the column can be configured.
-     */
-    configurable: boolean;
-}
-/**
- * The compute function of the column.
- */
-type ComputeFn<T extends ObjectType, V, E> = TriMapper<V, T, number, E>;
-/**
- * The computed type of the column.
- */
-export type TableComputedType<T extends ObjectType, V, E> = MaybeComputed<E, ComputeFn<T, V, E>>;
-/**
- * The schema of the table.
- */
-export type TableSchema<T extends ObjectType> = NonEmptyArray<TableColumn<T>>;
-/**
- * The column type.
- */
-export type TableColumn<T extends ObjectType = ObjectValue, K extends StringKey<T> = StringKey<T>> = TableColumnRender<T, K> | TableColumnText<T, K> | TableColumnNumber<T, K> | TableColumnBoolean<T, K> | TableColumnImage<T, K> | TableColumnCode<T, K> | TableColumnEnum<T, K> | TableColumnDataDictionary<T, K> | TableColumnId<T, K> | TableColumnIcon<T, K> | TableColumnFile<T, K> | TableColumnRichText<T, K> | TableColumnMarkdown<T, K>;
-/**
- * The base type of the column.
- */
-interface TableColumnBase<T extends ObjectType, K extends StringKey<T>> {
-    /**
-     * The name of the column.
-     */
-    name: K;
-    /**
-     * The title of the column.
-     */
-    title?: ReactNode;
-    /**
-     * Whether to show the column.
-     */
-    show?: boolean;
-    /**
-     * The width of the column.
-     */
-    width?: number;
-    /**
-     * The align of the column.
-     */
-    align?: Align;
-    /**
-     * Whether to fix the column.
-     */
-    fixed?: TableColumnFixed;
-    /**
-     * Whether to sort the column.
-     * When the value is a number, it means the priority of the column for multiple columns sorting.
-     */
-    sort?: boolean | number;
-    /**
-     * The summary of the column.
-     */
-    summary?: Mapper<readonly T[], ReactNode>;
-    /**
-     * The colSpan of the summary cell.
-     * @default 1
-     */
-    summaryColSpan?: number;
-    /**
-     * Whether the column can be configured.
-     * @default true
-     */
-    configurable?: boolean;
-    /**
-     * The dependent column names of the column.
-     * When the dependent columns have changed, the column will be updated.
-     */
-    dependentColumnNames?: K[];
-}
-/**
- * The render type of the column.
- */
-interface TableColumnRender<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "Render";
-    /**
-     * The render of the column.
-     */
-    render: TriMapper<T[K], T, number, ReactNode>;
-}
-/**
- * The text type of the column.
- */
-interface TableColumnText<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "Text";
-    /**
-     * The default value of the column.
-     */
-    defaultValue?: T[K] & string;
-    /**
-     * Whether to ellipsis the column.
-     */
-    ellipsis?: boolean;
-    /**
-     * The color of the column.
-     */
-    color?: TableComputedType<T, T[K] & string, ColorType>;
-    /**
-     * Whether to bold the column.
-     */
-    bold?: TableComputedType<T, T[K] & string, boolean>;
-    /**
-     * Whether to italic the column.
-     */
-    italic?: TableComputedType<T, T[K] & string, boolean>;
-    /**
-     * Whether to copy the column.
-     */
-    copyable?: boolean;
-    /**
-     * The prefix of the column.
-     */
-    prefix?: string;
-    /**
-     * The suffix of the column.
-     */
-    suffix?: string;
-    /**
-     * The formatter of the column.
-     */
-    formatter?: TriMapper<T[K] & string, T, number, string> | Expression;
-}
-/**
- * The number type of the column.
- */
-interface TableColumnNumber<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "Number";
-    /**
-     * The default value of the column.
-     */
-    defaultValue?: T[K] & number;
-    /**
-     * The color of the column.
-     */
-    color?: TableComputedType<T, T[K] & number, ColorType>;
-    /**
-     * Whether to bold the column.
-     */
-    bold?: TableComputedType<T, T[K] & number, boolean>;
-    /**
-     * Whether to italic the column.
-     */
-    italic?: TableComputedType<T, T[K] & number, boolean>;
-    /**
-     * The prefix of the column.
-     */
-    prefix?: string;
-    /**
-     * The suffix of the column.
-     */
-    suffix?: string;
-    /**
-     * The formatter of the column.
-     */
-    formatter?: TriMapper<T[K] & number, T, number, string> | Expression;
-}
-/**
- * The boolean type of the column.
- */
-interface TableColumnBoolean<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "Boolean";
-    /**
-     * The default value of the column.
-     */
-    defaultValue?: T[K] & boolean;
-    /**
-     * The color of the column.
-     * The key of the color mapping record can be `true`, `false` or `*` to represent all remaining values.
-     */
-    color?: TableComputedType<T, T[K] & boolean, ColorType | Record<"true" | "false" | "*", ColorType>>;
-    /**
-     * Whether to bold the column.
-     */
-    bold?: TableComputedType<T, T[K] & boolean, boolean>;
-    /**
-     * Whether to italic the column.
-     */
-    italic?: TableComputedType<T, T[K] & boolean, boolean>;
-    /**
-     * The true text of the column.
-     */
-    trueText?: string;
-    /**
-     * The false text of the column.
-     */
-    falseText?: string;
-}
-/**
- * The image type of the column.
- */
-interface TableColumnImage<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "Image";
-    /**
-     * The default value of the column.
-     */
-    defaultValue?: T[K] & string;
-    /**
-     * The dimensions of the image.
-     */
-    dimensions?: Dimensions;
-}
-/**
- * The code type of the column.
- */
-interface TableColumnCode<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "Code";
-    /**
-     * The default value of the column.
-     */
-    defaultValue?: T[K] & string;
-    /**
-     * The language of the code.
-     */
-    language?: "javascript" | "typescript" | "css" | "json" | "java" | "groovy" | "xml" | "bash" | "plaintext" | "shell" | "markdown" | "yaml" | "sql" | "pgsql";
-}
-/**
- * The enum type of the column.
- */
-interface TableColumnEnum<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "Enum";
-    /**
-     * The default value of the column.
-     */
-    defaultValue?: string;
-    /**
-     * Whether to ellipsis the column.
-     */
-    ellipsis?: boolean;
-    /**
-     * Whether to show the enum name as a tag.
-     *
-     * @default true
-     */
-    showAsTag?: boolean;
-    /**
-     * The color mapping of the enum.
-     * The key of the color mapping record can be a specific value or `*` to represent all remaining values.
-     */
-    color?: TableComputedType<T, T[K] & string, ColorType | Record<T[K] & string | "*", ColorType>>;
-    /**
-     * Whether to bold the column.
-     * Only works when `showAsTag` is `false`.
-     */
-    bold?: TableComputedType<T, T[K] & string, boolean>;
-    /**
-     * Whether to italic the column.
-     * Only works when `showAsTag` is `false`.
-     */
-    italic?: TableComputedType<T, T[K] & string, boolean>;
-}
-/**
- * The data dictionary type of the column.
- */
-interface TableColumnDataDictionary<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "DataDictionary";
-    /**
-     * The default value of the column.
-     */
-    defaultValue?: string;
-    /**
-     * Whether to ellipsis the column.
-     */
-    ellipsis?: boolean;
-    /**
-     * The color mapping of the data dictionary.
-     * The key of the color mapping record can be a specific value or `*` to represent all remaining values.
-     */
-    color?: TableComputedType<T, T[K] & string, ColorType | Record<T[K] & string | "*", ColorType>>;
-    /**
-     * Whether to bold the column.
-     */
-    bold?: TableComputedType<T, T[K] & string, boolean>;
-    /**
-     * Whether to italic the column.
-     */
-    italic?: TableComputedType<T, T[K] & string, boolean>;
-}
-/**
- * The id type of the column.
- */
-interface TableColumnId<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "Id";
-    /**
-     * The default value of the column.
-     */
-    defaultValue?: string;
-    /**
-     * Whether to ellipsis the column.
-     */
-    ellipsis?: boolean;
-    /**
-     * The color of the column.
-     */
-    color?: TableComputedType<T, T[K] & string, ColorType>;
-    /**
-     * Whether to bold the column.
-     */
-    bold?: TableComputedType<T, T[K] & string, boolean>;
-    /**
-     * Whether to italic the column.
-     */
-    italic?: TableComputedType<T, T[K] & string, boolean>;
-}
-/**
- * The icon type of the column.
- */
-interface TableColumnIcon<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "Icon";
-    /**
-     * The default value of the column.
-     */
-    defaultValue?: T[K] & string;
-}
-/**
- * The file type of the column.
- */
-interface TableColumnFile<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "File";
-}
-/**
- * The rich text type of the column.
- */
-interface TableColumnRichText<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "RichText";
-    /**
-     * The default value of the column.
-     */
-    defaultValue?: T[K] & string;
-}
-/**
- * The markdown type of the column.
- */
-interface TableColumnMarkdown<T extends ObjectType, K extends StringKey<T>> extends TableColumnBase<T, K> {
-    /**
-     * The type of the column.
-     */
-    type: "Markdown";
-    /**
-     * The default value of the column.
-     */
-    defaultValue?: T[K] & string;
-}
-export {};

package/types/vef-tabs/index.d.ts

@@ -1,4 +0,0 @@
-import type { VefTabsProps } from "./props";
-declare function VefTabs({ size, ...props }: VefTabsProps): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { VefTabsProps };
-export default VefTabs;

package/types/vef-tabs/props.d.ts

@@ -1,11 +0,0 @@
-import type { BasicSize, Except } from "@vef-framework/shared";
-import type { TabsProps } from "antd";
-/**
- * The props of VefTabs component.
- */
-export interface VefTabsProps extends Except<TabsProps, "animated" | "children" | "size" | "indicatorSize" | "prefixCls" | "rootClassName"> {
-    /**
-     * The size of the tabs.
-     */
-    size?: BasicSize;
-}

package/types/vef-tag/index.d.ts

@@ -1,4 +0,0 @@
-import type { VefTagProps } from "./props";
-declare function VefTag({ closable, color, inverse, ...restProps }: VefTagProps): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { VefTagProps };
-export default VefTag;

package/types/vef-tag/props.d.ts

@@ -1,19 +0,0 @@
-import type { ColorType, Except } from "@vef-framework/shared";
-import type { TagProps } from "antd";
-/**
- * The props of VefTag component.
- */
-export interface VefTagProps extends Except<TagProps, "closable" | "closeIcon" | "visible" | "color" | "prefixCls" | "rootClassName"> {
-    /**
-     * Whether to allow the tag to be closed.
-     */
-    closable?: boolean;
-    /**
-     * The color of the tag.
-     */
-    color?: ColorType;
-    /**
-     * Whether to invert the color of the tag.
-     */
-    inverse?: boolean;
-}