RibbonItem
Unofficial
Represents a button item in the sidebar ribbon.
Import:
import type { RibbonItem } from 'obsidian';Signature:
export interface RibbonItemProperties
| Property | Type | Description | |
|---|---|---|---|
| buttonEl? | HTMLElement | The rendered button element, once created. | |
| hidden | boolean | Whether this ribbon item is hidden. | |
| icon | IconName | Icon name displayed for this ribbon item. | |
| id | string | Unique identifier for this ribbon item. | |
| title | string | Tooltip title displayed on hover. |
Methods
| Method | Returns | Description | |
|---|---|---|---|
| callback() | Promise<void> | Callback invoked when this ribbon item is clicked. |
Links to this page:
- AudioRecorderPlugin
- BacklinkPlugin
- BasesPlugin
- BookmarksPlugin
- CanvasPlugin
- CommandPalettePlugin
- DailyNotesPlugin
- EditorStatusPlugin
- FileExplorerPlugin
- FileRecoveryPlugin
- FootnotesPlugin
- GlobalSearchPlugin
- GraphPlugin
- InternalPlugin
- MarkdownImporterPlugin
- NoteComposerPlugin
- OutgoingLinkPlugin
- OutlinePlugin
- PagePreviewPlugin
- PropertiesPlugin
- PublishPlugin
- RandomNotePlugin
- SlashCommandPlugin
- SlidesPlugin
- SwitcherPlugin
- SyncPlugin
- TagPanePlugin
- TemplatesPlugin
- WebviewerPlugin
- WordCountPlugin
- WorkspaceRibbon
- WorkspacesPlugin
- ZkPrefixerPlugin