Skip to content

Commit 510317a

Browse files
Fixes #71 - Roadmap and cleanup
1 parent 646bb20 commit 510317a

File tree

8 files changed

+14
-635
lines changed

8 files changed

+14
-635
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,20 @@ Ionic integration adapters for Vue.
2626
<img src="https://res.cloudinary.com/modus-labs/image/upload/w_560/v1535019553/labs/logo-ionic-vue.svg" width="260" alt="@modus/ionic-vue">
2727
</p>
2828

29+
## Roadmap
30+
31+
Overview: all of the controllers and major features such as transitions and router have been implemented and tested for several months now.
32+
Apart from minor improvements and further testing of various mixes of Ionic components and implementations this library is considered feature complete.
33+
34+
| Feature | Status | @ionic/vue | Notes |
35+
|-------------|---------|------------|-------|
36+
| Router | :heavy_check_mark: | :x: | Essentially an extension of Vue's official router <br/>Probably the most stable of all components<br>Present in @ionic/vue, not exported and pending approval |
37+
| Router View | :heavy_check_mark: | :x: | Wrapper around official `<router-view>` <br> Enables Ionic transitions <br> [Latest PR](https://github.com/ionic-team/ionic/pull/17821) pending |
38+
| Tabs | :heavy_check_mark: | :x: | Development sponsored by [JustWatch](https://www.justwatch.com/) <br> [PR](https://github.com/ionic-team/ionic/pull/17678) pending |
39+
| Controllers | :heavy_check_mark: | :heavy_check_mark: | Fully implemented |
40+
| TypeScript | :heavy_check_mark: | :heavy_check_mark: | Fully implemented |
41+
| Unit tests | :x: | :x: | Outdated as were originally written in plain JS, need to be updated for TS |
42+
2943
## Installing / Getting started
3044

3145
A quick introduction of the minimal setup you need to get a hello world up &
@@ -111,18 +125,6 @@ IonicVue supports all of the Ionic controllers:
111125

112126
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.
113127

114-
### Cookbook examples
115-
116-
**Important: these examples are deprecated, please use the [ionic-vue-examples](https://github.com/ModusCreateOrg/ionic-vue-examples/) instead.**
117-
118-
- [Basic routing](cookbook/index.html)
119-
- [Named views](cookbook/named-views.html)
120-
- [Named views with transitions](cookbook/named-views-transitions.html)
121-
- [Custom transitions](cookbook/custom-transitions.html)
122-
- [Mix Ionic and custom transitions](cookbook/mixed-transitions.html)
123-
- [Ionic tabs](cookbook/tabs.html)
124-
- [Ionic controllers](cookbook/ionic-controllers.html)
125-
126128
## Developing
127129

128130
### Setting up Dev

cookbook/custom-transitions.html

Lines changed: 0 additions & 86 deletions
This file was deleted.

cookbook/index.html

Lines changed: 0 additions & 72 deletions
This file was deleted.

cookbook/ionic-controllers.html

Lines changed: 0 additions & 135 deletions
This file was deleted.

0 commit comments

Comments
 (0)