https://github.com/viobui/ngx-imageviewer
https://github.com/viobui/ngx-imageviewer
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/viobui/ngx-imageviewer
- Owner: viobui
- Created: 2024-09-27T08:39:00.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-08T06:47:34.000Z (7 months ago)
- Last Synced: 2024-10-14T13:01:52.376Z (7 months ago)
- Language: TypeScript
- Size: 15.7 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- fucking-awesome-angular - ngx-imageviewer - Generate a image/pdf viewer using canvas. (Table of contents / Third Party Components)
- awesome-angular - ngx-imageviewer - Generate a image/pdf viewer using canvas. (Table of contents / Third Party Components)
- trackawesomelist - ngx-imageviewer (⭐1) - Generate a image/pdf viewer using canvas. (Recently Updated / [Oct 12, 2024](/content/2024/10/12/README.md))
README
# Angular 18 - Canvas Image/PDF Viewer
[](https://travis-ci.org/hallysonh/ngx-imageviewer)
[](https://greenkeeper.io/)
[](http://npm.im/@hallysonh/ngx-imageviewer)
[](https://opensource.org/licenses/MIT)
[](https://github.com/semantic-release/semantic-release)
This project generate a image/pdf viewer using canvas.
## Features
- Configurable
- Resizeble component
- Supports JPEG, PNG, GIF and **PDF**
- Support File Objects
- Avaliable actions:
- **Rotate**
- **Zoom**
- Reset to maximize size
- Free movable
- Change page (available just for PDF files)
## Demo
Access a demo [here](https://hallysonh.github.io/ngx-imageviewer/) or download this project and execute: `yarn && yarn start` or `npm install && npm run start` to self server it.
## Install
Run `yarn add @hallysonh/ngx-imageviewer hammerjs` to install it and its dependency.
> hammerjs is currently mandatory, but it will be optional in a future release.
## Icon Font
You can use any icon font to render the button's icons. However, the default icon font is the Google's Material Icons. To use them you can just add the follow line to your index.html:
```html
```
Optionaly, you can also install the font library via npm or yarn.
> when using another icon font, you should provide a config object with the button icon mapping
## Basic Usage
After import the module `ImageViewerModule`:
```typescript
import { ImageViewerModule } from '@hallysonh/ngx-imageviewer';
@NgModule({
imports: [ImageViewerModule],
})
export class AppModule {}
```
Use the follow code on your html:
```html
```
Optionaly, you can provide the fields `width` and `height`. If you omit those values, the width and height in the config object will be used.
## Add PDF Support
To add PDF rendering support, you must first include `pdfjs` by running `yarn add [email protected]` and add its reference in your `angular.json` file, like below:
```json
{
...
"scripts": [
{
"input": "node_modules/pdfjs-dist/build/pdf.min.js"
}, {
"input": "node_modules/pdfjs-dist/build/pdf.worker.min.js"
}
],
...
}
```
## Custom Configuration
Optionaly, you can provide a custom configuration like below:
```typescript
import { IMAGEVIEWER_CONFIG, ImageViewerConfig } from '@hallysonh/ngx-imageviewer';
...
const MY_IMAGEVIEWER_CONFIG: ImageViewerConfig = {
buttonStyle: {
bgStyle: '#B71C1C' // custom container's background style
}
};
...
@Component({
...
providers: [
{
provide: IMAGEVIEWER_CONFIG,
useValue: MY_IMAGEVIEWER_CONFIG
}
]
...
})
...
```
The default configuration available is:
```typescript
export const IMAGEVIEWER_CONFIG_DEFAULT: ImageViewerConfig = {
width: 800, // component default width
height: 600, // component default height
bgStyle: '#ECEFF1', // component background style
scaleStep: 0.1, // zoom scale step (using the zoom in/out buttons)
rotateStepper: false, // touch rotate should rotate only 90 to 90 degrees
loadingMessage: 'Loading...',
buttonStyle: {
iconFontFamily: 'Material Icons', // font used to render the button icons
alpha: 0.5, // buttons' transparence value
hoverAlpha: 0.7, // buttons' transparence value when mouse is over
bgStyle: '#000000', // buttons' background style
iconStyle: '#ffffff', // buttons' icon colors
borderStyle: '#000000', // buttons' border style
borderWidth: 0, // buttons' border width (0 == disabled)
},
tooltips: {
enabled: true, // enable or disable tooltips for buttons
bgStyle: '#000000', // tooltip background style
bgAlpha: 0.5, // tooltip background transparence
textStyle: '#ffffff', // tooltip's text style
textAlpha: 0.9, // tooltip's text transparence
padding: 15, // tooltip padding
radius: 20, // tooltip border radius
},
zoomOutButton: {
// zoomOut button config
icon: 'zoom_out', // icon text
tooltip: 'Zoom out', // button tooltip
sortId: 0, // number used to determine the order of the buttons
show: true, // used to show/hide the button
},
// shorter button configuration style
nextPageButton: createButtonConfig('navigate_next', 'Next page', 0),
beforePageButton: createButtonConfig('navigate_before', 'Previous page', 1),
zoomInButton: createButtonConfig('zoom_in', 'Zoom in', 1),
rotateLeftButton: createButtonConfig('rotate_left', 'Rotate left', 2),
rotateRightButton: createButtonConfig('rotate_right', 'Rotate right', 3),
resetButton: createButtonConfig('autorenew', 'Reset', 4),
};
```