core-outline 1.1.19 → 1.1.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# CoreOutline React Component
|
|
2
|
+
|
|
3
|
+
A React component for integrating Core&Outline session recording and event tracking into your web application.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Install the package using npm:
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install core-outline
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
or using yarn:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
yarn install core-outline
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
import React from 'react';
|
|
21
|
+
import CoreOutline from 'core-outline';
|
|
22
|
+
|
|
23
|
+
function App() {
|
|
24
|
+
return (
|
|
25
|
+
<CoreOutline
|
|
26
|
+
data_source_id={{ YOUR_DATA_SOURCE_ID }}
|
|
27
|
+
data_source_secret={{ YOUR_DATA_SOURCE_SECRET }}>
|
|
28
|
+
{/* Your app components */}
|
|
29
|
+
</CoreOutline>
|
|
30
|
+
);
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
export default App;
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
To flag items clicked or purchased:
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
import { flag_item_clicked, flag_item_purchased } from 'core-outline;
|
|
40
|
+
|
|
41
|
+
To flag items clicked:
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
flag_item_clicked('ITEM_ID');
|
|
45
|
+
|
|
46
|
+
To flag items purchased:
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
flag_item_purchased('ITEM_ID');
|
|
50
|
+
|