Alpina
Search…
Changelog

Before you start

In order to use Changelog you must first have our JS snippet on your pages. You can learn more about the integration process by clicking below:
You must also configure your changelog, you can do so by clicking here.

Using changelog

Once your changelog settings are in order and the snippet has been added to your pages you can proceed to integrate it in your application.
1
AlpinaJSChangelog({
2
// you can find the path in the settings
3
path: 'alpinachangelog',
4
5
// this is the button that
6
// will open and close the changelog dropdown
7
trigger: '#triggerButton',
8
9
// (optional) you can also use the offset parameter
10
// to tweak the dropdown positioning on the page
11
offset: [10, 5],
12
13
// (optional) you can add some hooks to know when
14
// the changelog dropdown has been opened / closed
15
hooks: {
16
onLoad: ({ latestRelease }) => {
17
// latestRelease contains the latest changelog release
18
// or null if none were found
19
20
// this can be used to detect if the user
21
// has seen the release or not.
22
// for example by comparing UUID or createdAt of latestRelease with
23
// a value saved (for example) in locale storage earlier
24
},
25
onOpen: () => {
26
// changelog has been opened
27
},
28
onClose: () => {
29
// changelog has been closed
30
},
31
}
32
});
Copied!
That's it! Now your changelog will appear whenever the trigger button is pressed.
Last modified 5mo ago