API

Warning: oculr-ngx is scheduled to be archived on October 1, 2026. No new features, dependency updates, or support are planned after that date. Existing and prospective consumers should review the archival notice before adopting or upgrading this package.

API list

Initialization and configuration

Setting up the Oculr library can be done in a few simple steps.

Directives

Oculr has a set of directives that help capture various display or interaction events.

oculrChange	A directive that captures input, select, and textarea changes.
oculrClick	A directive that captures button and anchor clicks.
oculrDisplay	A directive that captures when a host element is rendered.
oculrFocus	A directive that captures when a host element gains focus.
oculrTrackValidation	A directive that captures validation errors on a Reactive form control.

Page Views

Oculr allows you to easily track the path a user navigates through while using your app.

Interceptors

Oculr comes with an HTTP interceptor ready to go out of the box.

Services

Oculr has a set of services that simplify library initionalization and capturing targeted analytic events.

EventDispatchService	A service that allows client apps to target analytic events.

Interfaces

Oculr has a set of interfaces that ensure the shape of the objects being passed around are consistent.

DirectiveEvent	An event interface used by directives.
AppEvent	An interface used for tracking general application events
AppErrorEvent	An interface used for tracking application errors

Feedback

Is something not working or unclear? Please create an issue or PR.