Skip to content

Commit 8f9483f

Browse files
committed
feat: implement menubar app
1 parent af8c77b commit 8f9483f

15 files changed

+4112
-148
lines changed

.vscode/extensions.json

-3
This file was deleted.

LICENSE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2022 Victor Aremu
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

+47-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,52 @@
1-
# Tauri + React + Typescript
1+
# Tauri macOS Menubar App Example
22

3-
This template should help get you started developing with Tauri, React and Typescript in Vite.
3+
This is an example project that shows how to create a macOS Menubar app using Tauri.
4+
5+
This template is based on Tauri + React + Typescript template. It should help get you started developing with Tauri, React and Typescript in Vite.
6+
7+
## Prerequisites
8+
9+
- _[<ins>Node.js<ins>](https://nodejs.org)_
10+
- _[<ins>Tauri CLI<ins>](https://tauri.studio/docs/getting-started/installation)_
11+
12+
## Getting Started
13+
14+
1. Clone this repository:
15+
16+
```
17+
git clone https://github.com/ahkohd/tauri-macos-menubar-app-example.git
18+
```
19+
20+
2. Navigate to the project directory:
21+
22+
```
23+
cd tauri-macos-menubar-app-example
24+
```
25+
26+
3. Run the demo
27+
28+
```
29+
pnpm install
30+
pnpm tauri dev
31+
```
32+
33+
5. Go to your menubar, click the Tauri tray icon.
34+
35+
## Demo
36+
37+
![Demo](./demo.gif)
438

539
## Recommended IDE Setup
640

741
- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
42+
43+
# Related
44+
45+
The following are related to this project:
46+
47+
- [tauri-nspanel](https://github.com/ahkohd/tauri-nspanel/tree/main/examples/vanilla): A Tauri plugin that enables the transformation of a standard application window into a panel, providing panel-specific functionalities and methods. It is designed for versatile application across various projects.
48+
- [tauri-plugin-spotlight](https://github.com/zzzze/tauri-plugin-spotlight): Also a Tauri plugin that helps you to emulate a spotlight window behavior. Unlike the `tauri-nspanel` or this example project, it does not utilize a panel. As a result, its ability to draw over fullscreen applications on newer macOS versions may be limited.
49+
50+
# License
51+
52+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE.md) file for details.

demo.gif

5.79 MB
Loading

renovate.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"extends": [
4+
"config:recommended"
5+
]
6+
}

0 commit comments

Comments
 (0)