Skip to content
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

Jump to bottom

docs(LocalNotifications): updated local notification config documentation #2601

Merged
merged 1 commit into from
Mar 19, 2020
Merged

docs(LocalNotifications): updated local notification config documentation #2601

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
16 changes: 16 additions & 0 deletions site/docs-md/apis/local-notifications/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,22 @@ const notifs = await LocalNotifications.schedule({
console.log('scheduled notifications', notifs);
```

## Local Notifications configuration (Android only)

The local notification plugin allows the following configuration values to be added in `capacitor.config.json` for the Android platform:

- `smallIcon`: It allows you to set the default icon for the local notification.
- `iconColor`: It allows you to set the default color for the local notification icon.

```json
"plugins": {
"LocalNotifications": {
"smallIcon": "ic_stat_icon_config_sample",
"iconColor": "#488AFF"
}
}
```

## API

<plugin-api name="local-notifications"></plugin-api>