SearchExtensionMethod<K, T> extension

Extension providing advanced search and sorting capabilities for BoxInterface.

This extension adds a search method to any BoxInterface implementation, enabling full-text search, multi-term filtering, multi-criteria sorting, and pagination over the values stored in the box. This is especially useful for building responsive UIs or APIs that require efficient querying of local data.

Example usage:

final results = await box.search(
  query: 'john doe',
  searchableText: (user) => '${user.firstName} ${user.lastName}',
  page: 0,
  pageSize: 10,
  sortBy: [SortCriterion((user) => user.lastName)],
);

on

• BoxInterface<K, T>

Methods

search({required String query, required String searchableText(T item), int? page, int pageSize = 20, List<SortCriterion<T>>? sortBy}) → Future<List<T>>

Available on BoxInterface<K, T>, provided by the SearchExtensionMethod extension

Performs a full-text search, optional multi-criteria sort, and pagination on the box values.