Skip to content

docs(react-web-sdk): enhance README with usage examples for useOptimi… #320

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

Open
Lotfi Anwar L Arif (Lotfi-Arif) wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −0
Open

docs(react-web-sdk): enhance README with usage examples for useOptimi… #320

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions packages/web/frameworks/react-web-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,25 @@ Use `useOptimization()` when a component needs direct access to the instance for
`identify()`, `reset()`, or manual tracking. Use `useEntryResolver()` when a component needs manual
entry resolution without the `OptimizedEntry` wrapper:

`useOptimization()` returns the SDK instance itself. Keep that instance in a variable and call
methods from it. Do not destructure SDK methods from the returned value because those methods rely
on the instance `this` binding.

```tsx
import { useOptimization } from '@contentful/optimization-react-web'

function ProductCta() {
const optimization = useOptimization()

return <button onClick={() => optimization.track({ event: 'purchase' })}>Buy now</button>
}
```

```tsx
// Avoid destructuring SDK methods; this loses the instance binding.
const { track } = useOptimization()
```

```tsx
import { useEntryResolver } from '@contentful/optimization-react-web'

Expand Down