Skip to content

Commit eb22451

Browse files
committed
Fix documentation links
1 parent 60bac4f commit eb22451

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This allows you to know the size of each observed element.
2424

2525
# 📚 Docs
2626

27-
This package was developed **and documented** as part of the [`@envato/react-breakpoints`](https://github.com/envato/react-breakpoints) package. It's separated into its own package because I believe it can be used separately if you don't need all the abstractions that React Breakpoints gives you. Please refer to the [React Breakpoints API Docs](https://github.com/envato/react-breakpoints/docs/api.md) for more details about `<Provider>` and `useResizeObserver()`.
27+
This package was developed **and documented** as part of the [`@envato/react-breakpoints`](https://github.com/envato/react-breakpoints) package. It's separated into its own package because I believe it can be used separately if you don't need all the abstractions that React Breakpoints gives you. Please refer to the [React Breakpoints API Docs](https://github.com/envato/react-breakpoints/blob/main/docs/api.md) for more details about `<Provider>` and `useResizeObserver()`.
2828

2929
# ⚡️ Quick start
3030

@@ -40,7 +40,7 @@ import { Provider as ResizeObserverProvider } from '@envato/react-resize-observe
4040
const App = () => <ResizeObserverProvider>...</ResizeObserverProvider>;
4141
```
4242

43-
⚠️ **Caution** — You may need to pass some props to `<Provider>` to increase **browser support**. Please refer to the [React Breakpoints API Docs](https://github.com/envato/react-breakpoints/docs/api.md#provider).
43+
⚠️ **Caution** — You may need to pass some props to `<Provider>` to increase **browser support**. Please refer to the [React Breakpoints API Docs](https://github.com/envato/react-breakpoints/blob/main/docs/api.md#provider).
4444

4545
## Observe an element
4646

src/Provider.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ interface ProviderProps {
77
}
88

99
/**
10-
* See API Docs: {@linkcode https://github.com/envato/react-breakpoints/blob/master/docs/api.md#provider|Provider}
10+
* See API Docs: {@linkcode https://github.com/envato/react-breakpoints/blob/main/docs/api.md#provider|Provider}
1111
*
1212
* Returns a React context provider with a ResizeObserver instance as its value.
1313
* Uses `window.ResizeObserver` to construct the instance if no `ponyfill` prop is provided.

src/createResizeObserver.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import type { ExtendedResizeObserverEntry } from './ExtendedResizeObserverEntry'
22

33
/**
44
* Creates a new ResizeObserver instance that works with the
5-
* {@linkcode https://github.com/envato/react-breakpoints/blob/master/docs/api.md#useresizeobserver|useResizeObserver}
5+
* {@linkcode https://github.com/envato/react-breakpoints/blob/main/docs/api.md#useresizeobserver|useResizeObserver}
66
* hook.
77
* @example
88
* const resizeObserverInstance = createResizeObserver(window.ResizeObserver);

src/useResizeObserver.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const boxOptions = {
1010
};
1111

1212
/**
13-
* See API Docs: {@linkcode https://github.com/envato/react-breakpoints/blob/master/docs/api.md#useresizeobserver|useResizeObserver}
13+
* See API Docs: {@linkcode https://github.com/envato/react-breakpoints/blob/main/docs/api.md#useresizeobserver|useResizeObserver}
1414
*
1515
* Returns a React callback ref to attach to a DOM element. It also returns
1616
* a resize observation entry every time the observed element changes size.

0 commit comments

Comments
 (0)