Improvements #28

yhnavein · 2014-11-05T17:08:33Z

I've been using angular-tour in a big Angular application and I had to make necessary adjustments, extensions and improvements to the original code to make integration successful. There are no breaking changes, and after my changes apps using original angular-tour should work as before. With those changes angular-tourtip works like a charm in a ~40 controller app. Even having simultaneous tours is possible without any hustle.

Changes:

added virtual steps, which allow to specify target element (this allow to have all steps in one place, not messing with having steps spread all over the different views). Moreover, I saw, that sometimes adding tourtip attributes to buttons and links can have influence on their behaviour. This is an easy way to fix that kind of problems
added additional callback on the tour level: tourComplete - which run only when user fully completed tour
added additional callbacks on the tourtip level: on-show, on-proceed
tourtips are now appended to the body, not to the target's element container. It's important, because this way tourtip is more consistent and it's styling doesn't depend on the element it was attached to.
added optional backdrop option
new available positions: center and center-top - when using them tourtip will be placed visually in the center of target element. It's good for a welcome tourtip on the page.
added tests around new features and extended README with examples and explanations

Cheers,

it's possible when placement="center" fixed way tour-step is added into document - instead adding tourstep after element, it's added directly into body. This way we won't have an issue with parent styling affecting our step popover fixed way position is calculated

default step should be -1 instead of previous 0

and it can be really random one added way to debug JS unit tests > npm run-script test-debug

fixing mess with offsets on demo page

on-show and on-proceed

methods, test structure improved

some refactoring of the *show* function improvement for virtual steps is additional option, which help determine target scope which will be used to evaluate onShow or onProgress callbacks it's affecting only virtual steps, as in normal case everytime it's the same scope this improvement can be disabled for whole application (by new option in tourConfig) or individually by use-source-scope="true" attribute on selected virtual tour steps

added throwing exception when target element does not exist

litch · 2014-11-30T04:23:47Z

This is really nice. I did notice, however, that there is one behavior change - it is now necessary to set the step of the tour to initiate it (say in the Controller). Whereas with the previous version, they would automatically start.

yhnavein · 2014-12-05T16:01:05Z

Yeah, you are right. I had to change it as in our application tour is not starting by default (which in my opinion is better - before showing some popups we are asking user if he would like to see the tour). It's much better to set up active step number by hand than hiding it just after starting tour.
Probably I will need to update README with this annotation.

litch · 2014-12-05T16:02:39Z

I agree - and my implementation is actually doing a check with the backend service to see whether the user is showing the tour, so it’s conditional as well. But the default behavior of the parent project was to show by default, so I was confused when using this fork.

On Dec 5, 2014, at 10:01 AM, Piotrek Dąbrowski notifications@github.com wrote:

Yeah, you are right. I had to change it as in our application tour is not starting by default (which in my opinion is better - before showing some popups we are asking user if he would like to see the tour). It's much better to set up active step number by hand than hiding it just after starting tour.
Probably I will need to update README with this annotation.

—
Reply to this email directly or view it on GitHub #28 (comment).

fastf0rward · 2014-12-12T15:34:16Z

+1 for merging this.

fixed code snippets in README updated template code snippet to the improved version

ikb42 · 2014-12-13T18:33:01Z

Great stuff, +1 for merging

AnnaGerber · 2014-12-18T23:37:38Z

+1 for merging, this would solve the problems I've been having integrating this module into a complex app

DaftMonk · 2014-12-19T05:34:59Z

Looks very promising. I'll review this and see about merging it after the holidays

bubbleheadinc · 2015-01-27T01:52:47Z

Good stuff. Any update on merging? Thanks.

adamburvill · 2015-01-28T18:26:00Z

Please merge this!

kavarell · 2015-01-30T02:02:49Z

Any word on when this will be merged?

default values were not read by the component bumped version

booleanbetrayal · 2015-04-24T01:48:42Z

@DaftMonk - did this PR get lost in the shuffle?

…her than body element

booleanbetrayal · 2015-04-27T14:22:03Z

@DaftMonk - added support for being able to parent tourtips against a something other than body. would love to see this PR merged!

barillax · 2015-04-27T17:26:08Z

Looks great! +1

mathemagica · 2015-04-28T20:45:20Z

+1

theblang · 2015-05-01T03:51:43Z

+1

…sition of tips + improved tip scrolling

fix(scrolling): account for container scroll offsets when updating position of tips + improved tip scrolling

…th custom container

fix(scrolling): fix miscalculation when determining scroll offsets with custom container

booleanbetrayal · 2015-07-22T13:29:42Z

Merging this!

Improvements

fastf0rward · 2015-07-22T13:35:50Z

Nice!

yhnavein · 2015-07-22T13:36:58Z

Yay! :)

yhnavein added 19 commits October 23, 2014 11:08

fixing dependencies for grunt

d6880f1

adding backdrop when tour starts (optional)

938c9bc

default step should be -1 instead of previous 0

configuration change - port 8080 is often occupied by dev stuff

7dc9044

and it can be really random one added way to debug JS unit tests > npm run-script test-debug

improving position calculation using scroll posiiton as well

d5fbf81

fixing mess with offsets on demo page

adding additional placement - center top

f0f26fa

added focusing elements when backdrop is enabled

b8e1249

added virtual steps and updated README

dc8cd07

added two callbacks on step level

ffab4ff

on-show and on-proceed

fixing unit tests... 3 to go

0d2a1fa

fixed all of unit tests

d9e3db7

added tests around calling onShow, onProceed

590acb1

methods, test structure improved

fixed issue with getting scroll pos on IE

7e41968

feat(*): new tour callback: tourComplete

8bc313c

added throwing exception when target element does not exist

test(*): added tests around new features

4da69d6

chore(*): updating readme

f853bee

updated README

e05be07

chore(docs): updated docs and demo

c34fdef

chore(README): adding note about breaking changes

9ca7e65

fixed code snippets in README updated template code snippet to the improved version

yhnavein mentioned this pull request Dec 13, 2014

Tour actions #17

Open

yhnavein mentioned this pull request Dec 13, 2014

Doesn't work with directives or ng-include #8

Open

yhnavein mentioned this pull request Jan 23, 2015

Switching URL and continue the tour #32

Open

yhnavein mentioned this pull request Feb 23, 2015

Does not work if next step of the current tour is on another page #33

Open

yhnavein added 2 commits March 12, 2015 10:14

chore(release): v0.1.2

fb1abf4

fix(angular-1.3): fixed default values for angular-tour

b6547da

default values were not read by the component bumped version

booleanbetrayal and others added 4 commits April 24, 2015 16:37

feat(container-element): allow tourtips to be parented to elements ot…

b6fdbb0

…her than body element

impr(): always == null instead === null

af5f5b2

chore(build): built project

e4dd814

Merge branch 'booleanbetrayal-add_container_support'

81cc99e

booleanbetrayal and others added 4 commits May 5, 2015 16:53

fix(scrolling): account for container scroll offsets when updating po…

06b1945

…sition of tips + improved tip scrolling

Merge pull request #2 from booleanbetrayal/fix_scrolling_offsets

fc2e3e8

fix(scrolling): account for container scroll offsets when updating position of tips + improved tip scrolling

fix(scrolling): fix miscalculation when determining scroll offsets wi…

60a2c61

…th custom container

Merge pull request #3 from booleanbetrayal/fix_container_offset_miscalc

0333120

fix(scrolling): fix miscalculation when determining scroll offsets with custom container

yhnavein mentioned this pull request Jul 19, 2015

Tour ToolTip not visible when element has overflow: hidden #30

Open

booleanbetrayal added a commit that referenced this pull request Jul 22, 2015

Merge pull request #28 from yhnavein/master

100296d

Improvements

booleanbetrayal merged commit 100296d into DaftMonk:master Jul 22, 2015

nicolairobles mentioned this pull request Aug 31, 2016

Fixed Broken Demo Directory #75

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improvements #28

Improvements #28

yhnavein commented Nov 5, 2014

litch commented Nov 30, 2014

yhnavein commented Dec 5, 2014

litch commented Dec 5, 2014

fastf0rward commented Dec 12, 2014

ikb42 commented Dec 13, 2014

AnnaGerber commented Dec 18, 2014

DaftMonk commented Dec 19, 2014

bubbleheadinc commented Jan 27, 2015

adamburvill commented Jan 28, 2015

kavarell commented Jan 30, 2015

booleanbetrayal commented Apr 24, 2015

booleanbetrayal commented Apr 27, 2015

barillax commented Apr 27, 2015

mathemagica commented Apr 28, 2015

theblang commented May 1, 2015

booleanbetrayal commented Jul 22, 2015

fastf0rward commented Jul 22, 2015

yhnavein commented Jul 22, 2015

Improvements #28

Improvements #28

Conversation

yhnavein commented Nov 5, 2014

litch commented Nov 30, 2014

yhnavein commented Dec 5, 2014

litch commented Dec 5, 2014

fastf0rward commented Dec 12, 2014

ikb42 commented Dec 13, 2014

AnnaGerber commented Dec 18, 2014

DaftMonk commented Dec 19, 2014

bubbleheadinc commented Jan 27, 2015

adamburvill commented Jan 28, 2015

kavarell commented Jan 30, 2015

booleanbetrayal commented Apr 24, 2015

booleanbetrayal commented Apr 27, 2015

barillax commented Apr 27, 2015

mathemagica commented Apr 28, 2015

theblang commented May 1, 2015

booleanbetrayal commented Jul 22, 2015

fastf0rward commented Jul 22, 2015

yhnavein commented Jul 22, 2015