feat(core): ✨ allow custom data when adding to history

aibolem · May 11, 2023 · 2eaab1c · 2eaab1c
1 parent e1e4b5f
commit 2eaab1c
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/packages/core/__tests__/utils/history.test.ts b/packages/core/__tests__/utils/history.test.ts
@@ -170,6 +170,24 @@ it('manage history with programmatic replace', async () => {
   expect(h.rs).toHaveBeenCalledTimes(1);
 });
 
+it('manage history with programmatic push and custom data', async () => {
+  const custom = {
+    custom: 'data',
+  };
+
+  history.add(first.url, 'barba', 'push', custom);
+  expect(history.current.data).toEqual(custom);
+});
+
+it('manage history with programmatic replace and custom data', async () => {
+  const custom = {
+    custom: 'data',
+  };
+
+  history.add(first.url, 'barba', 'replace', custom);
+  expect(history.current.data).toEqual(custom);
+});
+
 it('store custom user data', async () => {
   const custom = {
     custom: 'data',

diff --git a/packages/core/src/utils/history.ts b/packages/core/src/utils/history.ts
@@ -113,7 +113,7 @@ export class History {
   /**
    * Add a new state.
    */
-  public add(url: string, trigger: Trigger, action?: HistoryAction): void {
+  public add(url: string, trigger: Trigger, action?: HistoryAction, data?: object): void {
     // If no state, it will be updated later.
     const ns = 'tmp';
     const method = action ?? this._getAction(trigger);
@@ -124,7 +124,7 @@ export class History {
         y: window.scrollY,
       },
       url,
-      data: {},
+      data: data ?? {},
     };
 
     switch (method) {