@acrolinx/sidebar-sdk 1.1.5 → 1.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -2
- package/dist/acrolinx-plugin.js +1 -1
- package/dist/acrolinx-sidebar-sdk.js +1 -1
- package/dist/acrolinx-sidebar-sdk.min.js +1 -1
- package/dist/adapters/SynchronizeAsyncAdapter.d.ts +2 -1
- package/dist/adapters/SynchronizeAsyncAdapter.js +5 -0
- package/dist/adapters/SynchronizeAsyncAdapter.js.map +1 -1
- package/package.json +4 -8
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Acrolinx Sidebar SDK JS
|
|
2
2
|
|
|
3
|
-
[](https://github.com/acrolinx/sidebar-sdk-js/actions/workflows/main.yml)
|
|
4
4
|
[](https://sonarcloud.io/dashboard?id=acrolinx_sidebar-sdk-js)
|
|
5
5
|
|
|
6
6
|
This is a library for integrating the [Acrolinx](https://www.acrolinx.com/) Sidebar into a web application.
|
|
@@ -68,6 +68,15 @@ The SDK provides [adapters](https://acrolinx.github.io/sidebar-sdk-js/pluginDoc/
|
|
|
68
68
|
If you need to support other editors, sometimes the `ContentEditableAdapter` works without any changes.
|
|
69
69
|
If not, implement the [`AdapterInterface`](https://acrolinx.github.io/sidebar-sdk-js/pluginDoc/modules/adapters_adapterinterface.html).
|
|
70
70
|
|
|
71
|
+
### Deprecation
|
|
72
|
+
> :warning: **If you’re dependent on Sidebar v14**: Please note it's getting deprecated.
|
|
73
|
+
|
|
74
|
+
You don't have to worry on changes in integration. There are only two things that you need to change.
|
|
75
|
+
1. You need to update to the latest SDK [version](https://www.npmjs.com/package/@acrolinx/sidebar-sdk).
|
|
76
|
+
2. [Optional] If you’re using the initialization ```minimumSidebarVersion=14.x.x``` config then remove it.
|
|
77
|
+
|
|
78
|
+
Refer Acrolinx JS [sample](https://github.com/acrolinx/acrolinx-sidebar-demo/tree/main/samples/boilerplate)
|
|
79
|
+
|
|
71
80
|
## References
|
|
72
81
|
|
|
73
82
|
* The [Sidebar DEMO JS](https://github.com/acrolinx/acrolinx-sidebar-demo) is built based on this SDK.
|
|
@@ -79,7 +88,7 @@ If not, implement the [`AdapterInterface`](https://acrolinx.github.io/sidebar-sd
|
|
|
79
88
|
* Run `npm i`
|
|
80
89
|
* Run `npm run build` to run all tests and build distribution
|
|
81
90
|
|
|
82
|
-
## Serve for Development
|
|
91
|
+
## Serve for Development
|
|
83
92
|
|
|
84
93
|
* Run 'npm run webpack-dev-server'
|
|
85
94
|
* Include '<script src="http://0.0.0.0:8081/dist/acrolinx-sidebar-sdk.js"></script>' into your project.
|
package/dist/acrolinx-plugin.js
CHANGED
|
@@ -23,7 +23,7 @@ var CLIENT_COMPONENT_MAIN_FALLBACK = [
|
|
|
23
23
|
var SIDEBAR_SDK_COMPONENT = {
|
|
24
24
|
id: 'com.acrolinx.sidebar-sdk-js',
|
|
25
25
|
name: 'Sidebar SDK JS',
|
|
26
|
-
version: '1.1.
|
|
26
|
+
version: '1.1.7.1',
|
|
27
27
|
};
|
|
28
28
|
var InternalAcrolinxSidebarPlugin = /** @class */ (function () {
|
|
29
29
|
function InternalAcrolinxSidebarPlugin(config, adapter, onGotSidebar, sidebarContentWindow) {
|