@buddy-technology/offer-component 0.3.1 → 0.3.3

package/API.md

@@ -16,6 +16,9 @@
 <dt><a href="#RemoveFromCartFunction">RemoveFromCartFunction</a> ⇒ <code><a href="#DataObject">DataObject</a></code></dt>
 <dd><p>A callback to be called with a payload object when users opt out of the offer.</p>
 </dd>
+<dt><a href="#ScrollToTopFunction">ScrollToTopFunction</a> : <code>function</code></dt>
+<dd><p>A function to override the default scroll to top of offer element behavior when navigating between screens</p>
+</dd>
 <dt><a href="#OverridesObject">OverridesObject</a> : <code>Object</code></dt>
 <dd></dd>
 <dt><a href="#ThemeObject">ThemeObject</a> : <code>Object</code></dt>
@@ -64,6 +67,12 @@ A callback to be called with a payload object when users opt out of the offer.
 
 **Kind**: global typedef  
 **Returns**: [<code>DataObject</code>](#DataObject) - the policy payload  
+<a name="ScrollToTopFunction"></a>
+
+## ScrollToTopFunction : <code>function</code>
+A function to override the default scroll to top of offer element behavior when navigating between screens
+
+**Kind**: global typedef  
 <a name="OverridesObject"></a>
 
 ## OverridesObject : <code>Object</code>
@@ -169,6 +178,7 @@ const theme = {
 | [onUserEvent] | [<code>OnUserEventCallback</code>](#OnUserEventCallback) |  | callback function for tracking user behavioral data. Triggers on user interactions such as input focus/blur, in-app navigation, etc. Refer to the docs for more details. |
 | [onAddToCart] | [<code>AddToCartFunction</code>](#AddToCartFunction) |  | callback function triggered when users opt into an offer-only offer. |
 | [onRemoveFromCart] | [<code>RemoveFromCartFunction</code>](#RemoveFromCartFunction) |  | callback function triggered when users opt out of an offer-only offer. |
-| includeCheckout | <code>boolean</code> |  | toggles whether or not to display the card capture checkout view. Defaults to true. When false, an AddToCart callback must be provided. |
+| [overrideScrollToTop] | [<code>ScrollToTopFunction</code>](#ScrollToTopFunction) |  | When present, this overrides the default scroll to top of offer element behavior when navigating between screens. |
+| [includeCheckout] | <code>boolean</code> |  | toggles whether or not to display the card capture checkout view. Defaults to true. When false, an AddToCart callback must be provided. |
 | [logoOverride] | [<code>LogoOverride</code>](#LogoOverride) |  | object for overriding Buddy's trust badge. |
 

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG 
 
+### v0.3.3  
+2023-07-26  
+ 
+- added overrideScrollToTop to options    
+---  
+  
+
+### v0.3.2  
+2023-06-27  
+ 
+- fix deploy action :crossed_fingers:   
+- fix includeCheckout should be optional    
+---  
+  
+
 ### v0.3.1  
 2023-06-27  
  

package/dist/index.js

@@ -37,6 +37,11 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  * @returns {DataObject} the policy payload
  */
 
+/**
+ * @typedef {Function} ScrollToTopFunction
+ * @description A function to override the default scroll to top of offer element behavior when navigating between screens
+ */
+
 /**
  * @typedef {Object} OverridesObject
  * @property {Array<String>} [webFonts] - array of url strings linking to web fonts.
@@ -111,7 +116,8 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  * @property {OnUserEventCallback} [onUserEvent] - callback function for tracking user behavioral data. Triggers on user interactions such as input focus/blur, in-app navigation, etc. Refer to the docs for more details.
  * @property {AddToCartFunction} [onAddToCart] - callback function triggered when users opt into an offer-only offer.
  * @property {RemoveFromCartFunction} [onRemoveFromCart] - callback function triggered when users opt out of an offer-only offer.
- * @property {boolean} includeCheckout - toggles whether or not to display the card capture checkout view. Defaults to true. When false, an AddToCart callback must be provided.
+ * @property {ScrollToTopFunction} [overrideScrollToTop] - When present, this overrides the default scroll to top of offer element behavior when navigating between screens.
+ * @property {boolean} [includeCheckout] - toggles whether or not to display the card capture checkout view. Defaults to true. When false, an AddToCart callback must be provided.
  * @property {LogoOverride} [logoOverride] - object for overriding Buddy's trust badge.
  */
 

package/lib/types.d.ts

@@ -19,6 +19,11 @@ declare type AddToCartFunction = () => DataObject;
  */
 declare type RemoveFromCartFunction = () => DataObject;
 
+/**
+ * A function to override the default scroll to top of offer element behavior when navigating between screens
+ */
+declare type ScrollToTopFunction = () => void;
+
 /**
  * @property [webFonts] - array of url strings linking to web fonts.
  * @property [styles] - Object Styles object for overriding any css.
@@ -103,7 +108,8 @@ declare type OnUserEventCallback = (type: EventObject) => void;
  * @property [onUserEvent] - callback function for tracking user behavioral data. Triggers on user interactions such as input focus/blur, in-app navigation, etc. Refer to the docs for more details.
  * @property [onAddToCart] - callback function triggered when users opt into an offer-only offer.
  * @property [onRemoveFromCart] - callback function triggered when users opt out of an offer-only offer.
- * @property includeCheckout - toggles whether or not to display the card capture checkout view. Defaults to true. When false, an AddToCart callback must be provided.
+ * @property [overrideScrollToTop] - When present, this overrides the default scroll to top of offer element behavior when navigating between screens.
+ * @property [includeCheckout] - toggles whether or not to display the card capture checkout view. Defaults to true. When false, an AddToCart callback must be provided.
  * @property [logoOverride] - object for overriding Buddy's trust badge.
  */
 declare type BuddyOfferElementProps = {
@@ -116,7 +122,8 @@ declare type BuddyOfferElementProps = {
     onUserEvent?: OnUserEventCallback;
     onAddToCart?: AddToCartFunction;
     onRemoveFromCart?: RemoveFromCartFunction;
-    includeCheckout: boolean;
+    overrideScrollToTop?: ScrollToTopFunction;
+    includeCheckout?: boolean;
     logoOverride?: LogoOverride;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buddy-technology/offer-component",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "author": "Buddy Technology",
   "main": "dist/index.js",
   "types": "./lib/types.d.ts",