obsidian APIs
- Plugin
- PluginSettingTab
- Setting
- App
- TFile
- Notice
- MarkdownView
- Modal
- Editor
- Vault
- addIcon
- WorkspaceLeaf
- TFolder
- TAbstractFile
- MarkdownPostProcessorContext
- Platform
- Menu
- normalizePath
- FuzzySuggestModal
- ButtonComponent
- FuzzyMatch
- MarkdownRenderer
- debounce
- TextComponent
- EditorPosition
- ItemView
- moment
- request
- DropdownComponent
- TextAreaComponent
- FileSystemAdapter
- CachedMetadata
- Scope
- MetadataCache
- ToggleComponent
- MarkdownRenderChild
- SuggestModal
- setIcon
- HeadingCache
- getAllTags
- EditorSuggest
- EditorSuggestContext
- EditorSuggestTriggerInfo
- FrontMatterCache
- FileView
- Component
- parseYaml
- Workspace
- LinkCache
- editorViewField
- EventRef
- View
- PluginManifest
- Pos
- Debouncer
- requestUrl
- ExtraButtonComponent
- MarkdownPostProcessor
- DataAdapter
- ListedFiles
- parseLinktext
- MenuItem
- ISuggestOwner
- OpenViewState
- FileManager
- ObsidianProtocolData
- Events
- SearchComponent
- ViewState
- renderResults
- Command
- Keymap
- Loc
- TagCache
- SearchMatches
- EmbedCache
- parseFrontMatterTags
- AbstractTextComponent
- Point
- MarkdownPreviewRenderer
- getLinkpath
- requireApiVersion
- resolveSubpath
- EditorRangeOrCaret
- EditorTransaction
- FolderItem
- ClipboardManager
- DragManager
- FileExplorerView
- AFItem
- Modifier
- EditorRange
- FileStats
- finishRenderMath
- loadMathJax
- renderMath
- fuzzySearch
- InstalledPlugin
- InternalPlugins
- prepareQuery
- CommandPalettePluginInstance
- PreparedQuery
- WorkspaceItem
- WorkspaceSplit
- ViewRegistry
- SearchResult
- StarredPluginInstance
- FileStarredItem
- StarredPluginItem
- ReferenceCache
- WorkspacesPluginInstance
- sortSearchResults
- SearchStarredItem
- Plugin_2
- QuickSwitcherOptions
- QuickSwitcherPluginInstance
- Chooser
- Hotkey
- KeymapContext
- KeymapEventListener
- RequestUrlResponse
- MarkdownPreviewView
- PopoverSuggest
- BlockCache
- stringifyYaml
- UserEvent
- renderMatches
- SearchMatchPart
- TextFileView
- ViewStateResult
- htmlToMarkdown
- MomentFormatComponent
- RequestUrlParam
- EditorSelection
- EditorSelectionOrCaret
- editorLivePreviewField
Other Related APIs
obsidian#Modifier TypeScript Examples
The following examples show how to use
obsidian#Modifier.
You can vote up the ones you like or vote down the ones you don't like,
and go to the original project or source file by following the links above each example. You may check out the related API usage on the sidebar.
Example #1
Source File: misc.ts From alx-folder-note with MIT License | 6 votes |
isModifier = (evt: MouseEvent, pref: Modifier): boolean => {
const { altKey, metaKey, ctrlKey, shiftKey } = evt;
switch (pref) {
case "Mod":
return Platform.isMacOS ? metaKey : ctrlKey;
case "Ctrl":
return ctrlKey;
case "Meta":
return metaKey;
case "Shift":
return shiftKey;
case "Alt":
return altKey;
default:
assertNever(pref);
}
}
Example #2
Source File: settings.ts From alx-folder-note with MIT License | 6 votes |
setModifier = () => {
new Setting(this.containerEl)
.setName("Modifier for New Note")
.setDesc("Choose a modifier to click folders with to create folder notes")
.addDropdown((dropDown) => {
type NoShift = Exclude<Modifier, "Shift">;
const windowsOpts: Record<NoShift, string> = {
Mod: "Ctrl (Cmd in macOS)",
Ctrl: "Ctrl (Ctrl in macOS)",
Meta: "⊞ Win",
// Shift: "Shift",
Alt: "Alt",
};
const macOSOpts: Record<NoShift, string> = {
Mod: "⌘ Cmd (Ctrl in Windows)",
Ctrl: "⌃ Control",
Meta: "⌘ Cmd (Win in Windows)",
// Shift: "⇧ Shift",
Alt: "⌥ Option",
};
const options = Platform.isMacOS ? macOSOpts : windowsOpts;
dropDown
.addOptions(options)
.setValue(this.plugin.settings.modifierForNewNote)
.onChange(async (value: string) => {
this.plugin.settings.modifierForNewNote = value as NoShift;
await this.plugin.saveSettings();
});
});
};