useFilter

Provides locale-aware string filtering methods.

Provides locale-aware string filtering with contains, startsWith, and endsWith methods. Built on Intl.Collator for proper locale-sensitive string comparison.

Import#

import { useFilter } from '@volue/wave-react';

Example#


API Reference#

Arguments#

Prop
Type
Default
locale*
string
options
Intl.CollatorOptions

Returns#

{
startsWith: (string: string, substring: string) => boolean;
endsWith: (string: string, substring: string) => boolean;
contains: (string: string, substring: string) => boolean;
}