{"id":22713108,"url":"https://github.com/lukasmoellerch/pdf-viewport","last_synced_at":"2025-04-23T07:39:22.878Z","repository":{"id":47167037,"uuid":"336665959","full_name":"lukasmoellerch/pdf-viewport","owner":"lukasmoellerch","description":"A library that makes using pdfjs in react projects easy.","archived":false,"fork":false,"pushed_at":"2021-09-10T09:44:54.000Z","size":1552,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T22:42:37.653Z","etag":null,"topics":["pdf","pdfjs","react","reactjs"],"latest_commit_sha":null,"homepage":"https://pdf-viewport.lukas-moeller.ch","language":"TypeScript","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/lukasmoellerch.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":"2021-02-07T00:27:50.000Z","updated_at":"2025-01-05T00:57:05.000Z","dependencies_parsed_at":"2022-09-19T03:10:14.401Z","dependency_job_id":null,"html_url":"https://github.com/lukasmoellerch/pdf-viewport","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lukasmoellerch%2Fpdf-viewport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lukasmoellerch%2Fpdf-viewport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lukasmoellerch%2Fpdf-viewport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lukasmoellerch%2Fpdf-viewport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lukasmoellerch","download_url":"https://codeload.github.com/lukasmoellerch/pdf-viewport/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250394112,"owners_count":21423360,"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":["pdf","pdfjs","react","reactjs"],"created_at":"2024-12-10T14:08:19.207Z","updated_at":"2025-04-23T07:39:22.858Z","avatar_url":"https://github.com/lukasmoellerch.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  pdf-viewport\n  \u003cbr\u003e\n\u003c/h1\u003e\n\u003cp align=\"center\" style=\"font-size: 1.2rem;\"\u003e\n A library that makes using pdfjs in react projects easy.\n\u003c/p\u003e\n\u003cp align=\"center\" style=\"font-size: 1.2rem;\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/v/pdf-viewport\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\" style=\"font-size: 1.2rem;\"\u003e\n  Demo: \u003ca href=\"https://pdf-viewport.lukas-moeller.ch\"\u003epdf-viewport.lukas-moeller.ch\u003c/a\u003e\n\u003c/p\u003e\n\n# Getting Started\n\nAdd `pdfjs-dist` and `pdf-viewport` as dependencies:\n```bash\n$ yarn add pdfjs-dist pdf-viewport\n$ npm install --save pdfjs-dist pdf-viewport\n```\n\nSet `pdfjsLib.GlobalWorkerOptions.workerSrc`. You could for example use a hosted variant of the worker or use `worker-loader` to bundle the worker yourself using webpack.\n```ts\nimport * as pdfjsLib from \"pdfjs-dist/es5/build/pdf\";\npdfjsLib.GlobalWorkerOptions.workerSrc = \"[your worker url]\"\n```\n\nLoad the PDF using `getDocument` from pdfjs. You can do this e.g. using `useEffect` or react-query:\n```ts\nconst [pdf, setPdf] = React.useState\u003cPDFDocumentProxy | undefined\u003e();\nReact.useEffect(() =\u003e {\n  getDocument(examplePdf).promise.then(setPdf);\n}, []);\n```\n\nNow you can use `pdf-viewport` to render the PDF using one of its components:\n```tsx\n\u003cPdfViewport\n  aspectRatio={portraitA4}\n  pdf={pdf}\n  pageNumber={1}\n\u003e\n  \u003cPdfCanvasLayer /\u003e\n\u003c/PdfViewport\u003e\n```\n\n## Reference\n\nComing soon!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukasmoellerch%2Fpdf-viewport","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flukasmoellerch%2Fpdf-viewport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukasmoellerch%2Fpdf-viewport/lists"}