@fewangsit/wangsvue-fats 1.0.0-alpha.3 → 1.0.0-alpha.30

package/components/image/Image.vue.d.ts

@@ -12,54 +12,54 @@ import { TransitionProps, VNode } from 'vue';
 import { ComponentHooks } from '../basecomponent';
 import { PassThroughOptions } from '../passthrough';
 import {
-  ClassComponent,
-  GlobalComponentConstructor,
-  PassThrough,
+    ClassComponent,
+    GlobalComponentConstructor,
+    PassThrough,
 } from '../ts-helpers';
 
 export declare type ImagePassThroughOptionType =
-  | ImagePassThroughAttributes
-  | ((
-      options: ImagePassThroughMethodOptions,
-    ) => ImagePassThroughAttributes | string)
-  | string
-  | null
-  | undefined;
+    | ImagePassThroughAttributes
+    | ((
+          options: ImagePassThroughMethodOptions,
+      ) => ImagePassThroughAttributes | string)
+    | string
+    | null
+    | undefined;
 
 export declare type ImagePassThroughTransitionType =
-  | TransitionProps
-  | ((options: ImagePassThroughMethodOptions) => TransitionProps)
-  | undefined;
+    | TransitionProps
+    | ((options: ImagePassThroughMethodOptions) => TransitionProps)
+    | undefined;
 
 /**
  * Custom passthrough(pt) option method.
  */
 export interface ImagePassThroughMethodOptions {
-  /**
-   * Defines instance.
-   */
-  instance: any;
-  /**
-   *ˆ
-   * Defines valid properties.
-   */
-  props: ImageProps;
-  /**
-   * Defines current inline state.
-   */
-  state: ImageState;
-  /**
-   * Defines valid attributes.
-   */
-  attrs: any;
-  /**
-   * Defines parent options.
-   */
-  parent: any;
-  /**
-   * Defines passthrough(pt) options in global config.
-   */
-  global: object | undefined;
+    /**
+     * Defines instance.
+     */
+    instance: any;
+    /**
+     *ˆ
+     * Defines valid properties.
+     */
+    props: ImageProps;
+    /**
+     * Defines current inline state.
+     */
+    state: ImageState;
+    /**
+     * Defines valid attributes.
+     */
+    attrs: any;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
+    /**
+     * Defines passthrough(pt) options in global config.
+     */
+    global: object | undefined;
 }
 
 /**
@@ -67,299 +67,299 @@ export interface ImagePassThroughMethodOptions {
  * @see {@link ImageProps.pt}
  */
 export interface ImagePassThroughOptions {
-  /**
-   * Used to pass attributes to the root's DOM element.
-   */
-  root?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the image's DOM element.
-   */
-  image?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the button's DOM element.
-   */
-  button?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the icon's DOM element.
-   */
-  icon?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the mask's DOM element.
-   */
-  mask?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the toolbar's DOM element.
-   */
-  toolbar?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the rotate right button's DOM element.
-   */
-  rotateRightButton?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the rotate right icon's DOM element.
-   */
-  rotateRightIcon?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the rotate left button's DOM element.
-   */
-  rotateLeftButton?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the rotate left icon's DOM element.
-   */
-  rotateLeftIcon?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the zoom out button's DOM element.
-   */
-  zoomOutButton?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the zoom out icon's DOM element.
-   */
-  zoomOutIcon?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the zoom in button's DOM element.
-   */
-  zoomInButton?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the zoom in icon's DOM element.
-   */
-  zoomInIcon?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the close button's DOM element.
-   */
-  closeButton?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the close icon's DOM element.
-   */
-  closeIcon?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the preview container's DOM element.
-   */
-  previewContainer?: ImagePassThroughOptionType;
-  /**
-   * Used to pass attributes to the preview's DOM element.
-   */
-  preview?: ImagePassThroughOptionType;
-  /**
-   * Used to manage all lifecycle hooks.
-   * @see {@link BaseComponent.ComponentHooks}
-   */
-  hooks?: ComponentHooks;
-  /**
-   * Used to control Vue Transition API.
-   */
-  transition?: ImagePassThroughTransitionType;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the image's DOM element.
+     */
+    image?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the button's DOM element.
+     */
+    button?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the mask's DOM element.
+     */
+    mask?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the toolbar's DOM element.
+     */
+    toolbar?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the rotate right button's DOM element.
+     */
+    rotateRightButton?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the rotate right icon's DOM element.
+     */
+    rotateRightIcon?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the rotate left button's DOM element.
+     */
+    rotateLeftButton?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the rotate left icon's DOM element.
+     */
+    rotateLeftIcon?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the zoom out button's DOM element.
+     */
+    zoomOutButton?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the zoom out icon's DOM element.
+     */
+    zoomOutIcon?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the zoom in button's DOM element.
+     */
+    zoomInButton?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the zoom in icon's DOM element.
+     */
+    zoomInIcon?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the close button's DOM element.
+     */
+    closeButton?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the close icon's DOM element.
+     */
+    closeIcon?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the preview container's DOM element.
+     */
+    previewContainer?: ImagePassThroughOptionType;
+    /**
+     * Used to pass attributes to the preview's DOM element.
+     */
+    preview?: ImagePassThroughOptionType;
+    /**
+     * Used to manage all lifecycle hooks.
+     * @see {@link BaseComponent.ComponentHooks}
+     */
+    hooks?: ComponentHooks;
+    /**
+     * Used to control Vue Transition API.
+     */
+    transition?: ImagePassThroughTransitionType;
 }
 
 /**
  * Custom passthrough attributes for each DOM elements
  */
 export interface ImagePassThroughAttributes {
-  [key: string]: any;
+    [key: string]: any;
 }
 
 /**
  * Defines current inline state in Image component.
  */
 export interface ImageState {
-  /**
-   * Mask visible state as a boolean.
-   * @defaultValue false
-   */
-  maskVisible: boolean;
-  /**
-   * Preview visible state as a boolean.
-   * @defaultValue false
-   */
-  previewVisible: boolean;
-  /**
-   * Rotate state as a number.
-   * @defaultValue 0
-   */
-  rotate: number;
-  /**
-   * Scale state as a boolean.
-   * @defaultValue 1
-   */
-  scale: number;
+    /**
+     * Mask visible state as a boolean.
+     * @defaultValue false
+     */
+    maskVisible: boolean;
+    /**
+     * Preview visible state as a boolean.
+     * @defaultValue false
+     */
+    previewVisible: boolean;
+    /**
+     * Rotate state as a number.
+     * @defaultValue 0
+     */
+    rotate: number;
+    /**
+     * Scale state as a boolean.
+     * @defaultValue 1
+     */
+    scale: number;
 }
 
 export type ImageGallery = {
-  src?: ImageProps['src'];
+    src?: ImageProps['src'];
 };
 
 /**
  * Defines valid properties in Image component.
  */
 export interface ImageProps {
-  /**
-   * The thumbnail image.
-   */
-  src?: string | Blob;
-  /**
-   * The thumbnail image width.
-   *
-   * small: 30
-   * medium: 80
-   * big: 125
-   *
-   * @default to 'big' or {@link width} - When the props.width specified, the size will use this value
-   */
-  size?: 'small' | 'medium' | 'big';
+    /**
+     * The thumbnail image.
+     */
+    src?: string | Blob;
+    /**
+     * The thumbnail image width.
+     *
+     * small: 30
+     * medium: 80
+     * big: 125
+     *
+     * @default to 'big' or {@link width} - When the props.width specified, the size will use this value
+     */
+    size?: 'small' | 'medium' | 'big';
 
-  /**
-   * Set custom size in pixels (without 'px')
-   * @example 30
-   */
-  width?: number;
-  /**
-   * Specify the rounded level.
-   *
-   * If true, the image will be full rounded.
-   *
-   * @default 'false'
-   */
-  rounded?: boolean;
-  /**
-   * Inline style of the image element.
-   */
-  imageStyle?: any;
-  /**
-   * Style class of the image element.
-   */
-  imageClass?: any;
-  /**
-   * Show preview as galeria. Display multiple image with thumbnail.
-   */
-  galleries?: ImageGallery[];
-  /**
-   * Custom indicator icon.
-   * @deprecated since v3.27.0. Use 'indicator' slot.
-   */
-  indicatorIcon?: string;
-  /**
-   * Disable the zoom-in button
-   * @defaultValue false
-   */
-  zoomInDisabled?: boolean | undefined;
-  /**
-   * Disable the zoom-out button
-   * @defaultValue false
-   */
-  zoomOutDisabled?: boolean | undefined;
-  /**
-   * Used to pass attributes to DOM elements inside the component.
-   * @type {ImagePassThroughOptions}
-   */
-  pt?: PassThrough<ImagePassThroughOptions>;
-  /**
-   * Used to configure passthrough(pt) options of the component.
-   * @type {PassThroughOptions}
-   */
-  ptOptions?: PassThroughOptions;
-  /**
-   * When enabled, it removes component related styles in the core.
-   * @defaultValue false
-   */
-  unstyled?: boolean;
+    /**
+     * Set custom size in pixels (without 'px')
+     * @example 30
+     */
+    width?: number;
+    /**
+     * Specify the rounded level.
+     *
+     * If true, the image will be full rounded.
+     *
+     * @default 'false'
+     */
+    rounded?: boolean;
+    /**
+     * Inline style of the image element.
+     */
+    imageStyle?: any;
+    /**
+     * Style class of the image element.
+     */
+    imageClass?: any;
+    /**
+     * Show preview as galeria. Display multiple image with thumbnail.
+     */
+    galleries?: ImageGallery[];
+    /**
+     * Custom indicator icon.
+     * @deprecated since v3.27.0. Use 'indicator' slot.
+     */
+    indicatorIcon?: string;
+    /**
+     * Disable the zoom-in button
+     * @defaultValue false
+     */
+    zoomInDisabled?: boolean | undefined;
+    /**
+     * Disable the zoom-out button
+     * @defaultValue false
+     */
+    zoomOutDisabled?: boolean | undefined;
+    /**
+     * Used to pass attributes to DOM elements inside the component.
+     * @type {ImagePassThroughOptions}
+     */
+    pt?: PassThrough<ImagePassThroughOptions>;
+    /**
+     * Used to configure passthrough(pt) options of the component.
+     * @type {PassThroughOptions}
+     */
+    ptOptions?: PassThroughOptions;
+    /**
+     * When enabled, it removes component related styles in the core.
+     * @defaultValue false
+     */
+    unstyled?: boolean;
 
-  /**
-   * Get image url for specifics project from its server.
-   * @returns The full URL of the image from the server.
-   * @param path - the Image path from API Response JSON
-   * @param width - the image width in pixels
-   * @param height - the image height in pixels
-   */
-  getImageURL?: (
-    path?: string | null,
-    width?: number,
-    height?: number,
-  ) => string | undefined;
+    /**
+     * Get image url for specifics project from its server.
+     * @returns The full URL of the image from the server.
+     * @param path - the Image path from API Response JSON
+     * @param width - the image width in pixels
+     * @param height - the image height in pixels
+     */
+    getImageURL?: (
+        path?: string | null,
+        width?: number,
+        height?: number,
+    ) => string | undefined;
 
-  /**
-   * The placeholder to be shown when the image failed to load, or the src is not provided.
-   * It should be preserved by project configuration.
-   */
-  placeholder?: string | undefined;
+    /**
+     * The placeholder to be shown when the image failed to load, or the src is not provided.
+     * It should be preserved by project configuration.
+     */
+    placeholder?: string | undefined;
 }
 
 /**
  * Defines valid slots in Image slots.
  */
 export interface ImageSlots {
-  /**
-   * Custom indicator template.
-   */
-  indicator(): VNode[];
-  /**
-   * Custom indicator icon template.
-   */
-  indicatoricon(): VNode[];
-  /**
-   * Custom refresh template.
-   */
-  refresh(): VNode[];
-  /**
-   * Custom undo template.
-   */
-  undo(): VNode[];
-  /**
-   * Custom zoomout template.
-   */
-  zoomout(): VNode[];
-  /**
-   * Custom zoomin template.
-   */
-  zoomin(): VNode[];
-  /**
-   * Custom close template.
-   */
-  close(): VNode[];
-  /**
-   * Custom image template.
-   * @param {Object} scope - image slot's params.
-   */
-  image(scope: {
     /**
-     * Style class of the image element.
+     * Custom indicator template.
+     */
+    indicator(): VNode[];
+    /**
+     * Custom indicator icon template.
      */
-    class: any;
+    indicatoricon(): VNode[];
     /**
-     * Style of the image element.
+     * Custom refresh template.
      */
-    style: any;
+    refresh(): VNode[];
     /**
-     * Image error function.
-     * @deprecated since v3.39.0. Use 'errorCallback' property instead.
+     * Custom undo template.
      */
-    onError: () => void;
+    undo(): VNode[];
     /**
-     * Preview click function.
+     * Custom zoomout template.
      */
-    errorCallback: () => void;
-  }): VNode[];
-  /**
-   * Custom preview template.
-   * @param {Object} scope - preview slot's params.
-   */
-  preview(scope: {
+    zoomout(): VNode[];
     /**
-     * Style class of the preview image element.
+     * Custom zoomin template.
      */
-    class: any;
+    zoomin(): VNode[];
     /**
-     * Style of the preview image element.
+     * Custom close template.
      */
-    style: any;
+    close(): VNode[];
     /**
-     * Preview click function.
-     * @deprecated since v3.39.0. Use 'previewCallback' property instead.
+     * Custom image template.
+     * @param {Object} scope - image slot's params.
      */
-    onClick: () => void;
+    image(scope: {
+        /**
+         * Style class of the image element.
+         */
+        class: any;
+        /**
+         * Style of the image element.
+         */
+        style: any;
+        /**
+         * Image error function.
+         * @deprecated since v3.39.0. Use 'errorCallback' property instead.
+         */
+        onError: () => void;
+        /**
+         * Preview click function.
+         */
+        errorCallback: () => void;
+    }): VNode[];
     /**
-     * Preview click function.
+     * Custom preview template.
+     * @param {Object} scope - preview slot's params.
      */
-    previewCallback: () => void;
-  }): VNode[];
+    preview(scope: {
+        /**
+         * Style class of the preview image element.
+         */
+        class: any;
+        /**
+         * Style of the preview image element.
+         */
+        style: any;
+        /**
+         * Preview click function.
+         * @deprecated since v3.39.0. Use 'previewCallback' property instead.
+         */
+        onClick: () => void;
+        /**
+         * Preview click function.
+         */
+        previewCallback: () => void;
+    }): VNode[];
 }
 
 /**
@@ -374,30 +374,30 @@ export interface ImageSlots {
  *
  */
 declare class Image extends ClassComponent<ImageProps, ImageSlots, unknown> {
-  /**
-   * Triggered when the preview overlay is shown.
-   *
-   * @memberof Image
-   */
-  show(): void;
-  /**
-   * Triggered when the preview overlay is hidden.
-   *
-   * @memberof Image
-   */
-  hide(): void;
-  /**
-   * Triggered when an error occurs while loading an image file.
-   *
-   * @memberof Image
-   */
-  error(): void;
+    /**
+     * Triggered when the preview overlay is shown.
+     *
+     * @memberof Image
+     */
+    show(): void;
+    /**
+     * Triggered when the preview overlay is hidden.
+     *
+     * @memberof Image
+     */
+    hide(): void;
+    /**
+     * Triggered when an error occurs while loading an image file.
+     *
+     * @memberof Image
+     */
+    error(): void;
 }
 
 declare module '@vue/runtime-core' {
-  interface GlobalComponents {
-    Image: GlobalComponentConstructor<Image>;
-  }
+    interface GlobalComponents {
+        Image: GlobalComponentConstructor<Image>;
+    }
 }
 
 export default Image;