Spaces:
Sleeping
Sleeping
File size: 3,364 Bytes
391a73c | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | <p align="center">
<img src="https://user-images.githubusercontent.com/5600341/27505816-c8bc37aa-587f-11e7-9a86-08a2d081a8b9.png" height="280px">
</p>
# @react-pdf/image
Image parsing and resolution library for react-pdf. Handles PNG and JPEG images from various sources including local files, remote URLs, base64 data URIs, buffers, and blobs.
## Installation
```bash
yarn add @react-pdf/image
```
## Usage
```js
import resolveImage from '@react-pdf/image';
const image = await resolveImage({ uri: './path/to/image.png' });
console.log(image.width); // Image width in pixels
console.log(image.height); // Image height in pixels
console.log(image.format); // 'png' or 'jpeg'
console.log(image.data); // Buffer containing image data
```
## Image Sources
The library supports multiple image source types:
### Local File
```js
const image = await resolveImage({ uri: './image.png' });
// or
const image = await resolveImage({ uri: '/absolute/path/to/image.jpg' });
```
> **Note:** Local file resolution is only available in Node.js environments.
### Remote URL
```js
const image = await resolveImage({ uri: 'https://example.com/image.png' });
```
With custom request options:
```js
const image = await resolveImage({
uri: 'https://example.com/image.png',
method: 'GET',
headers: {
Authorization: 'Bearer token',
},
body: null,
credentials: 'include',
});
```
### Base64 Data URI
```js
const image = await resolveImage({
uri: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
});
```
### Buffer
```js
import fs from 'fs';
const buffer = fs.readFileSync('./image.png');
const image = await resolveImage(buffer);
```
### Blob (Browser)
```js
const response = await fetch('https://example.com/image.png');
const blob = await response.blob();
const image = await resolveImage(blob);
```
### Data Object
```js
const image = await resolveImage({
data: imageBuffer,
format: 'png', // 'png', 'jpg', or 'jpeg'
});
```
## Caching
Images are cached by default to avoid redundant processing. You can disable caching for individual requests:
```js
const image = await resolveImage({ uri: './image.png' }, { cache: false });
```
The cache has a default limit of 30 entries and uses LRU (Least Recently Used) eviction.
## Types
### Image
The resolved image object:
```ts
interface Image {
width: number;
height: number;
data: Buffer;
format: 'jpeg' | 'png';
key?: string;
}
```
### ImageSrc
All supported image source types:
```ts
type ImageSrc =
| Blob
| Buffer
| DataImageSrc
| LocalImageSrc
| RemoteImageSrc
| Base64ImageSrc;
type DataImageSrc = {
data: Buffer;
format: 'jpg' | 'jpeg' | 'png';
};
type LocalImageSrc = {
uri: string;
format?: 'jpg' | 'jpeg' | 'png';
};
type RemoteImageSrc = {
uri: string;
method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
headers?: Record<string, string>;
format?: 'jpg' | 'jpeg' | 'png';
body?: any;
credentials?: 'omit' | 'same-origin' | 'include';
};
type Base64ImageSrc = {
uri: `data:image${string}`;
};
```
## Supported Formats
- **PNG** - Portable Network Graphics
- **JPEG/JPG** - Joint Photographic Experts Group
JPEG images with EXIF orientation data are automatically handled, with width and height adjusted accordingly.
## License
MIT
|