@bsara/react-filter
A simple React component used for array filtering.
NOTE: This component uses a for-loop for filtering rather than the native
Array
'sfilter
function. This means that filtering will be more performant (see jsperf test for details).
Install
$ npm i --save @bsara/react-filter
Usage
import React from 'react';
import Filter from '@bsara/react-filter';
export default function MyComponent(props) {
return (
{/* ... */}
<Filter
items={props.items}
predicate={_predicate}
predicateArg={props.predicateArg}
render={(filteredItems) => (
// Render filtered items...
)} />
{/* ...or... */}
<Filter items={props.items}
predicate={_predicate}
predicateArg={props.predicateArg}>
{(filteredItems) => (
// Render filtered items...
)}
</Filter>
{/* ... */}
);
}
function _predicate(item, index, predicateArg) {
// Determine if item should be included in filtered list...
}
Props
-
items
?Array
Array of items to be filtered and passed to
render
prop. -
render(filteredItems) or children(filteredItems)
!Function
- REQUIREDRender function (or function as child) called after
items
filtering is complete. -
predicate(item, itemIndex[, predicateArg])
!Function
- REQUIREDFunction to be called for each item in
items
. Returntrue
to includeitem
in the resulting filtered items list. Returnfalse
to excludeitem
from the resulting filtered items list. -
predicateArg
?*
Parameter to be passed as an extra argument in
predicate
function. This prop is not required and is provided solely for convenience. -
skip
?Boolean
When
true
, skips filtering and the value ofitems
prop will be passed torender
, unsorted. This is useful in the case where sorting may only be conditionally needed.
License
ISC License (ISC)
Copyright (c) 2019, Brandon D. Sara (https://bsara.dev/)
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.