Skip to content

Commit

Permalink
feat(packages/sui-react-web-vitals): update doc
Browse files Browse the repository at this point in the history
BREAKING CHANGES:

pathname for allowed
  • Loading branch information
Andrés Alvarez authored and Andrés Alvarez committed Nov 27, 2023
1 parent 3aaee12 commit 52bd64d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions packages/sui-react-web-vitals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,16 +139,16 @@ export default function App() {
}
```

#### Allowed pathnames
#### Allowed routes

Use `pathnames` prop if you only want to track a set of pathnames
Use `allowed` prop if you only want to track a set of pathnames or route ids

```jsx
import WebVitalsReporter from '@s-ui/react-web-vitals'

export default function App() {
return (
<WebVitalsReporter pathnames={['/products/:id']}>
<WebVitalsReporter allowed={['/products/:id', 'search']}>
<main />
</WebVitalsReporter>
)
Expand Down

0 comments on commit 52bd64d

Please sign in to comment.