# tauri-plugin-positioner-api

> Helps positioning your tauri windows.

Latest version **0.2.7** (published 2022-06-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install tauri-plugin-positioner-api
pnpm add tauri-plugin-positioner-api
yarn add tauri-plugin-positioner-api
bun add tauri-plugin-positioner-api
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.7 |
| Published | 2022-06-16 |
| First published | 2021-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 1 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jonas Kruckenberg |
| Maintainers | jkruckenberg |
| Keywords | tauri-plugin |

## Links

- npm: https://www.npmjs.com/package/tauri-plugin-positioner-api
- npm.io page: https://npm.io/package/tauri-plugin-positioner-api

## Dependencies (1)

- [@tauri-apps/api](https://npm.io/package/@tauri-apps/api.md) ^1.0.0

## Recent versions

- 0.2.7 (latest) — 2022-06-16
- 0.2.6 — 2022-05-25
- 0.2.5 — 2022-05-18
- 0.2.4 — 2022-05-11
- 0.2.3 — 2022-04-27
- 0.2.2 — 2022-02-17
- 0.2.1 — 2022-02-15
- 0.2.0 — 2022-01-19
- 0.1.0 — 2021-11-19
- 0.0.0 — 2021-11-19

## README

# Tauri plugin positioner

[![Crates.io][crates-badge]][crates-url]
[![Documentation][docs-badge]][docs-url]
[![MIT licensed][mit-badge]][mit-url]

[crates-badge]: https://img.shields.io/crates/v/tauri-plugin-positioner.svg
[crates-url]: https://crates.io/crates/tauri-plugin-positioner
[docs-badge]: https://img.shields.io/docsrs/tauri-plugin-positioner.svg
[docs-url]: https://docs.rs/tauri-plugin-positioner
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: LICENSE

A plugin for Tauri that helps position your windows at well-known locations.

This plugin is a port of [electron-positioner](https://github.com/jenslind/electron-positioner) for [tauri](https://tauri.studio).

## Install

### Rust

```toml
[dependencies]
tauri-plugin-positioner = "1.0"
```

### JavaScript

```
pnpm add tauri-plugin-positioner
# or
npm install tauri-plugin-positioner
# or
yarn add tauri-plugin-positioner
```

## Usage

You need to register the plugin first:

```rust
fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_positioner::init())
        .run(tauri::generate_context!())
        .expect("failed to run app");
}
```

Now you can import the JavaScript API package and move the window:

```javascript
import { move_window, Position } from 'tauri-plugin-positioner-api'

move_window(Position.TopRight)
```

### Rust only

If you only intend on moving the window from rust code, you can import the `Window` trait extension instead of registering the plugin:

> Note: `Window.move_window` method must be called from a different thread!

```rust
use tauri_plugin_positioner::{WindowExt, Position};

fn main() {
    tauri::Builder::default()
        .setup(|app| {
          let mut win = app.get_window("main").unwrap();
      
          let _ = win.move_window(Position::TopRight);
          
          Ok(())
        })
        .run(tauri::generate_context!())
        .expect("failed to run app");
}
```

## Contributing

PRs are welcome!

## License

[MIT © Jonas Kruckenberg](./LICENSE)

---
_Source: https://npm.io/package/tauri-plugin-positioner-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._