Skip to content

Latest commit

 

History

History
128 lines (76 loc) · 4.89 KB

CHANGELOG.md

File metadata and controls

128 lines (76 loc) · 4.89 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[v2.12.1]

  • Demote log level from error to warn
  • Patched the history API methods, such as pushState and replaceState, to trigger a custom userflow:pushstate and userflow:replacestate events whenever the state changes, improving our handling of these changes.
  • Added userflow.setLinkUrlDecorator() method to override how Userflow.js displays links to e.g. your knowledge base. See Userflow.js docs
  • Added unreadAnnouncementCount field to ResourceCenterState object, which represents the number of unread announcements.
  • Added userflow.disableEvalJs() to block all "Evaluate Javascript" actions from running.

Added

  • Added userflow.setServerEndpoint() to override which server Userflow.js should connect to. For advanced use with self-hosted proxy.

Fixed

  • Detect Chrome iOS (starting a little arbitrarily at v100) as es2020 compatible (instead of serving it the legacy bundle).

Added

  • Added userflow.setBaseZIndex() to override Userflow's default base z-index of 1234500.

Added

  • Added userflow.load(), which returns a Promise that resolves once the full Userflow.js has been loaded from our CDN, or rejects if it fails.

Added

  • Added types for new list data type and append/prepend/remove list operations

Added

  • Added userflow.setPageTrackingDisabled() to turn off auto tracking of page_viewed events

Added

  • Added stubs of new resource center related methods: userflow.openResourceCenter(), userflow.closeResourceCenter(), userflow.toggleResourceCenter(), userflow.setResourceCenterLauncherHidden(), userflow.getResourceCenterState(). See Userflow.js docs

Added

  • Added typings for signature option in userflow.identify() and userflow.group() (for use with upcoming identity verification).

Fixed

  • Added missing stub of userflow.start method.

Fixed

  • Support importing userflow.js with server-side rendering such as with Next.js.

Added

  • Added some missing stubbed missing implementations so they can be used before proper Userflow.js is loaded from CDN.

Added

  • module build in ESM format.
  • It will now detect whether the user's browser supports ES2020 features and load either a modern Userflow.js version (small and fast in modern browsers) or a legacy Userflow.js version (larger but supports older browsers).

Changed

  • Now only using ES5 syntax (enforced via ESLint rules) to possibly support IE11 without transpilation one day.
  • BREAKING CHANGE: The scripts are now loaded from js.userflow.com instead of js.getuserflow.com, which means your app's Content Security header may need an update. Please consult our CSP guide.

Removed

  • loadUserflow() was removed. Calling any of the userflow.*() methods will automatically load Userflow.js from CDN.
  • Deprecated userflow.startFlow() was removed. Use userflow.start() instead.
  • Deprecated userflow.endAllFlows() was removed. Use userflow.endAll() instead.
  • Deprecated IdentifyParams type was removed. Use Attributes instead.
  • Deprecated immediate: boolean option was removed - no longer relevant.