obsidian-livesync/docs/tips/status-display.md

Synchronisation status and CSS customisation

Use General Settings to choose whether synchronisation status appears in the status bar, inside the editor, or both. The following sections explain the indicators and how to customise their appearance.

Status indicators

• Activity Indicator
  • 📲 A finite remote operation is in progress
  • 🌐N Approximate remote requests currently in progress
• Status
  • ⏹️ Stopped
  • 🌀 Starting synchronisation
  • ⏩ Comparing CouchDB change history, including entries already held locally
  • 💤 LiveSync enabled. Waiting for changes
  • ⚡️ Synchronisation in progress
  • ⚠ An error occurred
• Statistical Indicators
  • ↑ Uploaded chunks and metadata
  • ↓ Downloaded chunks and metadata
• Progress Indicators
  • 📥 Unprocessed transferred items
  • 📄 Working database operation
  • 💾 Working write storage processes
  • ⏳ Working read storage processes
  • 🛫 Pending read storage processes
  • 📬 Batched read storage processes
  • ⚙️ Working or pending storage processes for hidden files
  • 🛄 Pending initial on-demand chunk requests
  • 🔁 Pending chunk retries, including retry delays
  • 🔌 Working customisation items (configuration, snippets, and plug-ins)

To prevent file and database corruption, please avoid closing Obsidian until all progress indicators have disappeared as much as possible (although the plug-in will attempt to resume if interrupted). This is especially important if you have deleted or renamed files.

CouchDB comparison count

When CouchDB change history is being compared, directional counts can appear before any new documents arrive, for example Sync: ⏩ (⏩↑ 1200) (⏩↓ 84) ↑ 0 ↓ 0. The ⏩↑ count is for the push direction, and ⏩↓ is for the pull direction. Each counts candidate changes-feed entries compared during the current replication attempt, including entries which do not need to be transferred and repeated entries on retries. They are feed-entry counts, not counts of Vault files which need to be transferred. The final ↑ and ↓ counts continue to show uploaded and downloaded Chunks and Metadata.

Each directional count has its own display timer. A positive count remains visible for three seconds after its last change, then clears; a count which reaches zero clears immediately. A change in one direction does not extend the other direction's timer. The ⏩ status icon follows comparison activity independently of these timers.

Customising status items with CSS snippets

The status bar and editor overlay use individual spans with the common livesync-stat- class prefix. CSS snippets can hide or style individual items. For example, this hides both directional comparison counts and the P2P summary:

.livesync-stat-ff-push,
.livesync-stat-ff-pull,
.livesync-stat-p2p {
    display: none;
}

The item classes include livesync-stat-network, livesync-stat-sync, livesync-stat-sent, livesync-stat-push-remaining, livesync-stat-arrived, livesync-stat-pull-remaining, livesync-stat-ff-push, livesync-stat-ff-pull, and livesync-stat-p2p. File-processing items use livesync-stat-file-processing, livesync-stat-file-pending, and livesync-stat-file-batched; queue items use livesync-stat-queue- followed by replication, database, storage, chunk-initial, chunk-retrying, plugin-scan, hidden-files, or conflicts. The skipped-file indicator uses livesync-stat-file-skip.

The former livesync-stat-ff class has been replaced by livesync-stat-ff-push and livesync-stat-ff-pull. Update existing CSS snippets to target one or both of the directional classes.

All items also have livesync-stat-item. Numeric children use livesync-stat-value, tabular digits, and right alignment. Each numeric item retains its widest displayed digit count during an active period, reducing movement as counts decrease. The editor overlay uses wider gaps between items, while remaining counts stay beside their transfer totals.

Inactive items receive livesync-stat-inactive instead of the HTML hidden attribute. The default CSS hides them immediately. They retain their last text, numeric width, and position amongst the other items so that CSS snippets can customise how they disappear. The numeric width starts afresh when an item becomes active again.

Animate editor status items

This optional CSS snippet shrinks inactive items in the editor status line and expands them when they reappear. It applies to all status items in that line. Because inactive items remain in the DOM, their width can transition as their state changes; the initial creation of an item is not guaranteed to animate. Text changes, including on first appearance, do not necessarily animate an item's width. The @supports guard leaves the default, immediate hiding behaviour in place in CSS engines which do not support calc-size().

@supports (width: calc-size(auto, size)) {
    .livesync-status-statusline > .livesync-stat-item {
        font-variant-numeric: tabular-nums;
        transition: width 0.125s;
        display: inline-block;
        width: calc-size(auto, size);
        overflow: hidden;
        white-space: nowrap;
    }

    .livesync-status-statusline > .livesync-stat-item.livesync-stat-inactive {
        transition: width 0.46s;
        display: inline-block;
        width: calc-size(auto, size * 0);
        overflow: hidden;
        white-space: nowrap;
        margin-inline-start: 0 !important;
    }

    @media (prefers-reduced-motion: reduce) {
        .livesync-status-statusline > .livesync-stat-item {
            transition: none;
        }

        .livesync-status-statusline > .livesync-stat-item.livesync-stat-inactive {
            transition: none;
        }
    }
}

The snippet affects the editor overlay only; the status bar keeps its default appearance. See the calc-size() reference for the CSS feature used to calculate an item's intrinsic width.

See the documentation index for setup and troubleshooting guides.