Improve reference for Spotlight.init

getsentry · Nov 22, 2023 · ad23a57 · ad23a57
1 parent c9e804d
commit ad23a57
Showing 1 changed file with 38 additions and 1 deletion.
diff --git a/packages/website/src/content/docs/reference/configuration.md b/packages/website/src/content/docs/reference/configuration.md
@@ -15,6 +15,43 @@ Spotlight.init({
 
 ### `integrations`
 
-_type:_ `<SpotlightIntegration>[]`
+**type:** [`SpotlightIntegration[]`](#spotlightintegration)
 
 Defines which integrations should be loaded for Spotlight.
+
+#### `SpotlightIntegration`
+
+```ts
+// TODO
+type SpotlightIntegration = {};
+```
+
+### `sidecar`
+
+**type:** string
+
+The Sidecar event-source stream endpoint.
+
+```js
+Spotlight.init({
+ sidecar: 'http://localhost:8969/stream',
+});
+```
+
+### `anchor`
+
+**type:** [`AnchorConfig`](#anchorconfig)
+
+The anchor position for the toolbar.
+
+```js
+Spotlight.init({
+ anchor: 'centerRight',
+});
+```
+
+#### `AnchorConfig`
+
+```ts
+type AnchorConfig = 'bottomRight' | 'bottomLeft' | 'centerRight' | 'centerLeft' | 'topLeft' | 'topRight';
+```