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

package/README.md

@@ -19,23 +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).
 
-## 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.
+## 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