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

package/README.md

@@ -19,45 +19,37 @@ 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).
 
-## 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.
+## Filter panels and session pagination
+
+Use a stable, unique `paginationId` on `w-table`, `w-tree-table` and
+`w-table-lazy`. The tables store the offset, page size, `sortField` and
+`sortOrder` per tenant. Local tables restore after data arrives; lazy tables
+include the restored state in the initial `queryElements` event.
+
+`w-filter-panel.searchClicked` fires on initialization as well as on manual
+searches. `options.source` is `init-storage`, `init-default` or `user-click`.
+For new integrations subscribe only to `searchClicked`, not also to `lastQuery`;
+the latter remains available for backwards compatibility.
+
+In `w-table-lazy`, call `applyFilterQuery(filterQuery)` after receiving
+`queryElements` and obtaining the table reference. It returns the query to send
+to the API, preserves initial/restored pagination and resets only the offset
+for manual searches. The reset and sorting are saved under the table's own
+pagination id. Missing source is treated as a manual search for compatibility.
+This method does not emit `queryElements` or call the API.
+
+The consumer must wait for both the filter query and the table query, then
+combine the filter rules with the returned lazy query. Do not replace it with
+fixed `first`/`rows` values, or call `refreshPagination(0)` during initialization.
+Later page and sort events should reuse the current panel filters without
+calling `applyFilterQuery` again.
+
+### Local alpha validation
+
+Build the library with the production configuration and run `npm pack` from
+`dist/wapp-components`. Install the resulting `3.5.0-alpha.1` archive in the
+consumer for local testing. Publication is a separate step; use an alpha dist
+tag when publishing a prerelease, never the default `latest` tag.
 
 ## Further help