ngx-wapp-components 3.4.1-alpha.4 → 3.4.1-alpha.5

package/README.md

@@ -19,23 +19,45 @@ After building your library with `ng build wapp-components`, go to the dist fold
 
 Run `ng test wapp-components` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
-## Lazy table initial page
-
-Use `[initialPage]="3"` on `w-table-lazy` to start on the third page.
-The default is `1`; only positive integers are accepted. With
-`[rowsPerPage]="10"`, page 3 emits the initial `queryElements` request with
-`first: 20` and `rows: 10`.
-
-Pagination saved in session for the tenant and table configuration's
-`identificator` takes priority, including its saved page size.
-`SessionStorageService` saves the key and pagination `id` as
-`table-paginator_[identificator]` to separate pagination from filter-panel keys.
-Pass the unprefixed identifier to `setTablePaginationQuery`,
-`getStoredPagination` and the table's `setStoredTablePagination` method.
-Old unprefixed pagination is not restored because those keys may belong to
-another component. Tables with the same `identificator` still share pagination.
-`initialPage` is applied only on initialization, not on subsequent page,
-sort or filter changes. Choose a page that exists in the result set.
+## Initial page for tables
+
+Use `[initialPage]="3"` with `[rowsPerPage]="10"` on `w-table` or
+`w-tree-table` to start on page 3 (offset 20). The default is page 1.
+Only positive integers are accepted; choose a page that exists in the data.
+For tree tables, pagination counts root nodes, not their children.
+
+The initial page is applied once, when data and the effective page size
+are available, including when data arrives asynchronously. Later navigation,
+filtering, data refreshes and page-size changes do not reapply it. Without
+`rowsPerPage`, the existing automatic page-size calculation is preserved.
+
+## Session pagination
+
+Set a stable, unique `paginationId` on `w-table`, `w-tree-table` or
+`w-table-lazy` to identify its pagination in the current tenant's session:
+
+```html
+<w-table paginationId="customers-list" ...></w-table>
+<w-tree-table paginationId="categories-tree" ...></w-tree-table>
+<w-table-lazy paginationId="orders-list" ...></w-table-lazy>
+```
+
+The saved page offset and page size take priority over `initialPage` and
+`rowsPerPage` when the component is created again. In non-lazy tables,
+restoration waits for data. Page navigation, the page-size selector and
+filter resets update the saved state. Configure the id before initialization
+and use different ids for independent lists, even if their row identifiers
+are the same. Storage uses the existing tenant from `LocalStorageService`.
+
+Without `paginationId`, `w-table` and `w-tree-table` do not read or write
+pagination in session. For backwards compatibility, `w-table-lazy` continues
+using `wappTableLazyLoadingObject.identificator` as its key when the new input
+is omitted. With an explicit id, only that id is used, not the legacy key.
+
+Pagination is stored directly under its id, without an automatic prefix.
+Choose ids distinct from other tenant session entries (such as filter panels).
+Existing entries using the old `table-paginator_` prefix are not restored;
+new pagination is saved under the unprefixed id.
 
 ## Further help