Skip to content
NetWiv
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Select language
English
한국어
Menu
Documentation home
Quickstart overview
Build an application
Deployment
Windows installer configuration
Quickstart
Release bundles
.NET compatibility
Linux
macOS
Project creation
Frontend templates
React development
Blazor Hybrid
Blazor Hybrid AOT future work
Coding agents
APIs and security
C# SDK
Generic Host
Frontend bindings
Generated plugin commands
Desktop frontend SDK
Menus
Plugin configuration
Desktop plugins
JSON store persistence
SQLite databases and migrations
Desktop filesystem watching
Bundle resources
Custom URI protocols
Isolation and IPC
Remote URL patterns
Runners, versions and hooks
Support and framework development
Design principles
Support and validation
API status
macOS WebView creation options
Platform behavior
Native architecture
C ABI
Framework development
Upstream tests
Compatibility
Frontend API
Frontend API
app
@netwiv/api/app
BundleType
DataStoreIdentifier
defaultWindowIcon
fetchDataStoreIdentifiers
getBundleType
getIdentifier
getName
getVersion
hide
removeDataStore
setDockVisibility
setTheme
show
supportsMultipleWindows
core
@netwiv/api/core
addPluginListener
Channel
checkPermissions
convertFileSrc
invoke
InvokeArgs
invokeJson
InvokeOptions
PermissionState
PluginListener
requestPermissions
Resource
SERIALIZE_TO_IPC_FN
transformCallback
dpi
@netwiv/api/dpi
LogicalPosition
LogicalSize
PhysicalPosition
PhysicalSize
Position
Size
event
@netwiv/api/event
emit
emitTo
Event
EventCallback
EventName
EventTarget
listen
once
Options
TauriEvent
UnlistenFn
image
@netwiv/api/image
Image
ImageSize
MenuIcon
transformImage
menu
@netwiv/api/menu
AboutMetadata
CheckMenuItem
CheckMenuItemOptions
IconMenuItem
IconMenuItemOptions
itemFromKind
Menu
MenuItem
MenuItemOptions
MenuOptions
NativeIcon
PredefinedMenuItem
PredefinedMenuItemOptions
Submenu
SubmenuOptions
path
@netwiv/api/path
appCacheDir
appConfigDir
appDataDir
appLocalDataDir
appLogDir
audioDir
BaseDirectory
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
plugins
Plugin modules
autostart
@netwiv/api/plugins/autostart
disable
enable
isEnabled
cli
@netwiv/api/plugins/cli
ArgMatch
CliMatches
getMatches
SubcommandMatch
clipboard-manager
@netwiv/api/plugins/clipboard-manager
clear
readImage
readText
writeHtml
writeImage
writeText
deep-link
@netwiv/api/plugins/deep-link
getCurrent
isRegistered
onOpenUrl
register
unregister
dialog
@netwiv/api/plugins/dialog
ask
confirm
ConfirmDialogOptions
DialogFilter
message
MessageDialogButtons
MessageDialogButtonsOk
MessageDialogButtonsOkCancel
MessageDialogButtonsYesNoCancel
MessageDialogCustomButtons
MessageDialogDefaultButtons
MessageDialogOptions
MessageDialogResult
open
OpenDialogOptions
OpenDialogReturn
save
SaveDialogOptions
fs
@netwiv/api/plugins/fs
BaseDirectory
copyFile
CopyFileOptions
create
CreateOptions
DebouncedWatchOptions
DirEntry
exists
ExistsOptions
FileHandle
FileInfo
lstat
mkdir
MkdirOptions
open
OpenOptions
readDir
ReadDirOptions
readFile
ReadFileOptions
readTextFile
readTextFileLines
remove
RemoveOptions
rename
RenameOptions
SeekMode
size
stat
StatOptions
truncate
TruncateOptions
UnwatchFn
watch
WatchEvent
WatchEventKind
WatchEventKindAccess
WatchEventKindCreate
WatchEventKindModify
WatchEventKindRemove
watchImmediate
WatchOptions
writeFile
WriteFileOptions
writeTextFile
global-shortcut
@netwiv/api/plugins/global-shortcut
isRegistered
register
ShortcutEvent
ShortcutHandler
unregister
unregisterAll
http
@netwiv/api/plugins/http
ClientOptions
DangerousSettings
fetch
Proxy
ProxyConfig
log
@netwiv/api/plugins/log
attachConsole
attachLogger
debug
error
info
LogLevel
LogOptions
trace
warn
notification
@netwiv/api/plugins/notification
isPermissionGranted
Options
PermissionState
requestPermission
sendNotification
opener
@netwiv/api/plugins/opener
openPath
openUrl
revealItemInDir
os
@netwiv/api/plugins/os
Arch
eol
exeExtension
Family
hostname
locale
OsType
Platform
type
version
positioner
@netwiv/api/plugins/positioner
handleIconState
moveWindow
moveWindowConstrained
Position
process
@netwiv/api/plugins/process
exit
relaunch
shell
@netwiv/api/plugins/shell
Child
ChildProcess
Command
CommandEvents
EventEmitter
IOPayload
open
OutputEvents
SpawnOptions
TerminatedPayload
sql
@netwiv/api/plugins/sql
default
QueryResult
store
@netwiv/api/plugins/store
getStore
LazyStore
load
ReloadOptions
Store
StoreOptions
stronghold
@netwiv/api/plugins/stronghold
AddressInfo
Client
ClientAccess
ClientPath
ConnectionLimits
Duration
Location
NetworkConfig
PeerAddress
Permissions
RecordPath
Store
StoreKey
Stronghold
Vault
VaultPath
upload
@netwiv/api/plugins/upload
download
HttpMethod
upload
websocket
@netwiv/api/plugins/websocket
CloseFrame
ConnectionConfig
default
Message
MessageKind
window-state
@netwiv/api/plugins/window-state
filename
restoreState
restoreStateCurrent
saveWindowState
StateFlags
resources
@netwiv/api/resources
Resource
tray
@netwiv/api/tray
MouseButton
MouseButtonState
TrayIcon
TrayIconClickEvent
TrayIconEvent
TrayIconEventBase
TrayIconEventType
TrayIconOptions
webview
@netwiv/api/webview
Color
DragDropEvent
getAllWebviews
getCurrentWebview
Webview
WebviewLabel
WebviewOptions
webview-window
@netwiv/api/webviewWindow
Color
DragDropEvent
getAllWebviewWindows
getCurrentWebviewWindow
WebviewWindow
WebviewWindowOptions
window
@netwiv/api/window
availableMonitors
BackgroundThrottlingPolicy
CloseRequestedEvent
Color
currentMonitor
CursorIcon
cursorPosition
DragDropEvent
Effect
EffectState
Effects
getAllWindows
getCurrentWindow
LogicalPosition
LogicalSize
Monitor
monitorFromPoint
PhysicalPosition
PhysicalSize
primaryMonitor
ProgressBarState
ProgressBarStatus
ScaleFactorChanged
ScrollBarStyle
Theme
TitleBarStyle
UserAttentionType
Window
WindowLabel
WindowOptions
WindowSizeConstraints
C# API reference
API reference
netwiv-core
NetWiv.Core
AboutMetadata
App
AppApi
AppCommandManifest
AppEvent
AppEvent<T>
AppHandle
AppMetadata
AssetRequest
AssetResponse
AuthorizationRequest
BackgroundThrottlingPolicy
BaseDirectory
Builder
BundleType
Capability
Channel
Channel<T>
CheckMenuItem
CheckMenuItemOptions
CloseRequestedEvent
CommandArgumentJson
CommandAttribute
CommandDescriptor
CommandHandler
CommandJsonContextAttribute
CommandRegistry
CursorIcon
DataStoreIdentifier
DragDropEvent
DragDropEventType
DragDroppedEvent
DragEnterEvent
DragLeaveEvent
DragOverEvent
Effect
Effects
EffectState
EmbeddedConfigMode
EventBus
FileScope
FileScopeEvent
FileScopeEventKind
FromServicesAttribute
GeneratedCommandRegistry
GeneratedPluginCommandRegistry
GeneratedPluginRegistry
GenerateFrontendBindingsAttribute
IconMenuItem
IconMenuItemOptions
IDesktopRuntime
IDpiPosition
IDpiSize
Image
ImageData
InvokeBody
InvokeContext
InvokeException
IPlugin
JsonValue
LogicalPosition
LogicalSize
Menu
MenuEvent
MenuIcon
MenuItem
MenuItemBase
MenuItemOptions
MenuOptions
Monitor
MouseButton
MouseButtonState
NativeIcon
PathApi
PermissionDefinition
PermissionScopeExtension
PhysicalPosition
PhysicalPosition<T>
PhysicalSize
PluginAttribute
PluginContext
PluginExportAttribute
PredefinedMenuItem
PredefinedMenuItemOptions
PredefinedMenuItemType
ProgressBarState
ProgressBarStatus
Request
ResizeDirection
Resource
ResourceTable
ResponseCommandDescriptor
ResponseCommandHandler
RgbaColor
RuntimeCommandContext
RuntimeCommandScope
RuntimeContext
RuntimeDocumentChange
RuntimeEvent
RuntimeEventTarget
RuntimeInvokeResponse
RuntimeMessage
ScaleFactorChanged
ScrollBarStyle
State<T>
Submenu
SubmenuOptions
Theme
TitleBarStyle
TrayIcon
TrayIconEvent
TrayIconEventType
TrayIconOptions
TrayIconRect
UriSchemeContext
UrlScopePattern
UserAttentionType
Webview
WebviewBuilder
WebviewOptions
WebviewWindow
WebviewWindowBuilder
Window
WindowBuilder
WindowOptions
WindowSizeConstraints
netwiv-hosting
NetWiv.Hosting
NetWivApplication
NetWivApplicationBuilder
netwiv-platform-desktop
NetWiv.Platform.Desktop
DesktopRuntime
netwiv-plugin-autostart
NetWiv.Plugin.Autostart
AutostartPlugin
netwiv-plugin-cli
NetWiv.Plugin.Cli
CliPlugin
netwiv-plugin-clipboardmanager
NetWiv.Plugin.ClipboardManager
ClipboardManagerPlugin
netwiv-plugin-deeplink
NetWiv.Plugin.DeepLink
DeepLinkPlugin
netwiv-plugin-dialog
NetWiv.Plugin.Dialog
DialogPlugin
netwiv-plugin-fs
NetWiv.Plugin.Fs
FsPlugin
netwiv-plugin-globalshortcut
NetWiv.Plugin.GlobalShortcut
GlobalShortcutPlugin
netwiv-plugin-http
NetWiv.Plugin.Http
HttpPlugin
netwiv-plugin-localhost
NetWiv.Plugin.Localhost
LocalhostPlugin
LocalhostRequest
LocalhostResponse
netwiv-plugin-log
NetWiv.Plugin.Log
LogPlugin
netwiv-plugin-notification
NetWiv.Plugin.Notification
NotificationPlugin
netwiv-plugin-opener
NetWiv.Plugin.Opener
OpenerPlugin
netwiv-plugin-os
NetWiv.Plugin.Os
OsPlugin
netwiv-plugin-persistedscope
NetWiv.Plugin.PersistedScope
PersistedScopePlugin
netwiv-plugin-positioner
NetWiv.Plugin.Positioner
PositionerPlugin
netwiv-plugin-process
NetWiv.Plugin.Process
ProcessPlugin
netwiv-plugin-shell
NetWiv.Plugin.Shell
ShellPlugin
netwiv-plugin-singleinstance
NetWiv.Plugin.SingleInstance
SingleInstancePlugin
netwiv-plugin-sql
NetWiv.Plugin.Sql
SqlMigration
SqlPlugin
netwiv-plugin-store
NetWiv.Plugin.Store
StorePlugin
netwiv-plugin-stronghold
NetWiv.Plugin.Stronghold
StrongholdPlugin
netwiv-plugin-upload
NetWiv.Plugin.Upload
UploadPlugin
netwiv-plugin-websocket
NetWiv.Plugin.Websocket
WebsocketPlugin
netwiv-plugin-windowstate
NetWiv.Plugin.WindowState
StateFlags
WindowStatePlugin
GitHub
Select theme
Dark
Light
Auto
Select language
English
한국어
Getting started with NetWiv
Follow the
package quickstart
to create, run and publish a NetWiv application.
