8.8 released—CSS Media Query support, SF Symbols and much more...
Learn more

View on GitHub


A NativeScript plugin that provides a UI element for picking an object/value from a list opened in a modal popup.


npm install @nativescript/picker


PickerField on iOSPickerField on Android



Register the plugin namespace using the xmlns attribute of the <Page> view.

   <picker:PickerField hint="Click here" items="{{ pickerItems }}"/>

Or with item template

<picker:PickerField focusOnShow="true" filterKeyName="name" showFilter="{{ enableFilter }}" pickerTitle="Nativescript Picker" rowHeight="60" id="picker" hint="Click here" textField="name" padding="10" pickerOpened="{{ pickerOpened }}" pickerClosed="{{ pickerClosed }}"
                    items="{{ pickerItems }}" >
        <GridLayout height="60">
            <Label text="{{ name}}" textWrap="true" verticalAlignment="center" />


Data filter

You can filter the data by setting showFilter="true", by default the plugin will look at the name key on the items source, but you can control this by setting filterKeyName="title" assuming your data Items contains a title key :

focus the search bar by setting focusOnShow="true"

let dataItems = new ObservableArray<{ title: string; age: number }>()

for (let i = 0; i <= 30; i++) {
    title: 'Title' + i,
    age: 30 + i,

Get selected item

You need to register the callback from pickerClosed property pickerClosed="onSelectedItem" this will return the selectedIndex :

onSelectedItem(args) {
    let index = args.object?.selectedIndex;
    console.log('Picker > closed', index);
    console.log('Picker > closed', dataItems[index].title);


You can targed the Picker via thoes css class ex: .pickerRootModal:

  • pickerRootModal targetting the Modal
  • pickerPage targetting the Page
  • pickerGridLayout targetting the GridLayout wraper that contains all the views
  • pickerListView targetting the ListView
  • pearchBarContainer targetting the search bar container StackLayout
  • pickerSearchBar targetting the search bar TextField

See here also


Import the plugin module in the module of your component:

import { NativeScriptPickerModule } from "@nativescript/picker/angular";
    imports: [

Then declare the fields in the HTML of your component:

<PickerField hint="Click here" [items]="pickerItems"></PickerField>

Define a custom item template

You can also define a custom item template for the picker's list:

  hint="Click here"
  [pickerTitle]="'Select item from list'"
  <ng-template let-item="item">
    <GridLayout columns="auto, *" rows="auto, *">
      <label text="Static text:" col="0"></label>
      <label [text]="item?.name" col="0" row="1"></label>
      <image [src]="item?.imageUrl" col="1" row="0" rowSpan="2"></image>

With the following bindings:

interface IDataItem {
  name: string
  id: number
  description: string
  imageUrl: string

this.items = new ObservableArray<IDataItem>()
for (let i = 0; i < 20; i++) {
    name: 'Item ' + i,
    id: i,
    description: 'Description ' + i,
    imageUrl: 'https://picsum.photos/150/70/?random',


import PickerField from '@nativescript/picker/vue'


Then, declare the fields in the template of your component:

<PickerField hint="Click here"></PickerField>

Style the PickerField

The PickerField can be targeted in CSS through its element selector and additionally by setting a class. The PickerField also opens a modal window containing a Page element that contains an ActionBar and a ListView. This Page element can be targeted with the PickerPage selector as follows:

PickerPage {

, and through the PickerPage selector, you can style all the picker modals with selectors like PickerPage ActionBar and PickerPage ListView.

PickerPage ActionBar {

PickerPage ListView {

In addition to that, if you set a class on the PickerField, it will be transferred to the PickerPage and with it, you can style individual modals.

PickerField API

The PickerField extends the TextField view which means that any functionality the default TextField provides is also available in the PickerField component. The only difference is that by design it is in "read-only" mode, or simply put you cannot change its text. Changing the text of the PickerField occurs when a user taps a value from the list

itemLoadingEventstringString value used when hooking to itemLoading event.
pickerTitlestringThe title of the modal view.
itemsitems: any[] | ItemsSourceThe source collection used to populate the list of the modal view.
itemTemplatestring | TemplateТhe UI template for the ListView items of the list of the modal view.
modalAnimatedbooleanOptional parameter specifying whether to show the modal view with animation.
textFieldstringThe 'property' of the object from the 'items' collection that will be used by the 'text' property of the PickerField.
valueFieldstringThe 'property' of the object from the 'items' collection that will be used when setting the selectedValue property of the PickerField.
selectedValueanyThe object selected from the list in the modal view.
selectedIndexnumberThe index of the object from the items collection that has been selected from the list in the modal view.
iOSCloseButtonPosition'left' | 'right'The position of the 'close' button of the ActionBar of the modal view.
iOSCloseButtonIconnumberThe icon of the 'close' button of the ActionBar of the modal view.
androidCloseButtonPosition'navigationButton' | 'actionBar' | 'actionBarIfRoom' | 'popup'The position of the 'close' button of the ActionBar of the modal view.
androidCloseButtonIconstringThe icon of the 'close' button of the ActionBar of the modal view.
showFilterShow the search bar
filterKeyNameSet object key to use when filtering (see the doc)
focusOnShowSet the focus to the serach bar
hintTextSet the hint of the search bar