API reference

Reference

Authoritative reference for every public @samline/ticker API, option, core utility, type, entrypoint, browser helper, and styling contract.

This reference documents the complete public surface of @samline/ticker.

  • Configuration — every option, default, normalization rule, and matching data attribute.
  • API — factory, controller, page manager, and browser registry signatures.
  • Core utilities — defaults, state factories, validators, and advanced runtime-state contracts.
  • TypeScript — exported types and state contracts.
  • Browser — module singleton and window.Ticker namespace.
  • Entrypoints — ESM, CommonJS, IIFE, CSS, and dependency behavior.
  • Styling — generated DOM, data attributes, classes, CSS variables, and animation ownership.
  • Recipes — common initialization, updates, dynamic content, multiple tickers, and cleanup.

The package has no runtime or peer dependencies. Every supported integration is built on native DOM APIs and the same Vanilla controller.