150 lines
3.7 KiB
TypeScript
150 lines
3.7 KiB
TypeScript
/**
|
|
*
|
|
* ImageCompare compares two images side by side with a slider.
|
|
*
|
|
* [Live Demo](https://www.primevue.org/imagecompare)
|
|
*
|
|
* @module imagecompare
|
|
*
|
|
*/
|
|
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core';
|
|
import type { ComponentHooks } from '@primevue/core/basecomponent';
|
|
import type { PassThroughOptions } from 'primevue/passthrough';
|
|
import { VNode } from 'vue';
|
|
|
|
export declare type ImageComparePassThroughOptionType = ImageComparePassThroughAttributes | ((options: ImageComparePassThroughMethodOptions) => ImageComparePassThroughAttributes | string) | string | null | undefined;
|
|
|
|
/**
|
|
* Custom passthrough(pt) option method.
|
|
*/
|
|
export interface ImageComparePassThroughMethodOptions {
|
|
/**
|
|
* Defines instance.
|
|
*/
|
|
instance: any;
|
|
/**
|
|
* Defines valid properties.
|
|
*/
|
|
props: ImageCompareProps;
|
|
/**
|
|
* Defines valid attributes.
|
|
*/
|
|
attrs: any;
|
|
/**
|
|
* Defines parent options.
|
|
*/
|
|
parent: any;
|
|
/**
|
|
* Defines passthrough(pt) options in global config.
|
|
*/
|
|
global: object | undefined;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough(pt) options.
|
|
* @see {@link ImageCompareProps.pt}
|
|
*/
|
|
export interface ImageComparePassThroughOptions {
|
|
/**
|
|
* Used to pass attributes to the root's DOM element.
|
|
*/
|
|
root?: ImageComparePassThroughOptionType;
|
|
/**
|
|
* Used to pass attributes to the slider's DOM element.
|
|
*/
|
|
slider?: ImageComparePassThroughOptionType;
|
|
/**
|
|
* Used to manage all lifecycle hooks.
|
|
* @see {@link BaseComponent.ComponentHooks}
|
|
*/
|
|
hooks?: ComponentHooks;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough attributes for each DOM elements
|
|
*/
|
|
export interface ImageComparePassThroughAttributes {
|
|
[key: string]: any;
|
|
}
|
|
|
|
/**
|
|
* Defines valid properties in ImageCompare component.
|
|
*/
|
|
export interface ImageCompareProps {
|
|
/**
|
|
* Index of the element in tabbing order.
|
|
* @defaultValue 0
|
|
*/
|
|
tabindex?: number | undefined;
|
|
/**
|
|
* Defines a string value that labels an interactive element.
|
|
*/
|
|
ariaLabel?: string | undefined;
|
|
/**
|
|
* Identifier of the underlying input element.
|
|
*/
|
|
ariaLabelledby?: string | undefined;
|
|
/**
|
|
* It generates scoped CSS variables using design tokens for the component.
|
|
*/
|
|
dt?: DesignToken<any>;
|
|
/**
|
|
* Used to pass attributes to DOM elements inside the component.
|
|
* @type {ImageComparePassThroughOptions}
|
|
*/
|
|
pt?: PassThrough<ImageComparePassThroughOptions>;
|
|
/**
|
|
* 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;
|
|
}
|
|
|
|
/**
|
|
* Defines valid slots in ImageCompare component.
|
|
*/
|
|
export interface ImageCompareSlots {
|
|
/**
|
|
* Custom left template.
|
|
*/
|
|
left(): VNode[];
|
|
/**
|
|
* Custom right template.
|
|
*/
|
|
right(): VNode[];
|
|
}
|
|
|
|
/**
|
|
* Defines valid emits in ImageCompare component.
|
|
*/
|
|
export interface ImageCompareEmitsOptions {}
|
|
|
|
export declare type ImageCompareEmits = EmitFn<ImageCompareEmitsOptions>;
|
|
|
|
/**
|
|
* **PrimeVue - ImageCompare**
|
|
*
|
|
* _ImageCompare compares two images side by side with a slider._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/imagecompare/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*
|
|
*/
|
|
declare const ImageCompare: DefineComponent<ImageCompareProps, ImageCompareSlots, ImageCompareEmits>;
|
|
|
|
declare module 'vue' {
|
|
export interface GlobalComponents {
|
|
ImageCompare: DefineComponent<ImageCompareProps, ImageCompareSlots, ImageCompareEmits>;
|
|
}
|
|
}
|
|
|
|
export default ImageCompare;
|