Skip to main content
Version: 3.14 Beta (Latest)

OHIF Extension Gallery

This page lists published OHIF extensions and modes that follow the current plugin contract. Use it to discover packages you can install into a viewer, and as the entry point for listing your own.

What qualifies​

An entry in the gallery is a package published to npm that satisfies the plugin contract:

  • It ships a contract v1 UMD build whose default export is the extension or mode object (see Building with an Agent for the normative contract).
  • Its id equals its package name — the string it registers itself under is identical to the name field in its package.json.
  • It carries the discovery keyword ohif-extension (for extensions) or ohif-mode (for modes) in package.json.

Listing here is curation, not certification. Inclusion means the entry met the review checklist below at submission time; it is not an endorsement, a compatibility guarantee, or a maintenance commitment by OHIF.

Curated list​

PackageTypeModulesHost rangeMaintainerLinks
@ohif/extension-exampleextensioncustomizationModule, panelModule, commandsModule, hangingProtocolModule^3.13.0-beta.0OHIFrepo

The Host range column is the @ohif/core semver range the maintainer tested the package against. Modules lists the module types the package contributes.

Search npm yourself​

The gallery is curated and intentionally small. To find every package that declares the discovery keyword — including ones not listed here — query npm directly. This is the replacement for the removed cli search command, which queried the same npm keyword endpoints.

From a terminal:

npm search ohif-extension
npm search ohif-mode

Or browse the npm registry directly:

If you already have packages installed in a Viewers workspace, pnpm plugin doctor reports any installed package that carries the ohif-extension / ohif-mode keyword but is not declared in your plugin configuration.

Submit your extension​

To add your package, open a pull request that edits platform/docs/src/data/extension-gallery.json and nothing else. Your entry must validate against the published schema; the docs build fails fast if it does not.

An entry looks like this:

{
"name": "@acme/extension-foo",
"type": "extension",
"description": "One sentence, 200 characters or fewer.",
"maintainer": { "name": "Acme Imaging", "url": "https://github.com/acme" },
"modules": ["panelModule", "commandsModule"],
"hostRange": "^3.13.0",
"links": {
"npm": "https://www.npmjs.com/package/@acme/extension-foo",
"repository": "https://github.com/acme/extension-foo"
}
}

Reviewers check that:

  • The package is public on npm.
  • The repository is public.
  • hostRange is the tested @ohif/core semver range for the package.
  • The package carries the ohif-extension or ohif-mode keyword.
  • The id equals the package name (name here matches the registered id).

Again: acceptance is curation, not certification.