Lime Web Components API Documentation - v5.31.0

This is the public API for Lime Web Components. It contains helper functions and interfaces for all services available in the Lime CRM platform.

Everything that is exported from this package is marked with one of the following statuses

  • @public - Released and ready to be used. The interface is stable and should not have any breaking changes without triggering a new major release.
  • @beta - The interface is fairly stable and can be used by those willing to accept breaking changes without notice. Breaking changes may still happen without notice, and without triggering a new major release. Feedback on the interfaces are welcome.
  • @alpha - Still under development and is likely to have frequent breaking changes without notice.
  • @deprecated - Can be used for the time being, but will be removed in the future. Has likely been replaced by something better. Do not use when writing new code.
  • @internal - Do not use!

Index

Command bus

Query

Tasks

Lime objects

Navigation

Lime types

Actions

Interfaces

Notifications

Application

Conditions

Config

Core

Localization

Device

Dialog

Event dispatching

Filters

HTTP

Keyboard shortcuts

Registering routes

User data

Views

Web components

Type Aliases

Variables