Helpcenter +918010117117 https://cdn1.storehippo.com/s/573db3149f0d58741f0cc63b/ms.settings/5256837ccc4abf1d39000001/57614ef64256dc6851749879-480x480.png" support@storehippo.com https://www.facebook.com/StoreHippohttps://twitter.com/StoreHippohttps://www.linkedin.com/company/hippoinnovations/https://plus.google.com/+Storehippo/posts
B4,309-10 Spaze iTech Park, Sector 49, Sohna Road, 122001 Gurgaon India
call to replace anchor tags contains '/admin' in href

Startup Widgets

Startup widgets contain logic to add behaviour to storefronts. Startup widgets make it possible to add behaviours that are standard across different themes. Following are some of the few examples:

  • Add some conditions before a product is added to cart
  • Execute javascript tag on the switch to a specific page.
  • Execute some logic before the page is rendered. 
  • Redirect to another page on specific conditions.

Third-party apps use startup widgets to capture events and perform tasks on those events. 

StoreHippo uses Single Page Architecture so startup widgets are executed only once. Once loaded, when a user switches pages, then widgets are not executed. If you want to write code for the specific page then you need to handle that through page events.

Go to Site > Startup Widgets section in StoreHippo Admin Panel to manage startup scripts. 

To add a new startup widget, click on Add New button in the top right corner.

Name

Enter the name of the startup script.

Controller

Provide your startup javascript code in this field. You can use global objects in the controller code.

Template

Provide the HTML code. You can use global widgets in the template code.

Events

StoreHippo triggers various events in different actions on your store. You can use these events and bind a handler to these events.

ms.bind

(eventName, callback)

Use this global function to bind to a particular event. The callback function is invoked when the event is triggered. The event object is passed to the callback function as the only argument.

Example

ms.bind('ms.page_change_start', function(event) {
    // code here
});

ms.trigger

(eventName, data)

It is used to trigger an event. data is the object containing the data that need to pass to the event handlers.

Example

There are standard events that are triggered in default theme automatically:

ms.trigger("ms.page_change_start");

Event Object

The event object is the standard Event Interface used by all Javascript DOM events. In addition, it contains a data property that contains the data that was passed while triggering the event.

data Data passed at the time of triggering of the event.

Standard Events 

ms.page_change_start Triggered when page change is started. call event.stopPropagation to prevent it to happen. The event.data.to contains the target page URL and event.data.from contains the current page URL.
ms.page_change_success Triggered when page change is successful and page rendering has just started. You can use ms.page object to get information about the page. 
ms.page_loaded Triggered when page is loaded. Page is considered fully loaded when a) there is no ajax requests pending b) main resource data is loaded (e.g. product data on product page) c) ajax requests are still pending after 5000ms (default timeout).
ms.page_not_found Triggered when a page is not found.
ms.message Triggered automatically whenever API response contains messages. It can be triggered manually to display messages to customers.
ms.order_placed Triggered when the order is successfully placed. Event data has orders array that might contain a single order (in case of single seller) or multiple orders (in case of multiple sellers)

 
Examples

  1. To prevent the state change on particular URL ("/page/test")
    ms.bind("ms.page_change_start", function (event) {
         if (event.data && event.data.to && event.data.to.indexOf("/page/test") > -1) {
            event.preventDefault();
        }
    });

  2. To add a script on a particular page
    ms.bind("ms.page_change_success", function (event) {
         if (ms.page.name == "checkout") {
            ms.loadScripts("<url to external script>").then(function() {
                 console.log("Script loaded");
            });
         }
    });

  3. Custom code when a user goes to the Product Page
    ms.bind("ms.page_change_success", function (event) {
        if (ms.page.name == 'product') {
            console.log(ms.product);
        }
    });

  4. How to restrict pages if the user is not logged in.
    ms.bind('ms.page_change_start', function(event) {
        // Direct user to login page if a user is not logged in.
        if(!ms.user || !ms.user.isLoggedIn){
           ms.goTo('/user/login')
        }
    });
  5. Load an external script and execute code once it is loaded.
    ms.loadScripts("<url to external script>").then(function() {
        // Write code to be executed after the script is loaded
        
    });
  6. Execute code on succesful placement of order.
    ms.bind('ms.order_placed', function(event) {  
         /* In case of single seller, orders will have a single order
           In case of multiple sellers, orders will have multiple orders. In addition, it will have originalOrder property that you can use to access the original order before splitting */
    
        event.data.orders.forEach(function(order) {
             console.log("ORDER", order);
        });
    });
  7. Open Modal/Popup window on specific pagesYou can use ms.modal widget to show modal (popup). You can add conditions like show the popup on specific pages or show the popup after some delay

API

StoreHipp provides the REST API. You can call the StoreHippo API in frontend theme using ms.api.

ms.api

Example: To list products

ms.app.call({command : "list", entity : "ms.products"}, function(err, response){
    if(err){
        // handle error
    } else {
        console.log("Response ", response);
    }
})

Hooks

Besides events, you can also use frontend API hooks to intercept the request and response of API hooks.

ms.api.addPrehook

Example: Restrict user to enter at least 5 items of any product

ms.app.addPrehook({entity: 'ms.carts', command: 'addItem'}, function(req, res, next) {
   if(ms.cart.item.quantity < 5) {
       // show a message to your user       alert('There must be at least 5 items in the cart');
       return res.send(406);
   }   return next();
});

Example: Validate order options before placing order.

ms.app.addPrehook({entity: 'ms.carts', command: 'addItem'}, function(req, res, next) {
  if(!ms.cart.options.test || ms.cart.options.test.length < 5) {     alert("The value for test must be longer than 5 characters");     return res.send(406);  }     return next();
});

ms.api.addPosthook

  Example: Calculate the total weight of the cart items

ms.app.addPosthook({entity: 'ms.carts', command: 'addItem'}, function(req, res, next) {
     if(res.data && res.data.cart) {
          res.data.cart.total_weight = 0;
          res.data.cart.items.forEach(function(item) {
             res.data.cart.total_weight += item.weight;
          });
    }
    next();
});



Example: triggering event to 3rd party (iZooto) data with Custom code for  when a product is added to cart

ms.app.addPosthook({entity: "ms.carts", command: "addItem"}, function (req, res, next) {
    var addedItem  = res.data.product;

    window._izq.push(["event","Buy Now",{
        "Category":addedItem.product.categories[0],
        "Product Name":addedItem.name,
        "Price":addedItem.price,
        "Quantity":addedItem.quantity
    }]);

    next();
});


Example: Custom code when a user is logged out

ms.app.addPosthook({entity: "ms.users", command: "logout"}, function (req, res, next) {

    //put your custom code here or call your API
    next();
});

Example: Custom code to show alert on form Submission.

ms.app.addPosthook({entity: 'ms.forms', command: 'performActions'}, function(req, res, next) {
    alert('Form successfully submitted')
    next();
})

Example: Custom code to show and hide data Substore specific

<div ng-if="ms.substore.alias == 'china'">
 Privacy Policy for China
</div>

<div ng-if="ms.substore.alias == 'india'">
 Privacy Policy for India
</div>

Example: GTM Add item when product is added to cart

ms.app.addPosthook({entity: "ms.carts", command: "addItem"}, function (req, res, next) {
    var product = res.data.product;
    window.dataLayer.push({
        'event': 'addToCart',
        'ecommerce': {
            'currencyCode': ms.user.currency.name,
            'add': {
                'products': [
                    {
                        'name': product.name,
                        'id': product._id,
                        'price': product.price,
                        'brand': product.brand,
                        'category': product.categories,
                        'variant': product.variant_id,
                        'quantity': product.quantity
                    }
                ]
            }
        }
    });
    next();
});

NOTE: The next() call need to be there to pass control to the next code in line.

Share:

2020-11-11T16:29:58.253Z