nativescript-iqkeyboardmanager - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

package.json

 {
- "name": "nativescript-iqkeyboardmanager",
- "version": "1.0.1",
- "description": "NativeScript wrapper of the popular IQKeyboardManager iOS library",
- "nativescript": {
-   "platforms": {
-     "ios": "1.4.0"
-   }
+  "name": "nativescript-iqkeyboardmanager",
+  "version": "1.1.0",
+  "description": "NativeScript wrapper of the popular IQKeyboardManager iOS library",
+  "typings": "index.d.ts",
+  "nativescript": {
+    "platforms": {
+      "ios": "1.4.0"
+    }
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tjvantoll/nativescript-IQKeyboardManager.git"
+  },
+  "keywords": [
+    "NativeScript"
+  ],
   "author": "TJ VanToll <[e-mail]> (http://tjvantoll.com/)",
@@ -14,2 +22,8 @@ "license": {
   },
+  "contributors": [
+    {
+      "name": "Eddy Verbruggen",
+      "email": "[e-mail]"
+    }
+  ],
   "homepage": "https://github.com/tjvantoll/nativescript-IQKeyboardManager",
@@ -16,0 +30,0 @@ "bugs": {

README.md

@@ -17,4 +17,49 @@ # NativeScript IQKeyboardManager Plugin
 
+## Advanced usage
+
+Want to tweak the appearance and/or behavior?
+
+Start by adding the following two paths into your app’s `references.d.ts` file. (See this repo’s demo app for a specific example.)
+
+```
+/// <reference path="./node_modules/tns-platform-declarations/ios/ios.d.ts" />
+/// <reference path="./node_modules/nativescript-iqkeyboardmanager/index.d.ts" />
+```
+
+> **NOTE**: You might also need to `npm install --save-dev tns-platform-declarations` to bring in NativeScript’s TypeScript definitions for native iOS development.
+
+Next, initialize an instance of `IQKeyboardManager` with the following line of code.
+
+```typescript
+const iqKeyboard = IQKeyboardManager.sharedManager();
+```
+
+You now have the full IQKeyboardManager APIs available for you to use. For example you could use the following code to switch to a dark keyboard.
+
+```typescript
+const iqKeyboard = IQKeyboardManager.sharedManager();
+iqKeyboard.overrideKeyboardAppearance = true;
+iqKeyboard.keyboardAppearance = UIKeyboardAppearance.Dark;
+```
+
+For more examples of what's possible, run the demo app (shown in the gif below) and check out the [app's `main-view-model.ts` file](demo/app/main-view-model.ts).
+
+<img src="https://github.com/tjvantoll/nativescript-IQKeyboardManager/raw/master/demo.gif" width="320px"/> 
+
 ## Documentation
 
 For more details on how IQKeyboardManager works, including more detailed API documentation, refer to [the library's CocoaPod page](https://cocoapods.org/pods/IQKeyboardManager).
+
+## Maintainers
+
+For maintainer’s of this plugin’s source code: when the [IQKeyboardManager Podfile](platforms/ios/Podfile) updates, you should generate new typings for for this plugin to reflect those changes.
+
+To do so, execute these commands.
+
+```bash
+cd demo
+TNS_DEBUG_METADATA_PATH="$(pwd)/metadata" tns build ios
+TNS_TYPESCRIPT_DECLARATIONS_PATH="$(pwd)/typings" tns build ios
+```
+
+Next, locate IQKeyboardManager’s generated typings file in the `demo/typings` folder and override the `IQKeyboardManager.d.ts` file in this repo’s root.

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14154

increased by496.21%

Number of package files

6

increased by20%

Lines of code

156

increased byInfinity%

Number of lines in readme file

64

increased by220%

Number of low supply chain risk alerts

0

decreased by-100%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes