https://github.com/nativescript-community/capacitor-plugins
Community plugin for `NativeScript for Capacitor`
https://github.com/nativescript-community/capacitor-plugins
Last synced: 8 months ago
JSON representation
Community plugin for `NativeScript for Capacitor`
- Host: GitHub
- URL: https://github.com/nativescript-community/capacitor-plugins
- Owner: nativescript-community
- Created: 2021-02-19T01:33:06.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-16T02:36:14.000Z (about 5 years ago)
- Last Synced: 2025-04-20T21:36:04.822Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.18 MB
- Stars: 22
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://badge.fury.io/js/%40nativescript-community%2Fcapacitor-plugins)
[](#contributors-)
# @nativescript-community/capacitor-plugins
__✅ This repository is test repository, and not release @nativescript-community/capacitor-plugins now.__
## 👊 Try this project
Please clone, and npm link in your local.
```bash
% git clone git@github.com:nativescript-community/capacitor-plugins.git
% cd capacitor-plugins && npm install
% npm link
```
## 📱 Install in your Capacitor Project
### PreInstall in your project
```
% npm install @capacitor/cli@next --save-dev
% npm install @capacitor/core@next --save
% npm install @nativescript/capacitor
```
### Install
```bash
% npm install --save @nativescript-community/capacitor-plugins
```
### Change your project
#### 1. Add `src/nativescript/index.ts`
Add the following code:
```diff
import '@nativescript/capacitor/bridge';
+ import * as Plugins from '@nativescript-community/capacitor-plugins';
+ native = Object.assign(native, Plugins);
...
```
[Example demo is here.](https://github.com/nativescript-community/capacitor-plugins/blob/main/demo/angular/src/nativescript/index.ts)
### 2. Change `src/native-custom.d.ts`
Replace the following code:
```diff
+ import type { pluginsGlobal } from '@nativescript-community/capacitor-plugins/src/interfaces';
declare module '@nativescript/capacitor' {
export interface customNativeAPI extends nativeCustom {}
}
/**
* Define your own custom strongly typed native helpers here.
*/
- export interface nativeCustom {
+ export interface nativeCustom extends pluginsGlobal {
```
[Example demo is here.](https://github.com/nativescript-community/capacitor-plugins/blob/main/demo/angular/src/native-custom.d.ts)
## Usage
[Usage Example demo is here.](https://github.com/nativescript-community/capacitor-plugins/blob/main/demo/angular/src/app/tab1/tab1.page.ts).
### 1. brightness(value: number)
You can change device brightness (1〜10). This is official example code.
```ts
import { native } from '@nativescript/capacitor';
native.brightness(1);
```
### 2. rateMyApp()
You can allow users to rate the app from inside the application.
#### iOS
No additional configurations are required for iOS.
However, for now it supports iOS version 10.3 and later.
#### Android
Before start using this function add next lines to the dependencies
section of your `android/app/build.gradle`
```gradle
implementation "androidx.appcompat:appcompat:1.2.0"
implementation 'com.google.android.play:core:1.10.0'
```
You can read more about how to import Google Play Core Library
into your project [here](https://developer.android.com/guide/playcore?authuser=1#java-kotlin)
In-app reviews only work on Android devices (phones and tablets) running Android 5.0 (API level 21)
or higher that have the Google Play Store installed and on Chrome OS devices that have the Google Play Store installed.
Important: your app should be published for at least internal testing.
Read more about it in [this SO answer](https://stackoverflow.com/questions/63286540/play-core-in-app-review-api-not-showing-the-review-activity)
#### Usage
```ts
import { native } from '@nativescript/capacitor';
native.rateMyApp();
```
### Demo Code
You can check Native Console Log. This is official example code.
```ts
import { native } from '@nativescript/capacitor';
native.dreamBig();
```
And Launch Native Modal View. This is official example code.
```ts
import { native } from '@nativescript/capacitor';
native.openNativeModalView();
```
## Option
### If you want use some plugin only:
You should select plugin and import.
`src/nativescript/index.ts`:
```ts
import { brightness } from '@nativescript-community/capacitor-plugins';
native = Object.assign(native, {
brightness,
});
```
`src/native-custom.d.ts`:
```ts
import type { IBrightness } from '@nativescript-community/capacitor-plugins/src/interfaces';
export interface nativeCustom extends IBrightness {
dreamBig: () => NativeProperty;
openNativeModalView: () => void;
}
```
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
