Skip to content

Update README as deprecated for NativeScript 8 with migration notes. #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
flipperlite wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README as deprecated for NativeScript 8 with migration notes. #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,47 @@
# NativeScript Numeric Keyboard

## IMPORTANT: Deprecated for NativeScript 8.x

This plugin is no longer needed for NativeScript (NS) 8.x and iOS. It's been replaced by out of the box functionality in `TextField`. Attempting to run this plugin in NS 8.x even in [the demo](demo) returns an error `Error is: Command xcodebuild failed with exit code 65.`. Make the following changes in your NS 6 or NS 7 projects:

```bash
ns plugin remove nativescript-numeric-keyboard
```
Remove any references and code related to that plugin:
```js
// remove
import { NumericKeyboard } from "nativescript-numeric-keyboard";

// remove
new NumericKeyboard().decorate({
textField: <TextField>page.getViewById('myTextFieldName'),
noDecimals: true,
noIpadInputBar: true,
returnKeyTitle: 'OK',
onReturnKeyPressed: (): boolean => {
// do something
return false; // Return true to hide/collapse the keyboard, use false to keep the keyboard in place.
}
});
```
Replace any references in your XML files:
```xml
<!-- REMOVE reference -->
<Page
xmlns:NK="nativescript-numeric-keyboard"
>
<!-- FROM -->
<NK:NumericKeyboardView android:keyboardType="number" ... />
<!-- TO OPTION #1 -->
<TextField ios:keyboardType="integer" android:keyboardType="number" ... />
<!-- TO OPTION #2 -->
<TextField keyboardType="number" ... />
```

[Documentation](https://docs.nativescript.org/ui/text-field#keyboardtype) for the `keyboardType` has more options to choose.

## Original Documentation Retained for Historical Purposes

[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][npm-url]
[![Twitter Follow][twitter-image]][twitter-url]
Expand Down