@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
136 lines (135 loc) • 3.72 kB
TypeScript
import { NeonFunctionalColor } from '@/common/enums/NeonFunctionalColor';
/**
* A dialog component for confirming simple actions. This will be rendered above the content of the main window and
* present just two options to the user, one to proceed with the action and the other to cancel it.
*/
declare const _default: import("vue").DefineComponent<{
/**
* The color of the button for the confirm (positive) action.
*/
color: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
/**
* Alternate confirm button color for creating a gradient button. NOTE: can also be the same color as 'color'.
*/
alternateColor: {
type: () => NeonFunctionalColor;
default: null;
};
/**
* The label of the button for the cancel (negative) action.
*/
cancelLabel: {
type: StringConstructor;
default: string;
};
/**
* The label of the button for the confirm (positive) action.
*/
confirmLabel: {
type: StringConstructor;
default: string;
};
/**
* The dialog title
*/
title: {
type: StringConstructor;
required: true;
};
/**
* The dialog question. Can be html (rendered using v-html).
*/
question: {
type: StringConstructor;
required: true;
};
/**
* Whether the dialog is open.
*/
open: {
type: BooleanConstructor;
default: boolean;
};
/**
* Increase the opacity so that the page behind the modal is no longer visible
*/
opaque: {
type: BooleanConstructor;
default: boolean;
};
}, {
actions: import("vue").Ref<HTMLDivElement | null>;
cancel: () => void;
confirm: () => void;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("cancel" | "confirm")[], "cancel" | "confirm", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
/**
* The color of the button for the confirm (positive) action.
*/
color: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
/**
* Alternate confirm button color for creating a gradient button. NOTE: can also be the same color as 'color'.
*/
alternateColor: {
type: () => NeonFunctionalColor;
default: null;
};
/**
* The label of the button for the cancel (negative) action.
*/
cancelLabel: {
type: StringConstructor;
default: string;
};
/**
* The label of the button for the confirm (positive) action.
*/
confirmLabel: {
type: StringConstructor;
default: string;
};
/**
* The dialog title
*/
title: {
type: StringConstructor;
required: true;
};
/**
* The dialog question. Can be html (rendered using v-html).
*/
question: {
type: StringConstructor;
required: true;
};
/**
* Whether the dialog is open.
*/
open: {
type: BooleanConstructor;
default: boolean;
};
/**
* Increase the opacity so that the page behind the modal is no longer visible
*/
opaque: {
type: BooleanConstructor;
default: boolean;
};
}>> & {
onCancel?: ((...args: any[]) => any) | undefined;
onConfirm?: ((...args: any[]) => any) | undefined;
}, {
open: boolean;
color: NeonFunctionalColor;
alternateColor: NeonFunctionalColor;
opaque: boolean;
cancelLabel: string;
confirmLabel: string;
}, {}>;
export default _default;