Yamada UIにスターをあげる

スター
Yamada UIYamada UIv1.7.2

InfiniteScrollArea

InfiniteScrollAreaは、無限スクロール機能を提供するコンポーネントです。このコンポーネントは、コンポーネントの終わりに達したときに次のデータセットを自動的に読み込み、表示することで、スムーズなスクロール体験を提供します。

ソース@yamada-ui/infinite-scroll-area

Props

InfiniteScrollAreaProps

behavior

説明

Determines whether scrolling is instant or animates smoothly.

タイプ

ScrollBehavior

colorScheme

説明

The visual color appearance of the component.

タイプ

"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"

disabled

説明

If true, the infinite scroll is disabled.

タイプ

boolean

デフォルト

false

finish

説明

The infinite scroll area finish to use.

タイプ

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

indexRef

説明

Ref to a reset index function.

タイプ

RefObject<(index: number) => void>

initialLoad

説明

If true, invoke onLoad function for the first time.

タイプ

boolean

デフォルト

false

isDisabled

非推奨

説明

If true, the infinite scroll is disabled.

非推奨

Use disabled instead.

タイプ

boolean

デフォルト

false

isReverse

非推奨

説明

If true, reverse direction.

非推奨

Use reverse instead.

タイプ

boolean

デフォルト

false

loading

説明

The infinite scroll area loading to use.

タイプ

type ONLY_FOR_FORMAT = | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

onLoad

説明

The callback invoked when trigger is intersect.

タイプ

({ entry, finish, index, }: { finish: () => void index: number entry?: IntersectionObserverEntry | undefined }) => void | Promise<void>

orientation

説明

The orientation of the infinite scroll.

タイプ

"horizontal" | "vertical"

デフォルト

'vertical'

resetRef

説明

Ref to a reset function.

タイプ

RefObject<(index?: number | undefined, runScroll?: boolean | undefined) => void>

reverse

説明

If true, reverse direction.

タイプ

boolean

デフォルト

false

rootMargin

説明

Margin around the root. Can have values similar to the CSS margin property, e.g. "10px 20px 30px 40px" (top, right, bottom, left).

タイプ

string

rootRef

説明

The element that is used as the viewport for checking visibility of the target. Defaults to the browser viewport if not specified or if null.

タイプ

RefObject<HTMLElement>

size

説明

The size of the InfiniteScrollArea.

タイプ

string

startIndex

説明

If set the onLoad function will start from the given index. If initialLoad is true, index starts from 0.

タイプ

number

デフォルト

1

threshold

説明

Either a single number or an array of numbers which indicate at what percentage of the target's visibility the observer's callback should be executed.

タイプ

number | number[]

triggerProps

説明

Props for infinite scroll area trigger component.

タイプ

HTMLUIProps

variant

説明

The variant of the InfiniteScrollArea.

タイプ

string

GitHubでこのページを編集する

ScrollAreaColorSwatch