vue-tel-input 6.0.0-beta.7 → 6.0.0

package/.editorconfig

@@ -0,0 +1,7 @@
+[*.{js,jsx,ts,tsx,vue}]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 100

package/.eslintrc.cjs

@@ -0,0 +1,11 @@
+/* eslint-env node */
+require("@rushstack/eslint-patch/modern-module-resolution");
+
+module.exports = {
+  "root": true,
+  "extends": [
+    "plugin:vue/vue3-essential",
+    "eslint:recommended",
+    "@vue/eslint-config-typescript/recommended"
+  ]
+}

package/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: iamstevendao
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/README.md

@@ -1,4 +1,5 @@
 # vue-tel-input
+
 International Telephone Input with Vue.
 
 [![](https://img.shields.io/npm/dt/vue-tel-input.svg)](https://www.npmjs.com/package/vue-tel-input) [![](https://img.shields.io/github/stars/iamstevendao/vue-tel-input.svg)](https://github.com/iamstevendao/vue-tel-input)
@@ -12,9 +13,10 @@ International Telephone Input with Vue.
 [Visit the website](https://iamstevendao.github.io/vue-tel-input/)
 
 ## Getting started
+
 - Install the plugin:
 
-  ```
+  ```sh
   npm install vue-tel-input
   ```
 
@@ -39,7 +41,9 @@ International Telephone Input with Vue.
   ```
 
 ## Installation
+
 ### npm
+
 ```bash
   npm install vue-tel-input
 ```
@@ -53,6 +57,7 @@ import 'vue-tel-input/dist/vue-tel-input.css'
 
 Vue.use(VueTelInput, options) // Define default global options here (optional)
 ```
+
 > View all available options in [Props](https://iamstevendao.github.io/vue-tel-input/documentation/props.html).
 
 Or use the component directly:
@@ -82,7 +87,7 @@ export default {
 <link rel="stylesheet" href="https://unpkg.com/vue-tel-input/dist/vue-tel-input.css">
 ```
 
-** If Vue is detected in the Page, the plugin is installed automatically.**
+**If Vue is detected in the Page, the plugin is installed automatically.**
 
 ** Otherwise, manually install the plugin into Vue:
 
@@ -90,48 +95,49 @@ export default {
 Vue.use(window['vue-tel-input']);
 ```
 
-### Use as a custom field of [vue-form-generator](https://github.com/vue-generators/vue-form-generator)
+## Changelog
 
-- Add a component using `vue-form-generator`'s `abstractField` mixin
-  ```html
-    <!-- tel-input.vue -->
-    <template>
-      <vue-tel-input v-model="value"></vue-tel-input>
-    </template>
-
-    <script>
-    import { abstractField } from 'vue-form-generator';
-
-    export default {
-      name: 'TelephoneInput',
-      mixins: [abstractField],
-    };
-    </script>
-  ```
+[Go to Github Releases](https://github.com/iamstevendao/vue-tel-input/releases)
 
-- Register the new field as a global component
-  ```js
-    import Vue from 'vue';
-    import TelInput from '<path>/tel-input.vue';
+## Development
 
-    Vue.component('field-tel-input', TelInput);
-  ```
+Clone the project
 
-- Now it can be used as `tel-input` in schema of `vue-form-generator`
-  ```js
-  var schema: {
-    fields: [{
-        type: "tel-input",
-        label: "Awesome (tel input)",
-        model: "telephone"
-    }]
-  };
-  ```
-Read more on `vue-form-generator`'s [instruction page](https://icebob.gitbooks.io/vueformgenerator/content/fields/custom_fields.html)
+```bash
+  git clone https://github.com/iamstevendao/vue-tel-input.git
+```
 
+Go to the project directory & checkout the `next` branch
 
-## Changelog
-[Go to Github Releases](https://github.com/iamstevendao/vue-tel-input/releases)
+```bash
+  cd vue-tel-input
+  git checkout next origin/next
+```
+
+Install dependencies
+
+```bash
+  npm install
+```
+
+Build the project
+
+```bash
+  npm run build
+```
+
+Start the es build example
+
+```bash
+  npm run dev
+```
+
+Start the browser build example
+
+```bash
+  npx http-server -p 8080
+  # 127.0.0.1:8080/examples/browser.html
+```
 
 ## License