@record-evolution/widget-image 1.1.11 → 1.1.13
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/README.md +16 -5
- package/dist/widget-image.js +605 -614
- package/dist/widget-image.js.map +1 -1
- package/package.json +8 -13
- package/src/default-data.json +21 -1
- package/src/definition-schema.d.ts +39 -0
- package/src/definition-schema.json +75 -1
- package/src/widget-image.ts +241 -25
- package/dist/src/widget-image.d.ts +0 -20
- package/dist/tsconfig.tsbuildinfo +0 -1
package/README.md
CHANGED
|
@@ -5,30 +5,41 @@ This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) reco
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm i widget-image
|
|
8
|
+
npm i @record-evolution/widget-image
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
13
13
|
```html
|
|
14
14
|
<script type="module">
|
|
15
|
-
|
|
15
|
+
import '@record-evolution/widget-image/widget-image.js'
|
|
16
16
|
</script>
|
|
17
17
|
|
|
18
|
-
<widget-image></widget-image>
|
|
18
|
+
<widget-image-1.1.12></widget-image-1.1.12>
|
|
19
19
|
```
|
|
20
|
+
|
|
20
21
|
## Expected data format
|
|
21
22
|
|
|
23
|
+
The widget supports both single image and multi-image modes:
|
|
24
|
+
|
|
25
|
+
### Single Image Mode
|
|
26
|
+
|
|
27
|
+
Display a single image with optional title and subtitle.
|
|
28
|
+
|
|
29
|
+
### Multi Image Mode
|
|
30
|
+
|
|
31
|
+
Display multiple images in an optimized grid layout with automatic sizing and aspect ratio calculation.
|
|
32
|
+
|
|
22
33
|
## Tooling configs
|
|
23
34
|
|
|
24
35
|
For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
|
|
25
36
|
|
|
26
37
|
If you customize the configuration a lot, you can consider moving them to individual files.
|
|
27
38
|
|
|
28
|
-
## Local Demo with
|
|
39
|
+
## Local Demo with Vite
|
|
29
40
|
|
|
30
41
|
```bash
|
|
31
42
|
npm start
|
|
32
43
|
```
|
|
33
44
|
|
|
34
|
-
To run a local development server that serves the basic demo
|
|
45
|
+
To run a local development server that serves the basic demo at http://localhost:8000/demo/
|