v5.0.0 (2019-08-25)
Breaking changes:
- Remove style vendor prefixing #519 (RobbieTheWagner)
- showCancelLink -> cancelIcon #518 (RobbieTheWagner)
- Remove link styles #509 (RobbieTheWagner)
- Remove Shepherd.Evented #506 (RobbieTheWagner)
Implemented enhancements:
- Vue wrapper #333
- Add includeStyles option #526 (RobbieTheWagner)
- Tie modal z-index to shepherdElementZIndex #523 (RobbieTheWagner)
- Add disableScroll to types #522 (RobbieTheWagner)
- Types don't support activeTour or Evented properties. #504
- Remove object-assign-deep, refactor setting popper options #516 (genadis)
- Use requestAnimationFrame to position modal opening #514 (RobbieTheWagner)
- Add overlayOpacity to styleVariables options #512 (RobbieTheWagner)
- Add keyboardNav and exitOnEsc options #508 (RobbieTheWagner)
- Move activeTour to namespace #507 (RobbieTheWagner)
Fixed bugs:
- advanceOn click doesn't work on nested elements #511
- Use currentTarget for advanceOn #513 (RobbieTheWagner)
Closed issues:
- Z-Index Issues #521
- ionic element - bubbles not pointing to right place due to clientHeight = 0 (etc.) #426
- Disable built in component styles #497
- Feature Request: I18n cancel link #499
Merged pull requests:
- Update rimraf to the latest version 🚀 #515 (greenkeeper[bot])
- Update rollup-plugin-license to the latest version 🚀 #505 (greenkeeper[bot])
- adding alt and role to img element #503 (MelSumner)
- fixing a11y issue by adding lang attribute to html element #501 (MelSumner)
v4.6.0 (2019-08-09)
Implemented enhancements:
- Wrong type definition for scrollTo #490
- Fade in modal overlay #496 (RobbieTheWagner)
- Fix for the wrong type definition of StepOptions.scrollTo #494 (moxival)
v4.5.0 (2019-08-09)
Fixed bugs:
- Passing 'HTMLElement' to tour.addStep{ text: ... } doesn't work anymore #492
- Support passing elements for text #493 (RobbieTheWagner)
v4.4.1 (2019-08-07)
Fixed bugs:
- ShepherdClass missing after adding modifiers of popper #486
- Use objectAssignDeep to deeply merge tippyOptions #488 (RobbieTheWagner)
v4.4.0 (2019-08-05)
Implemented enhancements:
- Add addSteps method and allow passing steps to tour constructor #485 (RobbieTheWagner)
Fixed bugs:
- Shepherd.Tour constructor definition of steps errors with showOn being undefined #114
v4.3.4 (2019-08-04)
Implemented enhancements:
- styleVariables missing in 'TourOptions' declaration and beforeShowStep not implemented #483
- Fix some types and docs #484 (RobbieTheWagner)
v4.3.3 (2019-08-02)
Implemented enhancements:
- Fix some TypeScript issues #482 (RobbieTheWagner)
v4.3.2 (2019-08-02)
Implemented enhancements:
- Add confirmCancel and confirmCancelMessage to types #480 (RobbieTheWagner)
v4.3.1 (2019-08-02)
Implemented enhancements:
- Closing the tour should move the focus back to the element that opened it #473
- Return focus after closing the tour #479 (RobbieTheWagner)
Merged pull requests:
- Update rollup-plugin-license to the latest version 🚀 #478 (greenkeeper[bot])
v4.3.0 (2019-08-01)
Implemented enhancements:
Fixed bugs:
- Fix cancel link color for when the header has dark background #477 (genadis)
- Fix content border radius #476 (genadis)
- Fix applying tippyOptions #475 (genadis)
v4.2.0 (2019-07-31)
Implemented enhancements:
- Accessibility support #198
- Remove shepherdElementWidth option #471 (RobbieTheWagner)
v4.1.0 (2019-07-30)
Implemented enhancements:
- Make cancel link more accessible #469 (RobbieTheWagner)
- switched to default export in TS typing #468 (grycmat)
v4.0.0 (2019-07-29)
Breaking changes:
- Switch modals from ids to classes and prefix them #466 (RobbieTheWagner)
- Simplify addStep API #464 (RobbieTheWagner)
- Remove predefined themes #462 (RobbieTheWagner)
- Switch to CSSinJS #450 (RobbieTheWagner)
- Use autoBind, pass context rather than manually binding #440 (RobbieTheWagner)
- Remove array support for
step.options.text
#429 (RobbieTheWagner) - .shepherd-popper -> .shepherd, move .shepherd-has-title #422 (RobbieTheWagner)
- Tippy v5 #420 (RobbieTheWagner)
- Remove remaining lodash, IE 11+ #419 (RobbieTheWagner)
- Remove the string option for
advanceOn
in favor of object #418 (RobbieTheWagner) - Remove string option for
attachTo
in favor of object #417 (RobbieTheWagner)
Fixed bugs:
- ommiting 'on' doesn't work #460
- Modal mask opening shows back up on scroll #444
- IE11 support is broken #437
- Incorrect path to typings files in package.json #435
- Start fixing IE11 support #438 (RobbieTheWagner)
- fix for incorrect types path in package.json #434 (cmcnicholas)
- Arrow navigation skips steps if you do back then next #423
- Only add keydown listeners once #424 (RobbieTheWagner)
- useModalOverlay does not play well with multiple instances on the page #370
Implemented enhancements:
- Make build smaller, while still supporting IE11 #467 (RobbieTheWagner)
- Convert to Preact components #458 (RobbieTheWagner)
- Add first class support for secondary button #457 (RobbieTheWagner)
- Prefixes fixes #453 (genadis)
- Add prefix to data attributes #452 (RobbieTheWagner)
- Import ES5 bodyScrollLock, use babel-transform-runtime #447 (RobbieTheWagner)
- Remove drop util #436 (RobbieTheWagner)
- Cleanup public/private API #430 (RobbieTheWagner)
Closed issues:
- An in-range update of eslint-plugin-jest is breaking the build 🚨 #443
- Modal classes are not prefixed #456
- fix removing 'shepherd-modal-target' #455
- Document canClickTarget #461
Merged pull requests:
- Document canClickTarget #465 (RobbieTheWagner)
- Add index to 'show' and 'cancel' events #454 (genadis)
- Remove Eager #451 (RobbieTheWagner)
- Add StackShare badge #446 (RobbieTheWagner)
- Transpile auto-bind #441 (RobbieTheWagner
- Update del to the latest version 🚀 #425 (greenkeeper[bot])
v3.1.0 (2019-06-25)
Fixed bugs:
- Fix jumpy disableScroll #416 (RobbieTheWagner)
- Reuse existing modal overlay #414 (RobbieTheWagner)
Merged pull requests:
- Update rollup-plugin-eslint to the latest version 🚀 #415 (greenkeeper[bot])
v3.0.0 (2019-06-23)
Breaking changes:
- Remove ul, li button wrapper #409 (RobbieTheWagner)
Implemented enhancements:
- Support to keyboard navigation #406
- Feature request --- Add Typescript Typings #359
- Add
disableScroll
option #413 (RobbieTheWagner) - Add aria-describedby and aria-labeledby #411 (RobbieTheWagner)
- Arrow nav #410 (RobbieTheWagner)
- Add focus trap, to disallow tabbing outside the modal #408 (RobbieTheWagner)
- Support close with ESC, focus tooltip on
show
#407 (RobbieTheWagner)
Merged pull requests:
- Update eslint to the latest version 🚀 #412 (greenkeeper[bot])
- Greenkeeper/rollup plugin visualizer 2.1.1 #404 (RobbieTheWagner)
v2.10.0 (2019-06-13)
Implemented enhancements:
- Add scrollIntoView options and polyfill #402 (RobbieTheWagner)
- Add TypeScript definitions #360 (superheri)
Fixed bugs:
- "TypeError: Property 'handleEvent' is not callable." in Firefox #393
- Remove addStepEventListeners call #396 (RobbieTheWagner)
Closed issues:
- [Proposal] center elements for scrollTo #398
- An in-range update of rollup is breaking the build 🚨 #392
Merged pull requests:
- build support for windows (rm does not exist) #403 (hheexx)
- Update stylelint-config-ship-shape to the latest version 🚀 #399 (greenkeeper[bot])
v2.9.1 (2019-06-09)
Implemented enhancements:
- Tippy 4.3.4, bump deps, fix lint #395 (RobbieTheWagner)
- Fix modal padding test failures, add tests, docs #390 (RobbieTheWagner)
Closed issues:
- An in-range update of autoprefixer is breaking the build 🚨 #388
- An in-range update of tippy.js is breaking the build 🚨 #387
- An in-range update of rollup-plugin-analyzer is breaking the build 🚨 #386
- An in-range update of rollup-plugin-node-resolve is breaking the build 🚨 #385
- An in-range update of rollup is breaking the build 🚨 #384
- Add space around attachedElement #379
Merged pull requests:
v2.9.0 (2019-05-26)
Implemented enhancements:
- Add back IE support #380 (RobbieTheWagner)
Fixed bugs:
- Show event of tour does not pass the hash of
step
andprevious
#371 - Ensure arguments are passed down to trigger #381 (RobbieTheWagner)
Closed issues:
- Is it possible to change fill color of the modal ? #374
- There will be blue edges after clicking #369
- [Suggestion] Add transition effects when the mask moving #304
Merged pull requests:
- Update rollup-plugin-eslint to the latest version 🚀 #378 (greenkeeper[bot])
- Update rollup-plugin-terser to the latest version 🚀 #376 (greenkeeper[bot])
- Update rollup-plugin-node-resolve to the latest version 🚀 #373 (greenkeeper[bot])
v2.8.0 (2019-05-03)
Implemented enhancements:
- Convert several lodash functions to internal utils #368 (RobbieTheWagner)
- Use internal debounce function #367 (RobbieTheWagner)
- Greenkeeper/stylelint 10.0.1 #362 (RobbieTheWagner)
Fixed bugs:
- Shepherd popper-tippy CSS styles mixing up with non-shepherd tippy styles on the page #363
Closed issues:
- An in-range update of rollup is breaking the build 🚨 #350
Merged pull requests:
- Added 'shepherd-popper' css class #366 (RobbieTheWagner)
- Add ESDoc, bump some deps #365 (RobbieTheWagner)
v2.7.0 (2019-04-22)
Fixed bugs:
- After tour is canceled/completed and started again, overlay is not present anymore #347
- Add createModalOverlay function #358 (RobbieTheWagner)
Merged pull requests:
- [BugFix] Issue #347 #357 (jayjfletcher)
v2.6.0 (2019-04-15)
Implemented enhancements:
- React wrapper #331
Fixed bugs:
- Minified File Size #354
- Fix inflated build size, bump some deps #355 (RobbieTheWagner)
v2.5.0 (2019-03-20)
Breaking changes:
- Drop IE support, bump some deps #344 (RobbieTheWagner)
Closed issues:
Merged pull requests:
- Add flipping tippy by default, scrollTo for demo #345 (RobbieTheWagner)
- Update del to the latest version 🚀 #340 (greenkeeper[bot])
v2.4.0 (2019-02-27)
Implemented enhancements:
Fixed bugs:
- Links in modal mode #328
- svg mask for the opening in browsers do not support getBoundingClientRect().x|y #330 (yaxinr)
Merged pull requests:
- Tippy 4 #336 (RobbieTheWagner)
- Fix inability to click things in shepherd-element #334 (RobbieTheWagner)
- Update rollup-plugin-css-only to the latest version 🚀 #327 (greenkeeper[bot])
v2.3.3 (2019-01-23)
Fixed bugs:
Merged pull requests:
- Update rollup-plugin-babel-minify to the latest version 🚀 #325 (greenkeeper[bot])
v2.3.2 (2019-01-16)
Fixed bugs:
- Object.assign not transpiled #323
- Toggling developer tools breaks modal mask #320
- Scrolling to an element causes modal overlay to appear in wrong place #319
Merged pull requests:
- Use @babel/plugin-transform-object-assign #324 (RobbieTheWagner)
- Apply scroll listener to all scroll events #322 (RobbieTheWagner)
- Use vh and vw to ensure modal is always full screen #321 (RobbieTheWagner)
v2.3.1 (2019-01-15)
Fixed bugs:
- fix: move touchmove event listener cleanup out of if statement #317 (chuckcarpenter)
Merged pull requests:
- Update rollup-plugin-license to the latest version 🚀 #318 (greenkeeper[bot])
v2.3.0 (2019-01-14)
Implemented enhancements:
- Inject tippy CSS to head #315 (RobbieTheWagner)
v2.2.0 (2019-01-14)
Implemented enhancements:
- setAttributeNS -> setAttribute, add modal utils tests #312 (RobbieTheWagner)
- Use rollup instead of webpack #309 (RobbieTheWagner)
v2.1.1 (2019-01-11)
Fixed bugs:
- Use correct cleanupStepEventListeners #311 (RobbieTheWagner)
v2.1.0 (2019-01-06)
Fixed bugs:
- fix: turn off passive events for touchmove on Safari > 10 #307 (chuckcarpenter)
Merged pull requests:
- Move modal to its own class #308 (RobbieTheWagner)
v2.0.2 (2019-01-04)
Fixed bugs:
- fix: remove class when modal hidden so elements are clickable #305 (chuckcarpenter)
v2.0.1 (2018-12-31)
v2.0.0 (2018-12-31)
Implemented enhancements:
- Add data attribute to the body for the currently active tour name and current step #284
- Use data attributes for element selection in demo/tests #273
Closed issues:
- An in-range update of autoprefixer is breaking the build 🚨 #298
- An in-range update of webpack is breaking the build 🚨 #297
Merged pull requests:
- Integrate modal functionality that was originally in Ember Shepherd #301 (BrianSipple)
- Use data attributes for test selectors #299 (RobbieTheWagner)
- Remove redundant
id
attribute on step tooltip containers. #295 (BrianSipple) - Link to Shepherd's Tippy defaults in docs #294 (BrianSipple)
v2.0.0-beta.35 (2018-11-09)
Implemented enhancements:
- Document Tour.removeStep #278
- Update documentation to clarify arrow usage. #287 (BrianSipple)
Fixed bugs:
- fix tooltip centering #288 (BrianSipple)
Closed issues:
- An in-range update of start-server-and-test is breaking the build 🚨 #283
Merged pull requests:
- Bump deps #291 (RobbieTheWagner)
- Add testing for
Tour.isActive
. #290 (BrianSipple) - Added documentation for tour.removeStep (fixes #278) #289 (joeinnes)
- Improve CodeClimate and test coverage. #286 (BrianSipple)
- Remove unnecessary management of
this.el.hidden
#285 (BrianSipple)
v2.0.0-beta.34 (2018-10-23)
Implemented enhancements:
- Change
data-id
todata-shepherd-step-id
on Step content elements. #282 (BrianSipple)
Closed issues:
- An in-range update of webpack is breaking the build 🚨 #280
v2.0.0-beta.33 (2018-10-19)
Implemented enhancements:
- Add minified js + css to release package #258
- Bump a bunch of deps #281 (RobbieTheWagner)
Fixed bugs:
- Exit animations don't play before step tooltip disappears. #277
- Allow exit animations to play before step tooltip disappears. #279 (BrianSipple)
- Remove default arrow setting on centered tippy #275 (chuckcarpenter)
Merged pull requests:
- Fix bug of classes not being added to targets on returned-to steps. #276 (BrianSipple)
v2.0.0-beta.32 (2018-10-13)
v2.0.0-beta.31 (2018-10-13)
v2.0.0-beta.30 (2018-10-13)
Implemented enhancements:
- Hide buttons if none are passed to
Step.options.buttons
#243 - Constrain input for
Step.options.buttons
to an array of buttons. #271 (BrianSipple)
Merged pull requests:
- fix docs typo #272 (BrianSipple)
v2.0.0-beta.29 (2018-10-11)
Implemented enhancements:
- Bundle minified Tippy code with distribution #263
- Implement
Tour.hide
#265 (BrianSipple)
Fixed bugs:
- Remove or restore hide method on Tour instance #249
Closed issues:
- An in-range update of tippy.js is breaking the build 🚨 #266
Merged pull requests:
- Bundle tippy with the main Shepherd distribution file. #270 (BrianSipple)
- remove spm from package.json #269 (BrianSipple)
- remove some popper arrow styles and target tippy-arrow #268 (chuckcarpenter)
- Update screenshot of intro step in README #264 (BrianSipple)
v2.0.0-beta.28 (2018-10-08)
Implemented enhancements:
- Not all of popper.js placement values are supported #259
- Integrate Tippy for step modal creation #255
- Tippy.js Integration #261 (BrianSipple)
Merged pull requests:
- use uniqueId for step ID prop over idAttribute #262 (chuckcarpenter)
- Support placement values and modifiers according to popper.js API (#259) #260 (tedbeer)
- Change localhost port for cypress tests and document how its used #257 (BrianSipple)
- replace hubspot favicons with shipshape favicons #256 (BrianSipple)
- documentation update: add beforeShowPromise example #253 (jaffadog)
- Update uglifyjs-webpack-plugin to the latest version 🚀 #247 (greenkeeper[bot])
- Update theming documentation. #242 (BrianSipple)
v2.0.0-beta.27 (2018-09-13)
Breaking changes:
- Rename
Tour.options.defaults
toTour.options.defaultStepOptions
. #244 (BrianSipple)
Implemented enhancements:
- Change
tour.options.defaults
totour.options.stepOptions
#240
Merged pull requests:
- Greenkeeper/babel plugin add module exports 1.0.0 #246 (RobbieTheWagner)
v2.0.0-beta.26 (2018-09-07)
Fixed bugs:
- Build syntax errors and element.prepend function not supported (Internet Explorer) #238
- Syntax errors and ParentNode.prepend not supported in IE #239 (alexdaube)
v2.0.0-beta.25 (2018-09-06)
v2.0.0-beta.24 (2018-09-05)
Implemented enhancements:
- Way to get user to confirm quitting a tutorial #133
- Add step options to ESDoc #234 (RobbieTheWagner)
- Add Confirm cancel #232 (RobbieTheWagner)
- improved theming #204 (bm2u)
Fixed bugs:
Closed issues:
- Action required: Greenkeeper could not be activated 🚨 #227
Merged pull requests:
- add
.vscode
directory to.gitignore
#237 (BrianSipple) - Update extract-loader to the latest version 🚀 #236 (greenkeeper[bot])
- [Issue/89]- add onCapture setting to bubble events such as blur for tour elements… #233 (chuckcarpenter)
v2.0.0-beta.23 (2018-08-29)
Implemented enhancements:
- Update to Babel 7, use lodash-es #231 (RobbieTheWagner)
Merged pull requests:
- add more tests for increased coverage #230 (chuckcarpenter)
- Update dependencies to enable Greenkeeper 🌴 #229 (greenkeeper[bot])
v2.0.0-beta.22 (2018-08-29)
Implemented enhancements:
- Implement ESDoc #226 (RobbieTheWagner)
Fixed bugs:
- Fix cancel on any step with a title #228 (chuckcarpenter)
v2.0.0-beta.21 (2018-08-27)
Merged pull requests:
- Merge coverage from cypress and unit tests #225 (RobbieTheWagner)
- Renaming of scss source dir #219 (bm2u)
v2.0.0-beta.20 (2018-08-26)
Implemented enhancements:
- Increase test coverage, refactor, and cleanup #224 (RobbieTheWagner)
v2.0.0-beta.19 (2018-08-25)
v2.0.0-beta.18 (2018-08-25)
Implemented enhancements:
- Add some tour tests #216 (RobbieTheWagner)
- Testing for Evented module #215 (chuckcarpenter)
Fixed bugs:
- ES2015 imports not working #210
- Fix issue with cancel button #220 (chuckcarpenter)
Merged pull requests:
- Move bind methods to their own file #222 (RobbieTheWagner)
- Start some refactoring #221 (RobbieTheWagner)
- Step.js coverage increase #218 (chuckcarpenter)
- Reduce Evented complexity #217 (RobbieTheWagner)
- Start refactoring for Code Climate #214 (RobbieTheWagner)
v2.0.0-beta.17 (2018-08-15)
Merged pull requests:
- Feature/webpack #212 (RobbieTheWagner)
v2.0.0-beta.16 (2018-08-14)
Implemented enhancements:
- [feature/builder] - replace Gulp with module loader and npm #203 (chuckcarpenter)
Fixed bugs:
- Uncaught TypeError: _shepherd2.default.Tour is not a constructor #202
Merged pull requests:
- Start on cypress #209 (RobbieTheWagner)
- increase test coverage #206 (chuckcarpenter)
v2.0.0-beta.15 (2018-08-06)
Fixed bugs:
- Error: Cannot find module 'popper' from '\node_modules\shepherd.js\dist\js' #201
v2.0.0-beta.14 (2018-08-02)
Fixed bugs:
- Error thrown if element not visible anymore #197
Merged pull requests:
- Basic testing framework #199 (chuckcarpenter)
- Update documentation link in demo tour #195 (mikelkew)
v2.0.0-beta.13 (2018-07-16)
Implemented enhancements:
v2.0.0-beta.12 (2018-07-12)
v2.0.0-beta.11 (2018-07-12)
Implemented enhancements:
- Attach shepherd-step to "custom" element / supporting dialog elements. #157
- Add renderLocation option #192 (RobbieTheWagner)
Fixed bugs:
Closed issues:
- Step class cleanup #36
v2.0.0-beta.10 (2018-07-11)
v2.0.0-beta.9 (2018-07-11)
Implemented enhancements:
- CSS should not be required to use this library #166
Fixed bugs:
- Arrows don't appear on some boxes randomly (video) #156
Closed issues:
- Undocumented
scrollToHandler
option #107
v2.0.0-beta.8 (2018-07-09)
v2.0.0-beta.7 (2018-07-07)
Fixed bugs:
- Use frame safe way for isArray() & isObject() #153
- remove shepherd-target class on tour.next()/tour.back() #109
Closed issues:
- Rethethering issue when target element is re-rendered. #112
v2.0.0-beta.6 (2018-07-07)
Implemented enhancements:
Fixed bugs:
- Hide events being triggered twice when there is another step #167
- Removing duplicate call to hide step #168 (pedroceles)
Closed issues:
- The install doc is not working #179
- addStep not return step instance #165
- cancelling the tour when clicking outside the element #141
- showCancelLink yields weird characters #117
Merged pull requests:
v2.0.0-beta.5 (2018-07-03)
v2.0.0-beta.4 (2018-07-03)
v2.0.0-beta.3 (2018-07-03)
Closed issues:
- How can i use it with ionic 2 typescript? #174
v2.0.0-beta.2 (2018-07-02)
v2.0.0-beta.1 (2018-07-02)
Implemented enhancements:
- Convert to popper #189 (RobbieTheWagner)
Fixed bugs:
- Attempting to fix uncaught exception caused by non-existing element f… #190 (RobbieTheWagner)
Closed issues:
- href of the "View docs" button on demo site --> 404 #187
- Demo site is down #185
- Maintainer/transfer #183
- cannot get node_modules/tether-shepherd/dist/js/shepherd.min.js #173
- ES6 import from NPM failed. #171
- Display Shepherd only during first visit #164
- Tether EOL implications #163
- Get the AttachTo object #150
- Arrow problem #145
attachment: together
does not work as expected if attachment width greater than target width #142- shepherd-step not placed in proper position #130
- attachTo is not working when passing a string #122
- Triggering click of an page element on tour step "show" #119
- Inherit animation styles from Drop #84
- Shepherd might need jQuery... #79
- Not accessibility friendly #26
Merged pull requests:
- RM Hubs Copyright #188 (FranDias)
- Link correct demo site #186 (drucci)
- Add Repo to package.json #149 (bm2u)
- Fixes bug where
buttons: false
resulted in the default Next button instead of showing the desired result of no buttons.
- Patches issue where Tether anchor reference was being cached instead of reset when step is shown.
- Adds functionality to pass an object
{element: el, on: tetherPositionString}
to tour stepattachTo
parameter.
- Exposes
scrollTo
option in Eager
- Positioning string parse improvements with regex
- Installation support for dynamically rendered pages in Eager
- Live updates for eager / creation of
tour.removeStep
- Moves
Tether.js
out ofbower_components
and intodist
for supoort in Eager
- Exposes tour object on eager install
- Adds
showOn
for conditionally showing tour steps
- Eager - Install helper now checks for the presence of first attach node before starting
- Fix stacking event listeners
- Pointer event none for arrows
- Update
Tether
to version 1 - Bump all dependencies
- Add proper UMD to
Shepherd
- Convert from
Coffeescript
toES6 (Babel)
- Fix
*.json
files to includemain
- Remove bundled versions
- Restructure directory layout
- Update
gulp
builds