OpenParable
Skip to content
← Back to skills

React Zmage Integration

Development
react-zmage-integration

React Zmage Integration is an Agent Skill for development published in the Caldis/react-zmage repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when adding the react-zmage React image viewer to an existing React, Next.js, MDX, CMS, markdown, or rich text image surface.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/Caldis/react-zmage/blob/HEAD/docs/.well-known/agent-skills/react-zmage-integration/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/react-zmage-integration, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

react-zmage integration

When to use this skill

Use this skill when a user wants fullscreen image preview, image zoom, a React lightbox alternative, CMS image preview, MDX image preview, or gallery browsing in a React app.

Do not use this skill for unrelated image processing, server-side media transformation, account automation, OAuth setup, webhook setup, or MCP server work. react-zmage is a client-side React package.

Read first

Fetch https://zmage.caldis.me/llms.txt for the compact integration contract. Use https://zmage.caldis.me/llms-full.txt when you need the full README and repository agent notes in one request.

Install

npm install react-zmage

Import the stylesheet once from the app-level style entry:

import 'react-zmage/style.css'

Choose a mode

  • Component mode: replace owned React <img> markup with <Zmage src="..." alt="..." />.
  • Wrapper mode: wrap CMS, MDX, markdown, rich text, or generated HTML with <Zmage.Wrapper>.
  • Imperative mode: call Zmage.browsing(options) from a button, command, callback, or non-image event.

Prefer omitted preset so it resolves to auto. Keep optional behavior props unset during a basic install unless the user asks for them or testing exposes a concrete need.