Skip to content

Guides References Blog Releases

GitHub Discord Twitter Bluesky Mastodon RSS

Select language

Guides
References
Blog

Blog
Command Line Interface
Security
Configuration
Environment Variables
Webview Versions
Releases
JavaScript
- Tauri
  - @tauri-apps
    
    namespaces
    
    app
    
    enumerations
    
    BundleType
    
    functions
    
    defaultWindowIcon
    fetchDataStoreIdentifiers
    getBundleType
    getIdentifier
    getName
    getTauriVersion
    getVersion
    hide
    removeDataStore
    setDockVisibility
    setTheme
    show
    
    type-aliases
    
    DataStoreIdentifier
    
    core
    
    classes
    
    Channel
    PluginListener
    Resource
    
    functions
    
    addPluginListener
    checkPermissions
    convertFileSrc
    invoke
    isTauri
    requestPermissions
    transformCallback
    
    interfaces
    
    InvokeOptions
    
    type-aliases
    
    InvokeArgs
    PermissionState
    
    variables
    
    SERIALIZE_TO_IPC_FN
    
    dpi
    
    classes
    
    LogicalPosition
    LogicalSize
    PhysicalPosition
    PhysicalSize
    Position
    Size
    
    event
    
    enumerations
    
    TauriEvent
    
    functions
    
    emit
    emitTo
    listen
    once
    
    interfaces
    
    Event
    Options
    
    type-aliases
    
    EventCallback
    EventName
    EventTarget
    UnlistenFn
    
    image
    
    classes
    
    Image
    
    functions
    
    transformImage
    
    interfaces
    
    ImageSize
    
    menu
    
    classes
    
    CheckMenuItem
    IconMenuItem
    Menu
    MenuItem
    PredefinedMenuItem
    Submenu
    
    enumerations
    
    NativeIcon
    
    interfaces
    
    AboutMetadata
    CheckMenuItemOptions
    IconMenuItemOptions
    MenuItemOptions
    MenuOptions
    PredefinedMenuItemOptions
    
    type-aliases
    
    SubmenuOptions
    
    mocks
    
    functions
    
    clearMocks
    mockConvertFileSrc
    mockIPC
    mockWindows
    
    interfaces
    
    MockIPCOptions
    
    path
    
    enumerations
    
    BaseDirectory
    
    functions
    
    appCacheDir
    appConfigDir
    appDataDir
    appLocalDataDir
    appLogDir
    audioDir
    basename
    cacheDir
    configDir
    dataDir
    delimiter
    desktopDir
    dirname
    documentDir
    downloadDir
    executableDir
    extname
    fontDir
    homeDir
    isAbsolute
    join
    localDataDir
    normalize
    pictureDir
    publicDir
    resolve
    resolveResource
    resourceDir
    runtimeDir
    sep
    tempDir
    templateDir
    videoDir
    
    tray
    
    classes
    
    TrayIcon
    
    interfaces
    
    TrayIconOptions
    
    type-aliases
    
    MouseButton
    MouseButtonState
    TrayIconClickEvent
    TrayIconEvent
    TrayIconEventBase
    TrayIconEventType
    
    webview
    
    classes
    
    Webview
    
    functions
    
    getAllWebviews
    getCurrentWebview
    
    interfaces
    
    WebviewOptions
    
    type-aliases
    
    Color
    DragDropEvent
    
    webviewWindow
    
    classes
    
    WebviewWindow
    
    functions
    
    getAllWebviewWindows
    getCurrentWebviewWindow
    
    window
    
    classes
    
    CloseRequestedEvent
    Window
    
    enumerations
    
    BackgroundThrottlingPolicy
    Effect
    EffectState
    ProgressBarStatus
    UserAttentionType
    
    functions
    
    availableMonitors
    currentMonitor
    cursorPosition
    getAllWindows
    getCurrentWindow
    monitorFromPoint
    primaryMonitor
    
    interfaces
    
    Effects
    Monitor
    ProgressBarState
    ScaleFactorChanged
    WindowOptions
    WindowSizeConstraints
    
    type-aliases
    
    CursorIcon
    Theme
    TitleBarStyle
  - @tauri-apps/api
- Plugins
  - autostart
    
    functions
    
    disable
    enable
    isEnabled
    
    @tauri-apps/plugin-autostart
  - barcode-scanner
    
    enumerations
    
    Format
    
    functions
    
    cancel
    checkPermissions
    openAppSettings
    requestPermissions
    scan
    
    interfaces
    
    Scanned
    ScanOptions
    
    @tauri-apps/plugin-barcode-scanner
    
    type-aliases
    
    PermissionState
  - biometric
    
    enumerations
    
    BiometryType
    
    functions
    
    authenticate
    checkStatus
    
    interfaces
    
    AuthOptions
    Status
    
    @tauri-apps/plugin-biometric
  - cli
    
    functions
    
    getMatches
    
    interfaces
    
    ArgMatch
    CliMatches
    SubcommandMatch
    
    @tauri-apps/plugin-cli
  - clipboard-manager
    
    functions
    
    clear
    readImage
    readText
    writeHtml
    writeImage
    writeText
    
    @tauri-apps/plugin-clipboard-manager
  - deep-link
    
    functions
    
    getCurrent
    isRegistered
    onOpenUrl
    register
    unregister
    
    @tauri-apps/plugin-deep-link
  - dialog
    
    functions
    
    ask
    confirm
    message
    open
    save
    
    interfaces
    
    ConfirmDialogOptions
    DialogFilter
    MessageDialogOptions
    OpenDialogOptions
    SaveDialogOptions
    
    @tauri-apps/plugin-dialog
    
    type-aliases
    
    OpenDialogReturn
  - fs
    
    classes
    
    FileHandle
    
    enumerations
    
    BaseDirectory
    SeekMode
    
    functions
    
    copyFile
    create
    exists
    lstat
    mkdir
    open
    readDir
    readFile
    readTextFile
    readTextFileLines
    remove
    rename
    size
    stat
    truncate
    watch
    watchImmediate
    writeFile
    writeTextFile
    
    interfaces
    
    CopyFileOptions
    CreateOptions
    DebouncedWatchOptions
    DirEntry
    ExistsOptions
    FileInfo
    MkdirOptions
    OpenOptions
    ReadDirOptions
    ReadFileOptions
    RemoveOptions
    RenameOptions
    StatOptions
    TruncateOptions
    WatchEvent
    WatchOptions
    WriteFileOptions
    
    @tauri-apps/plugin-fs
    
    type-aliases
    
    UnwatchFn
    WatchEventKind
    WatchEventKindAccess
    WatchEventKindCreate
    WatchEventKindModify
    WatchEventKindRemove
  - global-shortcut
    
    functions
    
    isRegistered
    register
    unregister
    unregisterAll
    
    interfaces
    
    ShortcutEvent
    
    @tauri-apps/plugin-global-shortcut
    
    type-aliases
    
    ShortcutHandler
  - http
    
    functions
    
    fetch
    
    interfaces
    
    ClientOptions
    DangerousSettings
    Proxy
    ProxyConfig
    
    @tauri-apps/plugin-http
  - log
    
    enumerations
    
    LogLevel
    
    functions
    
    attachConsole
    attachLogger
    debug
    error
    info
    trace
    warn
    
    interfaces
    
    LogOptions
    
    @tauri-apps/plugin-log
  - nfc
    
    enumerations
    
    NFCTypeNameFormat
    TechKind
    
    functions
    
    isAvailable
    record
    scan
    textRecord
    uriRecord
    write
    
    interfaces
    
    NFCRecord
    ScanOptions
    Tag
    TagRecord
    UriFilter
    WriteOptions
    
    @tauri-apps/plugin-nfc
    
    type-aliases
    
    ScanKind
    
    variables
    
    RTD_TEXT
    RTD_URI
  - notification
    
    classes
    
    Schedule
    
    enumerations
    
    Importance
    ScheduleEvery
    Visibility
    
    functions
    
    active
    cancel
    cancelAll
    channels
    createChannel
    isPermissionGranted
    onAction
    onNotificationReceived
    pending
    registerActionTypes
    removeActive
    removeAllActive
    removeChannel
    requestPermission
    sendNotification
    
    interfaces
    
    Action
    ActionType
    ActiveNotification
    Attachment
    Channel
    Options
    PendingNotification
    ScheduleInterval
    
    @tauri-apps/plugin-notification
    
    type-aliases
    
    PermissionState
  - opener
    
    @tauri-apps/plugin-opener
  - os
    
    functions
    
    arch
    eol
    exeExtension
    family
    hostname
    locale
    platform
    type
    version
    
    @tauri-apps/plugin-os
    
    type-aliases
    
    Arch
    Family
    OsType
    Platform
  - positioner
    
    enumerations
    
    Position
    
    functions
    
    handleIconState
    moveWindow
    moveWindowConstrained
    
    @tauri-apps/plugin-positioner
  - process
    
    functions
    
    exit
    relaunch
    
    @tauri-apps/plugin-process
  - shell
    
    classes
    
    Child
    Command
    EventEmitter
    
    functions
    
    open
    
    interfaces
    
    ChildProcess
    CommandEvents
    OutputEvents
    SpawnOptions
    TerminatedPayload
    
    @tauri-apps/plugin-shell
    
    type-aliases
    
    IOPayload
  - sql
    
    classes
    
    default
    
    interfaces
    
    QueryResult
    
    @tauri-apps/plugin-sql
  - store
    
    classes
    
    LazyStore
    Store
    
    functions
    
    getStore
    load
    
    @tauri-apps/plugin-store
    
    type-aliases
    
    StoreOptions
  - stronghold
    
    classes
    
    Client
    Location
    Store
    Stronghold
    Vault
    
    interfaces
    
    AddressInfo
    ClientAccess
    ConnectionLimits
    Duration
    NetworkConfig
    PeerAddress
    Permissions
    
    @tauri-apps/plugin-stronghold
    
    type-aliases
    
    ClientPath
    RecordPath
    StoreKey
    VaultPath
  - updater
    
    classes
    
    Update
    
    functions
    
    check
    
    interfaces
    
    CheckOptions
    DownloadOptions
    
    @tauri-apps/plugin-updater
    
    type-aliases
    
    DownloadEvent
  - upload
    
    functions
    
    download
    upload
    
    @tauri-apps/plugin-upload
  - websocket
    
    classes
    
    default
    
    interfaces
    
    CloseFrame
    ConnectionConfig
    MessageKind
    
    @tauri-apps/plugin-websocket
    
    type-aliases
    
    Message
  - window-state
    
    enumerations
    
    StateFlags
    
    functions
    
    filename
    restoreState
    restoreStateCurrent
    saveWindowState
    
    @tauri-apps/plugin-window-state
Rust (docs.rs)

GitHub Discord Twitter Bluesky Mastodon RSS

Select language

On this page

Overview

On this page

Overview

Family

Family = "unix" | "windows"

Defined in: index.ts:97

© 2025 Tauri Contributors. CC-BY / MIT