styleguidist/react-styleguidist

Support for useImperativeHandle

Open

#1.426 aberto em 30 de ago. de 2019

Ver no GitHub
 (0 comments) (3 reactions) (0 assignees)TypeScript (1.416 forks)github user discovery
help wanted

Métricas do repositório

Stars
 (11.091 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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.

Guia do colaborador