-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
User Feedback V8 - Documentation seems OFF #12015
User Feedback V8 - Documentation seems OFF #12015
Comments
Sorry to hijack this thread, but I think it fits.
which I think should be changed now that 8 is out there. :) |
@pquerner not sure to understand fully the subtlety - I am a Sentry Saas (sentry.io) user. |
Does not matter. It affects the v8 documentation (in my case the migration one). |
Hey, sorry about both of these, the docs were not yet fully updated, but should be correct now: For user feedback, the docs have been updated to show the new APIs, sorry again for the confusion: https://docs.sentry.io/platforms/javascript/user-feedback/configuration/#general Self hosted needs to be 24.4.2 or up to support all feedback functionality. |
Hi, Many thanks for the update! However I think you where using another version? the onClick={async () => {
const form = await feedback.createForm({});
form.appendToDom();
form.open();
}} Genuine question, was it mandatory to "complexify" the API? i.e before By the way awesome feature that is the possibility to add screenshot 👍 Cheers, |
@AdrienFromToulouse i'll double check the docs around One of the big drivers for making the api more complex is that we wanted to code-split the form code from the main SDK to save bundle size whenever the page loads but users don't click to interact with the button. So I wanted to make the "await load dialog" part separate from the "show dialog" call, incase the network is down, or things are slow and you wanna have that control. It's been a tradeoff for sure, and a it was a huge change from the beta code too... but we're hopeing it'll payoff because it allows us a little more flexibility to add features without numbers on bundlephobia getting out of control! |
…12125) These params are optional, to the TS typedef should align with that. **Before:** <img width="1008" alt="SCR-20240520-ltyb" src="https://github.com/getsentry/sentry-javascript/assets/187460/8d242640-f67a-406d-a963-9b40fea1de54"> **After:** <img width="1089" alt="SCR-20240520-ltvg" src="https://github.com/getsentry/sentry-javascript/assets/187460/71d98556-9151-4146-8de9-6504e22d4731"> Related to #12015
Is there an existing issue for this?
How do you use Sentry?
Sentry Saas (sentry.io)
Which SDK are you using?
@sentry/nextjs
SDK Version
8.0.0
Framework Version
18.3.1
Link to Sentry event
No response
SDK Setup
Steps to Reproduce
Custom button working before
v8
After upgrading to
v8
the following error appears:Property 'openDialog' does not exist on type 'Integration & { attachTo(el: string | Element, optionOverrides: any): () => void; createForm(optionOverrides: any): Promise<FeedbackDialog>; createWidget(optionOverrides: any): any; remove(): void; }'
The documentation here, does not provide any upgrade path: https://docs.sentry.io/platforms/javascript/guides/nextjs/user-feedback/configuration/#bring-your-own-widget
confer
Alternatively, you can call feedback.openDialog():
Cheers,
Expected Result
An up to date documentation precisely explaining how to instantiate a custom button with
v8
.Actual Result
Property 'openDialog' does not exist on type 'Integration & { attachTo(el: string | Element, optionOverrides: any): () => void; createForm(optionOverrides: any): Promise<FeedbackDialog>; createWidget(optionOverrides: any): any; remove(): void; }'
The text was updated successfully, but these errors were encountered: