Angular Paginator (ページネーター) の概要

Angular のページネーションは、プラットフォームが巨大なデータセットを扱うときに開発者に提供する最適な機能の 1 つです。Angular Paginator の目的は、大量のデータコレクションを複数のページに分割して配布することです。これにより、優れた UX を提供しながら、ページ化された情報と項目を比較しやすく理解しやすい方法で表示します。

通常、Angular Paginator コンポーネントはページ番号または合計レコードを表示します。

Ignite UI for Angular Pagination を使用すると、データセットを複数の同様のページに分割できます。このページネーション方法は、特に大きなデータセットや無限スクロールユーザーインターフェイスに適しています。Angular の Pagination コンポーネントを使用すると、ページの範囲から特定のページを選択し、各ページに表示するレコード数を決定できます。

Angular Paginator の例

以下の Angular Pagination の例は、ユーザーがさまざまな項目を含む 4 つのページをナビゲートし、ドロップダウンメニューから表示する項目の数を選択する方法を示す Paginator テンプレートを示しています。

Ignite UI で Angular Paginator を使用する方法

各ページネーターインスタンスには以下が必要です。

ページごとの項目数 (デフォルト値は 15 です)。
ページングされている項目の合計数

また、デフォルトでは、Angular Paginator コンポーネントが初期化されると現在のページは 0 に設定されますが、page プロパティで変更できます。

<igx-paginator #paginator [totalRecords]="120" [perPage]="25">
</igx-paginator>

Angular ページネーションのテンプレート

デフォルトのページネーションテンプレートは 2 つの主要部分で構成されます。1 つ目はドロップダウンで各ページに表示される項目の数を定義できます。2 つ目はナビゲーションボタンでページ間を簡単に移動できます。

また、igx-paginator-content 参照が igx-paginator 内で定義されている場合、ページング領域はユーザーによるカスタムテンプレートの追加をサポートします。

<igx-paginator #paginator>
    <igx-paginator-content>
        ...
    </igx-paginator-content>
</igx-paginator>

さらに、IgxPageSizeSelectorComponent と IgxPageNavigationComponent が導入され、ページネーターコンポーネントでカスタムコンテンツを定義できるようになりました。以下に例を示します。前者はページサイズに対応するドロップダウン要素とラベルを追加し、後者はすべてのアクションボタンでページナビゲーションを処理します。

<igx-paginator #paginator>
    <igx-paginator-content>
        <igx-page-size></igx-page-size>
        <igx-page-nav></igx-page-nav>
    </igx-paginator-content>
</igx-paginator>

ページングは、paginate、previousPage、nextPage メソッドおよび page、perPage、totalRecords 入力を使用して、Paging API (以下のセクションで詳細に説明されています) を介してプログラムで実行することもできます。ここで page は現在のページを設定できます。perPage は 1 ページに表示される項目の数を設定できます。totalRecords はグリッドにあるレコードの数を設定できます。TotalRecords プロパティは、リモートデータのページングがあり、リモートレコードの合計数に基づいてページの数を変更する場合に役に立ちます。ページングを使用しており、すべてのデータがグリッドに渡される場合、totalRecords プロパティの値は提供されたデータソースの長さにデフォルトで設定されることに注意してください。totalRecords が設定されている場合、データソースに基づいてデフォルトの長さよりも優先されます。

ページング API

入力	説明
displayDensity	ページネーションの表示密度を取得または設定します。
page	現在のページをを取得または設定します。
perPage	ページごとに表示される項目数を取得または設定します。
selectOptions	パジネーターの Select 要素でカスタムオプションを取得または設定します。デフォルトの選択値 [5、10、15、25、50、100、500]
totalRecords	合計レコード数を取得または設定します。
totalPages	合計ページ数を取得または設定します。
resourceStrings	リソース文字列を取得または設定します。デフォルトで EN リソースを使用します。
overlaySettings	カスタム OverlaySettings を取得/設定します。

出力	説明
perPageChange	ページネーターの `perPage` プロパティ値が変更されたときに発生します。
pageChange	現在のページが変更されたときに発生されます。
paging	ページングが実行さる前に発生されます。キャンセル可能。
pagingDone	ページングが実行された後に発生されます。

Angular Paginator のローカリゼーション

最小限のコードで、ページングコンポーネントのすべての文字列を簡単にローカライズできます。特定のページングインスタンスをローカライズするには、resourceStrings 入力プロパティを使用します。

手順 1 - IPaginatorResourceStrings インターフェースと changei18n 関数をインポートします:

import { IPaginatorResourceStrings, changei18n } from "igniteui-angular";

手順 2 - ページングリソース文字列を定義します。

private paginatorResourceStrings: IPaginatorResourceStrings = {
    igx_paginator_label: 'Records per page:',
    igx_paginator_first_page_button_text: 'Custom first page text',
    igx_paginator_last_page_button_text: 'Custom last page text',
    igx_paginator_next_page_button_text: 'Custom next page text',
    igx_paginator_previous_page_button_text: 'Custom previous page text',
    igx_paginator_pager_text: 'out of'
};

手順 3 - app.module レベルでコンポーネントのグローバル i18n を変更するために、オブジェクトをパラメーターとして changei18n 関数に渡します。これにより、アプリケーションのすべてのページングコンポーネントのリソース文字列が変更されます。

public ngOnInit(): void {
    changei18n(this.paginatorResourceStrings as any);
}

リソース文字列を特定のページングコンポーネントに変更するには、@ViewChild を使用して、ページが再描画される前に呼び出されるコールバックを使用して、requestAnimationFrame メソッド内で目的の resourceStrings を設定します。新しくインスタンス化されたオブジェクトを resourceStrings プロパティに設定すると、指定されたコンポーネントのインスタンスのみがローカライズされます。

@ViewChild('paginator', { read: IgxPaginatorComponent, static: false }) public paginator: IgxPaginatorComponent;
...

public ngOnInit(): void {
    requestAnimationFrame(() => {
        this.paginator.resourceStrings = this.paginatorResourceStrings;
    });
}

API リファレンス

その他のリソース

コミュニティに参加して新しいアイデアをご提案ください。