npm:changelog-sidebar

Usage no npm install needed!

<script type="module">
  import changelogSidebar from 'https://cdn.skypack.dev/changelog-sidebar';
</script>

README

Changes Sidebar SDK

The sidebar SDK makes it possible to hide and show a changelog on Changes using a programmable sidebar. This SDK is powered by the Core SDK.

Useful Links

Why keep a changelog
How to keep a good changelog
Using the sidebar
How to use Changes in React

Installation

# npm
npm install changelog-sidebar

# yarn
yarn add changelog-sidebar

Usage

import Sidebar from 'changelog-sidebar';

// Instantiate the sidebar
let sdk = new Sidebar({
  id: '5Web2XRF',
  key: 'IK-X2zvTYjp-NCg-3q2Rj'
});

// Toggle the sidebar
sdk.toggle();

// Open the sidebar
sdk.open();

// Close the sidebar
sdk.close();

API

`new SidebarSDK(options)`

Create a new sidebar-instance.

`options`

Type:

{
  id: string;
  key: string;
  element: string;
}

`sdk.open()`

Open the sidebar programmatically.

`sdk.close()`

Close the sidebar programmatically.

`sdk.toggle()`

Open or close the sidebar programmatically.