Skip to content
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.

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

Add options.process caveat to readme #192

Merged
merged 2 commits into from
Jan 6, 2022
Merged

Add options.process caveat to readme #192

merged 2 commits into from
Jan 6, 2022

Conversation

bgergen
Copy link
Collaborator

@bgergen bgergen commented Dec 30, 2021

Adding a note to document the bug reported in issue #189 until we can address.

README.md Outdated
@@ -330,6 +330,8 @@ function Page2() {
When `Page1` mounts, event with data `{page: 'Page1', event: 'pageview'}` will be dispatched.
When `Page2` mounts, nothing will be dispatched.

_**Note:** The `options.process` function does not currently take single-page app (SPA) navigation into account. If the example above were implemented as an SPA, navigating back to `Page1`, with no page reload, would **not** cause `options.process` to fire a second time even if the `Page1` component remounts._
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we also mention the workaround and maybe link to the open issue for more reference/info?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup! Will do.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added. Wasn't sure whether you wanted to link directly to the code sandbox.

@tizmagik tizmagik merged commit e59fca4 into main Jan 6, 2022
@tizmagik tizmagik deleted the docs-process-note branch January 6, 2022 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants