vueless/ui.form-input-file/types.ts

Vue Styleless UI Component Library, powered by Tailwind CSS.

import defaultConfig from "./config.ts";

import type { ComponentConfig } from "../types.ts";

export type Config = typeof defaultConfig;

export interface Props {
  /**
   * Input value.
   */
  modelValue?: File | File[];

  /**
   * Input label.
   */
  label?: string;

  /**
   * Input description.
   */
  description?: string;

  /**
   * Error message.
   */
  error?: string;

  /**
   * Label placement.
   */
  labelAlign?: "top" | "topInside" | "topWithDesc";

  /**
   * Input size.
   */
  size?: "sm" | "md" | "lg";

  /**
   * Max file size in megabytes.
   */
  maxFileSize?: number;

  /**
   * Allowed file types.
   */
  allowedFileTypes?: string[];

  /**
   * Allow selecting multiple files.
   */
  multiple?: boolean;

  /**
   * Disable the input.
   */
  disabled?: boolean;

  /**
   * Unique element id.
   */
  id?: string;

  /**
   * Component config object.
   */
  config?: ComponentConfig<Config>;

  /**
   * Data-test attribute for automated testing.
   */
  dataTest?: string | null;
}