magner/dist/types/form/fields/button.d.ts

Universal admin panel magnetic to any backend

import type { TranslateData } from '../../../utils/core/translate';
import type { IconImport } from '../../../types/utils/useful';
import type { BaseField, BaseProps } from '../base';
export type ButtonType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'text';
export type ButtonNativeType = 'button' | 'submit';
/** Interface mimicking the El-button component properties:
 * https://element-plus.org/#/en-US/component/button */
export interface ButtonProps<ENTITY extends {}> extends BaseProps<ENTITY> {
    /** Button content */
    text: TranslateData;
    /** Default is 'primary' */
    type?: ButtonType;
    /** submit is default for forms, button otherwise */
    nativeType?: ButtonNativeType;
    /** Displays button with the half-transparent background fill (not a bright button) */
    plain?: boolean;
    /** Whether the button has round borders */
    round?: boolean;
    /**
     * Icon as a Vue component.
     * Used as `() => SomeIcon` or  `() => import('../smt.svg'))`
     */
    icon?: IconImport;
}
/** Button, if used in the form, does not return any value by itself and acts as a custom component. */
export interface ButtonField<ENTITY extends {}> extends BaseField<ENTITY> {
    type: 'button';
    props: ButtonProps<ENTITY>;
    /** This string is prompted to the button's 'changeAction' function in 'data.type' argument */
    clickActionType?: string;
    /** This value will be dynamically prompted to the form values any time it is changed
     * (by whatever component from the 'changeAction') */
    value?: unknown;
}