Omni Infobox

by Claude (Anthropic)
5
4
3
2
1
Score: 49/100

Description

Reviews

No reviews yet.

Stats

12
stars
5,544
downloads
5
forks
97
days
0
days
0
days
7
total PRs
0
open PRs
1
closed PRs
6
merged PRs
13
total issues
0
open issues
13
closed issues
32
commits

Latest Version

15 hours ago

Changelog

Fixes a way to lose note text near the infobox, and lets infoboxes take their image from a note property.

  • No more lost note text (#17). A selection that ran between the infobox card and the note, for example a shift-click on the card or a drag across its edge, could quietly select part of the note, and the next Enter deleted it. Selections now stay on one side of the card's edge, and you can still copy text from the card.
  • The card no longer covers note text (#17). Narrow panes now show the card above the note instead of inside the editor. Wide panes keep space beside the note.
  • Recover from "[object Object]" (#17). If Obsidian's Properties panel offers "Display as text?" for the infobox property, choose Cancel. If the infobox was already converted, the card offers Restore infobox with the last version shown since Obsidian started. Older losses can be recovered with Obsidian's core File recovery plugin.
  • Safer saves (#17). Infobox edits save any unsaved typing first, and "Add infobox" waits for its first write before opening the editor.
  • Images from note properties (#18). Set a default Image property (for example cover) in Settings → Omni Infobox, or choose one per infobox in its editor. It is used when the infobox has no image of its own. It accepts file names, [[links]], ![[embeds]], Markdown images, URLs, or a list of these (shown as a gallery).

Validation: 29 regression tests and GitHub CI passed. Real-app checks passed on Obsidian 1.12.7 on Windows, with 155 assertions on two consecutive runs and no renderer errors. They include the Properties-panel conversion through Obsidian's own UI. The same real-app test fails on 1.2.0. Physical mobile devices and macOS were not tested.

Manual installation: copy main.js, styles.css, and manifest.json into your vault's .obsidian/plugins/omni-infobox/ folder, then reload the plugin. Existing community-plugin users can update through Obsidian.

README file from

Github

Omni Infobox

An Obsidian plugin that renders Wikipedia-style infoboxes from YAML frontmatter, featuring an interactive visual editor and a floating panel pinned to the top-right of the reading and editing panes.

Features

  • Frontmatter-driven: no special syntax in note body required
  • In-note visual editor for updating fields, tags, and images without writing raw YAML
  • Supports supertitle, title, subtitle, images, captions, tags, and key-value fields
  • Single images or multi-image tabbed galleries with custom tab labels and captions
  • Drag-and-drop reordering for fields, sections, and tags
  • Smart list formatting: YAML arrays, multiline bullets, pipes (|), and commas (,) automatically render as bulleted lists
  • Supports internal wikilinks with aliases throughout titles, captions, and fields
  • Tag integration with add, remove, reorder, and toggle visibility
  • Automatic light/dark theme support
  • Optional per-note colors and integration with Style Settings
  • Reusable infobox templates stored as ordinary vault notes
  • Works on desktop and mobile

Installation

Manual

  1. Download main.js, styles.css, and manifest.json from the latest release
  2. Copy them into .obsidian/plugins/omni-infobox/ inside your vault
  3. Enable the plugin in Settings → Community Plugins

Community Plugins

Search for Omni Infobox in the Obsidian community plugin browser.

Usage

Command Palette

Open the Command Palette (Ctrl/Cmd + P) to access:

  • Omni Infobox: Add infobox — initializes an infobox on the current note, or opens the editor if one already exists
  • Omni Infobox: Remove Infobox — removes the infobox block from frontmatter entirely (only available when the note has an infobox)
  • Omni Infobox: Insert infobox template — imports an infobox from a template note; asks before replacing an existing infobox

Templates

Open an infobox's editor and choose Save as template. Enter a name to save a copy of its sections, labels, values, images, tags, and colors in the Infobox templates vault folder. Existing templates are never overwritten. You can edit these template notes like any other note, including clearing example field values.

On another note, run Insert infobox template and choose a template. The imported title becomes the destination note's name. The note body and other frontmatter properties are preserved. Templates are independent copies: editing one does not change infoboxes already imported from it.

Change the template folder under Settings → Omni Infobox. You can also place existing notes with an infobox: block in that folder, including subfolders. This works alongside Obsidian's core Templates plugin; it does not require it.

Colors and layout

Expand Colors in the infobox editor to set an optional card background, text, section background, section text, and border color. Use hex colors such as #e6f0e9 or #315b43; clear a value to return to the theme default. For vault-wide colors, install the optional Style Settings plugin and open its Omni Infobox section, with separate light and dark colors. Per-note colors take precedence.

The same values can be stored in frontmatter:

infobox:
  title: Character
  colors:
    background: '#e6f0e9'
    text: '#203329'
    section: '#315b43'
    sectionText: '#ffffff'
    border: '#a3baa9'
  fields:
    - section: Identity
    - Name: Example

Wide panes reserve space beside the note for a pinned infobox, so it never covers note text. Panes narrower than 700 CSS pixels show the card above the note, outside the editor. Resizing panes or switching between Reading view, Live Preview, and Source mode updates placement automatically. You can select and copy text in the card, but a selection cannot run from the card into the note, so typing in the note never replaces text you did not select.

Visual editor

Every rendered infobox includes an Edit button at the bottom of the panel. Clicking it opens a modal where you can:

  • Edit the supertitle, title, and subtitle
  • Add, remove, and drag-and-drop reorder tags
  • Manage images, browse vault image files, and edit tab labels and captions
  • Add section dividers and data fields with multiline text support
  • Drag-and-drop or use arrow buttons to reorder fields and sections

Changes save back to the note's YAML frontmatter automatically.

YAML frontmatter

Add an infobox: block to your note's YAML frontmatter:

---
infobox:
  supertitle: Historical Figure
  title: Albert Einstein
  subtitle: Theoretical Physicist
  images:
    - label: Portrait
      image: einstein.jpg
      caption: Photograph from [[1921]]
    - label: Lecture
      image: "[[einstein-lecture.jpg]]"
      caption: Einstein giving a lecture
  tags: [science, physics]
  showTags: true
  fields:
    - section: Personal
    - Born: March 14, 1879
    - Died: April 18, 1955
    - Nationality: [[Germany|German]] / [[United States|American]]
    - section: Career
    - Field: Theoretical physics
    - Known for: General relativity | Special relativity | Photoelectric effect
    - Awards: Nobel Prize in Physics (1921)
---

Frontmatter fields

Key Type Description
supertitle string Optional italicized header rendered above the main title
title string Bold heading at the top of the card
subtitle string Italic line below the title
image string A single filename or URL. Supports [[wikilinks]] and ![[wikilinks]]
caption string Small italic text below a single image
images list Image gallery entries, each with image and optional label and caption
imageProperty string Name of a note property to take the image from when image/images are empty (see Images)
tags list/string Optional tags to show in the infobox. Falls back to the note's frontmatter and inline tags
showTags boolean Set to false to hide tags for a note
fields list Array of single-key objects (see below)

Text values in title, subtitle, caption, section headers, field labels, and field values can include internal links such as [[Mondstadt]] or [[Knights of Favonius|the Knights]]. Quote values that begin with a wikilink, especially when text follows it:

  - Ancestors: "[[Marlow Sonners]] (maternal great-grandmother, deceased)"

An unquoted [[link]] is interpreted as a YAML array, and adding text after it makes the YAML invalid. For this specific error, the plugin offers Add YAML quotes in place of the infobox. This repairs the values only when the resulting frontmatter parses successfully; it preserves the note body. Other YAML errors must be corrected manually.

Fields list

Each item in fields is a single-key YAML object:

  • Regular row: any key/value pair renders as a label + value row
  • Section header: use the key section to insert a divider with a category label
fields:
  - section: Category Name   # renders as a section divider
  - Label: Value             # renders as a data row

Field values containing multiple items are automatically rendered as a bulleted list:

  • YAML lists: Known for: [General relativity, Special relativity]
  • Multiline strings with - bullets
  • Pipe-separated: Known for: General relativity | Special relativity
  • Comma-separated: Known for: General relativity, Special relativity

Delimiters inside wikilinks (such as alias pipes or commas) are preserved and will not split the link.

For titled groups of lists inside one field, use Markdown headings and bullets in a YAML block scalar. These can also be entered directly in the visual editor's value box:

fields:
  - Aliases: |
      #### Codenames
      - Black King
      - Iron God

      #### Nicknames
      - Armored Avenger
      - [[Golden Boy]]

Each heading becomes a compact divider within the value column, with its list underneath. Inside a block scalar, wikilinks do not need YAML quotes.

Images

Images can be specified as:

  • A plain filename: image: einstein.jpg (resolved via vault)
  • A wikilink: image: "[[einstein.jpg]]" or image: "![[einstein.jpg]]"
  • A remote URL: image: https://example.com/photo.jpg

For a gallery, use images instead of image. With more than one entry, the infobox shows image tabs:

images:
  - label: Portrait
    image: "[[einstein.jpg]]"
    caption: Photograph from 1921
  - label: Lecture
    image: "[[einstein-lecture.jpg]]"
    caption: Einstein giving a lecture
Images from note properties

An infobox can show an image stored in one of the note's own properties, for example one filled in by Dataview, Templater, or another plugin. Set a default property name under Settings → Omni Infobox → Image property (for example cover), or pick a property for one infobox in its editor under Images → Image property, which is saved as imageProperty:

---
cover: "[[einstein.jpg]]"
infobox:
  title: Albert Einstein
  imageProperty: cover   # optional; overrides the default from settings
---

The property can hold a filename, [[link]], ![[embed]], Markdown image, URL, or a list of these (shown as a gallery). The property name is matched case-insensitively. Images set directly with image or images always take precedence.

Troubleshooting

Properties shows a "Type mismatch" warning on infobox. The infobox is a nested object, which Obsidian's Properties panel cannot display. If the infobox property was given a type such as Text, Properties shows a warning that offers to "Display as text". Choose Cancel: choosing Update and then editing the value replaces the whole infobox with the text [object Object]. If that has already happened, the infobox area shows Restore infobox, which puts back the last version shown since Obsidian started. Notes changed before that can be recovered with Obsidian's core File recovery plugin.

Contributing

Issues and pull requests are welcome.

Run npm ci and npm test for regression tests. For real-app checks, use a disposable vault named test-vault with the plugin installed, start Obsidian with a separate --user-data-dir and --remote-debugging-port=9237, then run npm run test:obsidian. Set OBSIDIAN_CDP to use another debugging URL. The smoke test refuses to run against other vault names; it creates Smoke*.md notes and a template in this test vault. Enable Style Settings there to include its integration checks. Screenshots are written to output/playwright (or OBSIDIAN_TEST_OUTPUT). No debugging connection is needed for normal plugin use.

License

MIT see LICENSE