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

package/README.md

@@ -19,37 +19,22 @@ 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).
 
-## 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.
+## Local table search persistence
+
+Set a stable, unique `paginationId` on `w-table` or `w-tree-table` to persist
+the page offset, page size, sorting and global search text in session storage.
+The optional `StoreableTablePagination.query.searchInput` field stores the text.
+
+- `w-table` restores search only when `wappTableObject.hasGlobalSearch` is enabled.
+- `w-tree-table` restores the text of its global search input.
+- Restoration updates both the visible input and the actual filter, preserving
+  the saved page within the filtered results, including when data arrives asynchronously.
+- Clearing the search stores an empty string so an older search is not restored.
+  Calling `w-table.clearFilters()` also clears the visible and stored search.
+- Existing entries without `searchInput` remain compatible and start with an empty search.
+- Without `paginationId`, searching still works but its state is not persisted.
+
+This search persistence does not apply to `w-table-lazy`.
 
 ## Further help