Skip to main content

HTML/CSS/JavaScript

This guide will walk you through creating your first Tauri app using just HTML, CSS, and JavaScript. This is probably the best place to start if you are new to web development.

Tauri is a framework to build desktop applications with any Front-end framework and a Rust core. Each app consists of two parts:

  1. Rust binary that creates the windows and exposes native functionality to those windows
  2. Frontend of your choice that produces the User Interface inside the window

In the following, we will first scaffold the Frontend, then set up the Rust project and lastly show you how to communicate between the two.

create-tauri-app

The easiest way to scaffold a new project is the create-tauri-app utility. It will ask you a series of questions and quickly bootstrap a Tauri project for you to begin developing with. It has support for vanilla HTML/CSS/JavaScript but also many frontend frameworks like React, Vue, or Svelte.

npm create tauri-app

Here's a preview of what we will be building:

Preview of Application Preview of Application

info

Before we continue, make sure you have completed the prerequisites and installed the Tauri CLI to have a working development environment.

Create the Frontend​

We will create a very minimal UI using an HTML file. To keep things tidy though, let's create a separate folder for it:

mkdir ui

Next, create an index.html file inside of that folder with the following contents:

index.html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Document</title>
  </head>
  <body>
    <h1>Welcome from Tauri!</h1>
  </body>
</html>

We will leave the UI at this for this Guide, but feel free to play around with more content or add styling through CSS.

Create the Rust Project​

At the heart of every Tauri app is a Rust binary that manages windows, the webview and calls to the operating system through a Rust crate called tauri. This project is managed by Cargo, the official package manager and general-purpose build tool for Rust. Our Tauri CLI uses Cargo under the hood so you rarely need to interact with it directly. Cargo has many more useful features that are not exposed through our CLI, such as testing, linting, and formatting, so please refer to their official docs for more.

To scaffold a minimal Rust project that is pre-configured to use Tauri, open a terminal and run the following command:

yarn tauri init

It will walk you through a series of questions:

  1. What is your app name?
    This will be the name of your final bundle and what the OS will call your app. You can use any name you want here.

  2. What should the window title be?
    This will be the title of the default main window. You can use any title you want here.

  3. Where are your web assets (HTML/CSS/JS) located relative to the "<current dir>/src-tauri/tauri.conf.json" file that will be created?
    This is the path that Tauri will load your frontend assets from when building for production.

    For the sake of this tutorial we will answer this with '../ui'.

  4. What is the URL of your dev server?
    This can be either a URL or a file path that Tauri will load during development.

    Because we don't use a frontend bundler with Hot Module Reloading (HMR) for this tutorial we will answer with the same path as the previous question: '../ui'.
info

If you're familiar with Rust, you will notice that tauri init looks and works a lot like cargo init. You can just use cargo init and add the necessary Tauri dependencies if you prefer a fully manual setup.

The tauri init command generates a folder called src-tauri. It's a convention for Tauri apps to place all core-related files into this folder. Let's quickly run through the contents of this folder:

  • Cargo.toml

    Cargo's manifest file. You can declare Rust crates your app depends on, metadata about your app, and much more. For the full reference see Cargo's Manifest Format.

  • tauri.conf.json

    This file lets you configure and customize aspects of your Tauri application from the name of your app to the list of allowed APIs. See Tauri's API Configuration for the full list of supported options and in-depth explanations for each.

  • src/main.rs

    This is the entrypoint to your Rust program and the place where we bootstrap into Tauri. You will find two sections in it:

    src/main.rs
     #![cfg_attr(
        all(not(debug_assertions), target_os = "windows"),
        windows_subsystem = "windows"
     )]

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

    The line beginning with cfg! macro serves just one purpose: it disables the command prompt window that would normally pop up on Windows if you run a bundled app. If you're on Windows, try to comment it out and see what happens.

    The main function is the entry point and the first function that gets invoked when your program runs.

  • icons

    Chances are you want a snazzy icon for your app! To get you going quickly, we included a set of default icons. You should switch these out before publishing your application. Learn more about the various icon formats in Tauri's icons feature guide.

And that's it! Now you can run the following command in your terminal to start a development build of your app:

yarn tauri dev

Preview of Application

Development Progress Development Progress

Invoke Commands​

Tauri lets you enhance your Frontend with native capabilities. We call these Commands, essentially Rust functions that you can call from your frontend JavaScript. This enables you to handle heavy processing or calls to the OS in much more performant Rust code.

Let's make a simple example:

#[tauri::command]
fn greet(name: &str) -> String {
   format!("Hello, {}!", name)
}

A Command is just like any regular Rust function, with the addition of the #[tauri::command] attribute macro that allows your function to communicate with the JavaScript context.

Lastly, we also need to tell Tauri about our newly created command so that it can route calls accordingly. This is done with the combination of the .invoke_handler() function and the generate_handler![] macro you can see below:

fn main() {
  tauri::Builder::default()
    .invoke_handler(tauri::generate_handler![greet])
    .run(tauri::generate_context!())
    .expect("error while running tauri application");
}

Now we're ready to call your Command from the JavaScript frontend!

We would normally be recommending the @tauri-apps/api package here, but since we're not using a bundler for this guide, please enable withGlobalTauri in your tauri.conf.json file:

{
  "build": {
    "beforeBuildCommand": "",
    "beforeDevCommand": "",
    "devPath": "..",
    "distDir": "..",
    "withGlobalTauri": true
  },

This will inject a pre-bundled version of the API functions into your frontend.

You can now modify your index.html file to call your Command:

index.html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Document</title>
  </head>
  <body>
    <h1>Welcome from Tauri!</h1>
    <script>
      // access the pre-bundled global API functions
      const invoke = window.__TAURI__.invoke

      // now we can call our Command!
      // Right-click the application background and open the developer tools.
      // You will see "Hello, World!" printed in the console!
      invoke('greet', { name: 'World' })
        // `invoke` returns a Promise
        .then((response) => console.log(response))
    </script>
  </body>
</html>
tip

If you want to know more about the communication between Rust and JavaScript, please read the Tauri Inter-Process Communication guide.