Skip to main content
Every deployed hostname needs a valid key, including public prototypes and non-commercial demos. Local development needs no key. These functions apply the key and tell you its state.

Import

Example

Ask about a license

Talk with our team about a license for your product.

Notes

  • Give the key exactly as you received it. Do not add spaces or line breaks.
  • Apply the key before the first view or the first export.
  • Without a valid key on a deployed site, exports throw LicenseError. saveProject always works.
  • See Licensing to ask about a license.

setLicenseKey

Apply a floorkit license key.

getLicenseState

The license state of this page.

getLicenseInfo

The verified key’s details, or undefined when no valid key is applied.

LicenseError

Thrown by an export when the site has no valid license key.

Types

LicenseState

The license state of this page.

LicenseInfo

What a verified license key says.
string
required
The key id.
string
required
The organisation the key was issued to.
LicenseType
required
The kind of key.
readonly string[]
required
The host rules the key is valid for.
Date
required
When the key was issued.
Date
required
The end date of the key.

LicenseType

The kind of a floorkit license key.

LicenseBlockReason

Why an export was refused.
Last modified on October 12, 2026