vaadin-pdf-viewer

WebJar for vaadin-pdf-viewer

License	Apache-2.0
Categories	Vaadin User Interface Web Frameworks PDF Data
GroupId	org.webjars.bowergithub.vaadin
ArtifactId	vaadin-pdf-viewer
Last Version	1.0.0-alpha11
Release Date	Jan 25, 2019
Type	jar
Description	vaadin-pdf-viewer WebJar for vaadin-pdf-viewer
Project URL	http://webjars.org
Source Code Management	https://github.com/vaadin/vaadin-pdf-viewer

Download vaadin-pdf-viewer

Filename	Size
vaadin-pdf-viewer-1.0.0-alpha11.pom
vaadin-pdf-viewer-1.0.0-alpha11.jar	26 MB
vaadin-pdf-viewer-1.0.0-alpha11-sources.jar	22 bytes
vaadin-pdf-viewer-1.0.0-alpha11-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.bowergithub.vaadin/vaadin-pdf-viewer/ -->
<dependency>
    <groupId>org.webjars.bowergithub.vaadin</groupId>
    <artifactId>vaadin-pdf-viewer</artifactId>
    <version>1.0.0-alpha11</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.bowergithub.vaadin/vaadin-pdf-viewer/
implementation 'org.webjars.bowergithub.vaadin:vaadin-pdf-viewer:1.0.0-alpha11'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.bowergithub.vaadin/vaadin-pdf-viewer/
implementation ("org.webjars.bowergithub.vaadin:vaadin-pdf-viewer:1.0.0-alpha11")

Apache Buildr

'org.webjars.bowergithub.vaadin:vaadin-pdf-viewer:jar:1.0.0-alpha11'

Apache Ivy

<dependency org="org.webjars.bowergithub.vaadin" name="vaadin-pdf-viewer" rev="1.0.0-alpha11">
  <artifact name="vaadin-pdf-viewer" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.bowergithub.vaadin', module='vaadin-pdf-viewer', version='1.0.0-alpha11')
)

Scala SBT

libraryDependencies += "org.webjars.bowergithub.vaadin" % "vaadin-pdf-viewer" % "1.0.0-alpha11"

Leiningen

[org.webjars.bowergithub.vaadin/vaadin-pdf-viewer "1.0.0-alpha11"]

Dependencies

compile (11)

Group / Artifact	Type	Version
org.webjars.bowergithub.polymer : polymer	jar	[2.0.0,3)
org.webjars.bowergithub.vaadin : vaadin-lumo-styles	jar	[1.3.3,2)
org.webjars.bowergithub.vaadin : vaadin-element-mixin	jar	[2.0.0,3)
org.webjars.bowergithub.vaadin : vaadin-themable-mixin	jar	[1.2.0,2)
org.webjars.bowergithub.vaadin : vaadin-text-field	jar	[2.1.7,3)
org.webjars.bowergithub.vaadin : vaadin-select	jar	[2.0.2,3)
org.webjars.bowergithub.vaadin : vaadin-item	jar	[2.1.0,3)
org.webjars.bowergithub.vaadin : vaadin-list-box	jar	[1.1.0,2)
org.webjars.bowergithub.vaadin : vaadin-material-styles	jar	[1.2.0,2)
org.webjars.bowergithub.mozilla : pdfjs-dist	jar	[2.0.943,3)
org.webjars.bowergithub.vaadin : license-checker	jar	[2.1.0,3)

Project Modules

There are no modules declared in this project.

<vaadin-pdf-viewer>

<vaadin-pdf-viewer> is a Web Component providing a PDF viewer functionality, part of the Vaadin components.

🛠 Status: Alpha

This component is not considered production ready. Especially, IE11 compatibility is missing.

Live Demo ↗ | API documentation ↗

<vaadin-pdf-viewer>
  ...
</vaadin-pdf-viewer>

Installation

The Vaadin components are distributed as Bower and npm packages. Please note that the version range is the same, as the API has not changed. You should not mix Bower and npm versions in the same application, though.

Unlike the official Polymer Elements, the converted Polymer 3 compatible Vaadin components are only published on npm, not pushed to GitHub repositories.

Polymer 2 and HTML Imports compatible version

Install vaadin-pdf-viewer:

bower i vaadin/vaadin-pdf-viewer --save

Once installed, import it in your application:

<link rel="import" href="bower_components/vaadin-pdf-viewer/vaadin-pdf-viewer.html">

Polymer 3 and ES Modules compatible version

Install vaadin-pdf-viewer:

npm i @vaadin/vaadin-pdf-viewer --save

Once installed, import it in your application:

import '@vaadin/vaadin-pdf-viewer/vaadin-pdf-viewer.js';

Getting started

Vaadin components use the Lumo theme by default.

To use the Material theme, import the correspondent file from the theme/material folder.

Entry points

• The component with the Lumo theme:

  theme/lumo/vaadin-pdf-viewer.html

• The component with the Material theme:

  theme/material/vaadin-pdf-viewer.html

• Alias for theme/lumo/vaadin-pdf-viewer.html:

  vaadin-pdf-viewer.html

Running demos and tests in browser

1. Fork the vaadin-pdf-viewer repository and clone it locally.

2. Make sure you have npm installed.

3. When in the vaadin-pdf-viewer directory, run npm install and then bower install to install dependencies.

4. Make sure you have polymer-cli installed globally: npm i -g polymer-cli.

5. Run npm start, browser will automatically open the component API documentation.

6. You can also open demo or in-browser tests by adding demo or test to the URL, for example:

• http://127.0.0.1:8080/components/vaadin-pdf-viewer/demo
• http://127.0.0.1:8080/components/vaadin-pdf-viewer/test

Running tests from the command line

1. When in the vaadin-pdf-viewer directory, run polymer test

Following the coding style

We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running gulp lint, which will automatically lint all .js files as well as JavaScript snippets inside .html files.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs.

This component uses Mozilla's PDF.js.

Contributing

To contribute to the component, please read the guideline first.

License

Commercial Vaadin Add-on License version 3 (CVALv3). For license terms, see LICENSE.

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.

Vaadin

An open platform for building modern web apps for Java back ends

Versions

Version
1.0.0-alpha11 Jan 25, 2019
1.0.0-alpha10 Jan 24, 2019
1.0.0-alpha9 Jan 23, 2019
1.0.0-alpha7 Jan 23, 2019
1.0.0-alpha6 Jan 22, 2019
1.0.0-alpha5 Jan 21, 2019
1.0.0-alpha4 Jan 21, 2019
1.0.0-alpha3 Jan 18, 2019
1.0.0-alpha1 Jan 11, 2019