{"id":13472759,"url":"https://github.com/gerhardberger/electron-pdf-window","last_synced_at":"2025-04-04T20:14:36.705Z","repository":{"id":12479616,"uuid":"71943929","full_name":"gerhardberger/electron-pdf-window","owner":"gerhardberger","description":"view PDF files in electron browser windows","archived":false,"fork":false,"pushed_at":"2022-03-09T19:17:11.000Z","size":2410,"stargazers_count":283,"open_issues_count":29,"forks_count":92,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-28T19:09:45.891Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gerhardberger.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-25T22:22:27.000Z","updated_at":"2025-03-23T12:16:13.000Z","dependencies_parsed_at":"2022-08-07T07:00:11.425Z","dependency_job_id":null,"html_url":"https://github.com/gerhardberger/electron-pdf-window","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gerhardberger%2Felectron-pdf-window","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gerhardberger%2Felectron-pdf-window/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gerhardberger%2Felectron-pdf-window/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gerhardberger%2Felectron-pdf-window/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gerhardberger","download_url":"https://codeload.github.com/gerhardberger/electron-pdf-window/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247242680,"owners_count":20907134,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T16:00:57.754Z","updated_at":"2025-04-04T20:14:36.687Z","avatar_url":"https://github.com/gerhardberger.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Tools","Library","Libraries"],"sub_categories":["For Electron","Uncategorized","Misc/Multi-language"],"readme":"# electron-pdf-window\n\nview PDF files in electron browser windows. this module adds support for viewing\nPDF files in electron [`BrowserWindow`s](http://electron.atom.io/docs/api/browser-window/).\nit works even if you navigate to a PDF file from a site, or opening a PDF file in\na new window. a `PDFWindow` instance is just a subclass of `BrowserWindow` so it\ncan be used just like it.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg align=\"center\" src=\"./screenshot.png\" height=400 /\u003e\n\u003c/p\u003e\n\n\n``` javascript\nconst { app } = require('electron')\nconst PDFWindow = require('electron-pdf-window')\n\napp.on('ready', () =\u003e {\n  const win = new PDFWindow({\n    width: 800,\n    height: 600\n  })\n\n  win.loadURL('http://mozilla.github.io/pdf.js/web/compressed.tracemonkey-pldi-09.pdf')\n})\n```\n\n## install\n\n```\n$ npm i electron-pdf-window\n```\n\n## usage\n\n#### `win = new PDFWindow([opts])`\n`win` is an electron [`BrowserWindow`](http://electron.atom.io/docs/api/browser-window/)\nthat has support for viewing PDF files.\n\n#### `PDFWindow.addSupport(win)`\nadds PDF viewing support for `win`, which is a `BrowserWindow` instance.\n\n## using from the renderer process\n\nUsing the `PDFWindow` class directly from the renderer process is not\nrecommended, because electron doesn't support proper extending of their built-in\nclasses. In order to add PDF support from the renderer, use the `addSupport`\nmethod.\n\n``` js\nconst { BrowserWindow } = require('electron').remote\nconst PDFWindow = require('electron-pdf-window')\n\nconst win = new BrowserWindow({ width: 800, height: 600 })\n\nPDFWindow.addSupport(win)\n\nwin.loadURL('file:///a/b/c.pdf')\n```\n\n## test\n\n```\n$ npm test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgerhardberger%2Felectron-pdf-window","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgerhardberger%2Felectron-pdf-window","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgerhardberger%2Felectron-pdf-window/lists"}