- Version: 2.0.8
- GitHub: https://github.com/nativescript-community/ui-checkbox
- Downloads:
- Last Day: 2
- Last Week: 48
- Last Month: 156
@nativescript-community/ui-checkbox
NativeScript plugin for checkbox.
![]() |
![]() |
---|---|
iOS Demo | Android Demo |
Table of Contents
- Installation * Platform controls used:
- API
- Properties
- Events
- API
- Css Styling
- Styling [Android]
- Demos
- Demos and Development
- Questions
Installation
Run the following command from the root of your project:
ns plugin add @nativescript-community/ui-checkbox
Platform controls used:
Android | iOS |
---|---|
Android CheckBox | BEMCheckBox |
API
Properties
- checked - boolean
- text - text to use with the checkbox
- fillColor - Color of the checkbox element
- boxType - Either 'square' (default) or 'circle'. It's recommended to use 'circle' for radiobuttons. Note that plugin version 3.0.0 switched the default for iOS to 'square' for alignment with Android. Still want
circle
on iOS andsquare
on Android? Just make theboxType
value conditional.
Events
- checkedChange - Use a reference to the CheckBox component to grab it's
checked
property when this event fires to see the new value.
API
- toggle() - Change the checked state of the view to the inverse of its current state.
Css Styling
- color - set the text label color
- font-size - checkbox is sized to text from here : default 15
- border-width - set the line width of the checkbox element: iOS only
Styling [Android]
- checkStyle - set to the name of your drawable
- checkPadding - set the padding of the checkbox
<Page
xmlns="http://schemas.nativescript.org/tns.xsd"
xmlns:CheckBox="@nativecript-community/ui-checkbox" loaded="pageLoaded">
<ActionBar title="Native Checkbox" />
<StackLayout>
<CheckBox:CheckBox checked="checkProp" text="myCheckText" fillColor="myCheckColor" id="myCheckbox" />
<CheckBox:CheckBox text="CheckBox Label" checked="false" />
</StackLayout>
</Page>
import { CheckBox } from '@nativecript-community/ui-checkbox';
import { topmost } from '@nativescript/core/ui/frame';
public toggleCheck() {
const checkBox = topmost().getViewById('yourCheckBoxId');
checkBox.toggle();
}
public getCheckProp() {
const checkBox = topmost().getViewById('yourCheckBoxId');
console.log('checked prop value = ' + checkBox.checked);
}
Angular Usage Sample:
import { TNSCheckBoxModule } from '@nativecript-community/ui-checkbox/angular';
@NgModule({
imports: [TNSCheckBoxModule]
// etc.
})
export class YourModule {}
// component:
export class SomeComponent {
@ViewChild('CB1') FirstCheckBox: ElementRef;
constructor() {}
public toggleCheck() {
this.FirstCheckBox.nativeElement.toggle();
}
public getCheckProp() {
console.log(
'checked prop value = ' + this.FirstCheckBox.nativeElement.checked
);
}
}
<StackLayout>
<CheckBox #CB1 text="CheckBox Label" checked="false"></CheckBox>
<button (tap)="toggleCheck()" text="Toggle it!"></button>
<button (tap)="getCheckProp()" text="Check Property"></button>
</StackLayout>
NativeScript-Vue Usage Sample
In your main.js
(The file where the root Vue instance is created) register the element
Vue.registerElement(
'CheckBox',
() => require('@nativecript-community/ui-checkbox').CheckBox,
{
model: {
prop: 'checked',
event: 'checkedChange'
}
}
);
And in your template, use it as:
<check-box :checked="isChecked" @checkedChange="isChecked = $event.value" />
Use checked
instead of v-model
. See #99.
Demos
This repository includes Angular, Vue.js, and Svelte demos. In order to run these execute the following in your shell:
$ git clone https://github.com/@nativescript-community/ui-checkbox
$ cd ui-checkbox
$ npm i
$ npm run setup
$ npm run build # && npm run build.angular
$ cd demo-ng # or demo-vue or demo-svelte
$ ns run ios|android
Demos and Development
Setup
To run the demos, you must clone this repo recursively.
git clone https://github.com/@nativescript-community/ui-checkbox.git --recursive
Install Dependencies:
npm i # or 'yarn install' or 'pnpm install'
Interactive Menu:
To start the interactive menu, run npm start
(or yarn start
or pnpm start
). This will list all of the commonly used scripts.
Build
npm run build
npm run build.angular # or for Angular
Demos
npm run demo.[ng|react|svelte|vue].[ios|android]
npm run demo.svelte.ios # Example
Questions
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.