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
+20-18
Original file line number
Diff line number
Diff line change
@@ -39,12 +39,12 @@ All attributes are optional.
39
39
40
40
-`focusElementSelector`: CSS selector for focus a HTML element. If the selector detect more that one, the only the first will be chosen.
41
41
-`focusElementCSSClass`: Add a class on focusElement
42
-
-`focusHighlightAnimation`: `true` for show highlight animation on the focus element. By defaut`false`.
43
-
-`focusBackdrop`: `true` for show a dark backdrop around the focus element. By defaut`false`.
44
-
-`focusGlow`: `true` for show a glow on the focus element. By defaut`false`.
42
+
-`focusHighlightAnimation`: `true` for show highlight animation on the focus element. By default`false`.
43
+
-`focusBackdrop`: `true` for show a dark backdrop around the focus element. By default`false`.
44
+
-`focusGlow`: `true` for show a glow on the focus element. By default`false`.
45
45
-`focusAction`: add an action `click` on the highlight zone.
46
-
-`typeSelector`: type of selection. Two modes possible: `element` (one unique HMLT element), `zone` (a zone with contains the first and last element). By defaut : `element`.
47
-
-`radius`: apply a “borderRadius” on highlight zone. If `number` the value as change in percent. If `auto` use the focused element borderRadius. If it's a simple `string`, use it without changes. By defaut, no radius.
46
+
-`typeSelector`: type of selection. Two modes possible: `element` (one unique HMLT element), `zone` (a zone with contains the first and last element). By default : `element`.
47
+
-`radius`: apply a “borderRadius” on highlight zone. If `number` the value as change in percent. If `auto` use the focused element borderRadius. If it's a simple `string`, use it without changes. By default, no radius.
48
48
-`marginZone`: add a maring of focus zone in px. (e.g. `12 15 12 13` for CSS `12px 15px 12px 13px`, `12 15` for `12px 15px 12px 15px`, `12` for `12px 12px 12px 12px`.)
49
49
-`scrollOnTarget`: if the walkthrough detects that `focusElementSelector` is outside of the current view, scrolls automatically. By default : `true`
50
50
-`visibilityCallback`: callback to check if `focusElementSelector` is hidden, only if the walkthrough needs specific verification. By default : `optional`
@@ -54,27 +54,28 @@ All attributes are optional.
54
54
55
55
-`contentTemplate`: add a `ng-template` with your description.
56
56
-`contentText`: show a simple description without formating in content.
57
-
-`contentStyle`: background style for content container. Possible values: `none`, `darken`. By defaut : `darken`.
58
-
-`alignContent`: align the `contentTemplate` horizontally. Possible values: `left`, `center` or `right`. By defaut : `left`.
59
-
-`verticalAlignContent`: align the `contentTemplate` vertically. Possible values: `above`, `top`, `center`, `bottom` or `below`. By defaut : `top`.
57
+
-`contentStyle`: background style for content container. Possible values: `none`, `darken`. By default : `darken`.
58
+
-`alignContent`: align the `contentTemplate` horizontally. Possible values: `left`, `center` or `right`. By default : `left`.
59
+
-`verticalAlignContent`: align the `contentTemplate` vertically. Possible values: `above`, `top`, `center`, `bottom` or `below`. By default : `top`.
60
60
-`contentSpacing`: The max space which separates the content to the focus zone horizontally, default is 0 (opposite of the focusZone)
61
61
-`verticalContentSpacing`: The max space which separates the content to the focus zone vertically, default is 50
62
62
-`rootElement`: root element on which walkthrough will scroll to after each positioning, as to avoid hidden zones
63
63
64
64
**Navigation**:
65
65
66
+
-`hidePrevious`: `true` to hide the previous button. By default `false`
66
67
-`previousStep`: add a ling to go to the previous `ng-walkthrough`.
67
68
-`nextStep`: add a ling to go to the next `ng-walkthrough`.
68
-
-`closeButton`: `true` for show the button. By defaut`false`.
69
-
-`closeAnywhere`: `false` for click anywhere to close. By defaut`true`.
70
-
-`finishButton`: `true` for show a link to exit. By defaut`false`.
71
-
-`disabled`: `true` for ignoring the walkthrough based on a boolean flag. By defaut`false`.
72
-
-`texts`: change texts. It's a overlay of `WalkthroughText`.
69
+
-`closeButton`: `true` for show the button. By default`false`.
70
+
-`closeAnywhere`: `false` for click anywhere to close. By default`true`.
71
+
-`finishButton`: `true` for show a link to exit. By default`false`.
72
+
-`disabled`: `true` for ignoring the walkthrough based on a boolean flag. By default`false`.
73
+
-`texts`: change texts. It's an overlay of `WalkthroughText`.
73
74
74
75
**Arrow**:
75
76
76
-
-`showArrow`: `true` for show the arrow. By defaut`false`.
77
-
-`arrowColor`: change the arrow color. By defaut`#FFF`.
77
+
-`showArrow`: `true` for show the arrow. By default`false`.
78
+
-`arrowColor`: change the arrow color. By default`#FFF`.
78
79
79
80
### `ng-walkthrough-flow` attributes
80
81
@@ -103,15 +104,16 @@ All attributes are optional and not overriding the subcomponents attributes exce
103
104
104
105
**Navigation**:
105
106
107
+
-`hidePrevious`: `true` to hide the previous button. By default `false`
106
108
-`closeButton`: `true` for show the button.
107
109
-`closeAnywhere`: `false` for for click anywhere to close.
108
110
-`texts`: change texts. It's a overlay of `WalkthroughText`.
109
-
-`finishButton`: `true` for show a link to exit. By defaut`false`. Always `true` on the last step.
111
+
-`finishButton`: `true` for show a link to exit. By default`false`. Always `true` on the last step.
110
112
111
113
**Arrow**:
112
114
113
-
-`showArrow`: `true` for show the arrow. By defaut`false`.
114
-
-`arrowColor`: change the arrow color. By defaut`#FFF`.
115
+
-`showArrow`: `true` for show the arrow. By default`false`.
116
+
-`arrowColor`: change the arrow color. By default`#FFF`.
0 commit comments