primevue-mirror/components/scrollpanel/ScrollPanel.d.ts

66 lines
1.5 KiB
TypeScript
Raw Normal View History

2023-02-28 17:39:29 +00:00
/**
*
* ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar.
*
* [Live Demo](https://www.primevue.org/scrollpanel/)
*
* @module scrollpanel
*
*/
2022-09-06 12:03:37 +00:00
import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
2023-02-28 17:39:29 +00:00
/**
* Defines valid properties in ScrollPanel component.
*/
2022-09-06 12:03:37 +00:00
export interface ScrollPanelProps {
2022-09-14 11:26:01 +00:00
/**
* Step factor to scroll the content while pressing the arrow keys.
2023-02-28 17:39:29 +00:00
* @defaultValue 5
2022-09-14 11:26:01 +00:00
*/
step?: number | undefined;
2022-09-06 12:03:37 +00:00
}
2023-02-28 17:39:29 +00:00
/**
* Defines valid slots in Accordion slots.
*/
2022-09-06 12:03:37 +00:00
export interface ScrollPanelSlots {
/**
* Custom content slot.
*/
default: () => VNode[];
}
2023-02-28 17:39:29 +00:00
export interface ScrollPanelEmits {}
2022-09-06 12:03:37 +00:00
2023-02-28 17:39:29 +00:00
/**
* **PrimeVue - ScrollPanel**
*
* _ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar.._
*
* [Live Demo](https://www.primevue.org/scrollpanel/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg)
*
* @group Component
*
*/
export declare class ScrollPanel extends ClassComponent<ScrollPanelProps, ScrollPanelSlots, ScrollPanelEmits> {}
2022-09-06 12:03:37 +00:00
declare module '@vue/runtime-core' {
interface GlobalComponents {
2022-09-14 11:26:01 +00:00
ScrollPanel: GlobalComponentConstructor<ScrollPanel>;
2022-09-06 12:03:37 +00:00
}
}
/**
*
* ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar.
*
* Demos:
*
2022-09-14 11:26:01 +00:00
* - [ScrollPanel](https://www.primefaces.org/primevue/scrollpanel)
2022-09-06 12:03:37 +00:00
*
*/
export default ScrollPanel;