Skip to main content

Create tag

This example demonstrates how to create a new custom tag in DocSpace using the JavaScript SDK.

Before you start

Please make sure you are using a server environment to run the HTML file because the JavaScript SDK must be launched on the server. You need to add the URL of your server's root directory to the Developer Tools section of DocSpace.

Full example
<!-- Step 1: HTML Setup -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Create Tag</title>

<!-- Replace with your actual portal URL -->
<script src="{PORTAL_SRC}/static/scripts/sdk/1.0.1/api.js"></script>

<style>
#button {
position: fixed;
bottom: 20px;
left: 50%;
transform: translateX(-50%);
background-color: #007bff;
color: white;
font-size: 16px;
padding: 10px 20px;
border: none;
border-radius: 6px;
cursor: pointer;
}
</style>
</head>

<body>
<!-- SDK iframe -->
<iframe id="ds-frame"></iframe>

<!-- Trigger Button -->
<button id="button">Create Tag</button>
</body>

<!-- Step 2: JavaScript SDK Logic -->
<script>
function onAppReady() {
const frame = DocSpace.SDK.frames["ds-frame"];
console.log(frame);
document.getElementById("button").onclick = () => {
let tagname = `tag-${Date.now().toString()}`;
docSpace.createTag(tagname);
};
}

const config = {
frameId: "ds-frame",
width: "100%",
height: "700px",
events: {
onAppReady,
},
};

const docSpace = DocSpace.SDK.initManager(config);
</script>
</html>

Step 1. Set HTML structure

Create a simple HTML page with an embedded DocSpace frame and a button to trigger the tag creation action:

<!-- Step 1: HTML Setup -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Create Tag</title>

<!-- Replace with your actual portal URL -->
<script src="{PORTAL_SRC}/static/scripts/sdk/1.0.1/api.js"></script>

<style>
#button {
position: fixed;
bottom: 20px;
left: 50%;
transform: translateX(-50%);
background-color: #007bff;
color: white;
font-size: 16px;
padding: 10px 20px;
border: none;
border-radius: 6px;
cursor: pointer;
}
</style>
</head>

<body>
<!-- SDK iframe -->
<iframe id="ds-frame"></iframe>

<!-- Trigger Button -->
<button id="button">Create Tag</button>
</body>
</html>
info

The API JavaScript file can normally be found in the following DocSpace folder: {PORTAL_SRC}/static/scripts/sdk/1.0.1/api.js where {PORTAL_SRC} is the name of the server with the ONLYOFFICE DocSpace installed.

Step 2. JavaScript SDK logic

Create a script block to configure and initialize the SDK. Use the createTag() method to create a new tag with a unique name.

function onAppReady() {
const frame = DocSpace.SDK.frames["ds-frame"];
console.log(frame);
document.getElementById("button").onclick = () => {
let tagname = `tag-${Date.now().toString()}`;
docSpace.createTag(tagname);
};
}

const config = {
frameId: "ds-frame",
width: "100%",
height: "700px",
events: {
onAppReady,
},
};

const docSpace = DocSpace.SDK.initManager(config);