Home

Welcome to the LogUI Client Documentation!

Need to find documentation on the LogUI client? This is the place you need to be.

If you're looking for getting started quickly with the LogUI client, and want to know the absolute basics on how to integrate LogUI within your web application, try our Quick Start Guide. Otherwise, click one of the links below to get more detailed information.

• ✨Quick Start Guide✨ Provides you with a straightforward guide on how to get the LogUI client up and running in tandem with an instance of the LogUI server.

• Acquiring the Client Provides details on how to acquire a copy of the LogUI client JavaScript bundle. You can either download it pre-compliled, or compile it yourself!

• The Configuration Object Explains in detail what the configuration object is, and details what settings you can provide.

• The LogUI Client API Outlines all of the exposed functions within the LogUI client JavaScript object, and what you can do with them. For example, we provide an init() and stop() function to start and stop the client, respectively.

• Event Handlers Provides detail on how the LogUI client does event handling, and also outlines the different LogUI event handlers that are currently available, which provide additional functionality over traditional DOM event handlers. These are listed below.

  • Mouse Hovering
  • Mouse Clicking
  • Submitting Forms
  • Scrollable Elements

• Metadata Sourcers Provides information on so-called metadata sourcers, components of the LogUI client that allow you to extract information from a variety of different sources around a webpage, and embed that information within events that are logged.

• Browser Events Outlines all of the different browser events that can be captured by the LogUI client, and how you can customise what is captured. These are events that are global to a webpage (such as a browser resize).