archived-plugins-workspace/README.md at 764e8f7719247da515243d9c9cafa6d087d21769

mirror of https://github.com/tauri-apps/plugins-workspace.git synced 2026-01-31 00:45:24 +01:00

Files

Tunglies 764e8f7719 feat(autostart): add app name configuration for auto start entry (#2707 )

* feat(autostart): add prefered name configuration for auto start entry

- Add PreferedName enum to support different naming strategies
- Implement Default trait for PreferedName with PackageInfoName as default
- Add prefered_name builder method with documentation and examples
- Integrate prefered name into auto start configuration

This change allows users to customize the name of their application in the
auto start entry using various naming strategies like package info name,
crate name, config identifier, or custom name.

* refactor(autostart): rename prefered_name to app_name and update related logic

- Change prefered_name to app_name in the Builder struct and methods
- Update PreferedName enum to include new variants and set AppName as default
- Modify documentation to reflect the new app_name usage for auto start entry

This refactor improves clarity in naming conventions and enhances the configuration options for auto start entries.

* refactor(autostart): update app_name handling in README and lib.rs

- Change app_name usage in README to a custom string
- Simplify app_name handling in lib.rs by removing PreferedName enum
- Update Builder struct to accept app_name as an optional string

This refactor enhances the clarity and usability of the auto start configuration.

* feat(autostart): add app_name builder method for custom application naming

- Introduced a new builder method app_name() to customize the application name in the autostart entry.
- Updated app_name handling in the Builder struct to accept a generic string type.

This enhancement allows for greater flexibility in defining application names for autostart configurations.

* Update .changes/autostart-feature.md

Co-authored-by: Tony <68118705+Legend-Master@users.noreply.github.com>

* [skip ci] format

---------

Co-authored-by: Tony <68118705+Legend-Master@users.noreply.github.com>

2025-05-20 23:51:36 +08:00

3.1 KiB

Raw Blame History

Automatically launch your application at startup.

Platform	Supported
Linux	✓
Windows	✓
macOS	✓
Android	x
iOS	x

Install

This plugin requires a Rust version of at least 1.77.2

There are three general methods of installation that we can recommend.

Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
Pull sources directly from Github using git tags / revision hashes (most secure)
Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)

Install the Core plugin by adding the following to your Cargo.toml file:

src-tauri/Cargo.toml

[dependencies]
tauri-plugin-autostart = "2.0.0"
# alternatively with Git:
tauri-plugin-autostart = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }

You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.

pnpm add @tauri-apps/plugin-autostart
# or
npm add @tauri-apps/plugin-autostart
# or
yarn add @tauri-apps/plugin-autostart

# alternatively with Git:
pnpm add https://github.com/tauri-apps/tauri-plugin-autostart#v2
# or
npm add https://github.com/tauri-apps/tauri-plugin-autostart#v2
# or
yarn add https://github.com/tauri-apps/tauri-plugin-autostart#v2

Usage

First you need to register the core plugin with Tauri:

src-tauri/src/lib.rs

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_autostart::Builder::new()
            .args(["--flag1", "--flag2"])
            .app_name("My Custom Name")
            .build())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Afterwards all the plugin's APIs are available through the JavaScript guest bindings:

import { enable, isEnabled, disable } from '@tauri-apps/plugin-autostart'

await enable()

console.log(`registered for autostart? ${await isEnabled()}`)

disable()

Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.

Partners

For the complete list of sponsors please visit our website and Open Collective.

License

MIT or MIT/Apache 2.0 where applicable.

3.1 KiB Raw Blame History