ngx-wapp-components 3.5.0 → 3.5.1

package/README.md

@@ -19,54 +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).
 
-## 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.
-
-Session pagination also includes `sortField` and `sortOrder` (`1` ascending,
-`-1` descending) for single-column sorting in all three table components.
-Sorting changes are saved immediately and preserved when navigating or changing
-page size. Restoring a local table sorts its data and updates its sort indicator;
-the lazy table includes the restored sorting in its first `queryElements` event.
-Existing entries without sorting remain valid and use the default unsorted
-state. External calls to the lazy table's `setStoredTablePagination` that only
-change `first` and `rows` retain the current sorting.
+## 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