Back to projects
TN

tauri-update-notifier

Library

Lightweight update notification library for Tauri applications

Update notification demo

About

A lightweight update notification library for Tauri applications using GitHub Releases. It provides an easy way to check for updates and display notifications to users.

The library includes both a core API for checking updates and ready-to-use React components, making it simple to integrate update notifications into your Tauri app.

Features

  • Zero dependencies - Core API has no external dependencies
  • React components - Ready-to-use notification component
  • Customizable - Full control over styling and behavior
  • TypeScript - Full type support included
  • Tauri-optimized - Works seamlessly with @tauri-apps/plugin-shell
  • GitHub Releases integration - Automatic version checking

Installation

npm install tauri-update-notifier

Quick Start

import { UpdateNotification } from 'tauri-update-notifier/react';
import { open } from '@tauri-apps/plugin-shell';

function App() {
  return (
    <>
      <YourApp />
      <UpdateNotification
        owner="your-github-username"
        repo="your-repo-name"
        currentVersion="1.0.0"
        onOpenUrl={open}
      />
    </>
  );
}

Tech Stack

TS

TypeScript

Primary language

R

React

UI components

T

Tauri

Target platform

Package Info

License MIT
Type Library