Skip to content
/ kompl Public

A website navigation widget. Guide your users through a curated collection of pages on your site.

License

Notifications You must be signed in to change notification settings

jaguart/kompl

Repository files navigation

kompl

A website navigation widget. Guide your users through a curated compilation of pages on your site.

Kompilation in Action

Installation

  • Head over to releases - download the .zip file
  • Unzip the contents into a folder that is accessible from your website - e.g. public/
  • Add <script src='/kompl.bundle.js' type='method'></script> into the <head> on all pages on your site, after JQuery - and note the type attribute should be set.

Usage

Add controls into your pages that play your compilations:

  <button onclick="
    $kompl.play(
      title:'Jeffs curated Kompilation',
      slugs: [
        '/p1/',
        '/p5/',
        '/p7/',
      ],
      style: 'clean',
      size: 'large',
      place: 'bc',
      show: 80%,
    )
    ">Show me!</button>

Documentation and Examples

You can see the widget in operation by clicking on the buttons on this page: https://normus.totahi.com/tags

You can read the documentation and examples here:

Credits

Author

Jeff, aka jaguart on Github. https://jaguart.tech - dabbler.

This is my first playground using TypeScript in the Node-verse. Canonical source - https://github.com/jaguart/kompl

About

A website navigation widget. Guide your users through a curated collection of pages on your site.

Resources

License

Stars

Watchers

Forks

Packages

No packages published