159 lines
4.1 KiB
TypeScript
159 lines
4.1 KiB
TypeScript
/**
|
|
*
|
|
* ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.
|
|
*
|
|
* [Live Demo](https://www.primevue.org/scrolltop/)
|
|
*
|
|
* @module scrolltop
|
|
*
|
|
*/
|
|
import { TransitionProps, VNode } from 'vue';
|
|
import { ComponentHooks } from '../basecomponent';
|
|
import { PassThroughOptions } from '../passthrough';
|
|
import { ClassComponent, GlobalComponentConstructor, PTOptions } from '../ts-helpers';
|
|
|
|
export declare type ScrollTopPassThroughOptionType = ScrollTopPassThroughAttributes | ((options: ScrollTopPassThroughMethodOptions) => ScrollTopPassThroughAttributes | string) | string | null | undefined;
|
|
|
|
export declare type ScrollTopPassThroughTransitionType = TransitionProps | ((options: ScrollTopPassThroughMethodOptions) => TransitionProps) | undefined;
|
|
|
|
/**
|
|
* Custom passthrough(pt) option method.
|
|
*/
|
|
export interface ScrollTopPassThroughMethodOptions {
|
|
/**
|
|
* Defines instance.
|
|
*/
|
|
instance: any;
|
|
/**
|
|
* Defines valid properties.
|
|
*/
|
|
props: ScrollTopProps;
|
|
/**
|
|
* Defines current inline state.
|
|
*/
|
|
state: ScrollTopState;
|
|
/**
|
|
* Defines passthrough(pt) options in global config.
|
|
*/
|
|
global: object | undefined;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough(pt) options.
|
|
* @see {@link ScrollTopProps.pt}
|
|
*/
|
|
export interface ScrollTopPassThroughOptions {
|
|
/**
|
|
* Used to pass attributes to the root's DOM element.
|
|
*/
|
|
root?: ScrollTopPassThroughOptionType;
|
|
/**
|
|
* Used to pass attributes to the icon's DOM element.
|
|
*/
|
|
icon?: ScrollTopPassThroughOptionType;
|
|
/**
|
|
* Used to manage all lifecycle hooks
|
|
* @see {@link BaseComponent.ComponentHooks}
|
|
*/
|
|
hooks?: ComponentHooks;
|
|
/**
|
|
* Used to control Vue Transition API.
|
|
*/
|
|
transition?: ScrollTopPassThroughTransitionType;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough attributes for each DOM elements
|
|
*/
|
|
export interface ScrollTopPassThroughAttributes {
|
|
[key: string]: any;
|
|
}
|
|
|
|
/**
|
|
* Defines current inline state in ScrollTop component.
|
|
*/
|
|
export interface ScrollTopState {
|
|
/**
|
|
* Current visible state as a boolean.
|
|
* @defaultValue false
|
|
*/
|
|
visible: boolean;
|
|
}
|
|
|
|
/**
|
|
* Defines valid properties in ScrollTop component.
|
|
*/
|
|
export interface ScrollTopProps {
|
|
/**
|
|
* Target of the ScrollTop.
|
|
* @defaultValue window
|
|
*/
|
|
target?: 'window' | 'parent' | undefined;
|
|
/**
|
|
* Defines the threshold value of the vertical scroll position of the target to toggle the visibility.
|
|
* @defaultValue 400
|
|
*/
|
|
threshold?: number | undefined;
|
|
/**
|
|
* Icon to display.
|
|
* @deprecated since v3.27.0. Use 'icon' slot.
|
|
*/
|
|
icon?: string | undefined;
|
|
/**
|
|
* Defines the scrolling behaviour, 'smooth' adds an animation and 'auto' scrolls with a jump.
|
|
* @defaultValue smooth
|
|
*/
|
|
behavior?: string | undefined;
|
|
/**
|
|
* Used to pass attributes to DOM elements inside the component.
|
|
* @type {ScrollTopPassThroughOptions}
|
|
*/
|
|
pt?: PTOptions<ScrollTopPassThroughOptions>;
|
|
/**
|
|
* 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 ScrollTop component.
|
|
*/
|
|
export interface ScrollTopSlots {
|
|
/**
|
|
* Custom scrolltop icon template.
|
|
*/
|
|
icon(): VNode[];
|
|
}
|
|
|
|
/**
|
|
* Defines valid emits in ScrollTop component.
|
|
*/
|
|
export interface ScrollTopEmits {}
|
|
|
|
/**
|
|
* **PrimeVue - ScrollTop**
|
|
*
|
|
* _ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/scrolltop/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*/
|
|
declare class ScrollTop extends ClassComponent<ScrollTopProps, ScrollTopSlots, ScrollTopEmits> {}
|
|
|
|
declare module '@vue/runtime-core' {
|
|
interface GlobalComponents {
|
|
ScrollTop: GlobalComponentConstructor<ScrollTop>;
|
|
}
|
|
}
|
|
|
|
export default ScrollTop;
|