Repository files navigation

Nativescript-Vue Plugin forvue-cli@3.0

This plugin will integrateNativescript-Vue into new and existing Vue projects. Additionally, it will allow for the choice of developing for Native only environments or Nativeand Web environments under a single project structure. In addition, choosing to integrateNativescript-Vue-Web, will allow for the development of Web components with a NativeScript-Vue like syntax that has the benefit of allowing for the sharing of components between the Native and Web sides of the project. This helps reduce the amount of code, maintenence needs, and the amount of time needed for development activities.

The key feature of this plugin is that it will allow you to compose SFC's that contain both Web and Native structures in them. If your component has exactly the same logic (<script> block) but you want different templates for web and native, you can use the special<template web> and<template native>. Also, if you need define different styles you can use<style web> and<style native>.

An example of this would be the following Vue component:

<templateweb><divclass="w-page"><divclass="w-container"><imgsrc="~/assets/logo.png"alt="logo"height="20%"width="20%"><HelloWorld:msg="msg"/></div></div></template><templatenative><Page><ActionBar:title="navbarTitle"/><GridLayoutrows="auto, auto"><HelloWorld:msg="msg"/></GridLayout></Page></template><script>importHelloWorldfrom'~/components/HelloWorld';exportdefault{components:{      HelloWorld,},data(){return{navbarTitle:`App.${appMode}.vue`,msg:`Mode=${appMode} and Platform=${process.env.VUE_APP_PLATFORM}`,};},}</script><styleweb>w-page {padding:1rem; }</style><stylenative>ActionBar {color: red; }</style>

If you want complete seperation of concerns between Web and Native for components, core logic and styling, you can also provide an alternate file naming scheme in your project. The name will dictate which mode (Web or Native) and platform (Android or IOS) the file will be used with. The same overall schema will work for.vue,.js,.ts,.scss,.css,.styl, and.less files.

Webpack will handle figuring out which files to include based on thenpm run command syntax you pass in. You can also mix and match this file naming schema with theweb ornative tag options mentioned above.

Atserve orbuild in conjunction with the mode such asandroid orios, Webpack will filter which files are looked at. For instance, if you donpm run serve:android, then it will look for*.native.vue and*.android.vue files and ignore*.ios.vue files entirely. Conversely, it will do the same when you are working withios and will ignore*.android.vue files.

This will allow you to develop generic native components under the*.native.vue file extension, but in special cases, it may require you to do platform specific components, core logic and styling. Use the corrosponding file extension to allow this to happen.

If you are building for web, then just*.vue will work and if you are building for a Nativeonly project, then*.vue will work as well as the previous options mentioned.

If you want to use common components and assets betweenweb,android andios, you can do that. Forassets, place them insrc/assets and for components, place them insrc/components. At compile time, assets will be copied to the output directory'sassets folder and can be universally accessed across environments via something like~/assets/logo.png. For components, they can be universally accessed via something similar tocomponents/HelloWorld.

If vue-cli 3 is not yet installed, first follow the instructions here:https://github.com/vuejs/vue-cli

Tip: If you don't want to overwrite your current vue-cli 2 setup because you still needvue init,then try this.

Generate a project using vue-cli 3.0

vue create my-app

Before installing the Nativescript-Vue CLI 3 Plugin, make sure to commit or stash changes in case you need to revert.

To install the Nativescript-Vue CLI 3 Plugin...

cd my-appvue add vue-cli-plugin-nativescript-vue

1. Enter a unique application identifier
   • Accepting the default is fine for testing
2. Use HTML5 history mode? (Default: hash mode)
   • Required parameter for the cli core generator when vue-router is used
3. Is this a brand new project? (Default: Yes)
   • By choosingNo, the plugin will try and be as non-destructive as possible to an existing project. It will do this by adding a folder into root namedns-example and add files into there to provide examples of how a project would change.
   • These changes will factor in answers to the other questions and adjust accordingly. Regardless of the answer, the plugin will install packages and adjustpackage.json as necessary to prep the project.
4. Dual Native AND Web development experience or a Native only? (Default: Dual)
   • By default, the plugin will assume you want to develop for the Web and Native environments within the same project. As such, there will be two sides to the project where web environments will be actively developed within/src and Native environments will be developed within/app unless you choose to integrateNativescript-Vue-Web and all files will be placed in/src.
   • Warning: Choosing to develop for Native only will move the main entry point of the project and development folder to/app, it will copy the necessary files and then delete/src.
   • By choosingDual, you will be able to bring your own component framework into the web portion of the project.NativeScript-Vuecannot use vue-router currently, so you will have to provide your own manual routing. The templated options deployed with the plugin will show how to do basic manual routing.
5. What type of template do you want to start with? (Default: Simple)
   • Simple is just a simple setup with a header and basic routing.
   • Nativescript-Vue-Web - The Simple template, but with NS-Vue like syntax for web components. This option should only appear if you have chosen to develop in the Dual Web and Native environments. This option will effecively integrate a web component framework that will allow you to develop components that can be used in the Web and Native side of the project. It usesNativeScript-Vue like syntax on components which will allow for the sharing of components between NativeScript and Web.
   • Sidebar (currently disabled), will allow you to start with a project that includes a fixed header and pop-out sidebar menu.
   • We expect to add more templates in the future as use cases come up.

You will have several options in serving and building the project:

1. npm run serve:web
2. npm run serve:android
3. npm run serve:ios
4. npm run build:web
5. npm run build:android
6. npm run build:ios

The basicserve andbuild options should be similar to what is in a CLI 3 project except the added options to dictate which kind of environment you are using:web,android orios. Please note that when building web projects, they will output todist and when building native projects, they will output toplatforms\android orplatforms\ios depending on which you are building at the time.

You will have the standard options for debugging available to you as you would with justtns. You can do the following to debug Native versions of your app.

1. npm run debug:android
2. npm run debug:ios

You should then be able to attach the Chrome debugger as you normally would via theNativeScript docs.

You should also be able to debug directly in VSCode. TheNativeScript VSCode Extension docs are a good place to start with understanding how to do this. However, you will need to modify yourlaunch.json file to forcetns to work properly with VUE CLI 3.

Yourlaunch.json file should look something like below. Notice the different in thetnsArgs line that is different than what is in the documentation link above.

{"version":"0.2.0","configurations": [    {"name":"Launch on iOS","type":"nativescript","request":"launch","platform":"ios","appRoot":"${workspaceRoot}","sourceMaps":true,"watch":true,"tnsArgs":[" --bundle --env.development cross-env-shell VUE_CLI_MODE=development.ios"]    },    {"name":"Attach on iOS","type":"nativescript","request":"attach","platform":"ios","appRoot":"${workspaceRoot}","sourceMaps":true,"watch":false    },    {"name":"Launch on Android","type":"nativescript","request":"launch","platform":"android","appRoot":"${workspaceRoot}","sourceMaps":true,"watch":true,"tnsArgs":[" --bundle --env.development cross-env-shell VUE_CLI_MODE=development.android"]    },    {"name":"Attach on Android","type":"nativescript","request":"attach","platform":"android","appRoot":"${workspaceRoot}","sourceMaps":true,"watch":false    },    {"type":"chrome","request":"launch","name":"web: chrome","url":"http://localhost:8080","webRoot":"${workspaceFolder}/src","breakOnLoad":true,"sourceMapPathOverrides": {"webpack:///src/*":"${webRoot}/*"      }    },  ]}

You will also need to modify yourvue.config.js file to include awebpack-chain statement that will setup your source map. It should look something like this:

module.exports={chainWebpack:config=>{config.devtool('inline-source-map')}}

You should be able to use the NativeScript Playground and Preview Apps via the following npm statements:

1. npm run preview:android
2. npm run preview:ios

Basic support for passing theenv command line option is in place, but has a slightly different syntax since we're working with the CLI 3 webpack infrastructure. To inject items intoenv at run-time, you will need to add-- --env.option Where option is one of the recognized options that Nativescript-Vue and this project supports.An example of this would be something like this:npm run serve:android -- --env.production. This would allow you to serve up a Production build of your Android app versus just runningnpm run serve:android which would serve a Development version of the same.

HMR will also work by passing in-- --hmr. An example of this would benpm run serve:android -- --hmr

The options passed in atnpm run will dictate what webpack config is provided. The first choice webpack will make is if this is aweb ornative environment. Then, if it's anative environment, it will determine choices to be made betweenios andandroid.

Each time the project is built or served, the plugin will copy the latest webpack config from the cli to the root of your project. When you build a project, it will clean-up this file at the end, but just serving the project will not. This is an issue withnativescript-dev-webpack and cannot be overcome at this time.

If you'd like to see what the webpack config is doing then you can run one of the following:

1. vue inspect -- --env.android > out-android.js
2. vue inspect -- --env.ios > out-ios.js
3. vue inspect -- --env.web > out-web.js

These will default to showing you the Development version of the webpack config. You can pass in the-- --env.production option to see the Production version of the config. Subtitutedevelopment.android orproduction.ios, etc to see the different configs based on the environmental variables.

Prebuilt in the webpack config are several aliases that you can use. Here is a table listing out the various alias and the folder they use based on the environment chosen:

If your CLI 3 project has TypeScript enabled, then the plugin will attempt to give you a very basic TypeScript version of the template you choose. When you invoke the plugin and the template generator makes changes, you will notice the*.d.ts files that are usually insrc will be moved to/types. The plugin's webpack integration will ensure these files are referenced correctly at compile and runtimes.