pixedi 1.0.5 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/README.md +7 -7
- package/README.npm.md +7 -7
- package/dist/lib/index.js +737 -549
- package/dist/lib/index.umd.js +5 -5
- package/dist/widget/pixedi-widget.js +7 -7
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
|
|
5
|
+
## 1.1.0
|
|
6
|
+
|
|
7
|
+
- Added a flip tool with horizontal and vertical mirroring and live preview.
|
|
8
|
+
|
|
9
|
+
## 1.0.6
|
|
10
|
+
|
|
11
|
+
- Created a dedicated `README.widget.md` with full widget API documentation and examples.
|
|
12
|
+
- Included `README.widget.md` in the npm package.
|
|
13
|
+
- Updated npm README to link to the widget documentation.
|
|
14
|
+
|
|
5
15
|
## 1.0.5
|
|
6
16
|
|
|
7
17
|
- Professionalized CI/CD pipeline: split build, deploy, and publish into separate jobs.
|
package/README.md
CHANGED
|
@@ -36,18 +36,18 @@ npm install react react-dom
|
|
|
36
36
|
### Import
|
|
37
37
|
|
|
38
38
|
```tsx
|
|
39
|
-
import {
|
|
39
|
+
import { Pixedi } from "pixedi";
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
### Usage
|
|
43
43
|
|
|
44
44
|
```tsx
|
|
45
|
-
import {
|
|
45
|
+
import { Pixedi } from "pixedi";
|
|
46
46
|
|
|
47
47
|
function App() {
|
|
48
48
|
return (
|
|
49
49
|
<div style={{ width: "100vw", height: "100vh" }}>
|
|
50
|
-
<
|
|
50
|
+
<Pixedi
|
|
51
51
|
image="https://example.com/photo.jpg"
|
|
52
52
|
onSave={async (base64) => {
|
|
53
53
|
// Upload or persist the edited image
|
|
@@ -73,10 +73,12 @@ function App() {
|
|
|
73
73
|
|
|
74
74
|
## Widget CDN
|
|
75
75
|
|
|
76
|
-
For non-React environments, use the standalone UMD widget from a CDN.
|
|
76
|
+
For non-React environments, use the standalone UMD widget from a CDN. See [`README.widget.md`](https://github.com/rastiv/pixedi/blob/main/README.widget.md) for full usage instructions, API reference, and examples.
|
|
77
|
+
|
|
78
|
+
Pin to a specific version in production:
|
|
77
79
|
|
|
78
80
|
```html
|
|
79
|
-
<script src="https://cdn.jsdelivr.net/npm/pixedi@1.0.
|
|
81
|
+
<script src="https://cdn.jsdelivr.net/npm/pixedi@1.0.6/dist/widget/pixedi-widget.js"></script>
|
|
80
82
|
```
|
|
81
83
|
|
|
82
84
|
For the latest version (use only for testing):
|
|
@@ -85,8 +87,6 @@ For the latest version (use only for testing):
|
|
|
85
87
|
<script src="https://cdn.jsdelivr.net/npm/pixedi/dist/widget/pixedi-widget.js"></script>
|
|
86
88
|
```
|
|
87
89
|
|
|
88
|
-
The widget exposes `ImageEditorWidget` on the global `window` object after the script loads.
|
|
89
|
-
|
|
90
90
|
## TypeScript
|
|
91
91
|
|
|
92
92
|
TypeScript declarations are included under `dist/lib/index.d.ts`. No additional `@types` package is required.
|
package/README.npm.md
CHANGED
|
@@ -36,18 +36,18 @@ npm install react react-dom
|
|
|
36
36
|
### Import
|
|
37
37
|
|
|
38
38
|
```tsx
|
|
39
|
-
import {
|
|
39
|
+
import { Pixedi } from "pixedi";
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
### Usage
|
|
43
43
|
|
|
44
44
|
```tsx
|
|
45
|
-
import {
|
|
45
|
+
import { Pixedi } from "pixedi";
|
|
46
46
|
|
|
47
47
|
function App() {
|
|
48
48
|
return (
|
|
49
49
|
<div style={{ width: "100vw", height: "100vh" }}>
|
|
50
|
-
<
|
|
50
|
+
<Pixedi
|
|
51
51
|
image="https://example.com/photo.jpg"
|
|
52
52
|
onSave={async (base64) => {
|
|
53
53
|
// Upload or persist the edited image
|
|
@@ -73,10 +73,12 @@ function App() {
|
|
|
73
73
|
|
|
74
74
|
## Widget CDN
|
|
75
75
|
|
|
76
|
-
For non-React environments, use the standalone UMD widget from a CDN.
|
|
76
|
+
For non-React environments, use the standalone UMD widget from a CDN. See [`README.widget.md`](https://github.com/rastiv/pixedi/blob/main/README.widget.md) for full usage instructions, API reference, and examples.
|
|
77
|
+
|
|
78
|
+
Pin to a specific version in production:
|
|
77
79
|
|
|
78
80
|
```html
|
|
79
|
-
<script src="https://cdn.jsdelivr.net/npm/pixedi@1.0.
|
|
81
|
+
<script src="https://cdn.jsdelivr.net/npm/pixedi@1.0.6/dist/widget/pixedi-widget.js"></script>
|
|
80
82
|
```
|
|
81
83
|
|
|
82
84
|
For the latest version (use only for testing):
|
|
@@ -85,8 +87,6 @@ For the latest version (use only for testing):
|
|
|
85
87
|
<script src="https://cdn.jsdelivr.net/npm/pixedi/dist/widget/pixedi-widget.js"></script>
|
|
86
88
|
```
|
|
87
89
|
|
|
88
|
-
The widget exposes `ImageEditorWidget` on the global `window` object after the script loads.
|
|
89
|
-
|
|
90
90
|
## TypeScript
|
|
91
91
|
|
|
92
92
|
TypeScript declarations are included under `dist/lib/index.d.ts`. No additional `@types` package is required.
|