@vef-framework/components 1.0.134 → 2.0.0

package/types/vef-modal/context.d.ts

@@ -1,27 +0,0 @@
-import type { Consumer } from "@vef-framework/shared";
-/**
- * The context of the modal.
- */
-export interface ModalContext {
-    /**
-     * Whether the modal is disabled.
-     */
-    isDisabled: boolean;
-    /**
-     * Sets the disabled state of the modal.
-     */
-    setIsDisabled: Consumer<boolean>;
-    /**
-     * Whether the modal is fully opened.
-     */
-    isFullyOpened: boolean;
-    /**
-     * Whether the modal is fully closed.
-     */
-    isFullyClosed: boolean;
-}
-declare const ModalContextProvider: import("react").ComponentType<{
-    value: ModalContext;
-    children: import("react").ReactNode;
-}>, useModalContext: import("@vef-framework/shared").Provider<ModalContext>, useModalContextSelector: <R>(selector: import("@vef-framework/shared").Mapper<ModalContext, R>) => R;
-export { ModalContextProvider, useModalContext, useModalContextSelector };

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

@@ -1,6 +0,0 @@
-import type { VefModalProps } from "./props";
-declare function VefModalBase({ title, open, closable, closeOnEscPress, closeOnMaskClick, destroyOnClose, showCancelButton, cancelButtonText, okButtonText, actions, width, loading, cancelOnClose, onClose, onOk, onCancel, onAfterOpen, onAfterClose, children, }: VefModalProps): import("@emotion/react/jsx-runtime").JSX.Element;
-declare const VefModal: import("react").MemoExoticComponent<typeof VefModalBase>;
-export type { VefModalProps };
-export { default as VefModalActionButtonWrapper, type VefModalActionButtonWrapperProps } from "./components/action-button-wrapper";
-export default VefModal;

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

@@ -1,87 +0,0 @@
-import type { ChildrenProps, Consumer, LengthValue, LiteralUnion, Mapper, MaybePromise, Provider } from "@vef-framework/shared";
-import type { ReactElement, ReactNode } from "react";
-/**
- * The props of the VefModal component.
- */
-export interface VefModalProps extends Required<ChildrenProps> {
-    /**
-     * The title of the modal.
-     */
-    title: ReactNode;
-    /**
-     * Whether the modal is open.
-     */
-    open?: boolean;
-    /**
-     * Whether the modal is closable.
-     * @default true
-     */
-    closable?: boolean;
-    /**
-     * Whether the modal is closed when the mask is clicked.
-     * @default false
-     */
-    closeOnMaskClick?: boolean;
-    /**
-     * Whether the modal is closed when the escape key is pressed.
-     * @default true
-     */
-    closeOnEscPress?: boolean;
-    /**
-     * Whether the modal is destroyed when it is closed.
-     * @default true
-     */
-    destroyOnClose?: boolean;
-    /**
-     * Whether the modal is canceled when it is closed.
-     * @default true
-     */
-    cancelOnClose?: boolean;
-    /**
-     * The width of the modal.
-     */
-    width?: LiteralUnion<"small" | "medium" | "narrow" | "half" | "wide" | "full", LengthValue>;
-    /**
-     * Whether the modal is loading.
-     */
-    loading?: boolean;
-    /**
-     * Whether to show the cancel button.
-     * @default true
-     */
-    showCancelButton?: boolean;
-    /**
-     * The text of the cancel button.
-     * @default "取消"
-     */
-    cancelButtonText?: string;
-    /**
-     * The text of the ok button.
-     * @default "提交"
-     */
-    okButtonText?: string;
-    /**
-     * The actions of the modal.
-     */
-    actions?: ReactNode | Mapper<readonly [ReactElement, ReactElement], ReactNode>;
-    /**
-     * The callback function when the ok button is clicked.
-     */
-    onOk?: Provider<MaybePromise<void>>;
-    /**
-     * The callback function when the modal is closed.
-     */
-    onClose?: Consumer<void>;
-    /**
-     * The callback function when the cancel button is clicked.
-     */
-    onCancel?: Provider<void>;
-    /**
-     * The callback function when the modal is opened.
-     */
-    onAfterOpen?: Consumer<void>;
-    /**
-     * The callback function when the modal is closed.
-     */
-    onAfterClose?: Consumer<void>;
-}

package/types/vef-not-found/index.d.ts

@@ -1,4 +0,0 @@
-import type { VefNotFoundProps } from "./props";
-declare function VefNotFound({ uri, title, onNavigateHome, }: VefNotFoundProps): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { VefNotFoundProps };
-export default VefNotFound;

package/types/vef-not-found/not-found-icon.d.ts

@@ -1,4 +0,0 @@
-import type { SVGProps } from "react";
-declare function SvgNotFoundIcon(props: SVGProps<SVGSVGElement>): import("@emotion/react/jsx-runtime").JSX.Element;
-declare const Memo: import("react").MemoExoticComponent<typeof SvgNotFoundIcon>;
-export default Memo;

package/types/vef-not-found/props.d.ts

@@ -1,18 +0,0 @@
-import type { Handler } from "@vef-framework/shared";
-/**
- * The props of the not found component.
- */
-export interface VefNotFoundProps {
-    /**
-     * The not found uri.
-     */
-    uri?: string;
-    /**
-     * The title of the not found.
-     */
-    title?: string;
-    /**
-     * The handler for navigating to the home page.
-     */
-    onNavigateHome?: Handler;
-}

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

@@ -1,4 +0,0 @@
-import type { VefPageProps } from "./props";
-declare function VefPage({ title, actions, header, footer, scrollable, children, }: VefPageProps): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { VefPageProps };
-export default VefPage;

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

@@ -1,29 +0,0 @@
-import type { ChildrenProps } from "@vef-framework/shared";
-import type { ReactNode } from "react";
-/**
- * The props of VefPage component.
- */
-export interface VefPageProps extends Required<ChildrenProps> {
-    /**
-     * The title of the page.
-     */
-    title?: ReactNode;
-    /**
-     * The actions of the page.
-     */
-    actions?: ReactNode;
-    /**
-     * The header of the page.
-     * Note: It will override the title and actions content.
-     */
-    header?: false | ReactNode;
-    /**
-     * The footer of the page.
-     */
-    footer?: ReactNode;
-    /**
-     * Whether the page body is scrollable.
-     * @default false
-     */
-    scrollable?: boolean;
-}

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

@@ -1,5 +0,0 @@
-import type { VefPaginationProps } from "./props";
-declare function VefPaginationBase({ defaultPageNumber, defaultPageSize, pageNumber, pageSize, total, size, pageSizeOptions, allowChangePageSize, showTotal, compact, allowQuickJump, onChange, ...restProps }: VefPaginationProps): import("@emotion/react/jsx-runtime").JSX.Element;
-declare const VefPagination: import("react").MemoExoticComponent<typeof VefPaginationBase>;
-export type { VefPaginationProps };
-export default VefPagination;

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

@@ -1,59 +0,0 @@
-import type { BasicSize, BiConsumer } from "@vef-framework/shared";
-import type { PaginationProps } from "antd";
-/**
- * The default options of the number of items per page.
- */
-export declare const defaultPageSizeOptions: number[];
-/**
- * The props for the VefPagination component.
- */
-export interface VefPaginationProps extends Pick<PaginationProps, "disabled"> {
-    /**
-     * The default page number.
-     */
-    defaultPageNumber?: number;
-    /**
-     * The default number of items per page.
-     */
-    defaultPageSize?: number;
-    /**
-     * The current page number.
-     */
-    pageNumber?: number;
-    /**
-     * The number of items per page.
-     */
-    pageSize?: number;
-    /**
-     * The total number of items.
-     */
-    total?: number;
-    /**
-     * The size of the pagination.
-     */
-    size?: Exclude<BasicSize, "large">;
-    /**
-     * The options of the number of items per page.
-     */
-    pageSizeOptions?: number[];
-    /**
-     * Whether to allow changing the number of items per page.
-     */
-    allowChangePageSize?: boolean;
-    /**
-     * Whether to allow quick jumping to pages.
-     */
-    allowQuickJump?: boolean;
-    /**
-     * Whether to show the total number of items.
-     */
-    showTotal?: boolean;
-    /**
-     * Whether to show the pagination in compact mode.
-     */
-    compact?: boolean;
-    /**
-     * The callback function when the page number or the number of items per page changes.
-     */
-    onChange?: BiConsumer<number, number>;
-}

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

@@ -1,4 +0,0 @@
-import type { VefParagraphProps } from "./props";
-declare function VefParagraph({ variant, color, bold, ellipsis, ellipsisRows, expandable, defaultExpanded, expanded, copyable, copiedText, onCopy, onExpand, ...restProps }: VefParagraphProps): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { VefParagraphProps };
-export default VefParagraph;

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

@@ -1,54 +0,0 @@
-import type { ColorType, Consumer, Except } from "@vef-framework/shared";
-import type { CopyConfig } from "antd/es/typography/Base";
-import type { ParagraphProps } from "antd/es/typography/Paragraph";
-/**
- * The props for the VefParagraph component.
- */
-export interface VefParagraphProps extends Except<ParagraphProps, "type" | "delete" | "ellipsis" | "color" | "strong" | "editable" | "keyboard" | "mark" | "code" | "underline" | "onCopy"> {
-    /**
-     * The variant of the text.
-     */
-    variant?: "mark" | "underline" | "strikethrough";
-    /**
-     * The color of the text.
-     */
-    color?: "secondary" | ColorType;
-    /**
-     * Whether to display the text in bold.
-     */
-    bold?: boolean;
-    /**
-     * Whether to ellipsis text when it is too long.
-     */
-    ellipsis?: boolean;
-    /**
-     * The number of rows to display when the text is ellipsis.
-     */
-    ellipsisRows?: number;
-    /**
-     * Whether to allow the text to be expanded.
-     */
-    expandable?: boolean;
-    /**
-     * Whether the text is expanded by default.
-     */
-    defaultExpanded?: boolean;
-    /**
-     * Whether the text is expanded.
-     */
-    expanded?: boolean;
-    /**
-     * The text to be copied.
-     *
-     * @default The same as the children.
-     */
-    copiedText?: string;
-    /**
-     * The callback function when the text is copied.
-     */
-    onCopy?: NonNullable<CopyConfig["onCopy"]>;
-    /**
-     * The callback function when the text is expanded.
-     */
-    onExpand?: Consumer<boolean>;
-}

package/types/vef-password/hooks/use-password-instance.d.ts

@@ -1,13 +0,0 @@
-import type { GetRef } from "antd";
-import type Password from "antd/es/input/Password";
-import type { ForwardedRef, RefObject } from "react";
-import type { VefPasswordInstance } from "../props";
-type PasswordRef = GetRef<typeof Password>;
-/**
- * The hook to get the instance of the VefPassword component.
- *
- * @param ref - The forwarded ref.
- * @returns The ref object.
- */
-export declare function usePasswordInstance(ref: ForwardedRef<VefPasswordInstance>): RefObject<PasswordRef>;
-export {};

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

@@ -1,4 +0,0 @@
-import type { VefPasswordInstance, VefPasswordProps } from "./props";
-declare const VefPassword: import("react").ForwardRefExoticComponent<VefPasswordProps & import("react").RefAttributes<VefPasswordInstance>>;
-export type { VefPasswordInstance, VefPasswordProps };
-export default VefPassword;

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

@@ -1,58 +0,0 @@
-import type { BasicSize, Consumer, Handler, MaybeNull } from "@vef-framework/shared";
-import type { PasswordProps } from "antd/es/input";
-/**
- * The instance of the VefPassword component.
- */
-export interface VefPasswordInstance {
-    /**
-     * The blur handler.
-     */
-    blur: Handler;
-    /**
-     * The focus handler.
-     */
-    focus: Handler;
-}
-/**
- * The props of the VefPassword component.
- */
-export interface VefPasswordProps extends Pick<PasswordProps, "className" | "style" | "placeholder" | "disabled" | "maxLength" | "prefix" | "status" | "variant" | "onClear"> {
-    /**
-     * The default value of the password.
-     */
-    defaultValue?: string;
-    /**
-     * The value of the password.
-     */
-    value?: MaybeNull<string>;
-    /**
-     * The size of the password.
-     */
-    size?: BasicSize;
-    /**
-     * Whether to allow clear.
-     * @default false
-     */
-    clearable?: boolean;
-    /**
-     * Whether to show count.
-     * @default false
-     */
-    showCount?: boolean;
-    /**
-     * The change handler.
-     */
-    onChange?: Consumer<MaybeNull<string>>;
-    /**
-     * The enter key press handler.
-     */
-    onEnterKeyPress?: Consumer<MaybeNull<string>>;
-    /**
-     * The blur handler.
-     */
-    onBlur?: Consumer<MaybeNull<string>>;
-    /**
-     * The focus handler.
-     */
-    onFocus?: Consumer<MaybeNull<string>>;
-}

package/types/vef-pie-chart/index.d.ts

@@ -1,6 +0,0 @@
-import type { StringKey } from "@vef-framework/shared";
-import type { VefPieChartProps } from "./props";
-declare function VefPieChartBase<T extends object, X extends StringKey<T> = StringKey<T>, N extends StringKey<T> = StringKey<T>>({ config, data, dataKey, nameKey, valueFormatter, innerRadius, }: VefPieChartProps<T, X, N>): import("@emotion/react/jsx-runtime").JSX.Element;
-declare const VefPieChart: typeof VefPieChartBase;
-export type { VefPieChartProps };
-export default VefPieChart;

package/types/vef-pie-chart/props.d.ts

@@ -1,16 +0,0 @@
-import type { StringKey } from "@vef-framework/shared";
-import type { BaseChartProps } from "../internal";
-/**
- * The props of the VefPieChart component.
- */
-export interface VefPieChartProps<T extends object, X extends StringKey<T> = StringKey<T>, N extends StringKey<T> = StringKey<T>> extends BaseChartProps<T, X> {
-    /**
-     * The key of the name of the data.
-     */
-    nameKey: N;
-    /**
-     * The inner radius of the pie chart.
-     * @default 60
-     */
-    innerRadius?: number;
-}

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

@@ -1,4 +0,0 @@
-import type { VefPopconfirmProps } from "./props";
-declare const VefPopconfirm: import("react").ForwardRefExoticComponent<VefPopconfirmProps & import("react").RefAttributes<HTMLElement>>;
-export type { VefPopconfirmProps as VefPopConfirmProps };
-export default VefPopconfirm;

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

@@ -1,41 +0,0 @@
-import type { Consumer, Handler, MaybePromise, Provider } from "@vef-framework/shared";
-import type { PopconfirmProps } from "antd";
-import type { ReactNode } from "react";
-/**
- * The props of the VefPopconfirm component.
- */
-export interface VefPopconfirmProps extends Pick<PopconfirmProps, "disabled" | "okText" | "cancelText" | "children"> {
-    /**
-     * The title of the popconfirm.
-     */
-    title?: ReactNode;
-    /**
-     * The content of the popconfirm.
-     */
-    content: ReactNode;
-    /**
-     * Whether to allow cancel.
-     * @default true
-     */
-    cancelable?: boolean;
-    /**
-     * The default opened state of the popconfirm.
-     */
-    defaultOpened?: boolean;
-    /**
-     * Whether the popconfirm is opened.
-     */
-    opened?: boolean;
-    /**
-     * The handler when the user clicks the OK button.
-     */
-    onOk?: Provider<MaybePromise<void>>;
-    /**
-     * The handler when the user clicks the Cancel button.
-     */
-    onCancel?: Handler;
-    /**
-     * The callback function when the popconfirm is opened or closed.
-     */
-    onOpenedChange?: Consumer<boolean>;
-}

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

@@ -1,4 +0,0 @@
-import type { VefPopoverProps } from "./props";
-declare const VefPopover: import("react").ForwardRefExoticComponent<VefPopoverProps & import("react").RefAttributes<HTMLElement>>;
-export type { VefPopoverProps };
-export default VefPopover;

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

@@ -1,46 +0,0 @@
-import type { Consumer } from "@vef-framework/shared";
-import type { PopoverProps } from "antd";
-import type { CSSProperties, ReactNode } from "react";
-/**
- * The trigger mode of the popover.
- */
-export type PopoverTrigger = "hover" | "click" | "focus";
-/**
- * The props of the VefPopover component.
- */
-export interface VefPopoverProps extends Pick<PopoverProps, "placement" | "children" | "className" | "style"> {
-    /**
-     * The title of the popover.
-     */
-    title?: ReactNode;
-    /**
-     * The content of the popover.
-     */
-    content: ReactNode;
-    /**
-     * The style of the popover content.
-     */
-    contentStyle?: CSSProperties;
-    /**
-     * The trigger mode of the popover.
-     * @default "click"
-     */
-    trigger?: PopoverTrigger;
-    /**
-     * Whether to show the arrow of the popover.
-     * @default false
-     */
-    arrow?: boolean;
-    /**
-     * The default opened state of the popover.
-     */
-    defaultOpened?: boolean;
-    /**
-     * Whether the popover is opened.
-     */
-    opened?: boolean;
-    /**
-     * The callback function when the popover is opened.
-     */
-    onOpenedChange?: Consumer<boolean>;
-}

package/types/vef-radio/hooks/use-data-options.d.ts

@@ -1,10 +0,0 @@
-import type { DataOption, EmptyObject, Except, NormalizedDataOption, ObjectType, PureDataOption } from "@vef-framework/shared";
-import type { VefRadioProps } from "../props";
-/**
- * The hook to use data options.
- */
-export declare function useDataOptions<T extends DataOption<T> = PureDataOption, P extends ObjectType = EmptyObject, R = T[]>({ value, onChange, ...rest }: Except<VefRadioProps<T, P, R>, "disabled" | "block" | "variant" | "buttonVariant" | "buttonSize">): {
-    optionsMap: Map<string, NormalizedDataOption<T>>;
-    normalizedOptions: NormalizedDataOption<T>[] | NormalizedDataOption<T>[];
-    isLoading: boolean;
-};

package/types/vef-radio/hooks/use-radio-instance.d.ts

@@ -1,11 +0,0 @@
-import type { DataOption, NormalizedDataOption } from "@vef-framework/shared";
-import type { ForwardedRef } from "react";
-import type { VefRadioInstance } from "../props";
-/**
- * The hook to get the instance of the radio.
- *
- * @param ref - The forwarded ref.
- * @param dataOptions - The data options.
- * @returns The ref of the radio.
- */
-export declare function useRadioInstance<T extends DataOption<T>>(ref: ForwardedRef<VefRadioInstance<T>>, dataOptions: Array<NormalizedDataOption<T>>): import("react").RefObject<HTMLDivElement>;

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

@@ -1,6 +0,0 @@
-import type { DataOption, EmptyObject, ObjectType } from "@vef-framework/shared";
-import type { FC, ReactNode, RefAttributes } from "react";
-import type { VefRadioInstance, VefRadioProps } from "./props";
-declare const VefRadio: (<T extends DataOption<T>, P extends ObjectType = EmptyObject, R = T[]>(props: VefRadioProps<T, P, R> & RefAttributes<VefRadioInstance<T>>) => ReactNode) & Pick<FC, "displayName">;
-export type { VefRadioInstance, VefRadioProps };
-export default VefRadio;

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

@@ -1,58 +0,0 @@
-import type { BasicSize, BiConsumer, DataOption, DataOptionConfig, EmptyObject, Handler, IdValue, NormalizedDataOption, ObjectType, Provider, PureDataOption, QueryConfig, StringKey } from "@vef-framework/shared";
-import type { RadioGroupProps } from "antd";
-/**
- * The instance of the VefRadio component.
- */
-export interface VefRadioInstance<T extends DataOption<T>> {
-    /**
-     * The blur method of the radio.
-     */
-    blur: Handler;
-    /**
-     * The focus method of the radio.
-     */
-    focus: Handler;
-    /**
-     * Get the data options of the radio.
-     */
-    getDataOptions: Provider<Array<NormalizedDataOption<T>>>;
-}
-/**
- * The variant of the radio.
- */
-export type RadioVariant = "default" | "button";
-/**
- * The button variant of the radio.
- */
-export type RadioButtonVariant = "solid" | "outline";
-/**
- * The props of the VefRadio component.
- */
-export interface VefRadioProps<T extends DataOption<T> = PureDataOption, P extends ObjectType = EmptyObject, R = T> extends QueryConfig<T[], P, R[]>, DataOptionConfig<StringKey<T>>, Pick<RadioGroupProps, "disabled" | "block"> {
-    /**
-     * The default value of the radio.
-     */
-    defaultValue?: IdValue;
-    /**
-     * The value of the radio.
-     */
-    value?: IdValue;
-    /**
-     * The variant of the radio.
-     */
-    variant?: RadioVariant;
-    /**
-     * The button variant of the radio.
-     * Only works when the variant is `button`.
-     */
-    buttonVariant?: RadioButtonVariant;
-    /**
-     * The size of the button.
-     * Only works when the variant is `button`.
-     */
-    buttonSize?: BasicSize;
-    /**
-     * The change handler of the radio.
-     */
-    onChange?: BiConsumer<IdValue, NormalizedDataOption<T>>;
-}

package/types/vef-rate/hooks/use-rate-instance.d.ts

@@ -1,12 +0,0 @@
-import type { GetRef, Rate } from "antd";
-import type { ForwardedRef, RefObject } from "react";
-import type { VefRateInstance } from "../props";
-type RateRef = GetRef<typeof Rate>;
-/**
- * The hook to use rate instance.
- *
- * @param ref - The forwarded ref.
- * @returns The ref object.
- */
-export declare function useRateInstance(ref: ForwardedRef<VefRateInstance>): RefObject<RateRef>;
-export {};

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

@@ -1,4 +0,0 @@
-import type { VefRateInstance, VefRateProps } from "./props";
-declare const VefRate: import("react").ForwardRefExoticComponent<VefRateProps & import("react").RefAttributes<VefRateInstance>>;
-export type { VefRateInstance, VefRateProps };
-export default VefRate;

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

@@ -1,25 +0,0 @@
-import type { Handler, Mapper } from "@vef-framework/shared";
-import type { RateProps } from "antd";
-import type { ReactNode } from "react";
-/**
- * The instance of the VefRate component.
- */
-export interface VefRateInstance {
-    /**
-     * The blur handler of the rate.
-     */
-    blur?: Handler;
-    /**
-     * The focus handler of the rate.
-     */
-    focus?: Handler;
-}
-/**
- * The props of the VefRate component.
- */
-export interface VefRateProps extends Pick<RateProps, "defaultValue" | "value" | "disabled" | "allowClear" | "allowHalf" | "count" | "onBlur" | "onFocus" | "onChange" | "onHoverChange"> {
-    /**
-     * The character of the rate.
-     */
-    character?: ReactNode | Mapper<number, ReactNode>;
-}

package/types/vef-responsive-container/index.d.ts

@@ -1,4 +0,0 @@
-import type { VefResponsiveContainerProps } from "./props";
-declare const VefResponsiveContainer: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Omit<VefResponsiveContainerProps, "ref"> & import("react").RefAttributes<HTMLDivElement>>>;
-export type { VefResponsiveContainerProps };
-export default VefResponsiveContainer;