Эта страница переведена машинным способом и может содержать ошибки. Читать оригинал на английском

Элементы

Pagination

Пагинация переключает страницы набора: результаты поиска, строки таблицы, архив. Она показывает «Назад», страницы вокруг текущей (первая и последняя показываются всегда, а на каждый пропущенный участок приходится многоточие), дочерние элементы приложения и «Вперёд». Поведение за ней: какие страницы показаны, нажатия, клавиатура, отключённые «Назад» и «Вперёд» на краях, ориентир навигации и текущая страница для скринридеров. Внешний вид остаётся за приложением: у элементов нет собственного цвета, размера или подписи, приложение стилизует их или рисует само.

el-pagination.tsx
el-pagination.tsxLive
import { mount, signal, Text, View } from "nsh";
import { Pagination } from "nsh/base";
import { desktop, Log, Panel, Segmented, Split, ui } from "./palette";

// Search results paged with a count, and a compact pager beside them. The
// look is all `itemClass` over the component's own numbers and labels:
// quiet items until hovered, the current page lit in the brand color
// (`selected:`) with `transition-colors` (still with reduced motion), the
// ends dimmed (`disabled:`).
const itemClass =
  "min-w-8 h-8 px-2 items-center justify-center rounded-md text-sm text-foreground " +
  "transition-colors duration-200 motion-reduce:transition-none hover:bg-hover active:opacity-70 " +
  "selected:bg-brand selected:text-on-brand disabled:opacity-35 focus:outline-2 focus:outline-ring";

const total = 238;
const page = signal(1);
const perPage = signal<"10" | "25">("10");
const chapter = signal(1);
const events = signal<string[]>([]);

const pages = () => Math.ceil(total / Number(perPage()));
const first = () => (page() - 1) * Number(perPage()) + 1;
const last = () => Math.min(page() * Number(perPage()), total);

const changed = (next: number) => {
  page.set(next);
  events.set([`onChange({ page: ${next} })`, ...events()].slice(0, 4));
};

function App() {
  return (
    <View style={{ flex: 1, backgroundColor: ui().page, padding: 20, paddingTop: 24, gap: 14 }}>
      <Text style={{ fontSize: 22, fontWeight: "700", color: ui().text }}>pagination</Text>
      <Text style={{ color: ui().muted }}>{desktop ? "Click a page, or Tab to one and press Return" : "Tap a page"}</Text>

      <Split
        gap={14}
        inspector={
          <>
            <Panel title="page · totalPages">
              <Text style={{ fontSize: 13, color: ui().text }}>{`${page()} of ${pages()}`}</Text>
            </Panel>
            <Log title="onChange({ page })" lines={events()} minHeight={110} />
          </>
        }
      >
        <View style={{ ...ui().card, borderRadius: 16, padding: desktop ? 16 : 18, gap: 14 }}>
          <View style={{ flexDirection: "row", alignItems: "center", justifyContent: "space-between", flexWrap: "wrap", gap: 8 }}>
            <Text style={{ fontSize: 13, color: ui().muted }}>{`Showing ${first()}–${last()} of ${total} results`}</Text>
            <Segmented
              size="small"
              options={[
                { value: "10", label: "10" },
                { value: "25", label: "25" },
              ]}
              value={perPage()}
              onChange={(next) => {
                const row = first();
                perPage.set(next);
                page.set(Math.floor((row - 1) / Number(next)) + 1);
              }}
            />
          </View>
          <Pagination
            page={page()}
            totalPages={pages()}
            visiblePages={desktop ? 7 : 5}
            accessibilityLabel="Search results pages"
            previousAccessibilityLabel="Previous"
            nextAccessibilityLabel="Next"
            class="gap-1 flex-wrap"
            itemClass={itemClass}
            onChange={({ page: next }) => changed(next)}
          />
          <View style={{ height: 1, backgroundColor: ui().line }} />
          <Pagination
            compact
            page={chapter()}
            totalPages={12}
            accessibilityLabel="Chapters"
            previousAccessibilityLabel="Previous chapter"
            nextAccessibilityLabel="Next chapter"
            class="items-center justify-between"
            itemClass={`${itemClass} px-3 border border-border`}
            onChange={({ page: next }) => chapter.set(next)}
          >
            <Text style={{ fontSize: 13, color: ui().muted }}>{`Chapter ${chapter()} of 12`}</Text>
          </Pagination>
        </View>
      </Split>
    </View>
  );
}

mount(App);
use nsh_base::{pagination, theme};
use nsh_core::prelude::*;

fn results() -> impl IntoElement {
    let page = signal(1u32);
    pagination()
        .page(move || page.get())
        .total_pages(24)
        .accessibility_label("Search results")
        .previous_accessibility_label("Previous")
        .next_accessibility_label("Next")
        .item_class("min-w-9 h-9 px-2 items-center justify-center rounded-md hover:bg-accent selected:bg-primary selected:text-primary-foreground disabled:opacity-50")
        .gap_1()
        .on_change(move |p: &u32| page.set(*p))
}

Pagination приходит из nsh/base, крейта nsh-base на Rust. В Rust pagination() создаёт его с сеттером на каждый проп (.page(..), .total_pages(..)), .on_change(..) для страницы, которую выбирает пользователь, типизированными методами стиля для строки и .child(..) для содержимого приложения.

#Страница

Страница принадлежит приложению: page — текущая страница, начиная с 1, а onChange({ page }) сообщает о странице, которую пользователь выбрал нажатием на страницу, на «Назад» или на «Вперёд». Приложение задаёт её, загружает эту страницу и показывает её строки. totalPages — это количество страниц; page за последней страницей показывает последнюю. Нажатие на текущую страницу ничего не сообщает, как и «Назад» на первой странице и «Вперёд» на последней.

#Показанные страницы

При visiblePages (не менее 5, по умолчанию) строка показывает все страницы, пока они помещаются. Сверх этого она показывает первую и последнюю страницы, текущую с таким количеством страниц с каждой стороны, какое помещается, (visiblePages - 3) / 2, и многоточие на каждый пропущенный участок страниц:

page из 20, visiblePages={7}Показано
11 2 3 4 5 … 20
61 … 4 5 6 7 8 … 20
201 … 16 17 18 19 20

Десять тысяч страниц показывают те же семь элементов. Нечётное visiblePages центрирует текущую страницу.

#Элементы

Каждый элемент получает itemClass и itemStyle приложения: текущая страница — selected:, элемент, не принимающий нажатия, — disabled:, элемент с фокусом клавиатуры — focus:. Строку раскладывает приложение с помощью class (по умолчанию в ряд; gap-*, justify-*).

Без renderItem страница показывает свой номер, многоточие — …, а «Назад» и «Вперёд» — свои метки доступности (‹ и › без них). renderItem рисует содержимое каждого элемента из PaginationItemState:

ПолеТипОписание
kind"previous" | "page" | "ellipsis" | "next"Что представляет собой элемент.
pagenumberНомер страницы; страница, на которую ведёт «Назад» или «Вперёд» (на краях — текущая); первая скрытая страница многоточия.
start, endnumberСкрытые страницы многоточия: start включительно, end (следующая показанная страница) не включается.
currentbooleanТекущая страница.
disabledbooleanНе принимает нажатия: «Назад» на первой странице, «Вперёд» на последней, все элементы отключённой пагинации.
<Pagination
  page={page()}
  totalPages={pages()}
  previousAccessibilityLabel="Previous page"
  nextAccessibilityLabel="Next page"
  itemClass="size-9 items-center justify-center rounded-md selected:bg-primary"
  renderItem={(item) =>
    item.kind === "previous" ? <Icon name="chevron-left" /> :
    item.kind === "next" ? <Icon name="chevron-right" /> :
    item.kind === "ellipsis" ? <JumpMenu from={item.start!} to={item.end!} onPick={(p) => page.set(p)} /> :
    <Text class={item.current ? "font-semibold text-primary-foreground" : "text-foreground"}>{item.page}</Text>
  }
  onChange={({ page: next }) => page.set(next)}
/>

Многоточие само не принимает нажатий: что оно делает, решает приложение. Menu, нарисованный в нём, перечисляет скрытые им страницы, как это делает JumpMenu выше.

#Компактный вид

compact показывает только «Назад», дочерние элементы и «Вперёд»: пейджер для узкого экрана, где страница указана в дочерних элементах.

<Pagination compact page={page()} totalPages={12} onChange={({ page: next }) => page.set(next)} class="items-center gap-3">
  <Text class="text-sm text-muted-foreground">{`${page()} of 12`}</Text>
</Pagination>

Дочерние элементы стоят после страниц и перед «Вперёд» в любой из форм: счётчик страниц, поле для перехода на страницу.

#Props

ПропRustТипПо умолчаниюОписание
page.page(..)numberобязательноТекущая страница, начиная с 1; приложение задаёт её в onChange.
totalPages.total_pages(..)numberобязательноСколько всего страниц, не менее 1.
visiblePages.visible_pages(..)number5Наибольшее число одновременно показанных страниц, включая первую и последнюю; не менее 5.
compact.compact(..)booleanfalseТолько «Назад», дочерние элементы и «Вперёд».
disabled.disabled(..)booleanfalseНи один элемент не принимает нажатия и фокус клавиатуры; стили disabled: применяются, а скринридеры сообщают, что элементы приглушены.
accessibilityLabel.accessibility_label(..)stringнетКак скринридеры называют навигацию: по чему она листает.
previousAccessibilityLabel, nextAccessibilityLabel.previous_accessibility_label(..), .next_accessibility_label(..)stringнетЧто скринридеры произносят для «Назад» и «Вперёд», а также их содержимое без renderItem.
itemClass, itemStyle.item_class(..), .item_style(|s| ..)string, StyleProp<TextStyle>нетВнешний вид каждого элемента: selected: на текущей странице, disabled:, focus:; текстовые стили передаются его содержимому.
renderItem.render_item(|s: &PaginationItemState| ..)(item: PaginationItemState) => JSX.ElementнетРисует содержимое каждого элемента из его состояния.
children.child(..)JSX.ElementнетСодержимое приложения после страниц, перед «Вперёд».
class, styleметоды стиляstring, StyleProp<ViewStyle>нетВнешний вид и раскладка строки.

#События

СобытиеRustОписание
onChange.on_change(|page: &u32| ..){ page }: страница, которую пользователь выбрал нажатием на страницу, «Назад» или «Вперёд». Текущая страница никогда не сообщается.

#Анимация

Текущая страница переходит от элемента к элементу так, как указывают классы selected: приложения: transition-colors на itemClass плавно переводит выделение со страницы, которую покинули, на страницу, которую выбрали. Смена страницы оставляет каждый элемент на месте и меняет то, что элементы показывают, поэтому строка никогда не мерцает; переходы приложения не выполняются при уменьшенной анимации (motion-reduce:transition-none).

#Доступность

  • Строка является ориентиром навигации с именем из accessibilityLabel.
  • Каждая страница, «Назад» и «Вперёд» — это кнопка. Текущая страница озвучивается как текущая (ARIA aria-current="page") и выбрана; «Назад» на первой странице и «Вперёд» на последней приглушены.
  • На macOS и в вебе каждая страница, «Назад» и «Вперёд» — остановка фокуса клавиатуры, а Return и Space нажимают её. Страница, нажатая с клавиатуры, сохраняет фокус, как только приложение её покажет, где бы она ни оказалась в строке; так же сохраняют его первая или последняя страница, когда до неё доходит «Назад» или «Вперёд».

Общие сведения о метках, ролях и объявлениях см. в разделе Accessibility.

#Особенности платформ

  • iOS, Android и Mac Catalyst: нажатие — это касание, заканчивающееся на элементе.
  • Настольные платформы (macOS, Windows, Linux, GPUI) и веб: нажатие — это щелчок; на macOS и в вебе Tab переходит по элементам.
  • Каждая платформа рисует то, что стилизует приложение.