ng-images-preview 1.0.0 → 1.0.1

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.
Files changed (2) hide show
  1. package/README.md +24 -1
  2. package/package.json +26 -1
package/README.md CHANGED
@@ -16,7 +16,7 @@ A lightweight, modern, and accessible Image Preview library for Angular 18+, bui
16
16
  [中文版](./README.zh-CN.md) | English
17
17
 
18
18
  ## 🔗 Live Demo
19
- Check out the component in action: **[https://lanxuexing.github.io/ng-images-preview/](https://lanxuexing.github.io/ng-images-preview/)** (After deployment)
19
+ Check out the component in action: **[https://lanxuexing.github.io/ng-images-preview/](https://lanxuexing.github.io/ng-images-preview/)**
20
20
 
21
21
  </div>
22
22
 
@@ -45,6 +45,29 @@ npm install ng-images-preview
45
45
 
46
46
  ## 🚀 Quick Start
47
47
 
48
+ ### ⚠️ Prerequisite: Enable Animations
49
+
50
+ This library relies on Angular animations. You must enable them in your application.
51
+
52
+ **Standalone (app.config.ts):**
53
+ ```typescript
54
+ import { provideAnimations } from '@angular/platform-browser/animations';
55
+
56
+ export const appConfig: ApplicationConfig = {
57
+ providers: [provideAnimations()]
58
+ };
59
+ ```
60
+
61
+ **NgModule (app.module.ts):**
62
+ ```typescript
63
+ import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
64
+
65
+ @NgModule({
66
+ imports: [BrowserAnimationsModule]
67
+ })
68
+ export class AppModule { }
69
+ ```
70
+
48
71
  ### 1. Import Directive
49
72
 
50
73
  Register `ImagesPreviewDirective` in your standalone component or module.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ng-images-preview",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "peerDependencies": {
5
5
  "@angular/common": ">=17.3.0",
6
6
  "@angular/core": ">=17.3.0"
@@ -8,6 +8,31 @@
8
8
  "dependencies": {
9
9
  "tslib": "^2.3.0"
10
10
  },
11
+ "description": "A lightweight, mobile-ready Angular 18+ image preview library with zoom, rotate, flip, and custom template support. Built with Signals and Vanilla CSS.",
12
+ "keywords": [
13
+ "angular",
14
+ "image-preview",
15
+ "images-preview",
16
+ "image-viewer",
17
+ "lightbox",
18
+ "gallery",
19
+ "zoom",
20
+ "rotate",
21
+ "mobile-ready",
22
+ "touch-support",
23
+ "signals",
24
+ "standalone",
25
+ "vanilla-css"
26
+ ],
27
+ "author": "lanxuexing <lanxuexing313wsr@163.com>",
28
+ "license": "MIT",
29
+ "repository": {
30
+ "type": "git",
31
+ "url": "https://github.com/lanxuexing/ng-images-preview.git"
32
+ },
33
+ "bugs": {
34
+ "url": "https://github.com/lanxuexing/ng-images-preview/issues"
35
+ },
11
36
  "sideEffects": false,
12
37
  "module": "fesm2022/ng-images-preview.mjs",
13
38
  "typings": "types/ng-images-preview.d.ts",