Skip to content

Feature: Logos Bible Software sync via logosref: protocol #818

@deferredreward

Description

@deferredreward

Summary

Add an optional toggle that causes gatewayEdit to follow along in Logos Bible Software as the user navigates verses.

How it works

Logos exposes a documented logosref: URI scheme. When gatewayEdit fires a URI like:

logosref:Bible.La3.5

…the OS hands it to Logos, which jumps to that verse in whatever resource the user has open. The handoff uses a hidden 1×1 <iframe> — completely invisible after a one-time browser prompt.

User-facing behavior

  • A Logos Sync toggle appears in the hamburger (☰) drawer menu with secondary text "Follow verse in Logos Bible Software".
  • Toggle state is persisted per-user in localStorage.
  • Navigation fires the URI with a 300 ms debounce so rapid scrolling doesn't flood Logos.
  • Users without Logos installed are completely unaffected — the iframe load silently fails.

Implementation

File Change
src/hooks/useLogosSync.js New hook — USFM→Logos book map, debounced iframe fire
src/context/StoreContext.jsx Add logosSync/setLogosSync via useUserLocalStorage
src/components/Drawer.jsx MUI Switch list item for the toggle
src/components/WorkspaceContainer.jsx Call useLogosSync with current bookId/chapter/verse

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions