zias/stats
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Carl-Gerhard Lindesvärd
2024-08-06 23:04:08 +02:00
committed by Carl-Gerhard Lindesvärd
parent 2226cb463d
commit 03cee826ff
23 changed files with 684 additions and 570 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
apps/docs/src/components/common-sdk-config.mdx Normal file
View File

@@ -0,0 +1,8 @@
##### Common options
- `apiUrl` - The url of the openpanel API or your self-hosted instance
- `clientId` - The client id of your application
- `clientSecret` - The client secret of your application (**only required for server-side events**)
- `filter` - A function that will be called before sending an event. If it returns false, the event will not be sent
- `disabled` - If true, the library will not send any events
- `waitForProfile` - If true, the library will wait for the profile to be set before sending events

5
apps/docs/src/components/sdk-config.mdx → apps/docs/src/components/web-sdk-config.mdx
View File

@@ -1,5 +1,6 @@
- `url` - The url of the openpanel API or your self-hosted instance
- `clientId` - The client id of your application
##### Web options
- `trackScreenViews` - If true, the library will automatically track screen views
- `trackOutgoingLinks` - If true, the library will automatically track outgoing links
- `trackAttributes` - If true, the library will automatically track attributes