@iimm/formily-mui/dist/esm/hooks/useFormilyFieldProps/index.d.ts

form field components based on @mui/material and @formily/react

import type { ReactNode } from "react";
import type { ICommonProps } from "../../types";
import type { CommonLayoutProps } from "../../layout/FormLayout";
interface IUseFormilyFieldConfig {
    /** 是否从Field获取label(title)配置 */
    label?: boolean;
    /** 是否从Field获取required配置 */
    required?: boolean;
    /** 是否从Field获取error配置 */
    error?: boolean;
    /** 是否从Field获取tooltip(description配置 */
    tooltip?: boolean;
    /** 是否从Field获取optionos(dataSource)配置 */
    options?: boolean;
    /** 是否从Field获取display配置 */
    display?: boolean;
    /** 是否从Field获取defaultValue(initialValue)配置 */
    defaultValue?: boolean;
    /** 是否从Field获取disabled配置 */
    disabled?: boolean;
    /** 是否从Field获取readOnly配置 */
    readOnly?: boolean;
    /** 是否从Field获取feedbackText配置 */
    feedbackText?: boolean;
    /** 是否从Field获取feedbackStatus配置 */
    feedbackStatus?: boolean;
    /** 是否从Field获取fullWidth配置 */
    fullWidth?: boolean;
    /** 是否从FormLayout获取labelPosition配置*/
    labelPosition?: boolean;
    /** 是否从FormLayout获取labelAlign配置 */
    labelAlign?: boolean;
    /** 是否从FormLayout获取labelWidth配置*/
    labelWidth?: boolean;
    /** 是否从FormLayout获取labelWrap配置 */
    labelWrap?: boolean;
    /** 是否从FormLayout获取wrapperAlign配置 */
    wrapperAlign?: boolean;
    /** 是否从FormLayout获取wrapperWidth配置*/
    wrapperWidth?: boolean;
    /** 是否从FormLayout获取wrapperWrap配置 */
    wrapperWrap?: boolean;
    /** 是否从FormLayout获取colon配置 */
    colon?: boolean;
    /** 是否从FormLayout获取tooltipIcon配置 */
    tooltipIcon?: boolean;
    /** 是否从FormLayout获取tooltipLayout配置*/
    tooltipLayout?: boolean;
    /** 是否从FormLayout获取showFeedback配置 */
    showFeedback?: boolean;
    /** 是否从FormLayout获取feedbackLayout配置*/
    feedbackLayout?: boolean;
    /** 是否从FormLayout获取配置*/
    noFormLayout?: boolean;
    /** 是否从FormLayout获取showInnerLabel配置*/
    showInnerLabel?: boolean;
    /** 是否从FormLayout获取keepFeedbackSpace配置
     * @default true
     */
    keepFeedbackSpace?: boolean;
}
interface IProps extends ICommonProps, CommonLayoutProps {
    label?: ReactNode;
    tooltip?: ReactNode;
    defaultValue?: any;
    disabled?: boolean;
    readOnly?: boolean;
    error?: boolean;
    required?: boolean;
    options?: any;
    display?: "visible" | "hidden" | "none" | string;
    feedbackStatus?: "error" | "warning" | "success" | "pending" | string;
    feedbackText?: ReactNode;
    /** 不从FormLayout获取信息 */
    noFormLayout?: boolean;
    withFormItem?: boolean;
}
/** 用来处理FormItem及字段项 props的hooks可以从FormLayout或Field 获取布局或label，error等信息*/
export declare function useFormilyFieldProps<T extends IProps = IProps>(props: T, extraConfig?: IUseFormilyFieldConfig): T;
export {};