First Commit

LouisMazel · Jan 16, 2019 · 55e140d · 55e140d
1 parent 7c8d14e
commit 55e140d
Show file tree

Hide file tree

Showing 23 changed files with 1,117 additions and 126 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,48 @@
+// http://eslint.org/docs/user-guide/configuring
+
+module.exports = {
+  root: true,
+
+  env: {
+    node: true
+  },
+
+  extends: [
+    'plugin:vue/strongly-recommended',
+    'eslint:recommended'
+  ],
+
+  rules: {
+    'generator-star-spacing': 0,
+    'arrow-parens': 0,
+    'prefer-const': 2,
+    'no-trailing-spaces': 'error',
+    'no-debugger': 0,
+    'no-extra-semi': 'error',
+    semi: [
+      'error',
+      'never'
+    ],
+    'no-var': 'error',
+    'vue/attributes-order': 'error',
+    'vue/no-confusing-v-for-v-if': 'error',
+    'vue/no-v-html': 'error',
+    'vue/order-in-components': 'error',
+    'vue/this-in-template': 'error',
+    'vue/script-indent': 'error'
+  },
+
+  parserOptions: {
+    parser: 'babel-eslint'
+  },
+
+  overrides: [
+    {
+      files: ['*.vue'],
+      rules: {
+        indent: 'off',
+        'vue/script-indent': ['error', 2, { baseIndent: 1 }]
+      }
+    }
+  ]
+}
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,7 @@
+public/
+node_modules/
+docs/
+demo/
+.gitignore
+.editorconfig
+.eslintrc
diff --git a/README.md b/README.md
@@ -1,29 +1,81 @@
 # vue-input-ui
 
-## Project setup
-```
-npm install
-```
+> A beautiful input made with Vue JS
 
-### Compiles and hot-reloads for development
-```
-npm run serve
+![vue-input-ui](./src/assets/demo.png)
+
+## Demo
+[Enjoy here](https://htmlpreview.github.io/?https://github.com/LouisMazel/vue-input-ui/blob/master/demo/index.html)
+
+## Installation
+
+### Using yarn
+
+`yarn add vue-input-ui`
+
+### Using npm
+
+`npm i --save vue-input-ui`
+
+## Usage
+
+### ES6 Modules / CommonJS
+
+```js
+import VueInputUi from 'vue-input-ui';
+import 'vue-input-ui/dist/vue-input-ui.min.css';
+
+Vue.component('vue-input-ui', VueInputUi);
 ```
 
-### Compiles and minifies for production
+```html
+<VueInputUi v-model="yourValue" />
 ```
-npm run build
+
+### UMD
+
+```html
+<VueInputUi v-model="yourValue" />
+
+<script src="https://unpkg.com/vue" charset="utf-8"></script>
+<script src="./dist/umd/vue-input-ui.min.js" charset="utf-8"></script>
+<link rel="stylesheet" type="text/css" href="./dist/umd/vue-input-ui.css">
+
+<script type="text/javascript">
+  Vue.component('vue-input-ui', window.VueInputUi.default);
+</script>
 ```
 
-### Run your tests
+## Props API
+
+| Props      | Type       | Required | Default    | Options        |
+|------------|------------|----------|------------|----------------|
+| v-model    | String/Int | true     | -          | -              |
+| label      | String     | false    | Enter Text | -              |
+| type       | String     | no       | text       | text or number |
+| hint*       | text       | no       | -          |                |
+| error-hint** | Boolean    | no       | false      |                |
+
+## Contribution
+
+### Project setup
+
+```bash
+npm install
 ```
-npm run test
+
+### Compiles and hot-reloads for development
+
+```bash
+npm run serve
 ```
 
 ### Lints and fixes files
-```
+
+```bash
 npm run lint
 ```
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+## License
+
+This project is licensed under [MIT License](http://en.wikipedia.org/wiki/MIT_License)
diff --git a/docs/css/app.bf794739.css b/docs/css/app.bf794739.css
diff --git a/docs/favicon.ico b/docs/favicon.ico
diff --git a/docs/img/logo.d4b9d197.png b/docs/img/logo.d4b9d197.png
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang=en><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=favicon.ico><title>vue-input-ui</title><link href=css/app.bf794739.css rel=preload as=style><link href=js/app.db0a003f.js rel=preload as=script><link href=js/chunk-vendors.1c377c6f.js rel=preload as=script><link href=css/app.bf794739.css rel=stylesheet></head><body><noscript><strong>We're sorry but vue-input-ui doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id=app></div><script src=js/chunk-vendors.1c377c6f.js></script><script src=js/app.db0a003f.js></script></body></html>
diff --git a/docs/js/app.db0a003f.js b/docs/js/app.db0a003f.js
diff --git a/docs/js/app.db0a003f.js.map b/docs/js/app.db0a003f.js.map
diff --git a/docs/js/chunk-vendors.1c377c6f.js b/docs/js/chunk-vendors.1c377c6f.js
diff --git a/docs/js/chunk-vendors.1c377c6f.js.map b/docs/js/chunk-vendors.1c377c6f.js.map
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<!DOCTYPE html><html lang=en><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=favicon.ico><title>vue-input-ui</title><link href=css/app.bf794739.css rel=preload as=style><link href=js/app.db0a003f.js rel=preload as=script><link href=js/chunk-vendors.1c377c6f.js rel=preload as=script><link href=css/app.bf794739.css rel=stylesheet></head><body><noscript><strong>We're sorry but vue-input-ui doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id=app></div><script src=js/chunk-vendors.1c377c6f.js></script><script src=js/app.db0a003f.js></script></body></html>