@dynamicforms/vuetify-inputs 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,394 @@
+import { Action as Action_2 } from '@dynamicforms/vue-forms';
+import { App } from 'vue';
+import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
+import { ComputedRef } from 'vue';
+import { CreateComponentPublicInstanceWithMixins } from 'vue';
+import { default as default_2 } from '@dynamicforms/vue-forms';
+import { DefineComponent } from 'vue';
+import { Editor } from '@ckeditor/ckeditor5-core';
+import { ExecuteAction } from '@dynamicforms/vue-forms';
+import { GlobalComponents } from 'vue';
+import { GlobalDirectives } from 'vue';
+import { PublicProps } from 'vue';
+import { Ref } from 'vue';
+import { ValidationError } from '@dynamicforms/vue-forms';
+import { WritableComputedRef } from 'vue';
+
+declare const __VLS_component: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+"update:modelValue": (value: any) => any;
+"click:clear": () => any;
+}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{
+"onUpdate:modelValue"?: ((value: any) => any) | undefined;
+"onClick:clear"?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+declare type __VLS_Props = BaseProps;
+
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+
+declare type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+export declare class Action {
+    readonly name: string;
+    displayStyle: ResponsiveRenderOptions;
+    formAction: Action_2;
+    constructor(data: ActionJSON, formAction: Action_2);
+    get label(): string | undefined;
+    get labelAvailable(): boolean;
+    get icon(): string | undefined;
+    get iconAvailable(): boolean;
+    static actionFormName(actionName: string): string;
+    private static makeFormAction;
+    static closeAction(data: ActionJSON, actionOrExecuteHandler?: Action_2 | ExecuteAction): Action;
+    static yesAction(data: ActionJSON, actionOrExecuteHandler?: Action_2 | ExecuteAction): Action;
+    static noAction(data: ActionJSON, actionOrExecuteHandler?: Action_2 | ExecuteAction): Action;
+}
+
+declare interface ActionComponentProps {
+    actions: Action[] | Ref<Action[]>;
+    buttonSize?: string | number;
+    showAsGroup?: ShowAsGroup;
+}
+
+/**
+ * DisplayMode enum provides an enumeration for supported ways of rendering a particular object in the DOM
+ */
+export declare enum ActionDisplayStyle {
+    BUTTON = 0,// action should render as a button
+    TEXT = 1
+}
+
+export declare namespace ActionDisplayStyle {
+    export function fromString(mode: string): ActionDisplayStyle;
+    export function fromAny(mode: any): ActionDisplayStyle;
+    export function isDefined(mode: number | string): boolean;
+}
+
+export declare interface ActionJSON {
+    name?: string;
+    label?: string;
+    icon?: string;
+    displayStyle?: BreakpointsJSON;
+    field_name?: string;
+}
+
+export declare interface ActionsJSON {
+    [key: string]: ActionJSON;
+}
+
+export declare interface BaseEmits<T = any> {
+    (e: 'update:modelValue', value: T): void;
+    (e: 'click:clear'): void;
+}
+
+export declare interface BaseProps<T = any> {
+    control?: default_2.IField<T>;
+    modelValue?: T;
+    label?: string;
+    errors?: string[];
+    placeholder?: string;
+    helpText?: string;
+    hint?: string;
+    enabled?: boolean;
+    visibility?: default_2.DisplayMode;
+    cssClass?: string;
+    clearable?: boolean;
+}
+
+export declare interface BreakpointJSON {
+    renderAs?: ActionDisplayStyle;
+    showLabel?: boolean;
+    showIcon?: boolean;
+    label?: string;
+}
+
+export declare type BreakpointNames = 'xl' | 'lg' | 'md' | 'sm' | 'xs';
+
+export declare interface BreakpointsJSON extends BreakpointJSON, Partial<Record<BreakpointNames, BreakpointJSON>> {
+}
+
+export declare const defaultBaseProps: {
+    enabled: undefined;
+};
+
+export declare const defaultDisplayStyle = ActionDisplayStyle.BUTTON;
+
+export declare const DfActions: DefineComponent<ActionComponentProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ActionComponentProps> & Readonly<{}>, {
+buttonSize: string | number;
+showAsGroup: ShowAsGroup;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const DfCheckbox: DefineComponent<Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+"update:modelValue": (value: any) => any;
+"click:clear": () => any;
+}, string, PublicProps, Readonly<Props> & Readonly<{
+"onUpdate:modelValue"?: ((value: any) => any) | undefined;
+"onClick:clear"?: (() => any) | undefined;
+}>, {
+enabled: boolean;
+allowNull: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const DfColor: DefineComponent<Props_2, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+"update:modelValue": (value: any) => any;
+"click:clear": () => any;
+}, string, PublicProps, Readonly<Props_2> & Readonly<{
+"onUpdate:modelValue"?: ((value: any) => any) | undefined;
+"onClick:clear"?: (() => any) | undefined;
+}>, {
+enabled: boolean;
+allowNull: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const DfDateTime: DefineComponent<Props_3, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+"update:modelValue": (value: any) => any;
+"click:clear": () => any;
+}, string, PublicProps, Readonly<Props_3> & Readonly<{
+"onUpdate:modelValue"?: ((value: any) => any) | undefined;
+"onClick:clear"?: (() => any) | undefined;
+}>, {
+enabled: boolean;
+inputType: "datetime" | "date" | "time";
+displayFormatDate: string;
+displayFormatTime: string;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const DfFile: DefineComponent<Props_4, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+"update:modelValue": (value: any) => any;
+"click:clear": () => any;
+}, string, PublicProps, Readonly<Props_4> & Readonly<{
+"onUpdate:modelValue"?: ((value: any) => any) | undefined;
+"onClick:clear"?: (() => any) | undefined;
+}>, {
+enabled: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const DfInput: DefineComponent<Props_5, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+"update:modelValue": (value: any) => any;
+"click:clear": () => any;
+}, string, PublicProps, Readonly<Props_5> & Readonly<{
+"onUpdate:modelValue"?: ((value: any) => any) | undefined;
+"onClick:clear"?: (() => any) | undefined;
+}>, {
+enabled: boolean;
+max: number;
+min: number;
+step: number;
+inputType: "text" | "password" | "email" | "url" | "number";
+precision: number;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
+
+export declare const DfRtfEditor: DefineComponent<Props_6, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+"update:modelValue": (value: any) => any;
+"click:clear": () => any;
+}, string, PublicProps, Readonly<Props_6> & Readonly<{
+"onUpdate:modelValue"?: ((value: any) => any) | undefined;
+"onClick:clear"?: (() => any) | undefined;
+}>, {
+enabled: boolean;
+minHeight: string;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {
+$editor: CreateComponentPublicInstanceWithMixins<Readonly<{
+modelValue: string;
+minHeight?: string;
+disabled?: boolean;
+}> & Readonly<{
+"onUpdate:modelValue"?: ((value: string) => any) | undefined;
+}>, {
+onEditorReady: (editorReady: Editor) => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+"update:modelValue": (value: string) => any;
+}, PublicProps, {
+modelValue: string;
+disabled: boolean;
+minHeight: string;
+}, false, {}, {}, GlobalComponents, GlobalDirectives, string, {
+editorElement: HTMLDivElement;
+}, HTMLDivElement, ComponentProvideOptions, {
+P: {};
+B: {};
+D: {};
+C: {};
+M: {};
+Defaults: {};
+}, Readonly<{
+modelValue: string;
+minHeight?: string;
+disabled?: boolean;
+}> & Readonly<{
+"onUpdate:modelValue"?: ((value: string) => any) | undefined;
+}>, {
+onEditorReady: (editorReady: Editor) => void;
+}, {}, {}, {}, {
+modelValue: string;
+disabled: boolean;
+minHeight: string;
+}> | null;
+}, any>;
+
+export declare const DfSelect: DefineComponent<Props_7, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+"update:modelValue": (value: any) => any;
+"click:clear": () => any;
+"update:modelValueDisplay": (value: SelectChoice[]) => any;
+}, string, PublicProps, Readonly<Props_7> & Readonly<{
+"onUpdate:modelValue"?: ((value: any) => any) | undefined;
+"onClick:clear"?: (() => any) | undefined;
+"onUpdate:modelValueDisplay"?: ((value: SelectChoice[]) => any) | undefined;
+}>, {
+enabled: boolean;
+allowNull: boolean;
+multiple: boolean;
+choices: SelectChoice[];
+allowTags: boolean;
+fetchChoices: SelectFetchChoices;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const DfTextArea: DefineComponent<Props_8, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+"update:modelValue": (value: any) => any;
+"click:clear": () => any;
+}, string, PublicProps, Readonly<Props_8> & Readonly<{
+"onUpdate:modelValue"?: ((value: any) => any) | undefined;
+"onClick:clear"?: (() => any) | undefined;
+}>, {
+enabled: boolean;
+rows: number;
+maxRows: number;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
+
+export declare const ErrorsWidget: DefineComponent<Props_9, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props_9> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
+
+export declare interface FileComms {
+    /**
+     * upload is called when a file is added to the input and needs to be uploaded to the backend for storage
+     * the component will then set its modelValue to the file identifier returned by this function. when the form
+     * is posted, only the identifier will be sent to the backend
+     *
+     * the method may throw an exception which will mean upload failure
+     *
+     * @param file the file to be uploaded
+     * @param progressCallback callback function to call with current upload progress data.
+     *  See e.g. axios onUploadProgress for axios post method
+     * @return file id
+     */
+    upload: (file: File, progressCallback?: FileProgressCallback) => Promise<string>;
+    /**
+     * delete is called when the file is removed from the input and needs to be deleted at the backend
+     * @param fileIdentifier the identifier that was returned by upload
+     */
+    delete: (fileIdentifier: string) => Promise<void>;
+    /**
+     * touch is called once per minute to let the backend know that the file is still in play and must not be discarded
+     * @param fileIdentifier the identifier that was returned by upload
+     */
+    touch: (fileIdentifier: string) => Promise<void>;
+}
+
+export declare type FileProgressCallback = (loaded: number, total: number) => void;
+
+export declare const InputBase: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+
+declare interface Props extends BaseProps {
+    allowNull?: boolean;
+}
+
+declare interface Props_2 extends BaseProps {
+    allowNull?: boolean;
+}
+
+declare interface Props_3 extends BaseProps {
+    inputType?: 'datetime' | 'date' | 'time';
+    displayFormatDate?: string;
+    displayFormatTime?: string;
+}
+
+declare interface Props_4 extends BaseProps {
+    comms: FileComms;
+}
+
+declare interface Props_5 extends BaseProps {
+    inputType?: 'text' | 'password' | 'email' | 'url' | 'number';
+    precision?: number;
+    step?: number;
+    min?: number;
+    max?: number;
+}
+
+declare interface Props_6 extends BaseProps {
+    minHeight?: string;
+}
+
+declare interface Props_7 extends BaseProps {
+    choices?: SelectChoice[];
+    multiple?: boolean;
+    allowTags?: boolean;
+    allowNull?: boolean;
+    fetchChoices?: SelectFetchChoices;
+}
+
+declare interface Props_8 extends BaseProps {
+    rows?: number;
+    maxRows?: number;
+}
+
+declare interface Props_9 {
+    errors: ValidationError[];
+}
+
+declare class ResponsiveRenderOptions {
+    private readonly _value;
+    constructor(data: BreakpointsJSON | undefined, label?: string);
+    getOptionsForBreakpoint(breakpoint: BreakpointNames): BreakpointJSON;
+    private static cleanBreakpoint;
+}
+
+export declare interface SelectChoice {
+    id: any;
+    text: any;
+    icon?: string;
+}
+
+export declare type SelectFetchChoices<T1 = any, T2 = any> = (queryValue?: T1, idValue?: T2) => Promise<SelectChoice[]>;
+
+declare type ShowAsGroup = 'no' | 'grouped' | 'grouped-no-borders';
+
+export declare function useInputBase<T = any>(props: BaseProps<T>, emit: BaseEmits<T>): {
+    value: WritableComputedRef<T, T>;
+    valid: ComputedRef<boolean>;
+    enabled: ComputedRef<boolean>;
+    errors: ComputedRef<default_2.ValidationError[]>;
+    visibility: ComputedRef<default_2.DisplayMode>;
+    vuetifyBindings: ComputedRef<    {
+    name: string | undefined;
+    class: string;
+    label: string;
+    messages: string | undefined;
+    readonly: boolean;
+    disabled: boolean;
+    placeholder: string;
+    'persistent-placeholder': boolean;
+    hint: string;
+    persistentHint: boolean;
+    hideDetails: boolean | "auto" | undefined;
+    helpText: string;
+    }>;
+};
+
+export declare const VuetifyInputs: {
+    install: (app: App) => void;
+};
+
+export { }