Releases: williamtroup/Journey.js
Releases · williamtroup/Journey.js
Journey.js v1.6.0 - Grouping support!
New Features:
- Added grouping support! This allows you to place your steps into different groups, allowing multiple journeys for your website/web app.
Binding Options:
- Added a new binding option called "group", which states the group the step should be part of (defaults to "default").
Public Functions:
- Added the parameter "group" to the public function "start()", which states the group of steps to use when starting the journey (defaults to "default).
- Added the parameter "group" to the public function "show()", which states the group of steps to use when resuming a journey (defaults to the last group started).
Improvements:
- The "onDoNotShowAgainChange" custom trigger now fires when the checkbox state is changed (instead of when the dialog closes).
Journey.js v1.5.1 - Fix!
- Fixed a fault that caused the progress bar to render incorrectly when the progress dots are disabled.
Journey.js v1.5.0 - Progress bar! Scroll to elements! More options!
New Features:
- Added progress bar support! This is shown under the progress dots.
- Added scroll to element support!
Binding Options:
- Added a new binding custom trigger called "removeHintWhenViewed", which states if a hint should be removed when clicked (defaults to false).
Configuration Options:
- Added a new configuration option called "showProgressBar", which states if the progress bar should be shown (defaults to false).
- Added a new configuration option called "showProgressBarText", which states if the progress bar text should be shown (defaults to false).
- Added a new configuration option called "scrollToElements", which states if the document view should be scrolled to view the current journey step (defaults to false).
Improvements:
- Refactored the SCSS file to be more organized, and easier to read.
- Smoother transition when the progress dots are updated.
Journey.js v1.4.0 - Confirm to close! New public functions! New custom triggers! More, much more...
New Features:
- Added close confirmation message support! This will only show when the text is configured.
Binding Options - Custom Triggers:
- Added a new binding custom trigger called "onAddStep", which states an event that should be triggered when a step is added (not hints).
- Added a new binding custom trigger called "onRemoveStep", which states an event that should be triggered when a step is removed (not hints).
Configuration Options:
- Added a new configuration option called "closeDialogConfirmationText", which states the confirmation message text that should be shown when closing the dialog (defaults to null).
- Added a new configuration option called "closeDialogOnDisabledBackgroundClick", which states if the dialog should be closed when the disabled background is clicked (defaults to false).
Public Functions:
- Added a new public function called "addDocumentSteps()", which will search the document body for new steps and add them.
- Added a new public function called "removeStep()", which will remove a step from the journey, or a hint.
- Added a new public function called "clearSteps()", which will remove all the steps from the journey.
- Added a new public function called "clearHints()", which will remove all the hints from the page.
- Added a new public function called "reverseStepOrder()", which will remove the order that the steps in the journey are shown in.
Fixes:
- Fixed a fault that prevented the public functions "start()", "show()", and "hide()" from returning the correct scope.
- Fixed errors in the public function documentation.
- Fixed a fault that allows invalid objects to be passed to the "addStep()" public function.
- Fixed the dialog being shown in the wrong position when the window is scrolled to a different position.
Journey.js v1.3.0 - Smoother journey! New options! More examples! More, more, more...
New Features:**
- Added smooth transition when the dialog is moved to different DOM elements in the journey.
- Added a custom tooltip, which uses the default theme colors!
Binding Options:**
- Added a new binding option called "showDisabledBackground", which states if the disabled background should be shown for this step (defaults to true).
- Added a new binding option called "tooltip", which states a custom tooltip to use for its progress dot in the main dialog (defaults to null).
Binding Options - Custom Triggers:**
- Added a new binding custom trigger called "onStart", which states an event that should be triggered when the journey is at the start.
Configuration Options:**
- Added a new configuration option called "showProgressDotToolTips", which states if the progress dot tooltips should be shown (defaults to true).
Fixes:**
- Fixed a fault that prevented the shortcut keys from being disabled when the configuration option "shortcutKeysEnabled" is set to false.
Journey.js v1.2.0 - Use Strict! Styling Updates! New Options! Lots, lots more...
New Features:**
- The "Do not show again" checkbox shown in the dialog can now be styled!
Binding Options:**
- BREAKING: The binding attribute "data-journey-options" has been renamed to "data-journey-js".
- BREAKING: All binding option custom triggers are now available under a new area called "events".
Configuration Options:
- Added a new configuration option called "objectErrorText", which states the error text that should be shown when an object error is detected (defaults to "Errors in object: {{error_1}}, {{error_2}}").
- Added a new configuration option called "attributeNotValidErrorText", which states the error text that should be shown when a binding object isn't valid (defaults to "The attribute '{{attribute_name}}' is not a valid object.").
- Added a new configuration option called "attributeNotSetErrorText", which states the error text that should be shown when a binding attribute isn't set (defaults to "The attribute '{{attribute_name}}' has not been set correctly.").
Improvements:
- Added "use strict" support internally and updated all public functions to use the new scope.
- All default parameters are now read more accurately and apply the correct defaults.
- The public function "setConfiguration()" will now only update the configuration (and refresh the displays) if something in the configuration has been changed.
Fixes:
- Fixed a minor formatting issue in the "package.json" file.
Journey.js v1.1.1 - 11 new translations!
Translations:
- Added translation support for Frisian (fy).
- Added translation support for Sinhalese (si).
- Added translation support for Tagalog (tl).
- Added translation support for Tamil (ta).
- Added translation support for Taiwanese (zh-tw).
- Added translation support for Telugu (te).
- Added translation support for Afrikaans (af).
- Added translation support for Armenian (hy).
- Added translation support for Belarusian (be).
- Added translation support for Catalan (ca).
- Added translation support for Esperanto (eo).
Journey.js v1.1.0 - Translation support, and large improvements!
New Features:
- Added a new folder to "dist" called translations, and added translation files for the following languages:
ar
Arabicbn
Bengalibg
Bulgarianzh
Chinese (simplified)da
Danishnl
Dutchen
English (default)et
Estonianfa
Farsifi
Finnishfr
Frenchgl
Galicianka
Georgiande
Germanel
Greekhe
Hebrewhi
Hindihu
Hungarianis
Icelandicid
Indonesianga
Irishit
Italianja
Japaneseko
Koreanlv
Latvianlt
Lithuanianlb
Luxembourgishms
Malayne
Nepalino
Norwegianpl
Polishpt
Portuguesero
Romaniansk
Slovaksl
Slovenianes
Spanishsv
Swedishth
Thaitr
Turkishuk
Ukrainian
General Improvements:
- Added Math injection directly into the main instance.
- Added JSON injection directly into the main instance.
CSS:
- Added a new ":root" variable called "--journey-js-default-font".
Documentation:
- Added install instructions into the main README files.
- Added documentation to state how issues and feature requests should be made.
Fixes:
- Fixed the "journey.js.nuspec" file including the ".github" folder when NuGet PACK is called.
- Fixed spacing issues in the dialog that occur when additional CSS libraries are not included.
Journey.js v1.0.3 - Fixes!
- Fixed the buttons not having any spacing around them by default.
- Fixed a fault that prevented the hints from closing correctly (due to element binding existing).
- Fixed a fault that caused a single progress dot to appear when only one item is available.
Journey v1.0.2 - CSS improvements!
- All hover transition effects now work for hovering, and not hovering, which results in a smoother display.
- Removed the outline effect for the "Back", "Next", and "Finish" buttons.
- Removed replicated HEX colors (all now reference the original ":root" variable).
- Added an ":active" states for all buttons, dots, and the close button (now shows a slightly lighter background color).
- Minor documentation improvements.