Skip to main content

Viewer mode

Viewer mode embeds a read-only document inside your application. It opens a file by ID and renders it in a non-editable state, allowing users to read and review documents without exposing editing controls. If you want users to have editing controls, use the Editor mode instead.

Initialization​

const docSpace = DocSpace.SDK.initViewer({
  frameId: "ds-frame",
  src: "https://your-docspace.com",
  id: "your-file-id",
});

Only the parameters frameId, src, and id are required. All other parameters are optional and have sensible defaults.

For setup instructions (connecting the script, CSP configuration, npm package), see Get started. For a complete HTML example, see Initialize viewer.

Configuration, events, and methods​

initViewer() accepts the full TFrameConfig configuration object and returns an SDKInstance.

Use cases​

Viewing a public document without login​

Use requestToken to let unauthenticated users view a document shared via a public link:

const docSpace = DocSpace.SDK.initViewer({
  frameId: "ds-frame",
  src: "https://your-docspace.com",
  id: "your-file-id",
  requestToken: "public-share-token",
});

Embedding a document preview in mobile layout​

editorType: "mobile" switches to a mobile-optimized layout; editorGoBack: false additionally hides the "Open file location" button — see Hiding UI elements and frame layout for its other two values:

const docSpace = DocSpace.SDK.initViewer({
  frameId: "ds-frame",
  src: "https://your-docspace.com",
  id: "your-file-id",
  editorType: "mobile",
  editorGoBack: false,
});