@syncfusion/react-navigations
Version:
Syncfusion React Navigations with Toolbar and Context Menu for seamless page navigation
48 lines (47 loc) • 1.49 kB
TypeScript
import { HTMLAttributes, RefAttributes, ForwardRefExoticComponent } from 'react';
/**
* Specifies the props for the HScroll component.
*/
export interface HScrollProps {
/**
* Specifies the left or right scrolling distance of the horizontal scrollbar moving.
* This property controls how far content scrolls when navigation buttons are clicked.
*
* @default undefined
*/
scrollStep?: number;
/**
* Specifies whether the HScroll component is enabled or disabled.
* When set to `true`, the component will be disabled.
*
* @default false
*/
isDisabled?: boolean;
}
/**
* Specifies the interface for the HScroll component instance.
*/
export interface IHScroll extends HScrollProps {
/**
* Specifies the h-scroll component element.
*
* @private
* @default null
*/
element?: HTMLDivElement | null;
}
/**
* HScroll component introduces horizontal scroller when content exceeds the current viewing area.
* It can be useful for components like Toolbar, Tab which need horizontal scrolling.
* Hidden content can be viewed by touch moving or navigation icon click.
*
* ```typescript
* <HScroll scrollStep={10} className="hscroll-container">
* <div>Item 1</div>
* <div>Item 2</div>
* <div>Item 3</div>
* </HScroll>
* ```
*/
export declare const HScroll: ForwardRefExoticComponent<HScrollProps & HTMLAttributes<HTMLDivElement> & RefAttributes<IHScroll>>;
export default HScroll;