Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a 'debug' option that shows or hides debug traces to console #5

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.project
node_modules
bower_components
96 changes: 96 additions & 0 deletions Gruntfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
/*global module:false*/
module.exports = function (grunt) {

// Project configuration.
grunt.initConfig({
// Metadata.
pkg: grunt.file.readJSON('package.json'),
banner: '/*! jquery.typer.js <%= pkg.version %>- <%= grunt.template.today("yyyy-mm-dd") %> */\n',
// Task configuration.
concat: {
options: {
banner: '<%= banner %>',
stripBanners: true
},
dist: {
src: ['src/jquery.typer.js'],
dest: 'dist/jquery.typer.js'
}
},
uglify: {
options: {
banner: '<%= banner %>'
},
dist: {
src: '<%= concat.dist.dest %>',
dest: 'dist/jquery.typer.min.js'
}
},
copy: {
dist: {
src:'src/jquery.typer.js',
dest: 'dist/jquery.typer.js'
}
},
jshint: {
options: {
curly: true,
eqeqeq: true,
immed: true,
latedef: true,
newcap: true,
noarg: true,
sub: true,
undef: true,
unused: true,
boss: true,
eqnull: true,
browser: true,
globals: {
jQuery: true
}
},
gruntfile: {
src: 'Gruntfile.js'
},
dist: {
options: {
curly: true,
eqeqeq: true,
immed: true,
latedef: true,
newcap: true,
noarg: true,
sub: true,
undef: true,
unused: true,
boss: true,
eqnull: true,
browser: true,
globals: {
jQuery: true,
console: true
}
},
src: 'src/jquery.typer.js'
}
},
watch: {
gruntfile: {
files: '<%= jshint.gruntfile.src %>',
tasks: ['jshint:gruntfile']
}
}
});

// These plugins provide necessary tasks.
grunt.loadNpmTasks('grunt-contrib-concat');
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-contrib-copy');

// Default task.
grunt.registerTask('dist', ['jshint:dist', 'concat:dist', 'uglify:dist', 'copy:dist']);

};
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ There are some options that are available to you as well:
typeDelay : 200,
clearOnHighlight : true,
typerDataAttr : 'data-typer-targets',
tapeColor : 'auto' // 'auto' or a css color value
typerOrder : 'random', // or 'sequential'
typerInterval : 2000
}
```
Expand All @@ -45,6 +47,11 @@ Set the options individually:
```javascript
$.typer.options.highlightSpeed = 500;
```

## Contributing

Make your changes on `src/jquery.typer.js`. To generate updated minified distribution versions run `$ grunt dist`.

## About

jquery.typer.js was originally developed for [LayerVault](http://layervault.com) by [Kelly Sutton](http://kellysutton.com).
Expand Down
29 changes: 29 additions & 0 deletions bower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "jquery-typer",
"version": "1.0.0",
"homepage": "https://github.com/kontur/jquery.typer.js",
"authors": [
"Various",
"check github repo"
],
"description": "JQuery plugin for typing out text",
"main": "./src/jquery.typer.js",
"keywords": [
"JQuery",
"plugin",
"text",
"typewriter"
],
"license": "MIT",
"dependencies": {
"jquery": ">=1.11.0"
},
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"app/bower_components",
"test",
"tests"
]
}
Loading