Acrolinx Sidebar SDK JS

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

Live Demo

Examples

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 Sidebar Quick Start.

Prerequisites

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:

Build With Acrolinx,
the Guidance for the Development of Acrolinx Integrations,
the Acrolinx SDKs, and
the Acrolinx Demo Projects.

Getting Started

Installation

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

npm install @acrolinx/sidebar-sdk

Instructions for Contributing Code

CONTRIBUTING.md

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.

Deprecation

⚠️ Sidebar v14 is getting deprecated

The process to update your existing integration is straightforward and involves the following steps:

Update to the Latest SDK Version: Please ensure that you’ve updated to the latest SDK version. The most recent version can be found on our NPM package page here.
Remove the Initialization Config (Optional): If your current implementation includes the initialization config minimumSidebarVersion=14.x.x, we recommend removing this configuration.

References

The Sidebar DEMO JS is built based on this SDK.
- Boilerplate sample
The Sidebar SDKs are based on the Acrolinx Sidebar Interface.

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

Run 'npm run webpack-dev-server'
Include '<script src="http://0.0.0.0:8081/dist/acrolinx-sidebar-sdk.js"></script>' into your project.
Check the output of the above npm task and correct the host port if needed.

License

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:

http://www.apache.org/licenses/LICENSE-2.0

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