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.

// you can find the path in the settings
path: 'alpinachangelog',
// this is the button that
// will open and close the changelog dropdown
trigger: '#triggerButton',
// (optional) you can also use the offset parameter
// to tweak the dropdown positioning on the page
offset: [10, 5],
// (optional) you can add some hooks to know when
// the changelog dropdown has been opened / closed
hooks: {
onLoad: ({ latestRelease }) => {
// latestRelease contains the latest changelog release
// or null if none were found
// this can be used to detect if the user
// has seen the release or not.
// for example by comparing UUID or createdAt of latestRelease with
// a value saved (for example) in locale storage earlier
onOpen: () => {
// changelog has been opened
onClose: () => {
// changelog has been closed

That's it! Now your changelog will appear whenever the trigger button is pressed.