vue

@growthbunker/vueflags

👩‍✈️👨‍✈️ One easy-to-use flag component for Vue.js with all ISO 3166-1 countries.

Showing:

Popularity

Downloads/wk

1.1K

GitHub Stars

84

Maintenance

Last Commit

2mos ago

Contributors

5

Package

Dependencies

0

Size (min+gzip)

4.5KB

License

MIT

Type Definitions

Tree-Shakeable

Yes?

Categories

Readme

npm npm Average time to resolve an issue Percentage of issues still open GitHub license Netlify Status

Documentation

You can browse the documentation for Vue Flags on the website.

Installation

npm install @growthbunker/vueflags

# Or if you prefer using yarn
yarn add @growthbunker/vueflags

Vue.js

In your main.js file:

import Vue from "vue"
import VueFlags from "@growthbunker/vueflags"

Vue.use(VueFlags)

Nuxt.js

Create a new plugin in plugins/vueflags.js:

import Vue from "vue"
import VueFlags from "@growthbunker/vueflags"

Vue.use(VueFlags)

Add this new plugin to nuxt.config.js.

module.exports = {
  // ...
  plugins: [{ src: "@/plugins/vueflags.js" }];
}

CDN

Get the latest version from jsdelivr, and import the JavaScript file in your page.

<script src="https://cdn.jsdelivr.net/npm/vue@2.5/dist/vue.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@growthbunker/vueflags@latest/dist/vueflags.min.js"></script>

We recommend our users to lock Vue Flags's version when using CDN. Requesting the latest version (as opposed to "latest major" or "latest minor") is dangerous because major versions usually come with breaking changes. Only do this if you really know what you are doing. Please refer to jsdelivr.com for more information.

Icons

All the flags are available here. Copy them somewhere in your somewhere in your "public" or "static" folder. You will also have to set the icon path for the component to be able to find them (see package options and component props).

A huge thank you to the author for designing these flags.

Example

Once the plugin is installed, you can use the component like this:

<template>
  <vue-flag code="fr" size="small" />
</template>

Contributing

You are more than welcome to contribute to Vue Flags. Just submit changes via pull request and I will review them before merging.

  1. Fork it! 🤙

  2. Create your feature branch: git checkout -b my-new-feature

  3. Commit your changes: git commit -am "Add some feature"

  4. Push to the branch: git push origin my-new-feature

  5. Submit a pull request 👍

The documentation is available in the docs folder. The Vue Flags components are available in the lib folder.

License

Vue Flags is MIT licensed.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial