@vaadin/vaadin-pdf-viewer
v1.0.0-alpha11
Published
vaadin-pdf-viewer
Downloads
20
Readme
<vaadin-pdf-viewer>
<vaadin-pdf-viewer> is a Web Component providing <element-functionality>, part of the Vaadin components.
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
Fork the
vaadin-pdf-viewer
repository and clone it locally.Make sure you have npm installed.
When in the
vaadin-pdf-viewer
directory, runnpm install
and thenbower install
to install dependencies.Make sure you have polymer-cli installed globally:
npm i -g polymer-cli
.Run
npm start
, browser will automatically open the component API documentation.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
- When in the
vaadin-pdf-viewer
directory, runpolymer 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.