Skip to content

Update createRef documentation #4247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dzearing merged 3 commits into from
Mar 13, 2018
Merged

Update createRef documentation #4247

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
690c09e
Update createRef documentation
Markionium Mar 13, 2018
843ffaf
Update BESTPRACTICES.md
dzearing Mar 13, 2018
fa620f0
Update BESTPRACTICES.md
dzearing Mar 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions ghdocs/BESTPRACTICES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,14 +173,26 @@ public render() {
```

Best, use createRef:

The `createRef` function in `lib/Utilities` is a polyfill for [React.createRef](https://github.com/facebook/react/pull/11555). (When Fabric switches over to React 16, we'll use React.createRef instead)

`createRef` creates a reference object that has the following type `{ value: T | null }`, where T is the element to reference (either a dom node or a react component). You set the reference by passing the reference object as the `ref` prop. You can then subsequently access the reference through the `.value` property on the reference object elsewhere in your code.

```typescript
import { createRef } from 'office-ui-fabric-react/lib/Utilities';

class Foo extends BaseComponent<...> {
private _root = createRef<HTMLElement>();
// Create the reference object that will be used for setting and accessing the reference
private _root = createRef<HTMLButtonElement>();

public render() {
return <div ref={ _root } />;
// Set the reference by passing the reference object as the ref prop
return <button ref={ _root } onClick={this._onClick} />;
}

private _onClick() {
// Access the reference through the .value property on the reference object
this._root.value.focus();
}
}
```
Expand Down