react-optimized-filter
A simple React component used for array filtering in an optimized way.
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).
In what way is this component "optimized"?
This component uses a for-loop for filtering rather than the native Array
's filter
function, which yields better performance.
Re-filters only occur if the given items have changed order or any of the items have been
changed/removed/added since the previous render or if any of the predicate props have
changed since the last render. A memoize once pattern is used to accomplish this (I.E.
the previous result of filtering is cached and filtering only occurs again if the
previously given props have changed, otherwise, the cached result is passed on to the
render
/children
prop).
It is important to note that a hash of items
and the predicate props is used to
determined if a change has occurred. This is very useful because one does not need to
ensure that the exact same objects are passed to OptimizedFilter
with every re-render;
instead, everything can be specified inline and you will still get all of the optimization
benefits of OptimizedFilter
. To illustrate, see the "Usage" section below. In the
example given, only the first render of MyComponent
will trigger filtering within
OptimizedFilter
, while all subsequent renders will not trigger re-filtering even though
a new function is created and passed as the predicate
prop with every render of
MyComponent
.
Install
$ npm i --save react-optimized-filter
Usage
import React from 'react';import OptimizedFilter from '/react-optimized-filter'; { return /* ... */ <OptimizedFilter = = = = /> /* ...or... */ <OptimizedFilter = = => filteredItems // Render filtered items... </Filter> /* ... */ ;}
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) 2020, 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.