Skip to content

Commit 9b808be

Browse files
committed
* Embedded template solving issues related to referencing html file
* Embedded close button image for tip walkthrough into directive file * Added external js file with icons solving issues related to referencing to icon files * Updated tests * Icons folder added to ignore in bower/npm, here for future developments if required * Updated Readme * Bumped to version 0.4.1
1 parent 77ecf6f commit 9b808be

9 files changed

+3607
-98
lines changed

README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,8 @@ This directive has been originally developed for the [Ionic Framework](http://io
5050

5151
## Usage
5252

53-
- Copy the gesture icon files to folder 'icons' under where you placed the directive javascript
5453
- Load the script files in your application:
5554

56-
Leave the template html aside the directive's javascript
57-
5855
```html
5956
<link rel="stylesheet" href="wherever-you-put-it/ng-walkthrough.css">
6057

@@ -66,6 +63,13 @@ Add dependencies on the `ng-walkthrough` AngularJS module:
6663
```javascript
6764
angular.module('myApp', ['ng-walkthrough']);
6865
```
66+
67+
If you want to use the directives supplied tap icons add this script file:
68+
69+
```html
70+
<script type="text/javascript" src="wherever-you-put-it/ng-walkthrough.tap_icons.js"></script>
71+
```
72+
6973
You can now use the directive, add the element to your HTML:
7074
```html
7175
<walkthrough walkthrough-type="X">
@@ -121,7 +125,7 @@ and use one of the two configurations:
121125
- `focus-element-id` (optional) - Any walkthrough type. ID of DOM element we want to give focus to, without it all screen will be grayed out
122126
- `is-round` (optional) - Any walkthrough type. Set to 'true' if you want the focused area to be round, otherwise it will be square set to the size of the DOM element
123127
- `has-glow` (optional) - Any walkthrough type. Set to 'true' if you want the focused area to have a glow around it
124-
- `icon` (optional) - Any walkthrough type. If set to any of the predefined values ("single_tap", "double_tap", "swipe_down", "swipe_left", "swipe_right", "swipe_up"), in such case the image will be bound to focus element (if exists). if giving any other icon then is not bound to focus element
128+
- `icon` (optional) - Any walkthrough type. If set to any of the predefined values ("single_tap", "double_tap", "swipe_down", "swipe_left", "swipe_right", "swipe_up"), in such case the icon will be bound to focus element (if exists), make sure to add 'ng-walkthrough.tap_icons.js' following instructions above. any other icon can be used and will be loaded from supplied folder
125129
- `main-caption` (optional) - Any walkthrough type. This is the text that will be displayed in the walk-through. Text can be formatted
126130
- `use-button` (optional) - Any walkthrough type. set to 'true' you want a button displayed that most be clicked in order to close walkthrough, otherwise clicking anywhere while walkthrough displayed will close it
127131
- `icon-padding-left` (optional) - Any walkthrough type. Add padding to the icon from the left in percentage

bower.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ng-walkthrough",
3-
"version": "0.3.3",
3+
"version": "0.4.1",
44
"homepage": "https://github.com/souly1/ng-walkthrough",
55
"authors": [
66
"Ophir Stern <souly01@gmail.com>"
@@ -41,6 +41,7 @@
4141
"node_modules",
4242
"bower_components",
4343
"screenshots",
44+
"icons",
4445
"test",
4546
"tests"
4647
]

karma.conf.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ module.exports = function(config) {
3232
'bower_components/ionic/release/js/ionic.js',
3333
'bower_components/ionic/release/js/ionic-angular.js',
3434
'ng-walkthrough.js',
35+
'ng-walkthrough.tap_icons.js',
3536
'test/**/*.js',
36-
'ng-walkthrough.html',
3737
{pattern: 'icons/**/*.png', watched: false, included: false, served: true},
3838
{pattern: 'css/*.css', watched: true, served: true, included: false},
3939
{pattern: 'test/css/*.css', watched: true, served: true, included: false}

ng-walkthrough.html

-34
This file was deleted.

0 commit comments

Comments
 (0)