Provide docs for TelemetryContextProviderProps attributes

iTwin · Feb 12, 2025 · d3e96c4 · d3e96c4
1 parent 550b4a6
commit d3e96c4
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 18 deletions.
diff --git a/packages/itwin/property-grid/api/property-grid-react.api.md b/packages/itwin/property-grid/api/property-grid-react.api.md
@@ -132,9 +132,7 @@ interface PropertyGridActionButtonRendererProps extends ActionButtonRendererProp
 export function PropertyGridComponent({ preferencesStorage, onPerformanceMeasured, onFeatureUsed, ...props }: PropertyGridComponentProps): JSX.Element | null;
 
 // @public
-export interface PropertyGridComponentProps extends Omit<MultiElementPropertyGridProps, "imodel"> {
-    onFeatureUsed?: (featureId: UsageTrackedFeatures) => void;
-    onPerformanceMeasured?: (feature: PerformanceTrackedFeatures, elapsedTime: number) => void;
+export interface PropertyGridComponentProps extends Omit<MultiElementPropertyGridProps, "imodel">, TelemetryContextProviderProps {
     preferencesStorage?: PreferencesStorage;
 }
 
@@ -268,9 +266,7 @@ export function TelemetryContextProvider({ onPerformanceMeasured, onFeatureUsed,
 
 // @public (undocumented)
 interface TelemetryContextProviderProps {
-    // (undocumented)
     onFeatureUsed?: (featureId: UsageTrackedFeatures) => void;
-    // (undocumented)
     onPerformanceMeasured?: (featureId: PerformanceTrackedFeatures, elapsedTime: number) => void;
 }
 

diff --git a/packages/itwin/property-grid/src/property-grid-react/PropertyGridComponent.tsx b/packages/itwin/property-grid/src/property-grid-react/PropertyGridComponent.tsx
@@ -8,30 +8,20 @@ import { MultiElementPropertyGrid } from "./components/MultiElementPropertyGrid.
 import { TelemetryContextProvider } from "./hooks/UseTelemetryContext.js";
 import { PreferencesContextProvider } from "./PropertyGridPreferencesContext.js";
 
-import type { PerformanceTrackedFeatures, UsageTrackedFeatures } from "./hooks/UseTelemetryContext.js";
+import type { TelemetryContextProviderProps } from "./hooks/UseTelemetryContext.js";
 import type { MultiElementPropertyGridProps } from "./components/MultiElementPropertyGrid.js";
 import type { PreferencesStorage } from "./api/PreferencesStorage.js";
 
 /**
  * Props for `PropertyGridComponent`.
  * @public
  */
-export interface PropertyGridComponentProps extends Omit<MultiElementPropertyGridProps, "imodel"> {
+export interface PropertyGridComponentProps extends Omit<MultiElementPropertyGridProps, "imodel">, TelemetryContextProviderProps {
   /**
    * Custom storage that should be used for persisting preferences.
    * Defaults to `IModelAppUserPreferencesStorage` that uses `IModelApp.userPreferences`.
    */
   preferencesStorage?: PreferencesStorage;
-
-  /**
-   * Callback that is invoked when performance of tracked feature is measured.
-   */
-  onPerformanceMeasured?: (feature: PerformanceTrackedFeatures, elapsedTime: number) => void;
-
-  /**
-   * Callback that is invoked when a tracked feature is used.
-   */
-  onFeatureUsed?: (featureId: UsageTrackedFeatures) => void;
 }
 
 /**

diff --git a/packages/itwin/property-grid/src/property-grid-react/hooks/UseTelemetryContext.tsx b/packages/itwin/property-grid/src/property-grid-react/hooks/UseTelemetryContext.tsx
@@ -39,8 +39,12 @@ const telemetryContext = createContext<TelemetryContext>({
   onFeatureUsed: () => {},
 });
 
-interface TelemetryContextProviderProps {
+/** @public */
+export interface TelemetryContextProviderProps {
+  /** Callback that is invoked when performance of tracked feature is measured. */
   onPerformanceMeasured?: (featureId: PerformanceTrackedFeatures, elapsedTime: number) => void;
+
+  /** Callback that is invoked when a tracked feature is used. */
   onFeatureUsed?: (featureId: UsageTrackedFeatures) => void;
 }