API reference
The complete API reference for @mnaoumov/obsidian-lib, generated from its TSDoc. Each module below maps to an import subpath (e.g. the active-file-provider module is @mnaoumov/obsidian-lib/active-file-provider).
Modules
Section titled “Modules”- active-file-provider
- app
- async-with-notice
- attachment-path
- attachment-unit-folder
- backlink
- backlink-index
- bases-view-registrar
- callout
- canvas
- case-insensitive-file-index
- code-block-markdown-information
- code-block-reg-exp
- codemirror/state-field-spec
- command-handlers/abstract-file-command-handler
- command-handlers/command-handler
- command-handlers/command-handler-component
- command-handlers/editor-command-handler
- command-handlers/file-command-handler
- command-handlers/folder-command-handler
- command-handlers/global-command-handler
- command-handlers/open-demo-vault-command-handler
- command-handlers/open-settings-command-handler
- command-handlers/unlock-active-note-command-handler
- command-registrar
- community-plugins
- components/abort-signal-component
- components/all-windows-event-component
- components/async-error-handler-component
- components/async-events-component
- components/case-insensitive-file-index-component
- components/component-ex
- components/console-debug-component
- components/core-plugin-toggle-component
- components/disposable-component
- components/embed-extensions-component
- components/generate-markdown-link-default-params-component
- components/layout-ready-component
- components/menu-event-registrar-component
- components/monkey-around-component
- components/notebook-navigator-menu-event-registrar-component
- components/plugin-context-component
- components/plugin-gate-component
- components/plugin-notice-component
- components/plugin-settings-component
- components/plugin-settings-tab-component
- components/plugin-suggestion-component
- components/pointer-position-component
- components/registry-component
- components/release-notes-component
- components/rename-delete-handler-component
- components/rmdir-guard-component
- components/settings-migration-component
- components/syntax-highlighting-component
- components/templates-language-component
- constructors/get-dom-events-handlers-constructor
- css-class
- data-handler
- dataview
- dataview-link
- debug
- demo-vault-helper
- demo-vault-helper-settings
- 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
- i18n/default-translations
- i18n/i18n
- i18n/locales/en
- i18n/locales/translations-map
- is-in-obsidian
- library
- library-styles
- link
- link-name
- link-update-progress
- logger
- loop
- markdown
- markdown-code-block-processor
- markdown-code-block-processor-registrar
- markdown-post-processor-registrar
- markdown-view
- menu-event-registrar
- metadata-cache
- mobile-trusted-input
- modals/alert
- modals/confirm
- modals/minimizable-modal
- modals/modal
- modals/modal-command-builder
- modals/prompt
- modals/select-item
- modals/select-option
- modals/suggest-modal-command-builder
- note-priority
- notebook-navigator
- obsidian-dev-utils-state
- obsidian-protocol-handler-registrar
- obsidian-settings
- parse-link
- path-settings
- plugin-cli-handler-registrar
- plugin/plugin
- plugin/plugin-api
- plugin/plugin-context
- plugin/plugin-event-source
- plugin/plugin-install-state
- plugin/plugin-lifecycle-events
- plugin/plugin-settings-tab
- plugin/settings-migration-api
- popovers/field-popover
- popovers/popover
- popovers/popover-anchor
- property-entry
- queue
- react/app-context
- reference
- resource-lock
- resource-url
- ribbon-icon-registrar
- setting-components/checkbox-component
- setting-components/code-highlighter-component
- setting-components/date-component
- setting-components/date-time-component
- setting-components/email-component
- setting-components/file-component
- setting-components/month-component
- setting-components/multiple-dropdown-component
- setting-components/multiple-email-component
- setting-components/multiple-file-component
- setting-components/multiple-text-component
- setting-components/number-component
- setting-components/password-component
- setting-components/setting-component-wrapper
- setting-components/telephone-component
- setting-components/text-based-component
- setting-components/time-component
- setting-components/tri-state-checkbox-component
- setting-components/typed-dropdown-component
- setting-components/typed-multiple-dropdown-component
- setting-components/typed-range-text-component
- setting-components/typed-text-component
- setting-components/url-component
- setting-components/validator-component
- setting-components/value-component-with-change-tracking
- setting-components/week-component
- setting-ex
- setting-group-ex
- status-bar-item-registrar
- templater
- transformers/duration-transformer
- trusted-input
- validation
- vault
- vault-delete
- vault-transaction
- view-registrar
- workspace