Skip to content

Latest commit

 

History

History
113 lines (75 loc) · 6.23 KB

README.md

File metadata and controls

113 lines (75 loc) · 6.23 KB
Raw

Vue Native

Backers on Open Collective Sponsors on Open Collective

Visit our website at vue-native.io or read the official documentation here.

Build native mobile apps using Vue

Vue Native is a framework to build cross platform native mobile apps using JavaScript. It is a wrapper around the APIs of React Native. So, with Vue Native, you can do everything that you can do with React Native. With Vue Native, you get

  • The simplicity of Vue.js. Incrementally build user interfaces with the familiar syntax of HTML and CSS in single file components.
  • Seamless interop with React Native. Use core React Native components with Vue.js syntax out of the box to develop mobile apps on both iOS and Android.

Contents

Documentation

You can find the full documentation for Vue Native on this website. It covers installation and setup, component basics, routing, testing, the internal API and more.

The source for the Vue Native documentation and website is hosted on a separate repo, here

Installation

To install Vue Native's official CLI, run

$ npm install vue-native-cli -g

To use the CLI, you must have either expo-cli or react-native-cli installed globally.

Project setup with Vue Native CLI

The Vue Native CLI can be used to easily generate a fully configured Vue Native app. It wraps expo-cli and react-native-cli to generate a simple single page application (SPA) after installing and configuring dependencies from vue-native-core.

You should have either expo-cli or react-native-cli installed as a global dependency. Refer to the installation guide for details on project setup. The GitHub repository for Vue Native CLI is hosted here.

With the CLI, generating a Vue Native project is as easy as running the command

$ vue-native init <projectName>

Using Vue Native in a React Native project

It is possible to integrate Vue Native into a pre-existing React Native project. You can find instructions to do this here.

These instructions can also be used to set up a Vue Native project from scratch.

React Native components that can't be used out of the box

The following modules are set to be removed from React Native in the future. Hence these modules are no longer made available with Vue Native.

  • AlertIOS
  • AsyncStorage
  • ImageStore
  • ListView
  • MaskedViewIOS
  • NetInfo
  • Slider
  • SwipeableListView
  • ViewPagerAndroid
  • WebView

If you still wish to use them, you can import them explicitly from react-native (until they are removed) or from their individual forked packages. For more information, refer to this page.

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

MIT

Credits to react-vue

A huge thanks to the author of react-vue for most of the work on Vue Native.