@proofkit/webviewer
Use the Web Viewer bridge package directly in custom apps.
Use this page when you already have a Vite app, Next.js app, custom Web Viewer project, or another web app where you want to use the ProofKit bridge directly. If you are new to ProofKit and want the recommended path from install to deployed FileMaker app, start with the ProofKit AI guide.
What this package does
@proofkit/webviewer makes it easier to work with FileMaker scripts and data from a custom Web Viewer integration. It runs in a FileMaker Web Viewer and lets your app interact with your FileMaker solution through local scripts.
New to ProofKit?
The happy path starts with ProofKit AI. Come back here when a guide points you to lower-level Web Viewer bridge details, or when you are wiring the package into an existing app yourself.
This is a client-side package, meant to run specifically in a FileMaker Web Viewer, but it can still be used in a hosted web app, such as Next.js. However, it will cause errors if loaded in a standard browser. For more information about deployment strategies, see the Deployment Methods guide.
For local development outside FileMaker, use fmBridge. It supports:
- Vite through
@proofkit/webviewer/vite-plugins - Next.js App Router through
<FmBridgeScript /> - Next.js Pages Router through
getFmBridgeScriptProps()plus<ResolvedFmBridgeScript />
For web-based applications where you're looking to interact with the Data API using a network request, check out the @proofkit/fmdapi package instead.
Add it to an existing app
The ProofKit AI workflow can scaffold a full Web Viewer project and install the FileMaker add-on that provides the necessary layouts, scripts, and custom functions. Use that path when you want ProofKit to create the project structure for you.
If you already have a ProofKit Web Viewer project and need to install or update the FileMaker add-on manually, run proofkit add addon webviewer from the project root. That downloads the latest add-on from the ProofKit CDN and opens it in FileMaker; you still need to add the add-on into your FileMaker file.
Related reference
fmFetchwraps FileMaker script calls that need a result back in the Web Viewer.callFMScriptcalls a FileMaker script when you do not need a result.fmBridgelets a local Vite or Next.js dev server talk to a real connected FileMaker file.- Data Access explains the generated FileMaker data path used by ProofKit Web Viewer apps.