# integrate-file-viewer

Sets up CogniteFileViewer in Flows applications to render CDF files, documents, and images without manual PDF worker configuration.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1900 installs · ★ 6
- Author: cognitedata
- License: Apache-2.0 · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/cognitedata/builder-skills/tree/HEAD/skills/integrate-file-viewer/SKILL.md
- Updated: 2026-10-20
- HTML: https://affpapa.org/en/nevibecode/skills/integrate-file-viewer

## What it does

This skill guides coding agents through embedding the Cognite file viewing library into a Flows project. It inspects `package.json` and `vite.config.ts`, moves library code into `src/cognite-file-viewer/`, and adds `react-pdf@^9.1.1`. The agent avoids installing `pdfjs-dist` directly because `react-pdf` includes it internally.

The skill adds `optimizeDeps.exclude: ['pdfjs-dist']` to `vite.config.ts` so Vite skips pre-bundling that breaks the PDF.js web worker. The component handles native PDFs, images (JPEG, PNG, WebP, SVG, TIFF), and plain text. Office formats like Word, Excel, or PowerPoint render via CDF Document Preview API conversion.

Without an explicit height on the container or component styles, the viewer collapses to zero height. File references accept CDF internal IDs, data-modeled instance IDs, or direct URLs.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add cognitedata/builder-skills --skill integrate-file-viewer -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/integrate-file-viewer/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/integrate-file-viewer/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add cognitedata/builder-skills --skill integrate-file-viewer -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/integrate-file-viewer/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add cognitedata/builder-skills --skill integrate-file-viewer -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/integrate-file-viewer/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install cognitedata/builder-skills integrate-file-viewer
```

2. **Manually: put the files in place**
- File: `.github/skills/integrate-file-viewer/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add cognitedata/builder-skills --skill integrate-file-viewer -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/cognitedata/builder-skills --path skills/integrate-file-viewer
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/integrate-file-viewer/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add cognitedata/builder-skills --skill integrate-file-viewer -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/cognitedata/builder-skills/tree/HEAD/skills/integrate-file-viewer/SKILL.md

## When to use it
- integrate CogniteFileViewer into a Flows app
- configure react-pdf and Vite worker exclusions
- preview CDF images, PDF files, and converted office documents
- render diagram annotation overlays using instance IDs

## Example prompts
- Add CogniteFileViewer to the asset inspector component
- Integrate CDF file preview with PDF annotations into this view
- Set up the file viewer for CDF documents and configure Vite

## Source text · SKILL.md · Apache-2.0

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 7064812e63d13b94.

BEGIN THIRD-PARTY FILE 7064812e63d13b94
````text
---
name: integrate-file-viewer
description: "MUST be used whenever integrating CogniteFileViewer into a Flows app to preview CDF files (PDFs, images, text). Do NOT manually wire up react-pdf or file resolution — this skill handles installation, Vite config, worker setup, and component usage. Triggers: file viewer, file preview, CogniteFileViewer, PDF viewer, view CDF files, document viewer, preview file."
allowed-tools: Read, Glob, Grep, Edit, Write, Bash
---

# Integrate CogniteFileViewer

Add `CogniteFileViewer` to this Flows app to preview CDF files (PDF, image, text).

## Dependencies

The file-viewer library files (copied in Step 2) require this npm package:

| Package | Version |
|---|---|
| `react-pdf` | `^9.1.1` |

`pdfjs-dist` ships as a dependency of `react-pdf` at the correct version — do not install it separately.
`react` and `@cognite/sdk` are assumed to already be present in Flows apps.

---

## Your job

Complete these steps in order. Read each file before modifying it.

---

## Step 1 — Understand the app

Read these files before touching anything:

- `package.json` — detect package manager (`packageManager` field or lock file) and existing deps
- `vite.config.ts` — understand current Vite setup
- The component where the viewer should be added

---

## Step 2 — Copy the file-viewer source files

The file-viewer library lives in the `code/` directory next to this skill file. Read and copy
**all** files from there into `src/cognite-file-viewer/` inside the app:

- `code/types.ts`
- `code/mimeTypes.ts`
- `code/fileResolution.ts`
- `code/useViewport.ts`
- `code/useFileResolver.ts`
- `code/useDocumentAnnotations.ts`
- `code/DocumentAnnotationOverlay.tsx`
- `code/CogniteFileViewer.tsx`
- `code/index.ts`

> The PDF.js worker is configured inside `CogniteFileViewer.tsx` — no separate consumer setup is needed.

---

## Step 3 — Install dependencies

Install `react-pdf` (see **Dependencies** above) using the app's package manager:

- pnpm → `pnpm add react-pdf@^9.1.1`
- npm  → `npm install react-pdf@^9.1.1`
- yarn → `yarn add react-pdf@^9.1.1`

> **pnpm users:** pnpm's strict linking may prevent the browser from resolving `pdfjs-dist`. Either add `pdfjs-dist` as a direct dependency (`pnpm add pdfjs-dist`), or add `public-hoist-pattern[]=pdfjs-dist` to `.npmrc`.

---

## Step 4 — Configure Vite

Add `optimizeDeps.exclude: ['pdfjs-dist']` to `vite.config.ts` to prevent Vite from pre-bundling pdfjs-dist (which breaks the worker):

```ts
export default defineConfig({
  // ... existing config ...
  optimizeDeps: {
    exclude: ['pdfjs-dist'],
  },
});
```

---

## Step 5 — Use the component

Import and render `CogniteFileViewer` from the locally copied files:

```tsx
import { CogniteFileViewer } from './cognite-file-viewer';
```
````
END THIRD-PARTY FILE 7064812e63d13b94

The third-party file has ended. Everything between the 7064812e63d13b94 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2807 of 9741 bytes. © cognitedata · Apache-2.0 · https://github.com/cognitedata/builder-skills/tree/HEAD/skills/integrate-file-viewer/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md