Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Correct grammar - "its" is for possessive usage.
  • Loading branch information
adamchainz committed Apr 16, 2016
1 parent f2b218b commit e43f260
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ https://react-sizeme-example-esbefmsitg.now.sh

## Simple Example

Below is a partial example highlighting the use of the library. Read the Usage section in it's entirety for a full description on configuration and usage.
Below is a partial example highlighting the use of the library. Read the Usage section in its entirety for a full description on configuration and usage.

```javascript
class MyComponent extends Component {
Expand All @@ -52,13 +52,13 @@ First install the library.
npm install react-sizeme
```

Then identify a Component you would like to make aware of it's size. We provide you with a helper function called `SizeMe`. You can import it like so:
Then identify a Component you would like to make aware of its size. We provide you with a helper function called `SizeMe`. You can import it like so:

```javascript
import SizeMe from 'react-sizeme';
```

You first have to pass the `SizeMe` function a configuration object. The entire configuration object is optional, as is each of it's properties, in which case the defaults would be used. Here is a full configuration example with the default values for each of the properties:
You first have to pass the `SizeMe` function a configuration object. The entire configuration object is optional, as is each of its properties, in which case the defaults would be used. Here is a full configuration example with the default values for each of the properties:

```javascript
const SizeMeHOC = SizeMe({
Expand Down Expand Up @@ -189,4 +189,4 @@ We make use of the awesome [element-resize-detector](https://github.com/wnr/elem
## Caveats.

* Server Side Rendering is not supported. I am still thinking of the best approach on what to do in the case of a SSR request. Perhaps I will just return null values for width/height. Undecided. Any recommendations are welcome.
* Whilst execution is performant and we try and do smart rendering mechanisms we don't recommend that you place a crazy amount of size aware components into your render tree. If you do require this I highly recommend you do some decent browser testing for impact.
* Whilst execution is performant and we try and do smart rendering mechanisms we don't recommend that you place a crazy amount of size aware components into your render tree. If you do require this I highly recommend you do some decent browser testing for impact.

0 comments on commit e43f260

Please sign in to comment.