87 lines
2.2 KiB
TypeScript
87 lines
2.2 KiB
TypeScript
/**
|
|
*
|
|
* Ripple directive adds ripple effect to the host element.
|
|
*
|
|
* [Live Demo](https://primevue.org/ripple)
|
|
*
|
|
* @module ripple
|
|
*/
|
|
import { DirectiveBinding, ObjectDirective } from 'vue';
|
|
import { DirectiveHooks } from '../basedirective';
|
|
import { PassThroughOptions } from '../passthrough';
|
|
import { DesignToken, PassThrough } from '../ts-helpers';
|
|
|
|
export declare type RippleDirectivePassThroughOptionType = RippleDirectivePassThroughAttributes | null | undefined;
|
|
|
|
/**
|
|
* Defines options of Ripple.
|
|
*/
|
|
export interface RippleOptions {
|
|
/**
|
|
* 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 {RippleDirectivePassThroughOptions}
|
|
*/
|
|
pt?: PassThrough<RippleDirectivePassThroughOptions>;
|
|
/**
|
|
* 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;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough(pt) options.
|
|
* @see {@link RippleOptions.pt}
|
|
*/
|
|
export interface RippleDirectivePassThroughOptions {
|
|
/**
|
|
* Used to pass attributes to the root's DOM element.
|
|
*/
|
|
root?: RippleDirectivePassThroughOptionType;
|
|
/**
|
|
* Used to manage all lifecycle hooks.
|
|
* @see {@link BaseDirective.DirectiveHooks}
|
|
*/
|
|
hooks?: DirectiveHooks;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough attributes for each DOM elements
|
|
*/
|
|
export interface RippleDirectivePassThroughAttributes {
|
|
[key: string]: any;
|
|
}
|
|
|
|
/**
|
|
* Binding of Ripple directive.
|
|
*/
|
|
export interface RippleDirectiveBinding extends Omit<DirectiveBinding, 'modifiers' | 'value'> {
|
|
/**
|
|
* Value of the Ripple.
|
|
*/
|
|
value?: RippleOptions | undefined;
|
|
}
|
|
|
|
/**
|
|
* **PrimeVue - Ripple**
|
|
*
|
|
* _Ripple directive adds ripple effect to the host element._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/ripple/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
*/
|
|
declare const Ripple: ObjectDirective;
|
|
|
|
export default Ripple;
|