Widget Initialization

Summary

Widget Initialization is the process of loading and initializing the SDK in your extension widget. This enables access to Writer methods and functionality. Every extension requires proper SDK initialization before use.

Overview

  • Including SDK library
  • Initializing the SDK
  • Data center selection
  • Error handling
  • SDK access patterns

Sub-Sections

SDK Library

Add this script tag to your HTML <head>:

<script src="https://static.zohocdn.com/sigma/client/sdk/v3/sigma-sdk.min.js"></script>

Data Center URLs

Data CenterRegionURL
USUnited Stateshttps://static.zohocdn.com/sigma/client/sdk/v3/sigma-sdk.min.js
EU / IN / AU / JP / CA / SAGlobal regionshttps://static.zohocdn.com/sigma/client/sdk/v3/sigma-sdk.min.js
CNChinahttps://static.zohocdn.com.cn/sigma/client/sdk/v3/sigma-sdk.min.js

Related Pages

SDK Initialization Sample Request

Copied<!DOCTYPE html>
<html>
<head>
    <title>My Extension</title>
    <script src="https://static.zohocdn.com/sigma/client/sdk/v3/sigma-sdk.min.js"></script>
</head>
<body>
    <h1>My Extension</h1>
    <script>
        async function initializeExtension() {
            try {
                await SigmaSDK.WRITER.init();
                console.log("Extension initialized successfully");
                setupUI();
            } catch (error) {
                console.error("Initialization failed:", error);
            }
        }

        function setupUI() {
            // Add event listeners, configure widgets
        }

        document.addEventListener('DOMContentLoaded', initializeExtension);
    </script>
</body>
</html>

Access Storage Sample Request

Copied// Store data
SigmaSDK.WRITER.storage.user.add({ key: "name", value: "data" });

// Retrieve data
const data = await SigmaSDK.WRITER.storage.user.fetch("name");

// Delete data
await SigmaSDK.WRITER.storage.user.delete("name");

Make Requests Sample Request

Copiedconst response = await SigmaSDK.WRITER.request({
    connectionLinkName: "myapi",
    type: "GET",
    url: "https://api.example.com/data"
});

Display Messages Sample Request

Copied// Modal message
SigmaSDK.WRITER.showMessage({
    type: "success",
    title: "Success",
    message: "Operation completed"
});

// Banner notification
SigmaSDK.WRITER.showBannerMessage({
    type: "info",
    message: "Processing..."
});

Custom Events Sample Request

Copied// Get document details
await WriterClient.dispatch("documentDetails", {});

// Insert content
await WriterClient.dispatch("insertContent", {
    content: "<p>Hello</p>",
    contentType: "HTML"
});