このページは機械翻訳のため、誤りを含む場合があります。 英語の原文を読む

要素

スクロール

Scroll は、ネイティブのスクロールビューです(iOS と Mac Catalyst では UIScrollView、Android では ScrollView)。すべての子要素をコンテンツとしてレイアウトし、ネイティブにスクロールさせます。スクロール、フリング、バウンス、スナップはプラットフォーム側でディスプレイのリフレッシュレートで動作します。Rust では scroll()、TSX では nsh の <Scroll> で作成します。

el-scroll.tsx
el-scroll.tsxLive
import { mount, Scroll, type ScrollRef, signal, Text, View } from "nsh";
import { button, buttonText, desktop, Inspector, Panel, size, ui, wide } from "./palette";

// The page colors, read when they render: they follow the theme.
const colors = (): string[] => [ui().accent, ui().info, ui().violet, ui().down, ui().warn, ui().up];

function App() {
  const page = signal(0);
  // A page is as wide as the scroll view: 390 on a phone, wider on a desktop.
  const width = signal(390);
  const y = signal(0);
  let scroller!: ScrollRef;
  const rows = Array.from({ length: 40 }, (_, i) => i + 1);

  /** Pages as wide as the scroll view; `inset`: each page's margin. */
  const pager = (inset: number, style: object) => (
    <Scroll
      horizontal
      pagingEnabled
      scrollbar={false}
      style={style}
      onLayout={({ bounds }) => width.set(bounds.size.width)}
      onMomentumEnd={({ offset }) => page.set(Math.round(offset.x / width()))}
    >
      <Each of={colors()}>
        {(color, index) => (
          <View style={{ width: width(), padding: inset }}>
            <View style={{ flex: 1, borderRadius: 16, backgroundColor: color(), alignItems: "center", justifyContent: "center" }}>
              <Text style={{ color: ui().page, fontSize: 32, fontWeight: "700" }}>{index() + 1}</Text>
            </View>
          </View>
        )}
      </Each>
    </Scroll>
  );
  const toTop = (compact: boolean) => (
    <View
      onPress={() => scroller.scrollTo({ y: 0, animated: true })}
      {...button("secondary", { size: compact ? "md" : "sm" })}
    >
      <Text style={buttonText()}>scrollTo top</Text>
    </View>
  );

  return (
    <View style={{ flex: 1, backgroundColor: ui().page, paddingTop: 24, gap: 12 }}>
      {() =>
        wide() ? (
          <View style={{ flex: 1, paddingHorizontal: 20, paddingBottom: 20, gap: 14 }}>
            <Text style={{ fontSize: 22, fontWeight: "700", color: ui().text }}>scroll</Text>
            <Text style={{ color: ui().muted }}>
              {desktop ? "Shift+wheel or swipe the trackpad across the pages; the wheel scrolls the rows" : "Swipe the pages and the rows"}
            </Text>
            <View style={{ flex: 1, flexDirection: "row", gap: 16 }}>
              <View style={{ flex: 1, minWidth: 0, gap: 12 }}>
                {pager(0, { height: 150, flexGrow: 0, borderRadius: 16 })}
                {/* The scroll view fills its region, so its scrollbar sits at the region's edge. */}
                <View style={{ flex: 1, borderRadius: 16, borderWidth: 1, borderColor: ui().line, overflow: "hidden" }}>
                  <Scroll ref={scroller} style={{ flex: 1 }} scrollEventThrottle={16} onScroll={(e) => y.set(e.offset.y)}>
                    <View style={{ padding: 12, gap: 6 }}>
                      <Each of={rows}>
                        {(n) => (
                          <View style={{ ...ui().row, borderRadius: 8, height: size.row, paddingHorizontal: 12, justifyContent: "center" }}>
                            <Text style={{ color: ui().text, fontSize: size.label }}>Row {n()}</Text>
                          </View>
                        )}
                      </Each>
                    </View>
                  </Scroll>
                </View>
              </View>
              <Inspector>
                <Panel title="Horizontal, pagingEnabled · onMomentumEnd">
                  <Text style={{ fontSize: 13, color: ui().text, fontVariant: ["tabular-nums"] }}>
                    page {page() + 1} of {colors().length}
                  </Text>
                </Panel>
                <Panel title="Vertical · onScroll">
                  <Text style={{ fontSize: 13, color: ui().text, fontVariant: ["tabular-nums"] }}>y = {Math.round(y())}</Text>
                </Panel>
                {toTop(true)}
              </Inspector>
            </View>
          </View>
        ) : (
          <>
            <Text style={{ fontSize: 22, fontWeight: "700", color: ui().text, paddingHorizontal: 20 }}>scroll</Text>

            <Text style={{ color: ui().muted, paddingHorizontal: 20 }}>
              Horizontal, pagingEnabled · page {page() + 1} · {desktop ? "Shift+wheel or swipe the trackpad" : "swipe"}
            </Text>
            {pager(12, { height: 140, flexGrow: 0 })}

            <View style={{ width: "100%", maxWidth: 640, alignSelf: "center", flexDirection: "row", justifyContent: "space-between", alignItems: "center", paddingHorizontal: 20 }}>
              <Text style={{ color: ui().muted }}>Vertical · y = {Math.round(y())}</Text>
              {toTop(false)}
            </View>
            <Scroll ref={scroller} style={{ flex: 1 }} scrollEventThrottle={16} onScroll={(e) => y.set(e.offset.y)}>
              <View style={{ width: "100%", maxWidth: 640, alignSelf: "center", paddingHorizontal: 20, paddingBottom: 20, gap: 8 }}>
                <Each of={rows}>
                  {(n) => (
                    <View style={{ ...ui().row, borderRadius: 12, padding: 14 }}>
                      <Text style={{ color: ui().text }}>Row {n()}</Text>
                    </View>
                  )}
                </Each>
              </View>
            </Scroll>
          </>
        )
      }
    </View>
  );
}

mount(App);
use nsh_core::prelude::*;

scroll().flex_1().child(
    view().p_4().gap_2().child(each(
        rows,
        |row: &Row| row.id,
        |row, _index| text(move || row.get().title),
    )),
)

スクロールビューはすべての子要素を作成するため、中程度のサイズのページに向いています。長いデータや際限のないデータにはリストを使用してください。リストはビューポート付近の行だけを作成し、再利用します。

スクロールビューにはスクロール方向に境界のあるサイズが必要です。flex: 1(.flex_1())を指定するか、境界のある高さを持つコンテナー内に配置してください。コンテンツはスクロールビューの幅(横スクロールの場合は高さ)でレイアウトされ、必要なだけの高さ(幅)になります。

#Props

共通プロパティ(style の型は ViewStyle)に加えて、以下のプロパティがあります。Rust では、スクロール関連のプロパティは Scrollable トレイトのメソッドで、リストと共通です。

#Scrolling

プロパティRust型デフォルト説明
horizontal.horizontal()booleanfalse横方向にスクロールします。
scrollable.scrollable(..)booleantrueユーザーがスクロールできます。
scrollbar.scrollbar(..)boolean | ScrollbarThemetrueスクロールインジケーターを表示します。プラットフォーム標準のもの、またはアプリがテーマを設定した後は、アプリの組み込みバーが表示されます。オブジェクトを渡すと、そのビュー専用のテーマになります。デスクトップとデスクトップブラウザーでは、横スクロールのビューはインジケーターを維持します。マウス用のスクロールバーだからです。
bounces.bounces(..)booleantrue端を越えてオーバースクロールします。
pagingEnabled.paging(..)booleanfalseビューポートの倍数の位置で止まります。
snapToInterval.snap_interval(px(..))number0この長さの倍数の位置で止まります(0 でオフ)。
snapToOffsets.snap_offsets(..)number[]これらのオフセットで止まります。
snapToAlignment.snap_alignment(SnapAlignment::Center)"start" | "center" | "end""start"snapToInterval を使うとき、アイテムのどの位置をビューポートに揃えるかを指定します。
disableIntervalMomentum.disable_interval_momentum(..)booleanfalseフリングで移動できるのは最大で 1 つのスナップポイントまでです。
decelerationRate.deceleration(rate)"normal" | "fast" | numberプラットフォーム依存フリングが減速する速さです。1 ミリ秒あたりに保持される速度で指定します(normal は 0.998、fast は 0.99)。
contentInset.content_inset(EdgeInsets { .. })Partial<Edges>コンテンツの周囲の余白です。
contentOffset.content_offset(point(..)){ x?, y? }開始位置です。
contentStyleコンテンツビュー自身のスタイルViewStyle子要素を囲み、子要素と一緒にスクロールするビューのスタイルです。flexGrow: 1 を指定すると、少なくともビューポートと同じ高さになります(中央に配置する空状態の表示など)。
contentClassコンテンツビュー自身のスタイルstringclasses と同じです。例: "grow justify-center p-4"。
keyboardDismissMode.keyboard_dismiss_mode(KeyboardDismissMode::OnDrag)"none" | "on-drag" | "interactive""none"ドラッグでキーボードを閉じるかどうかを指定します。
keyboardShouldPersistTaps.keyboard_taps(KeyboardTaps::Handled)"never" | "always" | "handled" | boolean"never"タップでキーボードを閉じるかどうかを指定します。never(タップはキーボードを閉じるだけ)、always(キーボードは表示されたまま)、handled(タップを処理するものがあればキーボードは表示されたまま)。
scrollValue.scroll_value(&value)AnimatedValueスクロールオフセット(主軸)が入力されるアニメーション値で、スクロール連動アニメーション用です。
scrollEventThrottle.event_throttle(ms)numberonScroll イベントの最小間隔(ミリ秒)です(いずれにしても 1 フレームにつき最大 1 回です)。

#Pull to refresh

プロパティRust型説明
refreshing.refreshing(..)booleanリフレッシュ用のスピナーを表示します。
onRefresh.on_refresh(..)() => voidユーザーがプルして更新しました。読み込みを開始し、終了するまで refreshing を設定してください。
refreshIndicator.refresh_indicator(Some(height)){ height: number }アプリが独自のインジケーターを描画します。高さは height ポイントです。プラットフォームのスピナーは非表示になり、プルが height に達するとリフレッシュが実行され、リフレッシュ中はコンテンツの上に height が確保されます。高さが 0 以下の場合は、インジケーターなしになります。
pullValue.pull_value(&value)AnimatedValueビューが上端を越えてどれだけプルされたかが入力されるアニメーション値です(静止時は 0、プルに応じて増加します。リフレッシュ中にコンテンツの上に確保される余白は height(refreshIndicator 使用時)です)。アプリ独自のインジケーター用です。
let refreshing = signal(false);

scroll()
    .flex_1()
    .refreshing(refreshing)
    .on_refresh(move || {
        refreshing.set(true);
        spawn(async move {
            load().await;
            refreshing.set(false);
        });
    })
    .child(content())

#Zooming

maximumZoomScale を minimumZoomScale(Rust では .zoom_range(min, max))より大きく設定すると、ピンチでコンテンツをズームできます。ズームインすると、縦横両方向にスクロールできます。リストはスケールを維持します。

プロパティRust型デフォルト説明
minimumZoomScale.zoom_range(min, max)number1最小のズームです。
maximumZoomScale.zoom_range(min, max)number1最大のズームです。
zoomScale.zoom(..)numberこの値が変わると、そのスケールにズームします。それ以外のときは、ユーザーが操作したズームが維持されます。
bouncesZoom.bounces_zoom(..)booleantrueピンチ操作で上限・下限を超えることができ、離すと元に戻ります。
zoomable.zoomable(..)booleantrueユーザーがピンチでズームできます。
centerContent.center_content(..)booleanfalseビューポートより小さい(ズームアウトした)コンテンツを中央に配置します。
let photo = element_ref();

scroll()
    .element_ref(&photo)
    .zoom_range(1.0, 4.0)
    .center_content(true)
    .flex_1()
    .bg(black())
    .child(
        image(PICTURE)
            .w(px(390.0))
            .h(px(520.0))
            .on_press(move || photo.zoom_to(1.0, None, true)),
    )

#Events

イベントRustペイロード発生タイミング
onScroll.on_scrollScrollEventオフセットが変化したとき(1 フレームにつき最大 1 回、かつ scrollEventThrottle より短い間隔では発生しません)。
onScrollDragStart / onScrollDragEnd.on_scroll_drag_start / .on_scroll_drag_end{ offset }(Point<Points>)ユーザーがドラッグを開始 / 終了したとき。
onMomentumStart / onMomentumEnd.on_momentum_start / .on_momentum_end{ offset }ドラッグ後の慣性スクロールが開始 / 終了したとき。新しいドラッグで止められた慣性スクロールも、最後に onMomentumEnd が発生します。
onScrollEnd.on_scroll_end{ offset }スクロールが静止したとき。
onRefresh.on_refreshなしプルして更新されたとき。

ScrollEvent は { offset: Point; contentSize: Size; size: Size; zoomScale }(Rust では offset、content_size、size、zoom_scale)です。内容は、オフセット、(ズーム後の)コンテンツサイズ、ビューポートサイズ、ズームスケール(ビューがズームしない場合は 1)です。

#Ref methods

メソッドRust説明
scrollTo({ x?, y?, animated? })scroll_to(point(x, y), animated)指定したオフセットまでスクロールします。
zoomTo({ scale, x?, y?, animated? })zoom_to(scale, Some(point(x, y)), animated)scale(上限・下限に丸められます)にズームします。コンテンツ上の点(x、y、ズームされていない座標)をビューポートの中央に置くか、中央付近を基準にします。例: ダブルタップでタップした点を拡大する場合など。
let scroller = element_ref();
scroll().element_ref(&scroller).child(content());

scroller.scroll_to(point(px(0.0), px(0.0)), true);

#Keyboard

スクロールビュー内の入力欄は、ネイティブの仕組みでキーボードに隠れないように保たれます。スクロールビューに下部インセットが設定され、フォーカスされた入力欄まで自動的にスクロールされます。スクロールビューの外にあるコンテンツには、下部のパディングまたはマージンで env(keyboard-inset-height) を使用してください。フォームとキーボードを参照してください。

#Right to left

横スクロールのビューは、右から左へのレイアウトでは右端から始まり、コンテンツが変化しても右端からの距離を保ちます。子要素は左右反転されます。

#Platform notes

  • Android: プルして更新は NSH が描画します(オーバースクロールはネイティブのままです)。contentInset はパディングとして適用され、decelerationRate は、スナップ時の慣性スクロールの動きを決めます。
  • Android では、NSH 独自のスクロールビューでズームします。このビューはコンテンツを左上を基準に拡大縮小し、縦横両方向にスクロールします。ピンチは、Android が定める指の間隔の最小値(約 27 mm)を超えてから始まります。
  • Mac Catalyst(Mac イディオム)では、NSH がプルを検出してスピナーを表示します。
  • iOS では、ズームが終了すると、テキストとキャンバスをズーム後の解像度で再描画します。