Skip to content

Commit c17abb2

Browse files
committed
Update boxSize documentation
1 parent 916220d commit c17abb2

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ See the [API Docs](/docs/api.md) for reference guides and usage examples.
100100

101101
# Observing vs. Consuming `ResizeObserverSize`
102102

103-
There is an important distinction between the `ResizeObserverSize` you observe and the `ResizeObserverSize` you consume for triggering breakpoints. See [Observing vs. Consuming `ResizeObserverSize`](/docs/boxSizes.md) for more information.
103+
There is an important distinction between the `boxSize` you observe and the `boxSize` you pass to your breakpoints. See [Observing vs. Consuming `ResizeObserverSize`](/docs/boxSizes.md) for more information.
104104

105105
# Server-Side Rendering
106106

docs/api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ const App = () => <ResizeObserverProvider ponyfill={ResizeObserver}>...</ResizeO
5151

5252
You can observe size changes of an element's `box` by rendering it through `<Observe>`'s `render` prop. Your render function receives a `observedElementProps` argument that you spread onto the DOM element you wish to observe. It also receives `widthMatch` and `heightMatch` arguments which match the values you assigned via `<Observe>`'s `breakpoints` prop.
5353

54-
⚠️ **Important** — There is an important distinction between the `ResizeObserverSize` you observe and the `ResizeObserverSize` you consume for triggering breakpoints. See [Observing vs. Consuming `ResizeObserverSize`](boxSizes.md) for more information.
54+
⚠️ **Important** — There is an important distinction between the `boxSize` you observe and the `boxSize` you pass to your breakpoints. See [Observing vs. Consuming `ResizeObserverSize`](boxSizes.md) for more information.
5555

5656
## Reference guide
5757

@@ -118,7 +118,7 @@ This library supports observing the following `box` options (but your browser ma
118118

119119
If `box` is left `undefined` or set to any value other than those listed above, `<Observe>` will default to using information from `ResizeObserverEntry.contentRect`.
120120

121-
⚠️ **Important** — There is an important distinction between the `ResizeObserverSize` you observe and the `ResizeObserverSize` you consume for triggering breakpoints. See [Observing vs. Consuming `ResizeObserverSize`](boxSizes.md) for more information.
121+
⚠️ **Important** — There is an important distinction between the `boxSize` you observe and the `boxSize` you pass to your breakpoints. See [Observing vs. Consuming `ResizeObserverSize`](boxSizes.md) for more information.
122122

123123
</details>
124124

@@ -255,7 +255,7 @@ This library supports the following `box` options (but your browser may not!):
255255

256256
If `box` is left `undefined` or set to any value other than those listed above, `useBreakpoints()` will default to using information from `ResizeObserverEntry.contentRect`.
257257

258-
⚠️ **Important** — There is an important distinction between the `ResizeObserverSize` you observe and the `ResizeObserverSize` you consume for triggering breakpoints. See [Observing vs. Consuming `ResizeObserverSize`](boxSizes.md) for more information.
258+
⚠️ **Important** — There is an important distinction between the `boxSize` you observe and the `boxSize` you pass to your breakpoints. See [Observing vs. Consuming `ResizeObserverSize`](boxSizes.md) for more information.
259259

260260
</details>
261261

@@ -452,7 +452,7 @@ This library supports the following `box` options (but your browser may not!):
452452
- [`'content-box'`](https://caniuse.com/#feat=mdn-api_resizeobserverentry_contentboxsize)
453453
- [`'device-pixel-content-box'`](https://github.com/w3c/csswg-drafts/issues/3554)
454454

455-
⚠️ **Important** — There is an important distinction between the `ResizeObserverSize` you observe and the `ResizeObserverSize` you consume for triggering breakpoints. See [Observing vs. Consuming `ResizeObserverSize`](boxSizes.md) for more information.
455+
⚠️ **Important** — There is an important distinction between the `boxSize` you observe and the `boxSize` you pass to your breakpoints. See [Observing vs. Consuming `ResizeObserverSize`](boxSizes.md) for more information.
456456

457457
</details>
458458

docs/boxSizes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Observing vs. Consuming `ResizeObserverSize`
22

3-
There is an important distinction between the `boxSize` you observe and the `boxSize` you consume for triggering breakpoints.
3+
There is an important distinction between the `boxSize` you observe and the `boxSize` you pass to your breakpoints.
44

55
> You can observe a `boxSize` on an element, and then respond to changes in **another** `boxSize` of that same element.
66

0 commit comments

Comments
 (0)