6

GitHub - williamtroup/Journey.js: 🚶 A lightweight, and easy-to-use, JavaScript l...

 4 months ago
source link: https://github.com/williamtroup/Journey.js
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

Journey.js

🚶 A lightweight, and easy-to-use, JavaScript library for building a website walk-through guide!

v0.3.0

Journey.js

What features does Journey.js have?

  • Zero-dependencies and extremely lightweight!
  • Full API available via public functions.
  • Fully styled in CSS/SASS and compatible with the Bootstrap library.
  • Full CSS theme support (using :root variables, with a default dark-mode theme).
  • Custom triggers for actions (when the dialog is shown for an element, or hidden, etc).
  • Shortcut keys (click here to see the full list).

What browsers are supported?

All modern browsers (such as Google Chrome, FireFox, and Opera) are fully supported.

What are the most recent changes?

To see a list of all the most recent changes, click here.

How do I get started?

To get started using Journey.js, do the following steps:

1. Prerequisites:

Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows:

<!DOCTYPE html>

2. Include Files:

<link rel="stylesheet" href="dist/Journey.js.css" />
<script src="dist/Journey.js"></script>

3. DOM Element Binding:

<button data-journey-options="{ 'title': 'Get Version', 'description': 'Logs the current version of Journey.js to the developers console.', 'order': 6 }" onclick="console.log( $journey.getVersion() );">Get Version</button>

To see a list of all the available binding options you can use for "data-journey-options", click here.

To see a list of all the available custom triggers you can use for "data-journey-options", click here.

4. Finishing Up:

To start the journey, call the following public function:

<script> 
  $journey.show();
</script>

That's it! Nice and simple. Please refer to the code if you need more help (fully documented).

How do I go about customizing Journey.js?

To customize, and get more out of Journey.js, please read through the following documentation.

1. Public Functions:

To see a list of all the public functions available, click here.

2. Configuration:

Configuration options allow you to customize how Journey.js will function. You can set them as follows:

<script> 
  $journey.setConfiguration( {
      safeMode: false
  } );
</script>

To see a list of all the available configuration options you can use, click here.


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK