tauri-plugin-app-icon 0.1.0

A Tauri plugin to programmatically change the app icon.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# Tauri Plugin — App Icon

[![Crates.io](https://img.shields.io/crates/v/tauri-plugin-app-icon.svg)](https://crates.io/crates/tauri-plugin-app-icon)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

A [Tauri](https://tauri.app) plugin to programmatically change the app icon at runtime on iOS and Android.

## Platform Support

| Platform | Supported |
|----------|-----------|
| iOS      | ✅        |
| Android  | ✅        |
| macOS    | ❌ (stub) |
| Windows  | ❌ (stub) |
| Linux    | ❌ (stub) |

## Installation

Add the plugin to your `Cargo.toml`:

```toml
[dependencies]
tauri-plugin-app-icon = "0.1"
```

Register the plugin in your Tauri app:

```rust
fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_app_icon::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}
```

## Commands

| Command          | Description                                                         |
|------------------|---------------------------------------------------------------------|
| `is_supported`   | Returns whether the device supports alternate icons.                |
| `get_name`       | Returns the name of the current alternate icon (or `null`).         |
| `change`         | Switches the app icon to a named alternate icon.                    |
| `reset`          | Resets the app icon back to the primary/default icon.               |

### JavaScript / TypeScript

```ts
import { isSupported, getName, change, reset } from "tauri-plugin-app-icon";

const supported = await isSupported();
if (supported) {
    await change({ name: "dark-icon" });
    const name = await getName();
    await reset();
}
```

## License

MIT