TypeScript

JavaScript and TypeScript are some of the most popular languages for a web platform.

The Client is designed to be used on the server side only, as it requires your **Localess API Token** to be kept secret. Do not use this client in your frontend application, as it exposes your API Token to the public.

Install

Bash

# NPM
npm install @localess/js-client@latest
# YARN
yarn add @localess/js-client@latest
# PNPM
pnpm add @localess/js-client@latest

Usage

TypeScript

import {localessClient} from "@localess/js-client";

const llClient = localessClient({
  // A fully qualified domain name with protocol (http/https) and port.
  origin: 'https://my-localess.web.app',
  // Localess space ID, cna be found in the Localess Space settings
  spaceId: 'I1LoVe2LocaLess4Rever',
  // Localess API token, can be found in the Localess Space settings
  token: 'Baz00KaT0KeN8S3CureLL' 
});

//Get the sync script URL for your environment, required for Visual Editor Features
llClient.syncScriptUrl() 

// Fetch all Content Links
llClient.getLinks()
// Fetch content by SLUG
llClient.getContentBySlug('docs/overview')
// Fetch content by ID
llClient.getContentById('FRnIT7CUABoRCdSVVGGs')
// Fetch translations by locale
llClient.getTranslations('en') 
//convert asset ID to a full asset URL
llClient.assetLink('FRnIT7CUABoRCdSVVGGs')

Listen for Events

Your application can subscribe to the Localess Visual Editor Events :

TypeScript

window.localess.on(['input', 'change'], (event) => {
  if (event.type === 'input' || event.type === 'change') {
    console.log(event.data);
    //Update your content data ...
  }
});