@syncfusion/react-navigations
Version:
A package of Pure React navigation components such as Toolbar and Context-menu which is used to navigate from one page to another
45 lines (44 loc) • 1.42 kB
TypeScript
import { HTMLAttributes, ForwardRefExoticComponent, RefAttributes } from 'react';
export interface VScrollProps {
/**
* Specifies the up or down scrolling distance of the vertical scrollbar moving.
* This property controls how far content scrolls when navigation buttons are clicked.
*
* @default undefined
*/
scrollStep?: number;
/**
* Specifies whether the VScroll component is enabled or disabled.
* When set to `true`, the component will be disabled.
*
* @default false
*/
isDisabled?: boolean;
}
/**
* Specifies the interface for the VScroll component instance.
*/
export interface IVScroll extends VScrollProps {
/**
* Specifies the VScroll component element.
*
* @private
* @default null
*/
element?: HTMLDivElement | null;
}
/**
* VScroll component introduces vertical scroller when content exceeds the current viewing area.
* It can be useful for components like Toolbar, Tab which need vertical scrolling.
* Hidden content can be viewed by touch moving or navigation icon click.
*
* ```typescript
* <VScroll scrollStep={10} className="vscroll-container">
* <div>Item 1</div>
* <div>Item 2</div>
* <div>Item 3</div>
* </VScroll>
* ```
*/
export declare const VScroll: ForwardRefExoticComponent<VScrollProps & HTMLAttributes<HTMLDivElement> & RefAttributes<IVScroll>>;
export default VScroll;