Skip to content

Latest commit

 

History

History

BoundaryClickWatcher

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

BoundaryClickWatcher

Wrap a component in BoundaryClickWatcher to detect clicks on our outside of the component. See an example of this in the Conversation story.

Usage

BoundaryClickWatcher uses the render callback pattern and returns a boolean.

Props

Name Type Default Required Description
insideClickHandler Function () {}; No Executes when the user clicks inside the boundary.
outsideClickHandler Function () {}; No Executes when the user clicks Outside the boundary.
alwaysListen bool false No If true the click event listener is added on mount instead of being added when handleInnerClick is called.
onMouseEnter Function () {}; No Executes when the user's mouse enters the boundary.
onMouseLeave Function () {}; No Executes when the user's leaves the boundary.
<BoundaryClickWatcher insideClickHandler={someFunc} outsideClickHandler={someOtherFunc} alwaysListen={false}>
  {(boundaryIsActive) => {
    return (
      <MyComponent
        boolProp={boundaryIsActive}
      />
    )
  }}
</BoundaryClickWatcher>

It's not necessary to have the child component as a function, you can pass it in as a regular node. Usage for this is if you only want to use insideClickHandler and outsideClickHandler.

<BoundaryClickWatcher insideClickHandler={someFunc} outsideClickHandler={someOtherFunc}>
    <MyComponent />
  }}
</BoundaryClickWatcher>