# NativeScript UI SideDrawer

- [Overview](#overview)
- [Installation](#installation)
- [Documentation](#documentation)
- [API Reference](#api-reference)
- [Sample Apps](#sample-apps)


## Overview

**NativeScript UI SideDrawer** is part of [Progress NativeScript UI](https://www.nativescript.org/ui-for-nativescript) - a suite of rich-UI components targeting the NativeScript platform.

The **NativeScript UI SideDrawer** plugin allows you to have a hidden view that contains navigation UI or common settings. A popular application that uses the drawer UI is the Android Play Store app. The hidden view can be displayed with a flick gesture and can be shown from any of the four edges of the screen. The view is also displayed with a transition which can be chosen from a set of pre-defined transitions.

<img src="https://docs.nativescript.org/img/ui-for-nativescript/sidedrawer-ios.png"><img src="https://docs.nativescript.org/img/ui-for-nativescript/sidedrawer-android.png">

## Installation

In Command prompt / Terminal navigate to your application root folder and run:

```
tns plugin add nativescript-ui-sidedrawer
```


## Documentation

More information about the usage of the plugin available in the Guides for [NativeScript Core](http://docs.telerik.com/devtools/nativescript-ui/Controls/NativeScript/SideDrawer/overview) and [NativeScript with Angular](http://docs.telerik.com/devtools/nativescript-ui/Controls/Angular/SideDrawer/overview).

## API Reference

[Here](http://docs.telerik.com/devtools/nativescript-ui/api/classes/radsidedrawer.html) is the API Reference section.

## Sample Apps

The features of the plugin are demonstrated in the Sample apps for [NativeScript Core](https://github.com/telerik/nativescript-ui-samples) and [NativeScript with Angular](https://github.com/telerik/nativescript-ui-samples-angular).
