Package Exports

@virto-commerce/front-modules-hotjar
@virto-commerce/front-modules-hotjar/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@virto-commerce/front-modules-hotjar) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Hotjar Module For VirtoCommerce Frontend

This module is designed for use with the VirtoCommerce frontend app. It provides a simple interface to initialize and use Hotjar, a behavior analytics tool that helps you understand your users by providing insights through heatmaps, session recordings, and surveys.

Installation

install the latest version

yarn add @virto-commerce/front-modules-hotjar

or install a specific version

yarn add @virto-commerce/front-modules-hotjar@1.0.0

Usage

Import the Module

Import the useHotjarModule composable in your Vue component:

import { useHotjarModule } from "@virto-commerce/front-modules-hotjar";

but preferably use async import

const { useHotjarModule } = await import("@virto-commerce/front-modules-hotjar");

Initialize Hotjar

To initialize Hotjar, call the initModule method with the appropriate properties:

const { initModule } = useHotjarModule();

initModule({
  getModuleSettings,
  isDevelopment: IS_DEVELOPMENT,
  logger: Logger,
  userId: user.value.id,
});

Publishing the Package

To publish the package, draft a new release. Ensure that that the version in package.json was changed accordingly in advance. After release package will be published automatically. On any concerns please see workflows in the Actions tab.

License

This software is licensed under the Virto Commerce Open Software License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://virtocommerce.com/opensourcelicense.

@virto-commerce/front-modules-hotjar