Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moduscreateorg/ionic-vue
Vuejs integration for Ionic versions 4 and 5
https://github.com/moduscreateorg/ionic-vue
hacktoberfest ionic vue vue-router vuejs
Last synced: about 15 hours ago
JSON representation
Vuejs integration for Ionic versions 4 and 5
- Host: GitHub
- URL: https://github.com/moduscreateorg/ionic-vue
- Owner: ModusCreateOrg
- License: mit
- Created: 2018-06-26T10:14:41.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T21:42:33.000Z (about 1 year ago)
- Last Synced: 2024-09-20T15:22:06.537Z (5 days ago)
- Topics: hacktoberfest, ionic, vue, vue-router, vuejs
- Language: TypeScript
- Homepage:
- Size: 1.61 MB
- Stars: 271
- Watchers: 17
- Forks: 26
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Ionic-Vue
[](https://circleci.com/gh/ModusCreateOrg/ionic-vue)
[](https://codecov.io/gh/ModusCreateOrg/ionic-vue)
[](https://sonarcloud.io/dashboard?id=ionic_vue)
[](http://makeapullrequest.com)
[](https://github.com/your/your-project/blob/master/LICENSE)
Ionic integration adapters for Vue.
## `Ionic-Vue` vs `@ionic/vue`
`Ionic-Vue` codebase has been contributed to the Ionic core and as [@ionic/vue](https://github.com/ionic-team/ionic/tree/master/vue). However, `@ionic/vue` provides limited support to Ionic v4.
The amazing Ionic team is always looking to bring the most modern of browser capabilities to their framework. The official Vue support will land after Vue 3 has stabilized.
Modus Create engineers continue to maintain this library to support the community that wants to create beautiful mobile apps with Vue and Ionic.
Our goal is to allow developers to be up to date with the latest advances of Ionic and Vue. Thus we are delivering features and bug fixes as fast as possible.
## Roadmap
Overview: all of the controllers and major features such as transitions and router have been implemented and tested for several months now.
Apart from minor improvements and further testing of various mixes of Ionic components and implementations this library is considered feature complete.
| Feature | Status | @ionic/vue | Notes |
|-------------|---------|------------|-------|
| Router | :heavy_check_mark: | :heavy_check_mark: | Fully implemented |
| Router View | :heavy_check_mark: | :heavy_check_mark: | Fully implemented |
| Tabs | :heavy_check_mark: | :heavy_check_mark: | Fully implemented |
| Controllers | :heavy_check_mark: | :heavy_check_mark: | Fully implemented |
| TypeScript | :heavy_check_mark: | :heavy_check_mark: | Fully implemented |
| MS Edge Fix | :heavy_check_mark: | :heavy_check_mark: | Fully implemented |
| Router keep-alive | :heavy_check_mark: | [Pending](https://github.com/ionic-team/ionic/pull/18561) | - |
| Functional Inputs | :heavy_check_mark: | [Pending](https://github.com/ionic-team/ionic/pull/19087) | - |
| Import controllers directly | :heavy_check_mark: | [Pending](https://github.com/ionic-team/ionic/pull/19573) | Improve treeshaking and sync with react and angular implementations |
| Restore scroll on navigation | :heavy_check_mark: | - | When going back through history restore the scroll position |
| Unit tests | :x: | :x: | Outdated as were originally written in plain JS, need to be updated for TS |
## Ionic versions 4 and 5
:warning: Moving forward all versions of `ionic-vue` will be supporting Ionic 5 only, if you'd like to continue using Ionic 4 please use `ionic-vue` version `1.3.4`
## Vue 3
:construction: We are actively developing the next major version of this library. It supports Vue 3 and all of the new APIs like Composition, new transition features, etc. You can [track the progress in the dev branch](https://github.com/ModusCreateOrg/ionic-vue/tree/dev).
## Installing / Getting started
A quick introduction of the minimal setup you need to get a hello world up and running.
```shell
npm install @ionic/core @modus/ionic-vue
```
Now you can use it during the initialization step of your Vue app.
```js
import Vue from 'vue'
import '@ionic/core/css/ionic.bundle.css'
import Ionic, { IonicVueRouter } from '@modus/ionic-vue'
import Home from './Home.vue'
Vue.use(Ionic)
Vue.use(IonicVueRouter)
new Vue({
router: new IonicVueRouter({
routes: [
{ path: '/', component: Home },
{ path: '/page', component: () => import('./Page.vue') }
],
}),
}).$mount('ion-app')
```
Ionic requires a root element of `ion-app` in your HTML.
IonicVueRouter requires `ion-vue-router` element in order to render Ionic transitions. Otherwise you can use the [official VueRouter](https://router.vuejs.org/)
```html
...
```
### IonicVue
`IonicVue` abstracts DOM interaction of Ionic UI components inside a Vue application.
```js
import { alertController } from '@ionic/vue';
Vue.component('Foo', {
methods: {
notify() {
alertController
.create({
header: 'Notification',
subHeader: null,
message: 'Hello World',
buttons: ['Bye'],
})
.then(a => a.present())
.catch(console.error)
},
},
})
```
IonicVue supports all of the Ionic controllers:
- [Action Sheet](https://github.com/ionic-team/ionic/tree/master/core/src/components/action-sheet)
- [Alert](https://github.com/ionic-team/ionic/tree/master/core/src/components/alert)
- [Loading](https://github.com/ionic-team/ionic/tree/master/core/src/components/loading)
- [Menu](https://github.com/ionic-team/ionic/tree/master/core/src/components/menu)
- [Modal](https://github.com/ionic-team/ionic/tree/master/core/src/components/modal)
- [Picker](https://github.com/ionic-team/ionic/tree/master/core/src/components/picker)
- [Popover](https://github.com/ionic-team/ionic/tree/master/core/src/components/popover)
- [Toast](https://github.com/ionic-team/ionic/tree/master/core/src/components/toast)
### IonicVueRouter
`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.
## Developing
### Setting up Dev
Simply clone the repo and install dependencies to get started with development.
```shell
git clone https://github.com/moduscreateorg/ionic-vue.git
cd ionic-vue/
npm install
```
Testing will require peer dependencies to be installed. Peer dependencies are:
- `vue`
- `vue-template-compiler`
- `vue-router`
- `@ionic/core`
You can install peer dependencies without modifying package.json.
```sh
npm run install.peer
```
We recommend trying out your `ionic-vue` changes in an actual app. You can do that with `npm link`:
```sh
cd ionic-vue/
npm link
cd ../sample-app/
npm link @modus/ionic-vue
```
[Beep](https://github.com/ModusCreateOrg/beep) is a fantastic sample application you can use to test `ionic-vue`.
### Building
Rollup automatically creates distribution packages.
For development build run:
```shell
npm run dev
```
For automatic rebuild on changes run:
```shell
npm run watch
```
For production build run:
```shell
npm run prod
```
## Tests
Make sure you have installed peer dependencies (explained above) before running tests.
```shell
npm test
```
## Static Analysis
The ionic-vue project uses SonarQube's SonarCloud product for static analysis scans.
Our publicly available dashboard for the project can be found [here](https://sonarcloud.io/dashboard?id=ionic_vue)
## Modus Create
[Modus Create](https://moduscreate.com) 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.
[](https://moduscreate.com)
This project is part of [Modus Labs](https://labs.moduscreate.com).
[](https://labs.moduscreate.com)
## Licensing
This project is [MIT licensed](./LICENSE).