@k8ordo/ui

InView

子要素が画面やスクロール領域に入っているかを知らせます。遅延読み込みや、スクロールに合わせた表示に使います。

インポート

ts
import { InView } from '@k8ordo/ui';

使い方

基本的な使い方

Out of view

Scroll down.

Target

tsx
const [container, setContainer] = useState<HTMLElement | null>(null);
const [isInView, setIsInView] = useState(false);

<div ref={setContainer} className={styles.scroller}>
  <InView onChange={setIsInView} root={container}>
    <p>Target</p>
  </InView>
</div>

once

onceを付けると、最初に見えた時点で観測をやめます。その後に外れてもfalseを知らせません。

Not seen yet

Scroll down, then back up. The badge stays.

Target

tsx
<InView once onChange={setHasBeenSeen} root={container}>
  <p>Target</p>
</InView>

複数の子要素

要素が複数あるときは、どれか1つでも見えていればtrueになります。後から増えたり外れたりした要素にも追従します。見えていた要素が外れて見えているものが無くなれば、falseを知らせます。観測する要素がまだ1つも無い間はonChangeを呼びません。

Props

children
Type: ReactNode
Default: -
onChange
Type: (isInView: boolean) => void
Default: -
once?
Type: boolean
Default: false
root?
Type: Element|null
Default: null
rootMargin?
Type: string
Default: '0px'
threshold?
Type: number
Default: 0
PropTypeDefault
childrenReactNode-
onChange(isInView: boolean) => void-
once?booleanfalse
root?Element|nullnull
rootMargin?string'0px'
threshold?number0
k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。