Global

Methods

getDisplayName(wrapper, Component) → {string}

Source:
Parameters:
Name Type Description
wrapper string

Wrapper name
Component React.Component

React Component
Returns:
Type:
string

Combined string

getForwardedComponent(displayName, Component) → {React.Component}

Source:
Parameters:
Name Type Description
displayName string

Component's displayName
Component React.Component

Target component
Returns:
Type:
React.Component

The same component with new displayName and forwardedRef

getMergedRef(ref, getterFn) → {function}

Source:
Parameters:
Name Type Description
ref React.RefObject
getterFn function
Returns:
Type:
function

makeAdaptive(Component, options) → {React.Component}

Source:
Parameters:
Name Type Description
Component React.Component

Target component
options Object
Returns:
Type:
React.Component

AdaptiveComponent

mergeMethods(methods, Component) → {React.ForwardRefExoticComponent}

Source:
Parameters:
Name Type Description
methods Array.<string>
Component React.Component
Returns:
Type:
React.ForwardRefExoticComponent

proxyConnect(mapStateToProps, mapDispatchToProps, mergeProps, opts) → {React.Component}

Source:
Parameters:
Name Type Description
mapStateToProps function
mapDispatchToProps function
mergeProps object
opts object
Returns:
Type:
React.Component

Wrapped with Redux.Connect component

proxyRef(Component) → {React.ForwardRefExoticComponent}

Source:
Parameters:
Name Type Description
Component React.Component
Returns:
Type:
React.ForwardRefExoticComponent

useActions(actions, deps) → {function|Array.<function()>}

Source:
Parameters:
Name Type Description
actions function | Array.<function()>

array of functions or one single function
deps Array.<any>

dependencies for useMemo
Returns:
Type:
function | Array.<function()>

array of functions or one single function wrapped with dispatch

useDebouncedCallback(func, delay, deps) → {function}

Note: Does not react to delay changes

Source:
Parameters:
Name Type Description
func function

Original function
delay number

Delay in ms
deps Array.<any>

Dependencies array for useEffect
Returns:
Type:
function

useEventListener(ref, type, handler, passive, capture, once)

Source:
Parameters:
Name Type Description
ref React.RefObject
type string

EventListener type
handler function

Handler function
passive Boolean

EventListener option passive
capture Boolean

EventListener option capture
once Boolean

EventListener option once

useIsMobile() → {Boolean}

Subscription on Resize. See nebenan-helpers/lib/dom

Source:
Returns:
Type:
Boolean

isMobile

useMergedTheme(baseTheme, passedTheme) → {*}

Source:
Parameters:
Name Type Description
baseTheme
passedTheme
Returns:
Type:
*

useMounted() → {React.MutableRefObject.<boolean>}

Source:
Returns:
Type:
React.MutableRefObject.<boolean>

useOnceCallback(fn, resetDeps) → {function}

Source:
Parameters:
Name Type Description
fn function

function to be called once
resetDeps Array.<any>

array of dependencies for resetting 'once' state
Returns:
Type:
function

callback with stable identity

usePromiseGuard() → {function}

Source:
Returns:
Type:
function

useResettingVisibility(timeout) → {Array.<boolean, function()>}

Source:
Parameters:
Name Type Description
timeout Number

Timeout for setTimeout in ms
Returns:
Type:
Array.<boolean, function()>

Current status and Toggle function

useSmartClickHandler(callback) → {function}

Source:
Parameters:
Name Type Description
callback function
Returns:
Type:
function

useStableCallback(callback) → {function}

Source:
Parameters:
Name Type Description
callback function
Returns:
Type:
function

useThrottledCallback(func, delay, deps) → {null}

Source:
Parameters:
Name Type Description
func function
delay number

delay in ms for throttle
deps Array.<any>

Array of dependencies for useEffect
Returns:
Type:
null

withHistory(Component) → {React.Component}

History HOC

Source:
Parameters:
Name Type Description
Component React.Component

Target component
Returns:
Type:
React.Component

Wrapped component