Skip to content
PHIALS
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Phials
Plugin SDK
Phoundry UI
Phials plugin documentation
Get started
Get started
Understand Phials plugins
Understand Phials plugins
What can plugins add to Phials?
Understand plugins, capabilities, and providers
Understand the plugin lifecycle
Understand the public SDK and trust boundary
Build your first plugin
Build your first plugin
Create a plugin project from the starter
Set your plugin identity
Build and run your plugin locally
Make and reload your first change
Use Svelte and Phoundry UI
Use Svelte and Phoundry UI
Build plugin components with Svelte 5
Use Phoundry UI components
Style and theme plugin interfaces
Design responsive and accessible plugin surfaces
Add capabilities
Add capabilities
Add commands
Add commands
Define and register a command
Use command context and availability
Make commands discoverable and add shortcuts
Place commands in context menus
Build nested and custom command controls
Build file viewers and editors
Build file viewers and editors
Match files to a viewer or editor
Build a responsive file surface
Add thumbnails and toolbar controls
Share viewer state with a preview session
Support File mode and Markdown embeds
Save edited files safely
Extract file metadata
Extract file metadata
Match files for metadata extraction
Extract and namespace file metadata
Define metadata fields and display formats
Control metadata columns and automatic visibility
Build file views
Build file views
Define and register a file view
Render files, selection, and navigation
Add view columns and sorting
Add file-view configuration controls
Set view defaults and Workspace Folder availability
Add panels and tabs
Add panels and tabs
Define and place a panel or tab
Manage instances and persisted state
Open or focus center tabs
Identify and replace center tabs
Finalize unsaved work before close or replacement
Add titles, icons, shortcuts, and tab menus
Add plugin settings
Add plugin settings
Define plugin settings
Read and update plugin settings
Build a custom settings interface
Create themes
Create themes
Add a theme to a plugin
Define theme metadata and modes
Style a theme with Phoundry UI tokens
Package and test theme release artifacts
Work with Phials
Work with Phials
Work with files and folders
Work with files and folders
Work with paths and file entries
Let users choose and read folders
Read and write text files safely
Create, rename, and trash files and folders
Watch folders for changes
Open and reveal files and folders
Inspect Git repositories
Use app and Explorer context
Use app and Explorer context
Understand runtime API scopes
Use Explorer pane context
Read Phials app settings
Call approved host commands
Store plugin data
Store plugin data
Choose between settings, storage, and a database
Store key-value plugin data
Define a plugin database schema
Query and update plugin database tables
Handle plugin data lifecycle and removal
Respond to events
Respond to events
Listen for Phials events
Define and emit plugin events
Manage subscriptions and asynchronous handlers
Show dialogs and notifications
Show dialogs and notifications
Confirm consequential actions
Ask for text or a choice
Show alerts and notifications
Test and troubleshoot
Test and troubleshoot
Run your plugin locally
Run your plugin locally
Install a development plugin locally
Rebuild and reload plugin changes
Test activation, restart, and persisted state
Test and validate your plugin
Test and validate your plugin
Type-check your plugin project
Test plugin logic and interfaces
Build and validate release artifacts
Verify permissions and runtime compatibility
Debug plugin failures
Debug plugin failures
Fix a plugin that will not load or activate
Fix missing or unavailable plugin capabilities
Fix plugin interface and rendering failures
Fix permission and Plugin API failures
Recover plugin settings and data
Collect diagnostics for unresolved failures
Package and publish
Package and publish
Configure the plugin manifest
Configure the plugin manifest
Create and synchronize a plugin manifest
Choose a stable plugin ID and public metadata
Declare Phials and Plugin API compatibility
Request the least plugin permissions
Validate a plugin manifest
Prepare a release
Prepare a release
Choose a plugin release version
Build a complete release artifact set
Document changes and new permissions
Verify a release candidate
Publish your plugin
Publish your plugin
Publish a GitHub release
Submit your plugin to the community registry
Verify the published installation
Maintain a published plugin
Maintain a published plugin
Publish a plugin update
Change permissions and compatibility safely
Migrate plugin settings and data
Recover from a broken release
Transfer, deprecate, or unlist a plugin
Reference
Reference
Plugin contract and compatibility
Plugin contract and compatibility
Public SDK support contract
Plugin lifecycle reference
Version and compatibility reference
Community plugin trust model
Manifest and permissions reference
Manifest and permissions reference
Plugin manifest field reference
Plugin permission reference
Permission-gated Plugin API operations
Approved host command reference
Events reference
Events reference
Phials event catalog
Plugin event naming and payload reference
Event delivery and cleanup reference
SDK type reference
SDK type reference
BooleanSettingsField
ClipboardAPI
ColumnLayoutChangedPayload
Command
CommandContext
CommandContextKey
CommandPlacement
CommandPlacementArea
CommandPlacementBase
CommandProvider
CommandShortcut
compareSemver
ContextMenuPlacementConfig
CoreEvents
DatabaseExecuteResult
definePlugin
definePluginManifest
DirectoryMetadataProfile
DirectoryMetadataProfileOptions
EditorHistoryHandle
EventHandler
EventMap
EventPayload
EventsAPI
EventSubscription
ExplorerAPI
ExtractedMetadata
FileBrowserViewProps
FileBrowserViewProvider
FileCategory
FileEntry
FileMatchAPI
FileMetadata
FileUtilsAPI
FilterValueOption
FolderSummary
GitAPI
GitBranch
GitCommit
GitDiffOptions
GitFileStatus
GitInfo
GitLogOptions
ItemShortcutConfig
JsonValue
KnownWorkspaceFolder
LayoutSettledPayload
LayoutSettledReason
manifestIdentity
MetadataAPI
MetadataColumnPolicy
MetadataProvider
MetadataProviderDirectoryStats
MetadataSchema
MetadataSchemaField
ModalAPI
ModuleAPI
ModuleInstance
ModuleOpenResult
ModulePosition
ModuleProvider
ModuleProviderProps
ModulesAPI
NotifyAPI
NumberSettingsField
parseManifest
PathSettingsField
PERMISSION_DESCRIPTIONS
PERMISSION_RISK
PhialsPlugin
PlatformShortcuts
PluginAPI
PluginBinaryFileSnapshot
PluginBinaryWriteResult
PluginCandidateIdentity
PluginColumnDefinition
PluginColumnType
PluginDatabaseAPI
PluginDatabaseMigration
PluginDatabaseSchema
PluginDatabaseSchemaOperations
PluginDatabaseTransaction
PluginDirectoryReadResult
PluginDirectoryWatch
PluginEvents
PluginFileError
PluginFileErrorCode
PluginFileFailure
PluginIdentity
PluginIdentityProjection
PluginIndexDefinition
PluginManifest
PluginPaneColumn
PluginPaneContext
PluginPaneListing
PluginPaneNavigation
PluginPaneSelection
PluginPaneSort
PluginPaneView
PluginPaneWorkspaceFolder
PluginPathOutcome
PluginPermission
PluginPreparedWrite
PluginProvider
PluginSecretsAPI
PluginSettings
PluginSettingsChange
PluginSettingsComponentProps
PluginSettingsSchema
PluginSettingsSubscription
PluginStorageAPI
PluginTableDefinition
PluginTextFileSnapshot
PluginTextWriteResult
PreviewAPI
PreviewDestination
PreviewDestinationCapabilities
PreviewProvider
PreviewSession
PreviewSessionFactoryProps
PreviewSurfaceProps
PreviewToolbarContributionProps
PreviewToolbarEditorState
ProviderType
RawMetadata
ReadonlyAppSettings
RepositoryLanguage
satisfiesMinVersion
SelectSettingsField
SettingsField
SettingsFieldBase
SettingsFieldType
ShortcutDefinition
StringSettingsField
SUPPORTED_PLUGIN_API_VERSION
ThumbnailContentAccess
ThumbnailContentSnapshot
ThumbnailDirectorySelection
ThumbnailHostFeature
ThumbnailInputDeclaration
ThumbnailIntrinsicDimensions
ThumbnailNativeAccess
ThumbnailNativeResult
ThumbnailProvider
ThumbnailRasterFormat
ThumbnailRenderContext
ThumbnailRenderResult
validateIdentityProjections
validateManifest
validatePluginId
validateSemver
ValidationResult
ViewAPI
ViewColumnDefinition
ViewItemSizePreset
WorkspaceFolderCalendarValue
WorkspaceFolderFileRef
WorkspaceFolderPropertyDefinition
WorkspaceFolderPropertyOption
WorkspaceFolderPropertyType
WorkspaceFolderPropertyValue
WorkspaceFolderPropertyWrite
WorkspaceFoldersAPI
WorkspaceFolderSchema
GitHub
Select theme
Dark
Light
Auto
WorkspaceFolderPropertyValue
Since Plugin API:
1.0.0
Signature
type
WorkspaceFolderPropertyValue
=
JsonValue
;
Related declarations
JsonValue