Skip to content

Commit

Permalink
Merge pull request #1544 from threepointone/master
Browse files Browse the repository at this point in the history
rename useImperativeMethods -> useImperativeHandle
  • Loading branch information
bvaughn committed Jan 15, 2019
2 parents df240a4 + 06b08a2 commit 924e76d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion content/docs/hooks-faq.md
Expand Up @@ -304,7 +304,7 @@ This might look strange at first, but an update during rendering is exactly what

### Can I make a ref to a function component?

While you shouldn't need this often, you may expose some imperative methods to a parent component with the [`useImperativeMethods`](/docs/hooks-reference.html#useimperativemethods) Hook.
While you shouldn't need this often, you may expose some imperative methods to a parent component with the [`useImperativeHandle`](/docs/hooks-reference.html#useimperativehandle) Hook.

### What does `const [thing, setThing] = useState()` mean?

Expand Down
10 changes: 5 additions & 5 deletions content/docs/hooks-reference.md
Expand Up @@ -21,7 +21,7 @@ If you're new to Hooks, you might want to check out [the overview](/docs/hooks-o
- [`useCallback`](#usecallback)
- [`useMemo`](#usememo)
- [`useRef`](#useref)
- [`useImperativeMethods`](#useimperativemethods)
- [`useImperativeHandle`](#useimperativehandle)
- [`useLayoutEffect`](#uselayouteffect)
- [`useDebugValue`](#usedebugvalue)

Expand Down Expand Up @@ -322,18 +322,18 @@ function TextInputWithFocusButton() {

Note that `useRef()` is useful for more than the `ref` attribute. It's [handy for keeping any mutable value around](/docs/hooks-faq.html#is-there-something-like-instance-variables) similar to how you'd use instance fields in classes.

### `useImperativeMethods`
### `useImperativeHandle`

```js
useImperativeMethods(ref, createInstance, [inputs])
useImperativeHandle(ref, createHandle, [inputs])
```

`useImperativeMethods` customizes the instance value that is exposed to parent components when using `ref`. As always, imperative code using refs should be avoided in most cases. `useImperativeMethods` should be used with `forwardRef`:
`useImperativeHandle` customizes the instance value that is exposed to parent components when using `ref`. As always, imperative code using refs should be avoided in most cases. `useImperativeHandle` should be used with `forwardRef`:

```js
function FancyInput(props, ref) {
const inputRef = useRef();
useImperativeMethods(ref, () => ({
useImperativeHandle(ref, () => ({
focus: () => {
inputRef.current.focus();
}
Expand Down

0 comments on commit 924e76d

Please sign in to comment.