Skip to main content

Installation

There are multiple ways to install and use the web client walker.js:

  • Google Tag Manager: Use the GTM to load walker.js.
  • NPM: Install walker.js as an NPM package.
  • Code: Directly include walker.js in the browser.

Configuration

There a few configuration options when creating a walker.js instance:

OptionTypeDescription
consentobjectInitial consent states, learn more under consent.
dataLayerbooleanAdds a dataLayer destination if enabled.
defaultbooleanAdd a dataLayer destination and run automatically.
elbstringName of assign the elb function to the window
elbLayerobjectPublic elbwalker API for async communication.
globalsobjectStatic attributes added to each event.
instancestringName of the walkerjs instance to assign to the window
pageviewbooleanTrigger a page view event by default.
prefixstringAttributes prefix used by the walker.
runbooleanAutomatically start running.
sessionfalse or
SessionConfig
Configuration for session detection.
taggingnumberCurrent version of the tracking setup.
userobjectSetting the user ids including id, device, and session.
const walkerjs = Walkerjs({
consent: {
functional: true,
},
dataLayer: true,
elb: 'elb',
elbLayer: window.elbLayer,
globals: {
tagged: false,
},
instance: 'walkerjs',
pageview: true,
run: true,
session: {
storage: true,
consent: 'marketing',
length: 60,
},
tagging: 1,
});

During a run you can still use globals and tagging to update the configuration.