Package Health Score

71 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.2.3	\|	03/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (0)

GitHub Stars: 739
Forks: 111
Contributors: 30

Direct Usage Popularity

The npm package tar-vue-pdf-embed receives a total of 0 downloads a week. As such, we scored tar-vue-pdf-embed popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package tar-vue-pdf-embed, we found that it has been starred 739 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the tar-vue-pdf-embed repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like tar-vue-pdf-embed is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 27
Open PR: 1
Last Release: 8 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of tar-vue-pdf-embed based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that tar-vue-pdf-embed demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 8 months
Dependencies: 0 Direct
Versions: 4
Install Size: 3.47 MB
Dist-tags: 1
# of Files: 14
Maintainers: 1
TS Typings: No

tar-vue-pdf-embed has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

📄 vue-pdf-embed

PDF embed component for Vue 2 and Vue 3

Features

Controlled rendering of PDF documents in Vue apps
Handles password protected documents
Includes text layer (searchable and selectable documents)
Includes annotation layer (annotations and links)
No peer dependencies or additional configuration required
Can be used directly in the browser (see Examples)

Compatibility

This package is compatible with both Vue 2 and Vue 3, but consists of two separate builds. The default exported build is for Vue 3, for Vue 2 import dist/vue2-pdf-embed.js (see Usage).

Installation

Depending on the environment, the package can be installed in one of the following ways:

npm install vue-pdf-embed@1

yarn add vue-pdf-embed@1

Usage

<template>
  <div>
    <h1>File</h1>
    

    <h1>Base64</h1>
    
  </div>
</template>

Props

Name	Type	Accepted values	Description
annotationLayer	`boolean`	`true` or `false`	whether the annotation layer should be enabled
height	`number` `string`	natural numbers	desired page height in pixels (ignored if the width property is specified)
imageResourcesPath	`string`	URL or path with trailing slash	path for icons used in the annotation layer
page	`number`	`1` to the last page number	number of the page to display (displays all pages if not specified)
rotation	`number` `string`	`0`, `90`, `180` or `270` (multiples of `90`)	desired page rotation angle in degrees
scale	`number`	rational numbers	desired ratio of canvas size to document size
source	`string` `object` `Uint8Array`	document URL or typed array pre-filled with data	source of the document to display
textLayer	`boolean`	`true` or `false`	whether the text layer should be enabled
width	`number` `string`	natural numbers	desired page width in pixels

Events

Name	Value	Description
internal-link-clicked	destination page number	internal link was clicked
loaded	PDF document proxy	finished loading the document
loading-failed	error object	failed to load document
password-requested	callback function, retry flag	password is needed to display the document
progress	progress params object	tracking document loading progress
rendered	–	finished rendering the document
rendering-failed	error object	failed to render document

Slots

Name	Props	Description
after-page	`page` (page number)	content to be added after the page
before-page	`page` (page number)	content to be added before the page

Public Methods

Name	Arguments	Description
download	filename (`string`)	download document
print	print resolution (`number`), filename (`string`), all pages flag (`boolean`)	print document via browser interface
render	–	manually (re)render document

Note: Public methods can be accessed via a template ref.

Static Methods

Besides the component itself, the module also includes a getDocument function for manual loading of PDF documents, which can then be used as the source prop of the component. In most cases it is sufficient to specify the source prop with a URL or typed array, while the result of the getDocument function can be used in special cases, such as sharing the source between multiple component instances. This is an advanced topic, so it is recommended to check the source code of the component before using this function.

Common Issues

This is a client-side library, so it is important to keep this in mind when working with SSR (server-side rendering) frameworks such as Nuxt. Depending on the framework used, you may need to properly configure the library import or use a wrapper.

The path to predefined CMaps should be specified to ensure correct rendering of documents containing non-Latin characters, as well as in case of CMap-related errors:

The image resource path must be specified for annotations to display correctly:

Note: The examples above use a CDN to load resources, however these resources can also be included in the build by installing the pdfjs-dist package as a dependency and further configuring the bundler.

Examples

Basic Usage Demo (JSFiddle)

Advanced Usage Demo (JSFiddle)

Advanced Usage Demo (StackBlitz)

License

MIT License. Please see LICENSE file for more information.

FAQs

What is tar-vue-pdf-embed?

PDF embed component for Vue 2 and Vue 3. Visit Snyk Advisor to see a full health score report for tar-vue-pdf-embed, including popularity, security, maintenance & community analysis.

Is tar-vue-pdf-embed popular?

We’re still processing downloads data for the npm package tar-vue-pdf-embed. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is tar-vue-pdf-embed well maintained?

We found indications that tar-vue-pdf-embed maintenance is sustainable demonstrating some project activity. We saw a total of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is tar-vue-pdf-embed safe to use?

The npm package tar-vue-pdf-embed was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 22 November-2024, at 12:08 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (0)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

📄 vue-pdf-embed

Features

Compatibility

Installation

Usage

Props

Events

Slots

Public Methods

Static Methods

Common Issues

Examples

License

tar-vue-pdf-embed development dependencies

FAQs

What is tar-vue-pdf-embed?

Is tar-vue-pdf-embed popular?

Is tar-vue-pdf-embed well maintained?

Is tar-vue-pdf-embed safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues