Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/capacitor-community/native-market
https://github.com/capacitor-community/native-market
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/capacitor-community/native-market
- Owner: capacitor-community
- License: mit
- Created: 2020-05-30T03:40:53.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T13:37:39.000Z (8 months ago)
- Last Synced: 2024-04-22T13:40:50.181Z (8 months ago)
- Language: Java
- Size: 409 KB
- Stars: 25
- Watchers: 8
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-capacitorjs - @capacitor-community/native-market - Capacitor community plugin for native market for Play Store/App Store. (Plugins / Community Plugins)
- awesome-capacitor - Native market - A native market plugin for linking to google play or app store. (Community plugins)
README
# Capacitor Native Market Plugin
Capacitor community plugin for native market for Play Store/App Store.
**Note:** The plugin doesn't work on iOS Simulator because it doesn't have App Store app installed.
It works on Android Virtual Devices if they have Google Play installed with a user logged in.
## Maintainers
| Maintainer | GitHub | Social |
| ------------- | ------------------------------------------- | ------------------------------------------------ |
| Priyank Patel | [priyankpat](https://github.com/priyankpat) | [@priyankpat\_](https://twitter.com/priyankpat_) |
Maintenance Status: Actively Maintained
## Plugin versions
| Capacitor version | Plugin version |
| ----------------- | -------------- |
| 6.x | 6.x |
| 5.x | 5.x |
| 4.x | 4.x |
| < 3.x | 0.1.x |
## Installation
To use npm
```bash
npm install @capacitor-community/native-market
```
To use yarn
```bash
yarn add @capacitor-community/native-market
```
Sync native files
```bash
npx cap sync
```
## Configuration
No configuration required for this plugin
## Supported methods
| Name | Android | iOS | Web |
| :------------------- | :------ | :-- | :-- |
| openStoreListing | ✅ | ✅ | ❌ |
| openDevPage | ✅ | ❌ | ❌ |
| openCollection | ✅ | ❌ | ❌ |
| openEditorChoicePage | ✅ | ❌ | ❌ |
| search | ✅ | ✅ | ❌ |
- [`openStoreListing(...)`](#openstorelisting)
- [`openDevPage(...)`](#opendevpage)
- [`openCollection(...)`](#opencollection)
- [`openEditorChoicePage(...)`](#openeditorchoicepage)
- [`search(...)`](#search)
## Example
```typescript
import { NativeMarket } from "@capacitor-community/native-market";
import { Capacitor } from "@capacitor/core";
/**
* This method will launch link in Play/App Store.
* @param appId - ID of your application.
* Eg:
* io.ionic.ioniconf on Android
* id1622127552 on iOS
* @returns void
*/
let appId = "id1622127552";
if (Capacitor.getPlatform() === "android") {
appId = "io.ionic.ioniconf";
}
NativeMarket.openStoreListing({
appId: appId,
});
/**
* This method will deep-link directly to an Play/App store listing page.
* @param devId - ID of developer. Eg. com.example.app
* @returns void
*/
NativeMarket.openDevPage({
devId: "5700313618786177705",
});
/**
* This method will link users to a collection or top charts.
* @param name - name of the collection. Click [here](https://developer.android.com/distribute/marketing-tools/linking-to-google-play#OpeningCollection) for android options.
* @returns void
*/
NativeMarket.openCollection({
name: "featured",
});
/**
* This method will link users to Editor's choice page.
* @param editorChoice - ID of your application. Eg. editorial_fitness_apps_us
* @returns void
*/
NativeMarket.openEditorChoicePage({
editorChoice: "editorial_fitness_apps_us",
});
/**
* This method will link users to custom search query.
* @param editorChoice - terms to be searched in Play/App store.
* @returns void
*/
NativeMarket.search({
terms: "capacitor",
});
```
### openStoreListing(...)
```typescript
openStoreListing(options: { appId: string; }) => Promise
```
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
---
### openDevPage(...)
```typescript
openDevPage(options: { devId: string; }) => Promise
```
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { devId: string; } |
---
### openCollection(...)
```typescript
openCollection(options: { name: string; }) => Promise
```
| Param | Type |
| ------------- | ------------------------------ |
| **`options`** | { name: string; } |
---
### openEditorChoicePage(...)
```typescript
openEditorChoicePage(options: { editorChoice: string; }) => Promise
```
| Param | Type |
| ------------- | -------------------------------------- |
| **`options`** | { editorChoice: string; } |
---
### search(...)
```typescript
search(options: { terms: string; }) => Promise
```
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { terms: string; } |
---