Skip to content

Obsidian Libv4.3.0

Select theme

Guides
API reference
- active-file-provider
- app
  - Overview
  - getApp
- async-with-notice
- attachment-path
- attachment-unit-folder
- backlink
- backlink-index
  - Overview
  - getIndexedBacklinksForFile
- bases-view-registrar
- callout
- canvas
  - Overview
  - getCanvasReferences
- case-insensitive-file-index
- code-block-markdown-information
  - Overview
  - CodeBlockMarkdownInformation
- code-block-reg-exp
  - Overview
  - createCodeBlockRegExp
- codemirror
  - state-field-spec
    Overview
    StateFieldSpec
- command-handlers
  - abstract-file-command-handler
    Overview
    AbstractFileCommandHandler
    AbstractFileCommandHandlerConstructorParams
    AbstractFileCommandHandlerHandleAbstractFileMenuParams
    AbstractFileCommandHandlerHandleAbstractFilesMenuParams
    AbstractFileCommandHandlerShouldAddToAbstractFileMenuParams
    AbstractFileCommandHandlerShouldAddToAbstractFilesMenuParams
  - command-handler
    Overview
    CommandHandler
    CommandHandlerConstructorParams
    CommandHandlerRegistrationContext
  - command-handler-component
    Overview
    CommandHandlerComponent
    CommandHandlerFactory
  - editor-command-handler
    Overview
    EditorCommandHandler
    EditorCommandHandlerConstructorParams
    EditorCommandHandlerEditorCheckCallbackParams
    EditorCommandHandlerHandleEditorMenuParams
    EditorCommandHandlerHandleViewportMenuParams
  - file-command-handler
    Overview
    FileCommandHandler
    FileCommandHandlerShouldAddToFileMenuParams
    FileCommandHandlerShouldAddToFilesMenuParams
  - folder-command-handler
    Overview
    FolderCommandHandler
    FolderCommandHandlerShouldAddToFolderMenuParams
    FolderCommandHandlerShouldAddToFoldersMenuParams
  - global-command-handler
    Overview
    GlobalCommandHandler
  - open-demo-vault-command-handler
    Overview
    OpenDemoVaultCommandHandler
    OpenDemoVaultCommandHandlerConstructorParams
  - open-settings-command-handler
    Overview
    OpenSettingsCommandHandler
    OpenSettingsCommandHandlerConstructorParams
  - unlock-active-note-command-handler
    Overview
    UnlockActiveNoteCommandHandler
    UnlockActiveNoteCommandHandlerConstructorParams
- command-registrar
- community-plugins
- components
  - abort-signal-component
    Overview
    AbortSignalComponent
  - all-windows-event-component
    Overview
    AllWindowsEventComponent
    AllWindowsEventComponentRegisterAllDocumentsDomEventParams
    AllWindowsEventComponentRegisterAllWindowsDomEventParams
  - async-error-handler-component
    Overview
    AsyncErrorHandlerComponent
  - async-events-component
    Overview
    registerAsyncEvent
  - case-insensitive-file-index-component
    Overview
    CaseInsensitiveFileIndexComponent
  - component-ex
    Overview
    ComponentEx
  - console-debug-component
    Overview
    ConsoleDebugComponent
  - core-plugin-toggle-component
    Overview
    CorePluginToggleComponent
    CorePluginToggleComponentConstructorParams
  - disposable-component
    Overview
    asDisposableComponent
  - embed-extensions-component
    Overview
    EmbedExtensionsComponent
  - generate-markdown-link-default-params-component
    Overview
    GenerateMarkdownLinkDefaultParamsComponent
    GenerateMarkdownLinkDefaultParamsComponentConstructorParams
  - layout-ready-component
    Overview
    CallbackLayoutReadyComponent
    LayoutReadyComponent
  - menu-event-registrar-component
    Overview
    MenuEventRegistrarComponent
  - monkey-around-component
    Overview
    around
    Factories
    FunctionKeys
    hasPatchToken
    MethodKeys
    MonkeyAroundComponent
    MonkeyAroundComponentRegisterFunctionPatchParams
    MonkeyAroundComponentRegisterMethodPatchParams
    PatchHandlerFunction
    PatchHandlerParams
    PostPatchHandlerFunction
    PostPatchHandlerParams
  - notebook-navigator-menu-event-registrar-component
    Overview
    NotebookNavigatorMenuEventRegistrarComponent
    NotebookNavigatorMenuEventRegistrarComponentConstructorParams
  - plugin-context-component
    Overview
    PluginContextComponent
  - plugin-gate-component
    Overview
    PluginConflict
    PluginConflictSeverity
    PluginDependency
    PluginGateComponent
    PluginGateComponentConstructorParams
  - plugin-notice-component
    Overview
    PluginNoticeCloseClickEvent
    PluginNoticeComponent
    PluginNoticeComponentDelayedNotice
    PluginNoticeComponentShowNoticeAfterDelayParams
    PluginNoticeComponentShowNoticeOptions
    PluginNoticeHideInfo
    PluginNoticeMode
  - plugin-settings-component
    Overview
    PluginSettingsComponentBase
    PluginSettingsComponentBaseConstructorParams
    PluginSettingsComponentBaseOnSaveSettingsParams
    PluginSettingsState
    ReadonlyPluginSettings
    ReadonlyPluginSettingsState
    SettingsValidator
  - plugin-settings-tab-component
    Overview
    PluginSettingsTabComponent
  - plugin-suggestion-component
    Overview
    PluginSuggestionComponent
    PluginSuggestionComponentConstructorParams
    SuggestedPluginState
  - pointer-position-component
    Overview
    PointerPositionComponent
  - registry-component
    Overview
    RegistryComponent
  - release-notes-component
    Overview
    ReleaseNotes
    ReleaseNotesComponent
    ReleaseNotesComponentConstructorParams
  - rename-delete-handler-component
    Overview
    GetRescuePathParams
    RenameDeleteHandlerComponent
    RenameDeleteHandlerSettings
  - rmdir-guard-component
    Overview
    NOT_EMPTY_DIRECTORY_ERROR_CODE
    RmdirGuardComponent
  - settings-migration-component
    Overview
    SettingsMigrationComponent
    SettingsMigrationComponentConstructorParams
  - syntax-highlighting-component
    Overview
    SyntaxHighlightingComponent
    SyntaxHighlightingComponentGrammarFactoryParams
    SyntaxHighlightingComponentGrammarSource
    SyntaxHighlightingComponentRegisterCodeBlockLanguageParams
    SyntaxHighlightingComponentRegisterPrismLanguageParams
  - templates-language-component
    Overview
    TemplatesLanguageComponent
    TemplatesLanguageComponentConstructorParams
    TemplatesLanguageComponentFormatSource
- constructors
  - get-dom-events-handlers-constructor
    Overview
    getDomEventsHandlersConstructor
- css-class
  - Overview
  - CssClass
- data-handler
- dataview
- dataview-link
- debug
  - Overview
  - getObsidianLibDebugger
- demo-vault-helper
- demo-vault-helper-settings
  - Overview
  - DemoVaultHelperSettings
- demo-vault-naming
- desktop-demo-vault-opener
- desktop-trusted-input
- editor
- editor-extension-registrar
- editor-suggest-registrar
- events
- extensions-registrar
- file-change
- file-explorer
- file-manager
- file-system
- folder-note
- frontmatter
- frontmatter-formatting
- frontmatter-link-cache-with-offsets
- generated-during-build
- hover-link-source-registrar
- html-element
- i18n
  - custom-type-options
    Overview
    CustomTypeOptionsBase
    CustomTypeOptionsResources
  - default-translations
    Overview
    DefaultTranslationsBase
  - i18n
    Overview
    DEFAULT_NS
    initI18N
    t
    TranslationsMap
  - locales
    en
    Overview
    en
    translations-map
    Overview
    DEFAULT_LANGUAGE
    defaultTranslationsMap
- is-in-obsidian
  - Overview
  - isInObsidian
- library
- library-styles
- link
- link-name
  - Overview
  - normalizeLinkName
- link-update-progress
- logger
- loop
- markdown
- markdown-code-block-processor
- markdown-code-block-processor-registrar
- markdown-post-processor-registrar
- markdown-view
  - Overview
  - getFullContentHtml
- menu-event-registrar
- metadata-cache
- mobile-trusted-input
- modals
  - alert
    Overview
    alert
    AlertParams
  - confirm
    Overview
    confirm
    ConfirmParams
  - minimizable-modal
    Overview
    MinimizableModal
    MinimizableModalConstructorOptions
  - modal
    Overview
    ModalBase
    ModalBaseConstructorParams
    ModalParamsBase
    showModal
  - modal-command-builder
    Overview
    CheckboxCommand
    CommandBase
    DropDownCommand
    KeyboardCommand
    ModalCommandBuilder
    ModalCommandBuilderBuildOptions
    ModalCommands
    ModalCommandsHost
    ModalCommandsRenderMode
    ModalCommandsTarget
  - prompt
    Overview
    prompt
    PromptParams
  - select-item
    Overview
    selectItem
    SelectItemParams
  - select-option
    Overview
    selectOption
    SelectOptionItem
    SelectOptionParams
  - suggest-modal-command-builder
    Overview
    SuggestModalCommandBuilder
    SuggestModalCommandBuilderBuildOptions
- note-priority
- notebook-navigator
- obsidian-dev-utils-state
- obsidian-protocol-handler-registrar
- obsidian-settings
- parse-link
- path-settings
- pdf
  - Overview
  - printToPdf
- plugin
- plugin-cli-handler-registrar
- popovers
  - field-popover
    Overview
    editFieldsInPopover
    EditFieldsInPopoverParams
    PopoverField
  - popover
    Overview
    PopoverValueGetter
    showPopover
    ShowPopoverBuildParams
    ShowPopoverParams
  - popover-anchor
    Overview
    createAnchorFromDocumentCenter
    createAnchorFromElement
    createAnchorFromPoint
    createAnchorFromSelection
    PopoverAnchor
- property-entry
- queue
- react
  - app-context
    Overview
    AppContext
    useApp
- reference
- resource-lock
- resource-url
- ribbon-icon-registrar
- setting-components
  - checkbox-component
    Overview
    CheckboxComponent
  - code-highlighter-component
    Overview
    CodeHighlighterComponent
  - date-component
    Overview
    DateComponent
  - date-time-component
    Overview
    DateTimeComponent
  - email-component
    Overview
    EmailComponent
  - file-component
    Overview
    FileComponent
  - month-component
    Overview
    IsoMonth
    MonthComponent
  - multiple-dropdown-component
    Overview
    MultipleDropdownComponent
  - multiple-email-component
    Overview
    MultipleEmailComponent
  - multiple-file-component
    Overview
    MultipleFileComponent
  - multiple-text-component
    Overview
    MultipleTextComponent
  - number-component
    Overview
    NumberComponent
  - password-component
    Overview
    PasswordComponent
  - setting-component-wrapper
    Overview
    ensureWrapped
  - telephone-component
    Overview
    TelephoneComponent
  - text-based-component
    Overview
    getTextBasedComponentValue
    TextBasedComponent
  - time-component
    Overview
    TimeComponent
  - tri-state-checkbox-component
    Overview
    TriStateCheckboxComponent
  - typed-dropdown-component
    Overview
    TypedDropdownComponent
  - typed-multiple-dropdown-component
    Overview
    TypedMultipleDropdownComponent
  - typed-range-text-component
    Overview
    TypedRangeTextComponent
  - typed-text-component
    Overview
    TypedTextComponent
    TypedTextComponentConstructorParams
  - url-component
    Overview
    UrlComponent
  - validator-component
    Overview
    getValidatorComponent
    ValidatorComponent
  - value-component-with-change-tracking
    Overview
    ValueComponentWithChangeTracking
  - week-component
    Overview
    IsoWeek
    WeekComponent
- setting-ex
- setting-group-ex
  - Overview
  - SettingGroupEx
- status-bar-item-registrar
- templater
- transformers
  - duration-transformer
    Overview
    DurationTransformer
- trusted-input
- validation
- vault
- vault-delete
- vault-transaction
- view-registrar
- workspace

Select theme

On this page

Overview

On this page

Overview

PluginApiRef.whenAvailable

PluginApiRef › whenAvailable

Type: (options?: WhenAvailablePluginApiOptions) => Promise<TApi>

Waits for the API to become available.