nuǝW pǝuoᴉʇᴉsoԀ ʎlǝʌᴉʇɐƃǝN
    Wondering what’s next for npm?Check out our public roadmap! »

    @analytics/amplitude

    0.0.3 • Public • Published

    Amplitude

    This library exports the amplitude plugin for the analytics package.

    This analytics plugin will load Amplitude integration into your application.

    For more information see the docs.

    Click to expand

    Installation

    npm install analytics
    npm install @analytics/amplitude

    How to use

    The @analytics/amplitude package works in the browser. To use, install the package, include in your project and initialize the plugin with analytics.

    Below is an example of how to use the browser plugin.

    import Analytics from 'analytics'
    import amplitudePlugin from '@analytics/amplitude'
    
    const analytics = Analytics({
      app: 'awesome-app',
      plugins: [
        amplitudePlugin({
          apiKey: 'token',
          // See options at https://bit.ly/3dRdZnE
          options: {
            trackingOptions: {
              ip_address: false
            }
          }
        })
      ]
    })
    
    /* Track a page view */
    analytics.page()
    
    /* Track a custom event */
    analytics.track('cartCheckout', {
      item: 'pink socks',
      price: 20
    })
    
    /* Identify a visitor */
    analytics.identify('user-id-xyz', {
      firstName: 'bill',
      lastName: 'murray'
    })

    After initializing analytics with the amplitudePlugin plugin, data will be sent into Amplitude whenever analytics.page, analytics.track, or analytics.identify are called.

    See additional implementation examples for more details on using in your project.

    Platforms Supported

    The @analytics/amplitude package works in the browser

    Browser usage

    The Amplitude client side browser plugin works with these analytic api methods:

    Browser API

    import Analytics from 'analytics'
    import amplitudePlugin from '@analytics/amplitude'
    
    const analytics = Analytics({
      app: 'awesome-app',
      plugins: [
        amplitudePlugin({
          apiKey: 'token',
          // See options at https://bit.ly/3dRdZnE
          options: {
            trackingOptions: {
              ip_address: false
            }
          }
        })
      ]
    })

    Configuration options for browser

    Option description
    apiKey
    required - string
    Amplitude project API key
    options
    required - object
    Amplitude SDK options

    Additional examples

    Below are additional implementation examples.

    Using in HTML

    Below is an example of importing via the unpkg CDN. Please note this will pull in the latest version of the package.

    <!DOCTYPE html>
    <html>
      <head>
        <title>Using @analytics/amplitude in HTML</title>
        <script src="https://unpkg.com/analytics/dist/analytics.min.js"></script>
        <script src="https://unpkg.com/@analytics/amplitude/dist/@analytics/amplitude.min.js"></script>
        <script type="text/javascript">
          /* Initialize analytics */
          var Analytics = _analytics.init({
            app: 'my-app-name',
            plugins: [
              undefined({
                apiKey: 'token',
                // See options at https://bit.ly/3dRdZnE
                options: {
                  trackingOptions: {
                    ip_address: false
                  }
                }
              })
            ]
          })
    
          /* Track a page view */
          analytics.page()
    
          /* Track a custom event */
          analytics.track('cartCheckout', {
            item: 'pink socks',
            price: 20
          })
    
          /* Identify a visitor */
          analytics.identify('user-id-xyz', {
            firstName: 'bill',
            lastName: 'murray'
          })
        </script>
      </head>
      <body>
        ....
      </body>
    </html>
    Using in HTML via ES Modules

    Using @analytics/amplitude in ESM modules.

    <!DOCTYPE html>
    <html>
      <head>
        <title>Using @analytics/amplitude in HTML via ESModules</title>
        <script>
          // Polyfill process.
          // **Note**: Because `import`s are hoisted, we need a separate, prior <script> block.
          window.process = window.process || { env: { NODE_ENV: 'production' } }
        </script>
        <script type="module">
          import analytics from 'https://unpkg.com/analytics/lib/analytics.browser.es.js?module'
          import undefined from 'https://unpkg.com/@analytics/amplitude/lib/analytics-plugin-amplitude.browser.es.js?module'
          /* Initialize analytics */
          const Analytics = analytics({
            app: 'analytics-html-demo',
            debug: true,
            plugins: [
              undefined({
                apiKey: 'token',
                // See options at https://bit.ly/3dRdZnE
                options: {
                  trackingOptions: {
                    ip_address: false
                  }
                }
              })
              // ... add any other third party analytics plugins
            ]
          })
    
          /* Track a page view */
          analytics.page()
    
          /* Track a custom event */
          analytics.track('cartCheckout', {
            item: 'pink socks',
            price: 20
          })
    
          /* Identify a visitor */
          analytics.identify('user-id-xyz', {
            firstName: 'bill',
            lastName: 'murray'
          })
        </script>
      </head>
      <body>
        ....
      </body>
    </html>

    Install

    npm i @analytics/amplitude

    DownloadsWeekly Downloads

    1,847

    Version

    0.0.3

    License

    MIT

    Unpacked Size

    29.9 kB

    Total Files

    10

    Last publish

    Collaborators

    • avatar