@shopware-ag/meteor-component-library/dist/common/MtBaseField.d.ts

The meteor component library is a Vue component library developed by Shopware. It is based on the [Meteor Design System](https://shopware.design/).

declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
    /**
     * Determines if the field is disabled.
     */
    disabled: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * Determines if the field is required.
     */
    required: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * Toggles the inheritance visualization.
     */
    isInherited: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * Determines if the field is inheritable.
     */
    isInheritanceField: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * Determines the active state of the inheritance toggle.
     */
    disableInheritanceToggle: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * Toggles the copy function of the text field.
     */
    copyable: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * If set to true the tooltip will change on successful copy.
     */
    copyableTooltip: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    hasFocus: {
        type: BooleanConstructor;
        required: true;
    };
    /**
     * A text that helps the user to understand what this field does.
     */
    helpText: {
        type: StringConstructor;
        required: false;
        default: string;
    };
    copyableText: {
        type: StringConstructor;
        required: false;
        default: string;
    };
    /**
     * The size of the text field.
     *
     * @values small, default
     */
    size: {
        type: StringConstructor;
        required: false;
        default: string;
        validator(value: string): boolean;
    };
    /**
     * @ignore
     */
    name: {
        type: StringConstructor;
        required: false;
        default: null;
    };
}>, {
    hasSlotContent: (slot: import('vue').Slot | undefined | null, props?: any) => boolean;
    future: {
        removeCardWidth: boolean;
        removeDefaultMargin: boolean;
    };
}, {
    id: string | undefined;
}, {
    identification(): string;
    showLabel(): boolean;
    mtFieldLabelClasses(): {
        "is--required": boolean;
    };
    mtBlockSize(): string;
    hasError(): boolean;
}, {}, import('vue').DefineComponent<import('vue').ExtractPropTypes<{
    validation: {
        type: (BooleanConstructor | ObjectConstructor | StringConstructor | ArrayConstructor)[];
        required: false;
        default: null;
    };
}>, {}, {}, {
    isValid(): boolean;
}, {
    validate(value: unknown): boolean;
    validateRule(value: unknown, rule: string): boolean;
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
    validation: {
        type: (BooleanConstructor | ObjectConstructor | StringConstructor | ArrayConstructor)[];
        required: false;
        default: null;
    };
}>> & Readonly<{}>, {
    validation: string | boolean | Record<string, any> | unknown[];
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any> | import('vue').DefineComponent<import('vue').ExtractPropTypes<{
    mapInheritance: {
        type: ObjectConstructor;
        required: false;
        default: null;
    };
    name: {
        type: StringConstructor;
        required: false;
        default: null;
    };
}>, {}, {}, {
    formFieldName(): string | undefined;
}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
    mapInheritance: {
        type: ObjectConstructor;
        required: false;
        default: null;
    };
    name: {
        type: StringConstructor;
        required: false;
        default: null;
    };
}>> & Readonly<{}>, {
    name: string;
    mapInheritance: Record<string, any>;
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
    /**
     * Determines if the field is disabled.
     */
    disabled: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * Determines if the field is required.
     */
    required: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * Toggles the inheritance visualization.
     */
    isInherited: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * Determines if the field is inheritable.
     */
    isInheritanceField: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * Determines the active state of the inheritance toggle.
     */
    disableInheritanceToggle: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * Toggles the copy function of the text field.
     */
    copyable: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    /**
     * If set to true the tooltip will change on successful copy.
     */
    copyableTooltip: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
    hasFocus: {
        type: BooleanConstructor;
        required: true;
    };
    /**
     * A text that helps the user to understand what this field does.
     */
    helpText: {
        type: StringConstructor;
        required: false;
        default: string;
    };
    copyableText: {
        type: StringConstructor;
        required: false;
        default: string;
    };
    /**
     * The size of the text field.
     *
     * @values small, default
     */
    size: {
        type: StringConstructor;
        required: false;
        default: string;
        validator(value: string): boolean;
    };
    /**
     * @ignore
     */
    name: {
        type: StringConstructor;
        required: false;
        default: null;
    };
}>> & Readonly<{}>, {
    name: string;
    size: string;
    required: boolean;
    disabled: boolean;
    isInherited: boolean;
    helpText: string;
    copyableText: string;
    isInheritanceField: boolean;
    disableInheritanceToggle: boolean;
    copyable: boolean;
    copyableTooltip: boolean;
}, {}, {
    "mt-inheritance-switch": import('vue').DefineComponent<{
        isInherited: boolean;
        disabled?: boolean;
    }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
        inheritanceRemove: () => any;
        inheritanceRestore: () => any;
    }, string, import('vue').PublicProps, Readonly<{
        isInherited: boolean;
        disabled?: boolean;
    }> & Readonly<{
        onInheritanceRemove?: (() => any) | undefined;
        onInheritanceRestore?: (() => any) | undefined;
    }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
    "mt-help-text": import('vue').DefineComponent<{
        text: string;
        width?: number;
        showDelay?: number;
        hideDelay?: number;
        placement?: import('@floating-ui/utils').Placement;
    }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
        text: string;
        width?: number;
        showDelay?: number;
        hideDelay?: number;
        placement?: import('@floating-ui/utils').Placement;
    }> & Readonly<{}>, {
        showDelay: number;
        hideDelay: number;
    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
    "mt-field-copyable": import('vue').DefineComponent<import('vue').ExtractPropTypes<{
        copyableText: {
            type: StringConstructor;
            required: false;
            default: null;
        };
        tooltip: {
            type: BooleanConstructor;
            required: false;
            default: boolean;
        };
    }>, {
        copyToClipboard: () => void;
        tooltipText: import('vue').ComputedRef<string>;
        wasCopied: import('vue').Ref<boolean, boolean>;
    }, {}, {}, {}, import('vue').DefineComponent<{}, {}, {}, {}, {
        createNotification(): void;
        createNotificationSuccess(config: any): void;
        createNotificationInfo(config: any): void;
        createNotificationWarning(config: any): void;
        createNotificationError(config: any): void;
        createSystemNotificationSuccess(config: any): void;
        createSystemNotificationInfo(config: any): void;
        createSystemNotificationWarning(config: any): void;
        createSystemNotificationError(config: any): void;
        createSystemNotification(config: any): void;
    }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
        copyableText: {
            type: StringConstructor;
            required: false;
            default: null;
        };
        tooltip: {
            type: BooleanConstructor;
            required: false;
            default: boolean;
        };
    }>> & Readonly<{}>, {
        tooltip: boolean;
        copyableText: string;
    }, {}, {
        "mt-icon": import('vue').DefineComponent<{
            name: string;
            color?: string;
            decorative?: boolean;
            size?: string;
            mode?: "solid" | "regular";
        }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
            name: string;
            color?: string;
            decorative?: boolean;
            size?: string;
            mode?: "solid" | "regular";
        }> & Readonly<{}>, {
            color: string;
            decorative: boolean;
            size: string;
            mode: "solid" | "regular";
        }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
    }, {
        tooltip: import('vue').ObjectDirective<any, any, string, string>;
    }, string, import('vue').ComponentProvideOptions, true, {}, any>;
}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
export default _default;