You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-15Lines changed: 30 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,21 @@ An angular [bower](http://bower.io/) component for creating simple tutorials.
4
4
5
5
##Installation##
6
6
7
+
###Build###
8
+
7
9
bower install angular-tutorial
8
-
cd [repo location]
10
+
cd bower_components/angular-tutorial
9
11
npm install && bower install && grunt
12
+
13
+
###Include Dependencies###
14
+
15
+
Angular Tutorial depends on [UI Bootstrap](http://angular-ui.github.io/bootstrap/)'s Modal and [Bootstrap](http://getbootstrap.com/)'s tooltip (we're forced to use Bootstrap's native tooltip until UI Bootstrap's tooltip supports programmatic triggers).
16
+
17
+
Make sure they are included in the page along with the `angular-tutorial` source:
@@ -58,31 +69,35 @@ The `waitForClick` step type tells the tutorial to wait for one of the specified
58
69
59
70
Properties
60
71
61
-
-`selectors` One or more [css selectors](http://www.w3schools.com/cssref/css_selectors.asp) to target (Array)
62
-
-`tooltips` Tooltips to show for the corresponding `selector` (Array)
63
-
- Tooltip properties:
64
-
- `text` Text to display in the tooltip (String)
65
-
- `placement` One of top, right, bottom or left (String)
72
+
-`highlight` One or more [css selectors](http://www.w3schools.com/cssref/css_selectors.asp) to hightlight via a cutout in the backdrop (defaults to `targets` if unspecified) (Array)
73
+
-`targets` One or more [css selectors](http://www.w3schools.com/cssref/css_selectors.asp) representing click targets (Array)
74
+
-`tooltips` Tooltips to show (Array)
75
+
Tooltip Properties
76
+
-`selector` CSS selector to affix the tooltip to (String, required)
77
+
-`text` Text to display in the tooltip (String)
78
+
-`placement` One of top, right, bottom or left (String)
66
79
67
80
####waitForNavigate#####
68
81
69
82
The `waitForNavigate` step type tells the tutorial to wait for a change to `$location.path()`.
70
83
71
84
Properties
72
-
73
-
-`path` The value `$location.path()` must be set to to continue (String, required)
74
-
-`selectors` One or more [css selectors](http://www.w3schools.com/cssref/css_selectors.asp) to target (Array)
85
+
86
+
-`highlight` One or more [css selectors](http://www.w3schools.com/cssref/css_selectors.asp) to hightlight via a cutout in the backdrop (defaults to `targets` if unspecified) (Array)
87
+
-`path` The change in `$location.path()` to wait for (String, required)
88
+
-`targets` One or more [css selectors](http://www.w3schools.com/cssref/css_selectors.asp) representing click targets (Array)
75
89
-`tooltips` Tooltips to show for the corresponding `selector` (Array)
76
-
- Tooltip properties:
77
-
- `text` Text to display in the tooltip (String)
78
-
- `placement` One of top, right, bottom or left (String)
90
+
Tooltip Properties
91
+
-`selector` CSS selector to affix the tooltip to (String, required)</li>
92
+
-`text` Text to display in the tooltip (String)
93
+
-`placement` One of top, right, bottom or left (String)
79
94
80
95
####showMessage####
81
-
96
+
82
97
The `showMessage` step type tells the tutorial to show a message using [ui-bootstrap](http://angular-ui.github.io/bootstrap/)'s `$modal` service
83
98
84
99
Properties
85
-
100
+
86
101
-`message` The message to display (String/Object, required)
87
102
If the message is an Object, the following properties are supported
88
103
-`message` Text to display in the tooltip (String, required)
0 commit comments