Skip to content

Latest commit

 

History

History
1709 lines (1128 loc) · 108 KB

CHANGELOG.md

File metadata and controls

1709 lines (1128 loc) · 108 KB
Raw

Changelog

Release (2024-05-06)

shepherd-docs 0.0.2 (patch) react-shepherd 5.0.0 (major) shepherd.js 12.0.0 (patch)

💥 Breaking Change

📝 Documentation

🏠 Internal

Committers: 3

v12.0.0-alpha.13 (2024-04-05)

🚀 Enhancement

🏠 Internal

Committers: 1

v12.0.0-alpha.12 (2024-04-02)

💥 Breaking Change

🏠 Internal

Committers: 1

v12.0.0-alpha.11 (2024-04-01)

🐛 Bug Fix

Committers: 1

v12.0.0-alpha.10 (2024-04-01)

🏠 Internal

Committers: 1

v12.0.0-alpha.9 (2024-04-01)

🚀 Enhancement

📝 Documentation

Committers: 2

v12.0.0-alpha.8 (2024-03-29)

🚀 Enhancement

🐛 Bug Fix

Committers: 2

v12.0.0-alpha.7 (2024-03-28)

🚀 Enhancement

🐛 Bug Fix

📝 Documentation

🏠 Internal

Committers: 2

v12.0.0-alpha.6 (2024-03-20)

📝 Documentation

🏠 Internal

Committers: 1

v12.0.0-alpha.5 (2024-03-20)

📝 Documentation

🏠 Internal

Committers: 1

v12.0.0-alpha.4 (2024-03-19)

🐛 Bug Fix

📝 Documentation

🏠 Internal

Committers: 2

v12.0.0-alpha.3 (2024-03-12)

🚀 Enhancement

🏠 Internal

Committers: 2

v12.0.0-alpha.2 (2024-03-08)

💥 Breaking Change

Committers: 1

v12.0.0-1 (2024-03-08)

v12.0.0-0 (2024-03-08)

💥 Breaking Change

🚀 Enhancement

🐛 Bug Fix

📝 Documentation

🏠 Internal

Committers: 6

v11.2.0 (2023-09-02)

🚀 Enhancement

  • #2399 Prevent ESC, KEY_RIGHT, KEY_LEFT propagation when keyboardNav is enabled (@karendolan)

Committers: 1

v11.1.1 (2023-04-03)

v11.1.0 (2023-04-03)

🚀 Enhancement

🐛 Bug Fix

  • #2204 Bugfix: prevent to show spurious warnings in dev panel console (@SamyCookie)

📝 Documentation

Committers: 5

v11.0.1 (2022-12-12)

🐛 Bug Fix

Committers: 1

v11.0.0 (2022-11-21)

💥 Breaking Change

🚀 Enhancement

  • #2137 Exporting StepOptionsButton type to be able to add tour steps buttons dynamically with type checking (@xhafan)
  • #2116 feat: add ability to specify corner radii (@simoneb)

🐛 Bug Fix

📝 Documentation

🏠 Internal

Committers: 6

v10.0.1 (2022-08-01)

🐛 Bug Fix

Committers: 1

v10.0.0 (2022-06-07)

💥 Breaking Change

🐛 Bug Fix

Committers: 1

v9.1.1 (2022-05-26)

🐛 Bug Fix

🏠 Internal

Committers: 2

v9.1.0 (2022-04-09)

🚀 Enhancement

  • #1815 Add dynamic text and label properties for buttons (@radibit)

Committers: 1

v9.0.0 (2022-01-11)

💥 Breaking Change

🚀 Enhancement

🐛 Bug Fix

📝 Documentation

🏠 Internal

Committers: 8

v8.3.1 (2021-05-07)

🐛 Bug Fix

Committers: 2

v8.3.0 (2021-04-06)

🏠 Internal

Committers: 2

v8.2.3 (2021-03-25)

🏠 Internal

Committers: 1

v8.2.1 (2021-03-24)

🏠 Internal

Committers: 1

v8.2.0 (2021-03-03)

🚀 Enhancement

  • #1189 Remove shepherd-target-click-disabled class on step hide (@zefj)

🐛 Bug Fix

📝 Documentation

🏠 Internal

Committers: 7

v8.1.0 (2020-10-05)

🚀 Enhancement

  • #1176 Add stepsContainer option, allowing users to specify rendering target for step elements (@zefj)
  • #1074 Add missing types for Step.options and Tour.steps (@anakorn)

🐛 Bug Fix

📝 Documentation

🏠 Internal

  • #1044 add Step.id to typings, fix tour.getById() typing (@cyremur)

Committers: 9

v8.0.2 (2020-07-10)

🚀 Enhancement

  • #1026 Add Edge 18 to browserslist (@te1)
  • #996 Step Element Target Action (@WORMSS)
  • #995 Added the correct this context to StepOption 'when' functions (@WORMSS)

🐛 Bug Fix

🏠 Internal

Committers: 5

v8.0.1 (2020-05-30)

v8.0.0 (2020-05-25)

💥 Breaking Change

🐛 Bug Fix

📝 Documentation

🏠 Internal

Committers: 3

Changelog

v7.0.2 (2020-02-25)

Full Changelog

Fixed bugs:

Closed issues:

  • Installing v7.0.0 fails #810

v7.0.1 (2020-02-24)

Full Changelog

v7.0.0 (2020-02-24)

Full Changelog

Breaking changes:

Implemented enhancements:

  • Refactor back to Popper #744

Fixed bugs:

  • Smooth scrolling not working? #788
  • Overlay does not resize #751
  • 🐛 Fix initial scroll to top before scrolling to target #801 (chuckcarpenter)

Closed issues:

  • .shepherd-arrow does not "flip" when scroll/resize causes a tour stop to switch sides #787
  • Arrow position is incorrect for ion-fab element #ionic #745
  • shepherd in webview does not show buttons #721

Merged pull requests:

v6.0.2 (2019-11-08)

Full Changelog

v6.0.1 (2019-11-06)

Full Changelog

v5.0.0 (2019-08-25)

Full Changelog

Breaking changes:

Implemented enhancements:

Fixed bugs:

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:

v4.6.0 (2019-08-09)

Full Changelog

Implemented enhancements:

v4.5.0 (2019-08-09)

Full Changelog

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)

Full Changelog

Fixed bugs:

  • ShepherdClass missing after adding modifiers of popper #486
  • Use objectAssignDeep to deeply merge tippyOptions #488 (RobbieTheWagner)

v4.4.0 (2019-08-05)

Full Changelog

Implemented enhancements:

Fixed bugs:

  • Shepherd.Tour constructor definition of steps errors with showOn being undefined #114

v4.3.4 (2019-08-04)

Full Changelog

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)

Full Changelog

Implemented enhancements:

v4.3.2 (2019-08-02)

Full Changelog

Implemented enhancements:

v4.3.1 (2019-08-02)

Full Changelog

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:

v4.3.0 (2019-08-01)

Full Changelog

Implemented enhancements:

  • Add option to specify container element for the modal #474 (genadis)

Fixed bugs:

v4.2.0 (2019-07-31)

Full Changelog

Implemented enhancements:

v4.1.0 (2019-07-30)

Full Changelog

Implemented enhancements:

v4.0.0 (2019-07-29)

Full Changelog

Breaking changes:

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:

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:

v3.1.0 (2019-06-25)

Full Changelog

Fixed bugs:

Merged pull requests:

v3.0.0 (2019-06-23)

Full Changelog

Breaking changes:

Implemented enhancements:

Merged pull requests:

v2.10.0 (2019-06-13)

Full Changelog

Implemented enhancements:

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:

v2.9.1 (2019-06-09)

Full Changelog

Implemented enhancements:

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:

  • Optional padding on modalOverlayOpening #383 (skmbr)

v2.9.0 (2019-05-26)

Full Changelog

Implemented enhancements:

Fixed bugs:

  • Show event of tour does not pass the hash of step and previous #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:

v2.8.0 (2019-05-03)

Full Changelog

Implemented enhancements:

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:

v2.7.0 (2019-04-22)

Full Changelog

Fixed bugs:

  • After tour is canceled/completed and started again, overlay is not present anymore #347
  • Add createModalOverlay function #358 (RobbieTheWagner)

Merged pull requests:

v2.6.0 (2019-04-15)

Full Changelog

Implemented enhancements:

  • React wrapper #331

Fixed bugs:

v2.5.0 (2019-03-20)

Full Changelog

Breaking changes:

Closed issues:

  • Shepherd Doesn't Work Good On Mobile #339
  • Fix demo app arrows to be title color #314

Merged pull requests:

v2.4.0 (2019-02-27)

Full Changelog

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:

v2.3.3 (2019-01-23)

Full Changelog

Fixed bugs:

  • Adds missing 'hide' to binded methods list in Tour #326 (seppsepp)

Merged pull requests:

v2.3.2 (2019-01-16)

Full Changelog

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:

v2.3.1 (2019-01-15)

Full Changelog

Fixed bugs:

Merged pull requests:

v2.3.0 (2019-01-14)

Full Changelog

Implemented enhancements:

v2.2.0 (2019-01-14)

Full Changelog

Implemented enhancements:

v2.1.1 (2019-01-11)

Full Changelog

Fixed bugs:

v2.1.0 (2019-01-06)

Full Changelog

Fixed bugs:

Merged pull requests:

v2.0.2 (2019-01-04)

Full Changelog

Fixed bugs:

v2.0.1 (2018-12-31)

Full Changelog

v2.0.0 (2018-12-31)

Full Changelog

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:

v2.0.0-beta.35 (2018-11-09)

Full Changelog

Implemented enhancements:

  • Document Tour.removeStep #278
  • Update documentation to clarify arrow usage. #287 (BrianSipple)

Fixed bugs:

Closed issues:

  • An in-range update of start-server-and-test is breaking the build 🚨 #283

Merged pull requests:

v2.0.0-beta.34 (2018-10-23)

Full Changelog

Implemented enhancements:

  • Change data-id to data-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)

Full Changelog

Implemented enhancements:

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)

Full Changelog

v2.0.0-beta.31 (2018-10-13)

Full Changelog

v2.0.0-beta.30 (2018-10-13)

Full Changelog

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:

v2.0.0-beta.29 (2018-10-11)

Full Changelog

Implemented enhancements:

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:

v2.0.0-beta.28 (2018-10-08)

Full Changelog

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:

v2.0.0-beta.27 (2018-09-13)

Full Changelog

Breaking changes:

  • Rename Tour.options.defaults to Tour.options.defaultStepOptions. #244 (BrianSipple)

Implemented enhancements:

  • Change tour.options.defaults to tour.options.stepOptions #240

Merged pull requests:

v2.0.0-beta.26 (2018-09-07)

Full Changelog

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)

Full Changelog

v2.0.0-beta.24 (2018-09-05)

Full Changelog

Implemented enhancements:

Fixed bugs:

  • advanceOn doesn't complete tour #93
  • advanceOn blur? #89

Closed issues:

  • Action required: Greenkeeper could not be activated 🚨 #227

Merged pull requests:

v2.0.0-beta.23 (2018-08-29)

Full Changelog

Implemented enhancements:

Merged pull requests:

v2.0.0-beta.22 (2018-08-29)

Full Changelog

Implemented enhancements:

Fixed bugs:

v2.0.0-beta.21 (2018-08-27)

Full Changelog

Merged pull requests:

v2.0.0-beta.20 (2018-08-26)

Full Changelog

Implemented enhancements:

v2.0.0-beta.19 (2018-08-25)

Full Changelog

v2.0.0-beta.18 (2018-08-25)

Full Changelog

Implemented enhancements:

Fixed bugs:

Merged pull requests:

v2.0.0-beta.17 (2018-08-15)

Full Changelog

Merged pull requests:

v2.0.0-beta.16 (2018-08-14)

Full Changelog

Implemented enhancements:

Fixed bugs:

  • Uncaught TypeError: _shepherd2.default.Tour is not a constructor #202

Merged pull requests:

v2.0.0-beta.15 (2018-08-06)

Full Changelog

Fixed bugs:

  • Error: Cannot find module 'popper' from '\node_modules\shepherd.js\dist\js' #201

v2.0.0-beta.14 (2018-08-02)

Full Changelog

Fixed bugs:

  • Error thrown if element not visible anymore #197

Merged pull requests:

v2.0.0-beta.13 (2018-07-16)

Full Changelog

Implemented enhancements:

  • Refactor css in shepherd-theme-arrows theme #52
  • Automatically use theme if styles are included #1

v2.0.0-beta.12 (2018-07-12)

Full Changelog

v2.0.0-beta.11 (2018-07-12)

Full Changelog

Implemented enhancements:

  • Attach shepherd-step to "custom" element / supporting dialog elements. #157
  • Add renderLocation option #192 (RobbieTheWagner)

Fixed bugs:

  • Tours fail to load on Chrome 65 #180
  • Step divs remain after tour has ended #66

Closed issues:

  • Step class cleanup #36

v2.0.0-beta.10 (2018-07-11)

Full Changelog

v2.0.0-beta.9 (2018-07-11)

Full Changelog

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)

Full Changelog

v2.0.0-beta.7 (2018-07-07)

Full Changelog

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)

Full Changelog

Implemented enhancements:

  • Close button as HTML entity #148 (bm2u)

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)

Full Changelog

v2.0.0-beta.4 (2018-07-03)

Full Changelog

v2.0.0-beta.3 (2018-07-03)

Full Changelog

Closed issues:

  • How can i use it with ionic 2 typescript? #174

v2.0.0-beta.2 (2018-07-02)

Full Changelog

v2.0.0-beta.1 (2018-07-02)

Full Changelog

Implemented enhancements:

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:

v1.7.0

  • Fixes bug where buttons: false resulted in the default Next button instead of showing the desired result of no buttons.

v1.6.0 & v1.6.2

  • Patches issue where Tether anchor reference was being cached instead of reset when step is shown.

v1.5.2

  • Adds functionality to pass an object {element: el, on: tetherPositionString} to tour step attachTo parameter.

v1.5.1

  • Exposes scrollTo option in Eager

v1.5.0

  • Positioning string parse improvements with regex
  • Installation support for dynamically rendered pages in Eager
  • Live updates for eager / creation of tour.removeStep

v1.2.2

  • Moves Tether.js out of bower_components and into dist for supoort in Eager

v1.2.1

  • Exposes tour object on eager install

v1.2.0

  • Adds showOn for conditionally showing tour steps

v1.1.4

  • Eager - Install helper now checks for the presence of first attach node before starting

v1.1.2 & v1.1.3

  • Fix stacking event listeners

v1.1.1

  • Pointer event none for arrows

v1.1.0

  • Update Tether to version 1
  • Bump all dependencies

v1.0.0

  • Add proper UMD to Shepherd
  • Convert from Coffeescript to ES6 (Babel)
  • Fix *.json files to include main
  • Remove bundled versions
  • Restructure directory layout
  • Update gulp builds