Skip to content

Commit

Permalink
Feature/register npm (#13)
Browse files Browse the repository at this point in the history
* feat: change files to register npm

* feat: edit example page

* chore: remove webpack option on karma config file

* chore: remove plugin on webapck config file
  • Loading branch information
seonim-ryu authored and GitHub Enterprise committed Sep 19, 2017
1 parent ae309cb commit c84d3e2
Show file tree
Hide file tree
Showing 21 changed files with 910 additions and 774 deletions.
16 changes: 16 additions & 0 deletions .eslintrc.js
@@ -0,0 +1,16 @@
module.exports = {
"extends": "tui",
"parserOptions": {
"ecmaVersion": 3
},
"env": {
"browser": true,
"jasmine": true,
"jquery": true,
"commonjs": true
},
"globals": {
"tui": true,
"loadFixtures": true
}
};
40 changes: 16 additions & 24 deletions .gitignore
Expand Up @@ -7,26 +7,17 @@ pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release
# Compiled files
dist

# Dependency directory
# Deployed apps should consider commenting this line out:
# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
node_modules

# Bower Components
bower_components
lib

#JSDOC
doc

# IDEA
.idea
Expand All @@ -36,20 +27,21 @@ lib
Thumbs.db
Desktop.ini

# MAC
# MACgi
.DS_Store

# SVN
.svn

# eclipse
.project
.metadata

# etc
temp
doc
demo
#report / screenshots
report
[0-9]*.[0-9]*.[0-9]
latest
screenshots

# Atom
tags
.ctags
.tern-project

# etc
.agignore
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
The MIT License

Copyright (c) 2016 NHN Entertainment Corp.
Copyright (c) 2017 NHN Entertainment Corp.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
92 changes: 63 additions & 29 deletions README.md
@@ -1,9 +1,5 @@
Virtual Keyboard
===============
Virtual Keyboard Component<br>
Create virtual keyboard that support number, english, korean, symbol.<br>
User can use the virtual keyboard like real keyboard in browser.<br>
If you use this component on PC, you can click the buttons else on mobile, you can touch the buttons.
# VirtualKeyboard
User can use the virtual keyboard like real keyboard in browser

## Feature
* Support virtual keys to input letters by click or touch
Expand All @@ -14,33 +10,71 @@ If you use this component on PC, you can click the buttons else on mobile, you c
* When this component toggle or shuffle the keys this component run the callback functions

## Documentation
* **API** : https://nhnent.github.io/tui.component.virtual-keyboard/latest
* **Tutorial** : https://github.com/nhnent/tui.component.virtual-keyboard/wiki/Virtual-Keyboard-Tutorial
* **Sample** - https://nhnent.github.io/tui.component.virtual-keyboard/latest/tutorial-desktop.html
* **API** : [https://nhnent.github.io/tui.virtual-keyboard/latest](https://nhnent.github.io/tui.virtual-keyboard/latest)
* **Tutorial** : [https://github.com/nhnent/tui.virtual-keyboard/wiki](https://github.com/nhnent/tui.virtual-keyboard/wiki)
* **Example** :
[https://nhnent.github.io/tui.virtual-keyboard/latest/tutorial-example01-basic.html](https://nhnent.github.io/tui.virtual-keyboard/latest/tutorial-example01-basic.html)

## Dependency
* [jquery](https://jquery.com/) >= 1.11.0
* [tui-code-snippet](https://github.com/nhnent/tui.code-snippet) >=1.2.5

## Sample Image
* Regular keyboard<br>
![alt tag](https://nhnent.github.io/tui.component.virtual-keyboard/vknormal.png)<br><br>
* Numeric keyboard<br>
![alt tag](https://nhnent.github.io/tui.component.virtual-keyboard/vksample.png)
## Test Environment
### PC
* IE8~11
* Edge
* Chrome
* Firefox
* Safari

## Dependency
* jquery: ^1.8.3
* tui-code-snippet: ^1.1.0
### Mobile
* iOS 10.3.x
* Android 5.5.x

## Usage
### Use `npm`

Install the latest version using `npm` command:

```
$ npm install tui-virtual-keyboard --save
```

or want to install the each version:

```
$ npm install tui-virtual-keyboard@<version> --save
```

To access as module format in your code:

```javascript
var VirtualKeyboard = require('tui-virtual-keyboard');
var instance = new VirtualKeyboard(...);
```

### Use `bower`
Install the latest version using `bower` command:

```
$ bower install tui-virtual-keyboard
```

or want to install the each version:

```
$ bower install tui-virtual-keyboard#<tag>
```

## Test environment
* PC
* IE8~11
* Chrome
* Firefox
To access as namespace format in your code:

```javascript
var instance = new tui.VirtualKeyboard(...);
```

## Download/Install
* Bower:
* latest : `bower install tui-component-virtual-keyboard`
* each version : `bower install tui-component-virtual-keyboard[#tag]`
* Download: https://github.com/nhnent/tui.component.virtual-keyboard
### Download
* [Download bundle files from `dist` folder](https://github.com/nhnent/tui.virtual-keyboard/tree/production/dist)
* [Download all sources for each version](https://github.com/nhnent/tui.virtual-keyboard/releases)

## LICENSE
[MIT LICENSE](https://github.com/nhnent/tui.component.virtual-keyboard/blob/master/LICENSE)
## License
[MIT LICENSE](https://github.com/nhnent/tui.virtual-keyboard/blob/master/LICENSE)
44 changes: 24 additions & 20 deletions bower.json
@@ -1,22 +1,26 @@
{
"name": "component-virtual-keyboard",
"authors": [
"NHN Ent. FE Dev team.<dl_javascript@nhnent.com>"
],
"license": "MIT",
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"test",
"tests",
"conf.json",
"karma.conf.js",
"gulpfile.js",
"samples"
],
"dependencies": {
"jquery" : "^1.8.3",
"tui-code-snippet" : "^1.1.0"
}
"name": "tui-virtual-keyboard",
"authors": [
"NHNent. FE Development Lab <dl_javascript@nhnent.com>"
],
"main": [
"dist/tui-virtual-keyboard.js"
],
"license": "MIT",
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"examples",
"src",
"test",
"jsdoc.conf.json",
"karma.conf.js",
"webpack.config.js",
"package.json"
],
"dependencies": {
"jquery": "^1.11.0",
"tui-code-snippet": "^1.2.5"
}
}
File renamed without changes.

0 comments on commit c84d3e2

Please sign in to comment.