Socket
Socket
Sign inDemoInstall

@teamhive/pdf-viewer

Package Overview
Dependencies
1
Maintainers
5
Versions
43
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @teamhive/pdf-viewer

PDF Viewer Web Component. Built with stencil and pdfjs.


Version published
Weekly downloads
287
decreased by-18.93%
Maintainers
5
Install size
19.3 MB
Created
Weekly downloads
 

Readme

Source

Built With Stencil

Hive PDF Viewer

This web component allows you to add PDF rendering support to your web applications.

Features

  • Rendering PDFs on web (Angular, Ionic, React, Stencil, etc.)
  • Search
  • Fit to Page / Fit to Width
  • Side panel for quick thumbnail navigation

Installation

  • npm i @teamhive/pdf-viewer

Usage

<hive-pdf-viewer src="http://www.mydomain.com/example.pdf"></hive-pdf-viewer>

Somewhere in your project (e.g. main.ts):

import { defineCustomElements } from '@teamhive/pdf-viewer/dist/loader';
defineCustomElements(window);

Angular

Add viewer assets to angular.json assets block:

{
    "projects": {
        "app": {
            "architect": {
                "build": {
                    "options": {
                        "assets": [
                            {
                                "glob": "**/*",
                                "input": "node_modules/@teamhive/pdf-viewer/dist/pdf-viewer/pdf-viewer-assets",
                                "output": "pdf-viewer-assets"
                            }

Follow the Stencil JS Framework Integration guide for more info.

Properties

PropertyDefaultDescription
srcThe PDF web address location (http, https)
page1The default page index.
enableToolbartrueIf the toolbar is available for display.
enableSideDrawertrueIf the side drawer UI (and button) is available for display.
enableSearchtrueIf the document can be searched through. Hides the button when false.

Events

EventDescription
linkClick(href: string)Emits the href clicked when it's not an internal document annotation.
pageChange(currentPage: number)Emits the current page number when the current page changes.

Contributors

Sean BanniganSean PerkinsJustin True
Sean BanniganSean PerkinsJustin True

FAQs

Last updated on 04 Feb 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc