@mnaoumov/obsidian-lib 10.5.1 → 10.6.0

package/dist/lib/cjs/settings-tabs.d.cts

@@ -0,0 +1,101 @@
+/// <reference path="./library-references.d.cts" />
+/// <reference lib="dom" />
+/**
+ * @file
+ *
+ * Tabbed sections inside a plugin's settings.
+ */
+/**
+ * A tab of {@link SettingsTabs}.
+ */
+export interface SettingsTab {
+    /**
+     * The name of an Obsidian icon shown before the name.
+     */
+    readonly icon?: string;
+    /**
+     * The id of the tab, unique among the tabs.
+     */
+    readonly id: string;
+    /**
+     * The name shown on the tab button.
+     */
+    readonly name: string;
+    /**
+     * Renders the tab's settings into the panel, which is empty each time the tab is selected.
+     *
+     * @param containerEl - The panel.
+     */
+    readonly render: (containerEl: HTMLElement) => void;
+}
+/**
+ * Tabbed sections inside a plugin's settings: a row of tab buttons and one panel, which renders only the selected tab.
+ * The arrow keys, Home and End move between tabs, as in the WAI-ARIA tabs pattern.
+ *
+ * ```ts
+ * public override display(): void {
+ *   this.containerEl.empty();
+ *   new SettingsTabs(this.containerEl)
+ *     .addTab({ id: 'general', name: 'General', render: (el) => this.renderGeneral(el) })
+ *     .addTab({ id: 'advanced', name: 'Advanced', render: (el) => this.renderAdvanced(el) })
+ *     .selectTab(this.lastTabId)
+ *     .onTabChange((tabId) => {
+ *       this.lastTabId = tabId;
+ *     });
+ * }
+ * ```
+ *
+ * In order to add the styles for the component, use {@link initPluginContext} in your plugin's `onload()` function.
+ *
+ * Alternatively, you can copy styles from {@link https://unpkg.com/@mnaoumov/obsidian-lib/dist/styles.css}.
+ */
+export declare class SettingsTabs {
+    /**
+     * The panel the selected tab renders into.
+     */
+    readonly panelEl: HTMLElement;
+    /**
+     * The row of tab buttons.
+     */
+    readonly tabBarEl: HTMLElement;
+    private changeCallback?;
+    private readonly entries;
+    private selectedTabId;
+    /**
+     * Creates new settings tabs.
+     *
+     * @param containerEl - The container element.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Adds a tab. The first tab added is selected.
+     *
+     * @param tab - The tab.
+     * @returns The tabs.
+     * @throws If a tab with the same id was already added.
+     */
+    addTab(tab: SettingsTab): this;
+    /**
+     * Gets the id of the selected tab.
+     *
+     * @returns The id, or `null` before any tab is added.
+     */
+    getSelectedTabId(): null | string;
+    /**
+     * Sets the callback to be called when the user selects another tab.
+     *
+     * @param callback - The callback, given the id of the selected tab.
+     * @returns The tabs.
+     */
+    onTabChange(callback: (tabId: string) => void): this;
+    /**
+     * Selects a tab and renders it into the panel. An unknown id, such as a stored id whose tab was since removed, leaves
+     * the selection as it is.
+     *
+     * @param tabId - The id of the tab.
+     * @returns The tabs.
+     */
+    selectTab(tabId: null | string | undefined): this;
+    private findEntry;
+    private onKeyDown;
+}

package/dist/lib/esm/__merged.d.mts

@@ -1,5 +1,6 @@
 /// <reference path="./library-references.d.mts" />
 export { AppActiveFileProvider } from './active-file-provider.mjs';
+export { AnchoredSuggest } from './anchored-suggest.mjs';
 export { getApp } from './app.mjs';
 export { retryWithTimeoutNotice, runWithTimeoutNotice } from './async-with-notice.mjs';
 export { AttachmentPathContext, CUSTOM_ATTACHMENT_LOCATION_PLUGIN_ID, DUMMY_PATH, getAttachmentFilePath, getAttachmentFolderPath, getAttachmentFolderPathForAttachment, getAttachmentFolderPathSyncOrNull, getAvailablePathForAttachments, getCheckIsAttachmentUnitFolderFunction, hasOwnAttachmentFolder, isAtProperAttachmentPath } from './attachment-path.mjs';
@@ -14,9 +15,12 @@ export { CalloutMode, renderCallout, wrapForCallout } from './callout.mjs';
 export { getCanvasReferences } from './canvas.mjs';
 export { CaseInsensitiveFileIndex, getCaseInsensitiveFileIndex, setCaseInsensitiveFileIndex, unsetCaseInsensitiveFileIndex } from './case-insensitive-file-index.mjs';
 export { createCodeBlockRegExp } from './code-block-reg-exp.mjs';
+export { captureCodeBlockFocus, claimCodeBlockRenderHandoff, CODE_BLOCK_RENDER_HANDOFF_LIFETIME_IN_MILLISECONDS, recordCodeBlockRenderHandoff, restoreCodeBlockFocus } from './code-block-render-handoff.mjs';
 export { createIncrementalParseStateField } from './codemirror/incremental-parse-state-field.mjs';
+export { createInlineTokenWidgetsExtension, execAll, toGlobalRegExp } from './codemirror/inline-token-widgets.mjs';
 export { dispatchToAllMarkdownEditorViews, getAllMarkdownEditorViews } from './codemirror/markdown-editor-views.mjs';
 export { rangeSetToArray } from './codemirror/range-set.mjs';
+export { createSettingsFacet } from './codemirror/settings-facet.mjs';
 export { AbstractFileCommandHandler } from './command-handlers/abstract-file-command-handler.mjs';
 export { CommandHandlerComponent } from './command-handlers/command-handler-component.mjs';
 export { CommandHandler } from './command-handlers/command-handler.mjs';
@@ -62,6 +66,7 @@ export { RegistryComponent } from './components/registry-component.mjs';
 export { ReleaseNotesComponent } from './components/release-notes-component.mjs';
 export { EmptyFolderBehavior, RenameDeleteHandlerComponent } from './components/rename-delete-handler-component.mjs';
 export { NOT_EMPTY_DIRECTORY_ERROR_CODE, RmdirGuardComponent } from './components/rmdir-guard-component.mjs';
+export { SettingsFacetComponent } from './components/settings-facet-component.mjs';
 export { SettingsMigrationComponent } from './components/settings-migration-component.mjs';
 export { SyntaxHighlightingComponent } from './components/syntax-highlighting-component.mjs';
 export { TemplatesLanguageComponent } from './components/templates-language-component.mjs';
@@ -81,8 +86,10 @@ export { getDemoVaultArchiveFileName, getDemoVaultFolderName } from './demo-vaul
 export { BulkOperationGitRepo, GitCommandError } from './desktop-bulk-operation-git.mjs';
 export { openDemoVault } from './desktop-demo-vault-opener.mjs';
 export { getDesktopOperatingSystem } from './desktop-operating-system.mjs';
+export { openDesktopRequestUrlStream } from './desktop-request-url-stream.mjs';
 export { PluginEditorExtensionRegistrar } from './editor-extension-registrar.mjs';
 export { PluginEditorSuggestRegistrar } from './editor-suggest-registrar.mjs';
+export { CommandEditorSuggest, prioritizeEditorSuggest } from './editor-suggest.mjs';
 export { syncOpenEditorBuffersForPath, toggleEditorReadOnly } from './editor.mjs';
 export { EventRefDisposable, subscribeDisposableEvent, subscribeEvent } from './events.mjs';
 export { PluginExtensionsRegistrar } from './extensions-registrar.mjs';
@@ -95,14 +102,17 @@ export { enableFrontmatterFormattingPreservation, preserveFrontmatterFormatting
 export { isFrontmatterLinkCacheWithOffsets, toFrontmatterLinkCacheWithOffsets } from './frontmatter-link-cache-with-offsets.mjs';
 export { checkIsPlainObject, parseFrontmatter, registerFrontmatterFormattingPreserver, removeEmptyFrontmatterValues, setFrontmatter } from './frontmatter.mjs';
 export { LIBRARY_STYLES, LIBRARY_VERSION } from './generated-during-build.mjs';
+export { formatHotkey, getHotkeyFromKeyboardEvent, isSameHotkey } from './hotkey.mjs';
 export { PluginHoverLinkSourceRegistrar } from './hover-link-source-registrar.mjs';
 export { appendCodeBlock, appendTextOrFragmentClone, applySpellcheckMode, asCodeBlock, createFragmentWithCodeBlocks } from './html-element.mjs';
 export { DEFAULT_NS, initI18N, t } from './i18n/i18n.mjs';
 export { en } from './i18n/locales/en.mjs';
 export { DEFAULT_LANGUAGE, defaultTranslationsMap } from './i18n/locales/translations-map.mjs';
+export { createInlineTokenPostProcessor, DEFAULT_INLINE_TOKEN_SKIP_SELECTOR, registerInlineTokenRenderer } from './inline-token-renderer.mjs';
 export { isInObsidian } from './is-in-obsidian.mjs';
 export { injectLibraryStyles, LAST_LIBRARY_VERSION_KEY, LIBRARY_STYLES_ELEMENT_ID } from './library-styles.mjs';
 export { OBSIDIAN_LIBRARY_NAME, ObsidianLibrary } from './library.mjs';
+export { getLinkAndTagCompletionTrigger, getVaultTagSuggestions, LinkAndTagCompletionKind, LinkAndTagInputSuggest } from './link-and-tag-input-suggest.mjs';
 export { normalizeLinkName } from './link-name.mjs';
 export { buildBacklinksSnapshot, convertLink, editBacklinks, editBacklinksSnapshot, editReferences, editReferencesInContent, extractReferenceFile, generateMarkdownLink, generateRawMarkdownLink, getGenerateMarkdownLinkDefaultParamsFns, hasAngleBrackets, hasEmbedSyntax, hasLeadingDot, hasLeadingSlash, hasWikilinkSyntax, LinkPathStyle, LinkStyle, shouldResetAlias, splitSubpath, updateFileUrlLinksInContent, updateFileUrlLinksInFile, updateLink, updateReferencesInContent, updateReferencesInFile } from './link.mjs';
 export { invokeAsyncAndLog } from './logger.mjs';
@@ -150,6 +160,8 @@ export { checkPropertyEntryMatches, isPropertyEntry, PROPERTY_ENTRY_PREFIX } fro
 export { addToQueue, addToQueueAndWait, flushQueue } from './queue.mjs';
 export { AppContext, useApp } from './react/app-context.mjs';
 export { getReferenceLinkText, isCanvasFileNodeReference, isCanvasReference, isCanvasTextNodeReference, isReferenceInHeading, isReferenceInOffsetRange, referenceToFileChange, sortReferences } from './reference.mjs';
+export { isOwnedByRenderedMarkdown, registerFoldHandlers, registerFootnoteLinkHandler } from './rendered-markdown.mjs';
+export { createRequestUrlFetch, encodeRequestUrlRequest, RequestUrlError, requestUrlEx, requestUrlStream } from './request-url.mjs';
 export { isResourceLockedForPath, isResourceLockedForPathByAncestor, lockResourceForPath, requestResourceUnlockForPath, ResourceLockComponent, ResourceLockedError, unlockResourceForPath } from './resource-lock.mjs';
 export { relativePathToResourceUrl } from './resource-url.mjs';
 export { PluginRibbonIconRegistrar } from './ribbon-icon-registrar.mjs';
@@ -159,6 +171,9 @@ export { DateComponent } from './setting-components/date-component.mjs';
 export { DateTimeComponent } from './setting-components/date-time-component.mjs';
 export { EmailComponent } from './setting-components/email-component.mjs';
 export { FileComponent } from './setting-components/file-component.mjs';
+export { FolderInputSuggest, FolderListComponent } from './setting-components/folder-list-component.mjs';
+export { HotkeyComponent } from './setting-components/hotkey-component.mjs';
+export { ListComponent } from './setting-components/list-component.mjs';
 export { MonthComponent } from './setting-components/month-component.mjs';
 export { MultipleDropdownComponent } from './setting-components/multiple-dropdown-component.mjs';
 export { MultipleEmailComponent } from './setting-components/multiple-email-component.mjs';
@@ -167,6 +182,7 @@ export { MultipleTextComponent } from './setting-components/multiple-text-compon
 export { NumberComponent } from './setting-components/number-component.mjs';
 export { PasswordComponent } from './setting-components/password-component.mjs';
 export { ensureWrapped } from './setting-components/setting-component-wrapper.mjs';
+export { TagInputSuggest, TagListComponent } from './setting-components/tag-list-component.mjs';
 export { TelephoneComponent } from './setting-components/telephone-component.mjs';
 export { getTextBasedComponentValue } from './setting-components/text-based-component.mjs';
 export { TimeComponent } from './setting-components/time-component.mjs';
@@ -181,6 +197,7 @@ export { WeekComponent } from './setting-components/week-component.mjs';
 export { adoptSettingEx, SettingEx } from './setting-ex.mjs';
 export { SettingGroupEx } from './setting-group-ex.mjs';
 export { openSettingTab } from './settings-modal.mjs';
+export { SettingsTabs } from './settings-tabs.mjs';
 export { PluginStatusBarItemRegistrar } from './status-bar-item-registrar.mjs';
 export { getTemplaterFunctions, getTemplaterRenderTargetFile, parseTemplate, requireTemplaterApi, resolveTemplaterApi, TEMPLATER_PLUGIN_ID, TemplaterActiveFileProvider, TemplaterRunMode, TemplaterUnavailabilityReason, TemplaterUnavailableError } from './templater.mjs';
 export { DurationTransformer } from './transformers/duration-transformer.mjs';