styleguidist/react-styleguidist

Support for useImperativeHandle

Open

#1426 aperta il 30 ago 2019

Vedi su GitHub
 (0 commenti) (3 reazioni) (0 assegnatari)TypeScript (1416 fork)github user discovery
help wanted

Metriche repository

Star
 (11.091 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

The problem

useImperativeHandle allows components to expose some of their API similarly to instance class methods.

function FancyInput(props, ref) {
  const inputRef = useRef();
  useImperativeHandle(ref, () => ({
    focus: () => {
      inputRef.current.focus();
    }
  }));
  return <input ref={inputRef} ... />;
}
FancyInput = forwardRef(FancyInput);

allows calling fancyInputRef.current.focus() in other component.

Proposed solution

It would be great to treat functions returned from this hook as part of the external API and add them to the documentation

Alternative solutions

I guess, this needs to be done in the react-dogen but I'd like to keep track of this in this repo. We could also move the issue over.

Guida contributor