Essentials

The Essentials API contains common functionality that you might need when building on the Wix platform.

The Essentials API includes the following submodules:

• auth: Allows you to work with Wix authentication and permissions.
• httpClient: Includes helper methods for making authenticated requests within the Wix platform.
• i18n: Allows app extensions to access the language and locale settings of the site on which it's installed.

Setup

To use the Essentials API, install the @wix/essentials package:

Install the package

To install the package, follow the instructions below based on your development environment.

Wix sites and Blocks apps

When developing with:

• Editor or Wix IDE: Use the package manager.
• Local IDE: Use the Wix CLI. Run the following command:

Wix apps and Headless

When developing CLI or self-hosted Wix apps, as well as headless apps or sites, run the following command:

or