Skip to content
This repository was archived by the owner on May 6, 2024. It is now read-only.

Commit fcd7fcb

Browse files
authored
feat(usepageactivetrigger): add page-reactivated type to Event (#77)
Add page-reactivated type to Events in order to separate from page-view. Change usePageActiveTrigger according to this change.
1 parent c793b4d commit fcd7fcb

4 files changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,14 @@ interface Event {
106106
elementTree: string[]; // The current list of rendered <TrackingElement /> down to the dispatched event
107107
component?: 'button' | 'link'; // Which primitive dispatched the event
108108
label?: string;
109-
event: 'click' | 'view' | 'load' | 'page-view' | 'submit' | 'browser-back'; // This property is added internally based on the kind of event you dispatched.
109+
event:
110+
| 'click'
111+
| 'view'
112+
| 'load'
113+
| 'page-view'
114+
| 'page-reactivated'
115+
| 'submit'
116+
| 'browser-back'; // This property is added internally based on the kind of event you dispatched.
110117
timestamp: number; // This property is added internally when the dispatch function is called
111118
customParameters?: {
112119
[key: string]: any;

src/hooks/usePageActiveTrigger/usePageActiveTrigger.spec.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ describe('usePageActiveTrigger', () => {
3535

3636
const expected = {
3737
app,
38-
event: Events.pageView,
38+
event: Events.pageReactivated,
3939
elementTree: [],
4040
timestamp: expect.any(Number)
4141
};

src/hooks/usePageActiveTrigger/usePageActiveTrigger.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import useVisibilityChange from '../useVisibilityChange';
1818
import { Events } from '../../types';
1919

2020
const usePageActiveTrigger = (initial?: boolean) => {
21-
const dispatch = useBaseTrigger(Events.pageView);
21+
const dispatch = useBaseTrigger(Events.pageReactivated);
2222

2323
useVisibilityChange((isVisible) => isVisible && dispatch({}), initial);
2424
};

src/types.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ export enum Events {
2020
view = 'view',
2121
load = 'load',
2222
pageView = 'page-view',
23+
pageReactivated = 'page-reactivated',
2324
submit = 'submit',
2425
browserBack = 'browser-back'
2526
}

0 commit comments

Comments
 (0)