Acrolinx Sidebar SDK for JavaScript

Usage no npm install needed!

<script type="module">
  import acrolinxSidebarSdk from 'https://cdn.skypack.dev/@acrolinx/sidebar-sdk';


Acrolinx Sidebar SDK JS

CI Sidebar SDK JS Quality Gate Status

This is a library for integrating the Acrolinx Sidebar into a web application.

See: Getting Started with Custom Integrations

Live Demo

Acrolinx Sidebar Web Live Demo


Acrolinx Sidebar Web Demo

The Acrolinx Sidebar

The Acrolinx Sidebar is designed to show up beside the window where you edit your content. You use it for checking, reviewing, and correcting your content. To get an impression what the Sidebar looks like in existing integrations, have a look at Get Started With the Sidebar.


Please contact Acrolinx SDK support for consulting and getting your integration certified. This sample works with a test license on an internal Acrolinx URL. This license is only meant for demonstration and developing purposes. Once you finished your integration, you'll have to get a license for your integration from Acrolinx.

Acrolinx offers different other SDKs, and examples for developing integrations.

Before you start developing your own integration, you might benefit from looking into:

Getting Started


To install the SDK to your npm-based Acrolinx Integration project call:

npm install @acrolinx/sidebar-sdk

Instructions for Contributing Code


SDK Features

The SDK provides adapters for:

  • contentEditable div-elements,
  • input text elements,
  • CodeMirror,
  • CKEditor,
  • Xeditor,
  • TinyMCE, and a
  • MultiEditorAdapter that can be used to combine different adapters as one document.

If you need to support other editors, sometimes the ContentEditableAdapter works without any changes. If not, implement the AdapterInterface.


Running This Project

  • Make sure you have a Chrome or chromium version later than 72.0.0. This is needed to execute the tests successfully.
  • Run npm i
  • Run npm run build to run all tests and build distribution

Serve for Development (Load local SDK in Browser)

  • Run 'npm run webpack-dev-server'
  • Include '' into your project.
  • Check the output of the above npm task and correct the host port if needed.


Copyright 2015-present Acrolinx GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:


Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

For more information visit: https://www.acrolinx.com