Simple template with Drawer navigation for Vanilla NativeScript apps using TypeScript
Clone or download
Latest commit c4e4353 Jan 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
hooks/after-createProject fix: after-createProject hook (#90) Oct 3, 2018
tools chor: update ios Images Oct 29, 2018
.gitignore
.npmignore chore: update dependencies (#93) Nov 13, 2018
CODE_OF_CONDUCT.md chore: update community files Jan 18, 2018
LICENSE chore: update community files Jan 4, 2019
README.md chore: forward issue tracking to nativescript repo(#82) Jul 10, 2018
package.json
tslint.json chore: migrate template to version 2 (#83) Jul 23, 2018

README.md

NativeScript Core with TypeScript Drawer Navigation Template

App templates help you jump start your native cross-platform apps with built-in UI elements and best practices. Save time writing boilerplate code over and over again when you create new apps.

App template featuring a RadSideDrawer component for navigation. The RadSideDrawer component is part of Progress NativeScript UI.

Key Features

  • Side drawer navigation
  • Five blank pages hooked to the drawer navigation
  • Customizable theme
  • UX and development best practices
  • Easy to understand code

Quick Start

Execute the following command to create an app from this template:

tns create my-drawer-ts --template tns-template-drawer-navigation-ts

Note: This command will create a new NativeScript app that uses the latest version of this template published to npm.

If you want to create a new app that uses the source of the template from the master branch, you can execute the following:

tns create my-drawer-ts --template https://github.com/NativeScript/template-drawer-navigation-ts

NB: Please, have in mind that the master branch may refer to dependencies that are not on NPM yet!

Walkthrough

Architecture

There is a folder that is used for setting RadSideDrawer instance as an application starting point:

  • /app-root/app-root.ts - sets up the RadSideDrawer drawer content and defines navigation frame for the pages.

RadSideDrawer has the following component structure:

  • RadSideDrawer - The component to display a drawer on the page.
  • RadSideDrawer.drawerContent - Part of the RadSideDrawer, it holds a custom component drawer that displays the contents of the drawer.
  • RadSideDrawer.mainContent - Part of the RadSideDrawer, it holds the main content for the page.

The template has the following blank pages:

  • /home/home-page.ts
  • /browse/browse-page.ts
  • /search/search-page.ts
  • /featured/featured-page.ts
  • /settings/settings-page.ts

Styling

This template is set up to use SASS for styling. All classes used are based on the {N} core theme – consult the documentation to understand how to customize it. Check it out to see what classes you can use on which component.

It has 4 global style files that are located at the root of the app folder:

  • _app-variables.scss - holds the global SASS variables that are imported on each component's styles.
  • _app-common.scss - the global common style sheet. These style rules are applied to both Android and iOS.
  • app.android.scss - the global Android style sheet. These style rules are applied to Android only.
  • app.ios.scss - the global iOS style sheet. These style rules are applied to iOS only.

Get Help

The NativeScript framework has a vibrant community that can help when you run into problems.

Try joining the NativeScript community Slack. The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.

If you have found an issue with this template, please report the problem in the NativeScript repository.

Contributing

We love PRs, and accept them gladly. Feel free to propose changes and new ideas. We will review and discuss, so that they can be accepted and better integrated.