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

RN: Add feedback widget documentation #12503

Open
wants to merge 6 commits into
base: antonis/react-native-capture-feedback
Choose a base branch
from

Conversation

antonis
Copy link
Collaborator

@antonis antonis commented Jan 29, 2025

⚠️ Based on: RN: Updates capture feedback documentation

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

Adds the Feedback Widget documentation for React Native

Part of getsentry/sentry-react-native#4302

Implementation PR: getsentry/sentry-react-native#4435

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

Should be merged after getsentry/sentry-react-native#4435 is released

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Copy link

vercel bot commented Jan 29, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 31, 2025 3:33pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Jan 31, 2025 3:33pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jan 31, 2025 3:33pm


The User Feedback Widget offers many customization options, and if the available options are insufficient, you can [use your own UI](/platforms/react-native/user-feedback/#user-feedback-api).

![An image showing the main customization options for the User Feedback Widget](./img/mobile-user-feedback-widget-customization.png)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is a cropped version of the JS image since the UI and props matched


<Alert>

Note that when the device is offline, the feedback will be stored locally and sent when the device is back online.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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


<Alert>

Note that the `showFeedbackForm` method depends on the React Native `Modal` implementation. It is supported fully in the legacy architecture. For the new architecture (Fabric renderer) it requires React Native `0.71` and up.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Copy link

codecov bot commented Jan 31, 2025

Bundle Report

Changes will increase total bundle size by 638.76kB (3.25%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.63MB 435.57kB (4.27%) ⬆️
sentry-docs-edge-server-array-push 363.54kB -312 bytes (-0.09%) ⬇️
sentry-docs-client-array-push 9.31MB 203.5kB (2.23%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-edge-server-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
src/middleware.js 3.35kB 204.0kB 1.67%
edge-instrumentation.js -3.71kB 149.99kB -2.41%
../types/cache-life.d.ts 49 bytes 5.86kB 0.84%
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js (New) 1.63MB 1.63MB 100.0% 🚀
4899.js 6 bytes 1.04MB 0.0%
../instrumentation.js 75.09kB 965.23kB 8.44% ⚠️
9523.js (New) 941.45kB 941.45kB 100.0% 🚀
8049.js (New) 520.4kB 520.4kB 100.0% 🚀
../app/[[...path]]/page.js -2.44kB 514.4kB -0.47%
6173.js (New) 400.06kB 400.06kB 100.0% 🚀
../app/[[...path]]/page.js.nft.json 14.76kB 374.72kB 4.1%
../app/platform-redirect/page.js.nft.json 14.76kB 374.63kB 4.1%
../app/sitemap.xml/route.js.nft.json 14.77kB 372.6kB 4.13%
7106.js (New) 328.69kB 328.69kB 100.0% 🚀
434.js (New) 274.26kB 274.26kB 100.0% 🚀
5443.js (New) 215.65kB 215.65kB 100.0% 🚀
8122.js (New) 149.31kB 149.31kB 100.0% 🚀
5151.js 1.22kB 121.92kB 1.01%
5141.js (New) 103.3kB 103.3kB 100.0% 🚀
3776.js (New) 90.39kB 90.39kB 100.0% 🚀
3845.js (New) 81.39kB 81.39kB 100.0% 🚀
2530.js (New) 77.3kB 77.3kB 100.0% 🚀
875.js (New) 72.07kB 72.07kB 100.0% 🚀
8548.js 324 bytes 68.02kB 0.48%
1419.js (New) 57.76kB 57.76kB 100.0% 🚀
4167.js (New) 44.81kB 44.81kB 100.0% 🚀
2657.js (New) 43.59kB 43.59kB 100.0% 🚀
167.js (New) 38.05kB 38.05kB 100.0% 🚀
5103.js (New) 37.17kB 37.17kB 100.0% 🚀
9952.js (New) 34.56kB 34.56kB 100.0% 🚀
4412.js (New) 34.42kB 34.42kB 100.0% 🚀
../app/sitemap.xml/route.js 1.52kB 33.86kB 4.69%
5207.js (New) 32.33kB 32.33kB 100.0% 🚀
../app/platform-redirect/page.js 701 bytes 30.83kB 2.33%
8899.js (New) 28.46kB 28.46kB 100.0% 🚀
2638.js (New) 26.35kB 26.35kB 100.0% 🚀
1031.js (New) 25.13kB 25.13kB 100.0% 🚀
6240.js (New) 25.11kB 25.11kB 100.0% 🚀
1010.js (New) 24.7kB 24.7kB 100.0% 🚀
7019.js (New) 24.25kB 24.25kB 100.0% 🚀
6060.js (New) 24.01kB 24.01kB 100.0% 🚀
7275.js (New) 20.61kB 20.61kB 100.0% 🚀
9567.js 61 bytes 18.81kB 0.33%
8327.js (New) 12.01kB 12.01kB 100.0% 🚀
8440.js (New) 11.95kB 11.95kB 100.0% 🚀
../../types/cache-life.d.ts 49 bytes 5.86kB 0.84%
../app/robots.txt/route.js -685 bytes 5.14kB -11.77%
9136.js (New) 4.78kB 4.78kB 100.0% 🚀
../app/_not-found/page.js 329 bytes 4.69kB 7.54% ⚠️
6184.js (New) 4.66kB 4.66kB 100.0% 🚀
../pages/_error.js 2 bytes 4.35kB 0.05%
../../static/media/react-router.*.svg (New) 1.82kB 1.82kB 100.0% 🚀
../../static/media/react-router.*.svg (New) 1.82kB 1.82kB 100.0% 🚀
6390.js (New) 1.55kB 1.55kB 100.0% 🚀
4846.js (New) 1.27kB 1.27kB 100.0% 🚀
5225.js (New) 1.27kB 1.27kB 100.0% 🚀
678.js (New) 1.27kB 1.27kB 100.0% 🚀
7692.js (New) 1.02kB 1.02kB 100.0% 🚀
7452.js (New) 1.02kB 1.02kB 100.0% 🚀
5690.js (New) 1.02kB 1.02kB 100.0% 🚀
4937.js (New) 1.02kB 1.02kB 100.0% 🚀
1899.js (New) 1.01kB 1.01kB 100.0% 🚀
1115.js (Deleted) -1.56MB 0 bytes -100.0% 🗑️
5017.js (Deleted) -866.17kB 0 bytes -100.0% 🗑️
3049.js (Deleted) -472.6kB 0 bytes -100.0% 🗑️
571.js (Deleted) -369.93kB 0 bytes -100.0% 🗑️
2485.js (Deleted) -295.12kB 0 bytes -100.0% 🗑️
7220.js (Deleted) -268.07kB 0 bytes -100.0% 🗑️
3119.js (Deleted) -198.32kB 0 bytes -100.0% 🗑️
3365.js (Deleted) -145.66kB 0 bytes -100.0% 🗑️
3315.js (Deleted) -101.0kB 0 bytes -100.0% 🗑️
9210.js (Deleted) -90.59kB 0 bytes -100.0% 🗑️
9602.js (Deleted) -77.67kB 0 bytes -100.0% 🗑️
544.js (Deleted) -76.59kB 0 bytes -100.0% 🗑️
4433.js (Deleted) -71.82kB 0 bytes -100.0% 🗑️
8739.js (Deleted) -58.02kB 0 bytes -100.0% 🗑️
9544.js (Deleted) -44.92kB 0 bytes -100.0% 🗑️
1969.js (Deleted) -42.8kB 0 bytes -100.0% 🗑️
2020.js (Deleted) -38.11kB 0 bytes -100.0% 🗑️
8830.js (Deleted) -37.23kB 0 bytes -100.0% 🗑️
5190.js (Deleted) -34.66kB 0 bytes -100.0% 🗑️
5882.js (Deleted) -34.5kB 0 bytes -100.0% 🗑️
1516.js (Deleted) -30.93kB 0 bytes -100.0% 🗑️
3221.js (Deleted) -29.16kB 0 bytes -100.0% 🗑️
9970.js (Deleted) -26.38kB 0 bytes -100.0% 🗑️
1760.js (Deleted) -25.16kB 0 bytes -100.0% 🗑️
5149.js (Deleted) -24.74kB 0 bytes -100.0% 🗑️
5875.js (Deleted) -22.5kB 0 bytes -100.0% 🗑️
6975.js (Deleted) -20.67kB 0 bytes -100.0% 🗑️
8783.js (Deleted) -19.47kB 0 bytes -100.0% 🗑️
5901.js (Deleted) -15.28kB 0 bytes -100.0% 🗑️
9853.js (Deleted) -12.06kB 0 bytes -100.0% 🗑️
7018.js (Deleted) -12.03kB 0 bytes -100.0% 🗑️
4364.js (Deleted) -4.69kB 0 bytes -100.0% 🗑️
9841.js (Deleted) -4.59kB 0 bytes -100.0% 🗑️
4268.js (Deleted) -1.46kB 0 bytes -100.0% 🗑️
3539.js (Deleted) -1.25kB 0 bytes -100.0% 🗑️
5248.js (Deleted) -1.25kB 0 bytes -100.0% 🗑️
6577.js (Deleted) -1.25kB 0 bytes -100.0% 🗑️
5614.js (Deleted) -988 bytes 0 bytes -100.0% 🗑️
3569.js (Deleted) -984 bytes 0 bytes -100.0% 🗑️
2070.js (Deleted) -982 bytes 0 bytes -100.0% 🗑️
5964.js (Deleted) -980 bytes 0 bytes -100.0% 🗑️
337.js (Deleted) -977 bytes 0 bytes -100.0% 🗑️

App Routes Affected:

App Route Size Change Total Size Change (%)
/[[...path]] 2.55MB 3.07MB 493.38% ⚠️
/platform-redirect 2.55MB 2.58MB 8474.12% ⚠️
/ 2.55MB 2.61MB 4151.41% ⚠️
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -613 bytes 866.04kB -0.07%
static/css/*.css 557 bytes 739.17kB 0.08%
static/css/*.css -973 bytes 17.0kB -5.41%
static/css/*.css -14.48kB 961 bytes -93.78%
static/css/*.css (New) 15.43kB 15.43kB 100.0% 🚀
static/chunks/bc085c76-*.js 1 bytes 627.75kB 0.0%
static/chunks/952c863e.*.js (New) 400.04kB 400.04kB 100.0% 🚀
static/chunks/9557-*.js (New) 391.11kB 391.11kB 100.0% 🚀
static/chunks/21f17e4c.*.js (New) 324.2kB 324.2kB 100.0% 🚀
static/chunks/3641.*.js (New) 280.82kB 280.82kB 100.0% 🚀
static/chunks/1835b391.*.js (New) 274.25kB 274.25kB 100.0% 🚀
server/app/_not-*.js 2.92kB 247.19kB 1.19%
server/app/[[...path]]/page_client-*.js 2.92kB 247.16kB 1.19%
static/chunks/f3e15c50.*.js (New) 240.48kB 240.48kB 100.0% 🚀
server/app/platform-*.js 2.83kB 232.48kB 1.23%
static/chunks/framework-*.js 1 bytes 182.47kB 0.0%
static/chunks/4bd1b696-*.js 1.0kB 167.93kB 0.6%
static/chunks/910.*.js (New) 153.75kB 153.75kB 100.0% 🚀
static/chunks/2920-*.js (New) 141.2kB 141.2kB 100.0% 🚀
static/chunks/main-*.js -1 bytes 1.93kB -0.05%
static/chunks/main-*.js 3.15kB 118.36kB 2.73%
static/chunks/76079dcc.*.js 1 bytes 116.69kB 0.0%
static/chunks/0ba0062a.*.js 1 bytes 116.69kB 0.0%
static/chunks/52774a7f-*.js -1.78kB 116.66kB -1.5%
static/chunks/5279.*.js (New) 103.28kB 103.28kB 100.0% 🚀
static/chunks/4820.*.js (New) 90.37kB 90.37kB 100.0% 🚀
static/chunks/27.*.js (New) 77.28kB 77.28kB 100.0% 🚀
static/chunks/3293-*.js (New) 72.64kB 72.64kB 100.0% 🚀
static/chunks/4335.*.js (New) 72.05kB 72.05kB 100.0% 🚀
static/chunks/app/[[...path]]/page-*.js 1.83kB 67.12kB 2.8%
static/chunks/3863.*.js (New) 57.74kB 57.74kB 100.0% 🚀
static/chunks/6127.*.js (New) 44.79kB 44.79kB 100.0% 🚀
static/chunks/7755.*.js (New) 43.57kB 43.57kB 100.0% 🚀
static/chunks/3920-*.js (New) 41.5kB 41.5kB 100.0% 🚀
static/chunks/4033.*.js (New) 38.03kB 38.03kB 100.0% 🚀
static/chunks/7739.*.js (New) 37.15kB 37.15kB 100.0% 🚀
static/chunks/2288.*.js (New) 34.54kB 34.54kB 100.0% 🚀
static/chunks/4716.*.js (New) 34.4kB 34.4kB 100.0% 🚀
static/chunks/7599.*.js (New) 32.31kB 32.31kB 100.0% 🚀
static/chunks/6691.*.js (New) 29.57kB 29.57kB 100.0% 🚀
static/chunks/828.*.js (New) 26.33kB 26.33kB 100.0% 🚀
static/chunks/8834.*.js (New) 25.09kB 25.09kB 100.0% 🚀
static/chunks/2286.*.js (New) 24.68kB 24.68kB 100.0% 🚀
static/chunks/2227.*.js (New) 24.23kB 24.23kB 100.0% 🚀
static/chunks/3628.*.js (New) 23.99kB 23.99kB 100.0% 🚀
static/chunks/3175.*.js (New) 20.6kB 20.6kB 100.0% 🚀
static/chunks/4746-*.js (New) 19.27kB 19.27kB 100.0% 🚀
static/chunks/0e5ce63c-*.js 4.78kB 17.56kB 37.38% ⚠️
static/chunks/app/platform-*.js 163 bytes 12.89kB 1.28%
static/chunks/407.*.js (New) 11.99kB 11.99kB 100.0% 🚀
static/chunks/2934.*.js (New) 11.93kB 11.93kB 100.0% 🚀
static/chunks/7740.*.js (New) 9.22kB 9.22kB 100.0% 🚀
static/chunks/4646.*.js (New) 9.1kB 9.1kB 100.0% 🚀
react-*.json 148 bytes 7.7kB 1.96%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
server/middleware-*.js -5.41kB 1.0kB -84.39%
static/chunks/1182.*.js (New) 6.0kB 6.0kB 100.0% 🚀
static/chunks/webpack-*.js 27 bytes 5.44kB 0.5%
app-*.json 82 bytes 4.19kB 2.0%
static/chunks/pages/_error-*.js 637 bytes 2.78kB 29.72% ⚠️
/static/media/react-*.685727a6.svg (New) 1.82kB 1.82kB 100.0% 🚀
/static/media/react-*.e30ce352.svg (New) 1.82kB 1.82kB 100.0% 🚀
static/chunks/3140.*.js (New) 1.25kB 1.25kB 100.0% 🚀
static/chunks/7926.*.js (New) 1.25kB 1.25kB 100.0% 🚀
static/chunks/9045.*.js (New) 1.25kB 1.25kB 100.0% 🚀
static/chunks/3072.*.js (New) 1.04kB 1.04kB 100.0% 🚀
static/chunks/6272.*.js (New) 1.03kB 1.03kB 100.0% 🚀
static/chunks/2534.*.js (New) 1.03kB 1.03kB 100.0% 🚀
static/chunks/9241.*.js (New) 1.03kB 1.03kB 100.0% 🚀
static/chunks/7993.*.js (New) 1.03kB 1.03kB 100.0% 🚀
static/mSu6XRaSw3mb3LcW_ltfk/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/mSu6XRaSw3mb3LcW_ltfk/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
server/dynamic-*.js (New) 33 bytes 33 bytes 100.0% 🚀
dynamic-*.json (New) 2 bytes 2 bytes 100.0% 🚀
static/chunks/8896.*.js (Deleted) -388.94kB 0 bytes -100.0% 🗑️
static/chunks/3088-*.js (Deleted) -371.55kB 0 bytes -100.0% 🗑️
static/chunks/90542734.*.js (Deleted) -369.91kB 0 bytes -100.0% 🗑️
static/chunks/531.*.js (Deleted) -295.1kB 0 bytes -100.0% 🗑️
static/chunks/d3ac728e.*.js (Deleted) -268.06kB 0 bytes -100.0% 🗑️
static/chunks/6463.*.js (Deleted) -145.64kB 0 bytes -100.0% 🗑️
static/chunks/3150-*.js (Deleted) -140.23kB 0 bytes -100.0% 🗑️
static/chunks/1339.*.js (Deleted) -100.99kB 0 bytes -100.0% 🗑️
static/chunks/4544.*.js (Deleted) -90.58kB 0 bytes -100.0% 🗑️
static/chunks/79b4291e.*.js (Deleted) -84.54kB 0 bytes -100.0% 🗑️
static/chunks/8090.*.js (Deleted) -77.65kB 0 bytes -100.0% 🗑️
static/chunks/2592-*.js (Deleted) -73.93kB 0 bytes -100.0% 🗑️
static/chunks/907.*.js (Deleted) -71.8kB 0 bytes -100.0% 🗑️
static/chunks/5397.*.js (Deleted) -58.0kB 0 bytes -100.0% 🗑️
static/chunks/5062.*.js (Deleted) -44.9kB 0 bytes -100.0% 🗑️
static/chunks/8709.*.js (Deleted) -42.78kB 0 bytes -100.0% 🗑️
static/chunks/6880.*.js (Deleted) -38.09kB 0 bytes -100.0% 🗑️
static/chunks/7019-*.js (Deleted) -37.72kB 0 bytes -100.0% 🗑️
static/chunks/3226.*.js (Deleted) -37.21kB 0 bytes -100.0% 🗑️
static/chunks/3764.*.js (Deleted) -34.64kB 0 bytes -100.0% 🗑️
static/chunks/3612.*.js (Deleted) -34.48kB 0 bytes -100.0% 🗑️
static/chunks/1037.*.js (Deleted) -32.11kB 0 bytes -100.0% 🗑️
static/chunks/7158.*.js (Deleted) -26.36kB 0 bytes -100.0% 🗑️
static/chunks/4778.*.js (Deleted) -25.14kB 0 bytes -100.0% 🗑️
static/chunks/7881.*.js (Deleted) -24.73kB 0 bytes -100.0% 🗑️
static/chunks/8997.*.js (Deleted) -22.48kB 0 bytes -100.0% 🗑️
static/chunks/881.*.js (Deleted) -20.65kB 0 bytes -100.0% 🗑️
static/chunks/5433.*.js (Deleted) -19.45kB 0 bytes -100.0% 🗑️
static/chunks/4717-*.js (Deleted) -19.05kB 0 bytes -100.0% 🗑️
static/chunks/7989.*.js (Deleted) -15.24kB 0 bytes -100.0% 🗑️
static/chunks/7928.*.js (Deleted) -12.04kB 0 bytes -100.0% 🗑️
static/chunks/754.*.js (Deleted) -12.01kB 0 bytes -100.0% 🗑️
static/chunks/1238.*.js (Deleted) -4.67kB 0 bytes -100.0% 🗑️
static/chunks/7238.*.js (Deleted) -4.57kB 0 bytes -100.0% 🗑️
static/chunks/8530.*.js (Deleted) -1.44kB 0 bytes -100.0% 🗑️
static/chunks/4323.*.js (Deleted) -1.23kB 0 bytes -100.0% 🗑️
static/chunks/9017.*.js (Deleted) -1.23kB 0 bytes -100.0% 🗑️
static/chunks/9708.*.js (Deleted) -1.23kB 0 bytes -100.0% 🗑️
static/chunks/2397.*.js (Deleted) -1.0kB 0 bytes -100.0% 🗑️
static/chunks/1569.*.js (Deleted) -998 bytes 0 bytes -100.0% 🗑️
static/chunks/6566.*.js (Deleted) -996 bytes 0 bytes -100.0% 🗑️
static/chunks/1680.*.js (Deleted) -994 bytes 0 bytes -100.0% 🗑️
static/chunks/6175.*.js (Deleted) -993 bytes 0 bytes -100.0% 🗑️
static/hYJdaqyck-*.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/hYJdaqyck-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

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.

1 participant