Skip to content

Update react api jsdoc example #9421

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
tonybaroneee wants to merge 1 commit into
base: telemetry
Choose a base branch
from
Open

Update react api jsdoc example #9421

Show file tree
Hide file tree
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
34 changes: 29 additions & 5 deletions docs-devsite/telemetry_react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,35 @@ The default [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance
### Example


```html
<body>
<FirebaseTelemetry firebaseApp={app} />
... my app ...
</body>
```tsx
import { useEffect, useState } from "react";
import { FirebaseTelemetry } from "@firebase/telemetry/react";
import { FirebaseApp, initializeApp } from "@firebase/app";

export default function MyApp() {
const [app, setApp] = useState<FirebaseApp | null>(null);

useEffect(() => {
if (getApps().length === 0) {
const newApp = initializeApp({...});
setApp(newApp);
} else {
setApp(getApp());
}
}, []);

return (
<>
{app && (
<FirebaseTelemetry
firebaseApp={app}
telemetryOptions={{...}}
/>
)}
...
</>
);
}

```

5 changes: 1 addition & 4 deletions packages/telemetry/src/angular/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,7 @@ export class FirebaseErrorHandler implements ErrorHandler {
private readonly router = inject(Router);
private readonly telemetry: Telemetry;

constructor(
app: FirebaseApp,
telemetryOptions?: TelemetryOptions
) {
constructor(app: FirebaseApp, telemetryOptions?: TelemetryOptions) {
this.telemetry = getTelemetry(app, telemetryOptions);
}

Expand Down
34 changes: 29 additions & 5 deletions packages/telemetry/src/react/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,35 @@ export * from '../public-types';
* implicitly caught by Error Boundaries, will not be captured by this component.
*
* @example
* ```html
* <body>
* <FirebaseTelemetry firebaseApp={app} />
* ... my app ...
* </body>
* ```tsx
* import { useEffect, useState } from "react";
* import { FirebaseTelemetry } from "@firebase/telemetry/react";
* import { FirebaseApp, initializeApp } from "@firebase/app";
*
* export default function MyApp() {
* const [app, setApp] = useState<FirebaseApp | null>(null);
*
* useEffect(() => {
* if (getApps().length === 0) {
* const newApp = initializeApp({...});
* setApp(newApp);
* } else {
* setApp(getApp());
* }
* }, []);
*
* return (
* <>
* {app && (
* <FirebaseTelemetry
* firebaseApp={app}
* telemetryOptions={{...}}
* />
* )}
* ...
* </>
* );
* }
* ```
*
* @param firebaseApp - The {@link @firebase/app#FirebaseApp} instance to use.
Expand Down
Loading