Interface IOneButtonProps<Data, Payload>

IOneButtonProps

interface IOneButtonProps<
    Data extends {} = IAnything,
    Payload extends IAnything = IAnything,
> {
    badgeColor?:
        | "error"
        | "primary"
        | "secondary"
        | "success"
        | "info"
        | "warning"
        | "default";
    badgeOverlap?: "rectangular"
    | "circular";
    badgeSx?: any;
    closeSubject?: TSubject<void>;
    color?:
        | "error"
        | "inherit"
        | "primary"
        | "secondary"
        | "success"
        | "info"
        | "warning";
    fieldDebounce?: number;
    fields: IField<Data, Payload>[];
    handler: OneHandler<Data, Payload>;
    incomingTransform?: (data: any, payload: Payload) => Data;
    isBaseline?: (field: IField) => boolean;
    isBaselineForRoot?: (field: IField) => boolean;
    noBadge?: boolean;
    onBlur?: (
        name: string,
        data: Data,
        payload: Payload,
        onValueChange: (value: Value) => void,
        onChange: (data: Data) => void,
    ) => void;
    onChange?: (Data: Data, initial: boolean) => void;
    onClose?: (data: Data) => void;
    oneSx?: any;
    onFocus?: (
        name: string,
        data: Data,
        payload: Payload,
        onValueChange: (value: Value) => void,
        onChange: (data: Data) => void,
    ) => void;
    onInvalid?: (name: string, msg: string, payload: Payload) => void;
    outgoingTransform?: (data: any, payload: Payload) => Data;
    payload?: Payload | () => Payload;
    readTransform?: (
        value: string | string[],
        name: string,
        data: Data,
        payload: Payload,
    ) => Value;
    reloadSubject?: TSubject<void>;
    waitForChangesDelay?: number;
    withCloseAfterChange?: boolean;
    writeTransform?: (
        value: string | string[],
        name: string,
        data: Data,
        payload: Payload,
    ) => Value;
    [key: string]: ButtonProps;
    [key: number]: ButtonProps;
    [key: symbol]: ButtonProps;
}

Type Parameters

  • Data extends {} = IAnything

    The data type of the IField object's data property

  • Payload extends IAnything = IAnything

    The payload type of the IField object

Hierarchy

  • Omit<
        dayjs,
        keyof {
            color: never;
            onBlur: never;
            onChange: never;
            onClick: never;
            onFocus: never;
            onInvalid: never;
        },
    >
    • IOneButtonProps

Indexable

  • [key: string]: ButtonProps
  • [key: number]: ButtonProps
  • [key: symbol]: ButtonProps

Properties

badgeColor? badgeOverlap? badgeSx? closeSubject? color? fieldDebounce? fields handler incomingTransform? isBaseline? isBaselineForRoot? noBadge? onBlur? onChange? onClose? oneSx? onFocus? onInvalid? outgoingTransform? payload? readTransform? reloadSubject? waitForChangesDelay? withCloseAfterChange? writeTransform?

Properties

OptionalbadgeColor

badgeColor?:
    | "error"
    | "primary"
    | "secondary"
    | "success"
    | "info"
    | "warning"
    | "default"

The color of the badge. Default is 'primary'.

OptionalbadgeOverlap

badgeOverlap?: "rectangular" | "circular"

The overlap type for the badge. Default is 'rectangular'.

OptionalbadgeSx

badgeSx?: any

The style for the badge. Default is null.

OptionalcloseSubject

closeSubject?: TSubject<void>

Optionalcolor

color?:
    | "error"
    | "inherit"
    | "primary"
    | "secondary"
    | "success"
    | "info"
    | "warning"

The color of the button. Default is 'inherit'.

OptionalfieldDebounce

fieldDebounce?: number

The debounce time in milliseconds for field changes. Default is null.

fields

fields: IField<Data, Payload>[]

An array of IField objects representing the fields associated with the button.

handler

handler: OneHandler<Data, Payload>

The handler function to be invoked when the button is clicked.

OptionalincomingTransform

incomingTransform?: (data: any, payload: Payload) => Data

OptionalisBaseline

isBaseline?: (field: IField) => boolean

OptionalisBaselineForRoot

isBaselineForRoot?: (field: IField) => boolean

OptionalnoBadge

noBadge?: boolean

Determines whether to display a badge on the button. Default is false.

OptionalonBlur

onBlur?: (
    name: string,
    data: Data,
    payload: Payload,
    onValueChange: (value: Value) => void,
    onChange: (data: Data) => void,
) => void

The blur callback function for the button. Default is null.

OptionalonChange

onChange?: (Data: Data, initial: boolean) => void

The change callback function for the button. Default is null.

OptionalonClose

onClose?: (data: Data) => void

OptionaloneSx

oneSx?: any

The style for the button. Default is null.

OptionalonFocus

onFocus?: (
    name: string,
    data: Data,
    payload: Payload,
    onValueChange: (value: Value) => void,
    onChange: (data: Data) => void,
) => void

The focus callback function for the button. Default is null.

OptionalonInvalid

onInvalid?: (name: string, msg: string, payload: Payload) => void

The invalidity callback function for the button. Default is null.

OptionaloutgoingTransform

outgoingTransform?: (data: any, payload: Payload) => Data

Optionalpayload

payload?: Payload | () => Payload

The payload to be passed to the handler when the button is clicked.

OptionalreadTransform

readTransform?: (
    value: string | string[],
    name: string,
    data: Data,
    payload: Payload,
) => Value

OptionalreloadSubject

reloadSubject?: TSubject<void>

OptionalwaitForChangesDelay

waitForChangesDelay?: number

The delay time in milliseconds to wait for changes before invoking the handler. Default is null.

OptionalwithCloseAfterChange

withCloseAfterChange?: boolean

OptionalwriteTransform

writeTransform?: (
    value: string | string[],
    name: string,
    data: Data,
    payload: Payload,
) => Value

Settings

Member Visibility

On This Page

Properties