Skip to content
This repository has been archived by the owner on Feb 8, 2023. It is now read-only.

added dom events for easier event track #3

Merged
merged 2 commits into from
Aug 13, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Cakefile
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
require('cake-dog')
fs = require 'fs'
{exec} = require 'child_process'

task 'build', 'build the source code to javascript', (options) ->
exec 'coffee --compile --output lib/ src/', (err, stdout, stderr) ->
throw err if err
console.log 'build process complete without error, chekcout lib directory'
37 changes: 27 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

# Usage

First, use bower to install gta:
```
bower install gta
```

include in html
Then, include the following script in your html and you are ready to go:

```
<script src="bower_component/gta/lib/index.js"></script>
Expand All @@ -19,18 +20,34 @@ include in html
account: 'ec912ecc405ccd050e4cdf452ef4e85a'
}
});
</script>
```

// track pageview
gta.pageview({ // use single object
'page': '/my-overridden-page?id=1',
'title': 'my overridden page'
})
gta.pageview('/api/hello', '?world'); // use multiple string
# Page View

// track event
gta.event('button', 'click', 'nav buttons', 4) //@params: category, action, label, value
</script>
Call the `pageview` function to record a new page view:
```
// use single object
gta.pageview({
'page': '/my-overridden-page?id=1',
'title': 'my overridden page'
})

// use multiple string
gta.pageview('/api/hello', '?world');
```

# Events

You can call the `event` function to track an event:
```
gta.event('button', 'click', 'nav buttons', 4) //@params: category, action, label, value
```
Or, easily add `data-gta='event'` to a dom element as:
```
<button data-gta='event' data-label='clicked a button' data-action='click' data-category='button'>click</button>
```
If `data-label` `data-action` `data-category` `data-value` is not provided then `className` `event type` `tagName` and `html` will be used instead.

# Api Documents

Expand Down
4 changes: 3 additions & 1 deletion bower.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,7 @@
"test",
"tests"
],
"dependencies": {}
"dependencies": {
"jquery": "~2.0.3"
}
}
17 changes: 17 additions & 0 deletions lib/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions src/index.coffee
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ class Gta
for provider, option of options
Provider = Gta["#{provider[0].toUpperCase()}#{provider[1..]}"]
@providers[provider] = new Provider(option) if Provider?
@delegateEvents() if window.jQuery

pageview: ->
for name, provider of @providers
Expand All @@ -19,6 +20,16 @@ class Gta
provider.event.apply(provider, arguments)
return this

delegateEvents: ->
$(document).on('click.gta', '[data-gta="event"]', (e) =>
$target = $(e.currentTarget)
category = $target.data('category') or $target[0].tagName
label = $target.data('label') or $target[0].className
action = $target.data('action') or e.type
value = $target.data('value') or $target.html()
@event(category, action, label, value)
)

@appendScript: (script) ->
dom = document.createElement('script')
text = document.createTextNode(script)
Expand Down
9 changes: 6 additions & 3 deletions test/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@
font-family: Monaco;
}
</style>
<script src="http://sailxjx.local.com/teambition/gta/lib/index.js"></script>
<script type="text/javascript" src="../bower_components/jquery/jquery.js"></script>
<script src="../lib/index.js"></script>
</head>
<body>
hello world
<button data-gta='event' data-label='clicked a button'>click</button>
<script>
gta = new Gta({
Google: {
Expand All @@ -24,8 +26,9 @@
gta.pageview({
'page': '/my-overridden-page?id=1',
'title': 'my overridden page'
})
gta.event('button', 'click', 'nav buttons', 4)
});
gta.event('button', 'click', 'nav buttons', 4);
$('body').append('<button data-gta="event" data-label="clicked an appended button">click again</button>');
</script>
</body>
</html>