AI Notice: Most documentation right now was auto-generated by an LLM. Handwritten documentation will be implemented over time on the road to 1.0
Type references
Stable public TypeScript types from the plugin SDK.
For narrative guides on implementing each provider kind, see Provider types.
Container
Provider union
Preview
- PreviewProvider
- PreviewProviderProps
- ThumbnailProviderProps
- FullscreenProviderProps
- ProviderQuickAction (not found in current sources)
Context (legacy)
Metadata
- MetadataProvider
- RawMetadata
- ExtractedMetadata
- FileMetadata
- MetadataSchemaField
- MetadataSchema
- MetadataColumnPolicy
- DirectoryMetadataProfileOptions
- MetadataProviderDirectoryStats
- DirectoryMetadataProfile
Toolbar (legacy)
- ToolbarButtonProvider
- ToolbarContext
- ToolbarSubToolbarProps
- ToolbarButtonDefinition
- ToolbarButtonGroupDefinition
- ToolbarButtonDropdownDefinition
- ToolbarDropdownItem
View
Theme
Selection (deprecated)
Module
Settings / database
- PluginSettingsSchema
- SettingsField
- SettingsFieldType
- BooleanSettingsField
- StringSettingsField
- NumberSettingsField
- SelectSettingsField
- PathSettingsField
- PluginDatabaseSchema
- PluginTableDefinition
- PluginColumnDefinition
- PluginIndexDefinition
- PluginColumnType
Base and scoped APIs
- PluginAPI
- PreviewAPI
- ContextAPI
- MetadataAPI
- SelectionActionAPI
- PluginSettings
- PluginStorageAPI
- PluginDatabaseAPI
- DatabaseExecuteResult
- ReadonlyAppSettings
- ModalAPI
- NotifyAPI
- FileUtilsAPI
- FileMatchAPI
- EventsAPI
- SelectionAPI
- ClipboardAPI
- FileOpsAPI
- SelectionFileOpsAPI
- ViewAPI
Commands
- CommandContextKey
- CommandContext
- CommandShortcut
- CommandPlacementArea
- CommandPlacementBase
- ToolbarPlacementConfig
- HeaderBarPlacementConfig
- ContextMenuPlacementConfig
- SelectionBarPlacementConfig
- CommandPlacement
- Command
- CommandProvider