UNPKG

@yamada-ui/infinite-scroll-area

Version:

Yamada UI infinite scroll area component

31 lines (28 loc) 1.19 kB
import * as _yamada_ui_core from '@yamada-ui/core'; import { HTMLUIProps, ThemeProps } from '@yamada-ui/core'; import { UseInfiniteScrollProps } from '@yamada-ui/use-infinite-scroll'; import { ReactNode } from 'react'; interface InfiniteScrollAreaOptions { /** * The infinite scroll area finish to use. */ finish?: ReactNode; /** * The infinite scroll area loading to use. */ loading?: ReactNode; /** * Props for infinite scroll area trigger component. */ triggerProps?: HTMLUIProps; } interface InfiniteScrollAreaProps extends Omit<HTMLUIProps, keyof UseInfiniteScrollProps>, UseInfiniteScrollProps, ThemeProps<"InfiniteScrollArea">, InfiniteScrollAreaOptions { } /** * `InfiniteScrollArea` is for providing infinite scroll functionality. * This feature provides a smooth scrolling experience by automatically loading and displaying the next dataset when the user reaches the end of the page. * * @see Docs https://yamada-ui.com/components/data-display/infinite-scroll-area */ declare const InfiniteScrollArea: _yamada_ui_core.Component<"div", InfiniteScrollAreaProps>; export { InfiniteScrollArea, type InfiniteScrollAreaProps };