Ionic-Vue becomes @ionic/vue
Important: This project has been contributed to the Ionic core and can be used as @ionic/vue.
Modus Create engineers will continue to support the community at the Ionic's official Issue board
However, this repository is still being actively maintained and kept in-sync with the official @ionic/vue. The main difference being the availability of
IonicVueRouter and flexibility of choosing dependency versions.
Our goal is to allow developers to be on the bleeding-edge and freely experiment, thus we are delivering features and bug fixes as fast as possible. Apart from the router you can switch between the libraries without any changes to your code-base.
Bug fixes, features, documentation and any other changes will be contributed back as well.
Ionic integration adapters for Vue.
Installing / Getting started
A quick introduction of the minimal setup you need to get a hello world up & running.
npm install @modus/ionic-vue
Now you can use it during the initialization step of your Vue app.
VueVuerouter:routes:path: '/' component: Homepath: '/page' import'./Page.vue'
Ionic requires a root element of
ion-app in your HTML.
ion-vue-router element in order to render Ionic transitions. Otherwise you can use the official VueRouter
IonicVue abstracts DOM interaction of Ionic UI components inside a Vue application and can be used via
IonicVue supports all of the Ionic controllers:
IonicVueRouter binds Ionic transitions and routing functionalities with Vue Router.
It is an extension of the official Vue Router thus it can be used as a drop-in replacement with all of the methods, hooks, etc. working as expected.
Important: these examples are deprecated, please use the ionic-vue-examples instead.
- Basic routing
- Named views
- Named views with transitions
- Custom transitions
- Mix Ionic and custom transitions
- Ionic tabs
- Ionic controllers
Setting up Dev
Simply clone the repo and install dependencies to get started with development.
git clone https://github.com/moduscreateorg/ionic-vue.gitcd ionic-vue/npm install
Testing will require peer dependencies to be installed. Peer dependencies are:
You can install peer dependencies without modifying package.json.
npm run install.peer
We recommend trying out your
ionic-vue changes in an actual app. You can do that with
cd ionic-vue/npm linkcd ../sample-app/npm link @modus/ionic-vue
Beep is a fantastic sample application you can use to test
Rollup automatically creates distribution packages.
For development build run:
npm run dev
For automatic rebuild on changes run:
npm run watch
For production build run:
npm run prod
Make sure you have installed peer dependencies (explained above) before running tests.
The ionic-vue project uses SonarQube's SonarCloud product for static analysis scans.
Our publicly available dashboard for the project can be found here
Modus Create is a digital product consultancy. We use a distributed team of the best talent in the world to offer a full suite of digital product design-build services; ranging from consumer facing apps, to digital migration, to agile development training, and business transformation.
This project is part of Modus Labs.
This project is MIT licensed.