Skip to content

Commit ebda3f3

Browse files
committed
readme usage
1 parent b573ec9 commit ebda3f3

4 files changed

Lines changed: 1172 additions & 1190 deletions

File tree

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ export class AppComponent {
5252
src: '/img/image1.jpg'
5353
},
5454
{
55-
src: 'https://picsum.photos/id/237/2000/3000',
56-
thumbnail: 'https://picsum.photos/id/237/160/160',
55+
src: 'https://picsum.photos/id/237/2000/3000',
56+
thumbnail: 'https://picsum.photos/id/237/160/160',
5757
}]
5858
}
5959
```
@@ -68,7 +68,17 @@ export class AppComponent {
6868

6969
### Input parameters
7070

71-
| Name | Required | Type | Default | Description |
72-
|---------------|----------|---------------|---------|------------------------------------------|
73-
| galleryItems | yes | GalleryItem[] | [ ] | Contains the list of images |
74-
| thumbnailSize | no | number | 160 | The width/height of the thumbnails in px |
71+
| Name | Required | Type | Default | Description |
72+
|---------------|----------|---------------|---------------------------------------|----------------------------------------------|
73+
| galleryItems | yes | GalleryItem[] | [ ] | Contains the list of images |
74+
| emptyMessage | no | string | 'Empty gallery, no images provided.' | Message to show in case empty items provided |
75+
| thumbnailSize | no | number | 160 | The width/height of the thumbnails in px |
76+
77+
### 3. When all parameters set
78+
79+
```html
80+
<ngx-simple-gallery [galleryItems]="galleryItems"
81+
[thumbnailSize]="65"
82+
emptyMessage="Please provide some images">
83+
</ngx-simple-gallery>
84+
```

0 commit comments

Comments
 (0)