@thisiscrowd/crowdbox 1.0.1 → 1.0.2
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 +17 -12
- package/dist/crowdbox.esm.js +1 -1
- package/dist/crowdbox.umd.js +1 -1
- package/package.json +8 -4
package/README.md
CHANGED
|
@@ -34,10 +34,10 @@ yarn add @thisiscrowd/crowdbox
|
|
|
34
34
|
|
|
35
35
|
```html
|
|
36
36
|
<!-- CSS -->
|
|
37
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@thisiscrowd/crowdbox@
|
|
37
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@thisiscrowd/crowdbox@latest/dist/crowdbox.css">
|
|
38
38
|
|
|
39
39
|
<!-- JavaScript (UMD) -->
|
|
40
|
-
<script src="https://cdn.jsdelivr.net/npm/@thisiscrowd/crowdbox@
|
|
40
|
+
<script src="https://cdn.jsdelivr.net/npm/@thisiscrowd/crowdbox@latest/dist/crowdbox.umd.js"></script>
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
---
|
|
@@ -76,8 +76,8 @@ yarn add @thisiscrowd/crowdbox
|
|
|
76
76
|
### JavaScript API
|
|
77
77
|
|
|
78
78
|
```js
|
|
79
|
-
import Crowdbox from
|
|
80
|
-
import 'crowdbox/styles';
|
|
79
|
+
import Crowdbox from "@thisiscrowd/crowdbox";
|
|
80
|
+
import '@thisiscrowd/crowdbox/styles';
|
|
81
81
|
|
|
82
82
|
const gallery = new Crowdbox({ loop: true, thumbnails: true });
|
|
83
83
|
|
|
@@ -182,8 +182,8 @@ gallery.destroy();
|
|
|
182
182
|
### GalleryGrid (simplest)
|
|
183
183
|
|
|
184
184
|
```jsx
|
|
185
|
-
import { GalleryGrid } from 'crowdbox/react';
|
|
186
|
-
import 'crowdbox/styles';
|
|
185
|
+
import { GalleryGrid } from '@thisiscrowd/crowdbox/react';
|
|
186
|
+
import '@thisiscrowd/crowdbox/styles';
|
|
187
187
|
|
|
188
188
|
const items = [
|
|
189
189
|
{ src: 'photo1.jpg', type: 'image', thumb: 'thumb1.jpg', caption: 'Photo 1' },
|
|
@@ -198,7 +198,8 @@ export default function Page() {
|
|
|
198
198
|
### Controlled Lightbox component
|
|
199
199
|
|
|
200
200
|
```jsx
|
|
201
|
-
import { Lightbox } from 'crowdbox/react';
|
|
201
|
+
import { Lightbox } from '@thisiscrowd/crowdbox/react';
|
|
202
|
+
import '@thisiscrowd/crowdbox/styles';
|
|
202
203
|
|
|
203
204
|
const [open, setOpen] = useState(false);
|
|
204
205
|
|
|
@@ -214,7 +215,8 @@ const [open, setOpen] = useState(false);
|
|
|
214
215
|
### useLightbox hook
|
|
215
216
|
|
|
216
217
|
```jsx
|
|
217
|
-
import { useLightbox } from 'crowdbox/react';
|
|
218
|
+
import { useLightbox } from '@thisiscrowd/crowdbox/react';
|
|
219
|
+
import '@thisiscrowd/crowdbox/styles';
|
|
218
220
|
|
|
219
221
|
function MyGallery({ items }) {
|
|
220
222
|
const { open } = useLightbox({ thumbnails: true, captions: true });
|
|
@@ -241,8 +243,8 @@ export default function Gallery({ items }) {
|
|
|
241
243
|
useEffect(() => {
|
|
242
244
|
let g;
|
|
243
245
|
// Dynamic import keeps Crowdbox out of the server bundle
|
|
244
|
-
import('crowdbox').then(({ Crowdbox }) => {
|
|
245
|
-
import('crowdbox/styles');
|
|
246
|
+
import('@thisiscrowd/crowdbox').then(({ Crowdbox }) => {
|
|
247
|
+
import('@thisiscrowd/crowdbox/styles');
|
|
246
248
|
g = new Crowdbox({ selector: null, thumbnails: true });
|
|
247
249
|
galleryRef.current = g;
|
|
248
250
|
});
|
|
@@ -265,9 +267,12 @@ export default function Gallery({ items }) {
|
|
|
265
267
|
}
|
|
266
268
|
```
|
|
267
269
|
|
|
270
|
+
## Plugins & Adapters
|
|
271
|
+
|
|
272
|
+
### Custom plugin
|
|
268
273
|
|
|
269
274
|
```js
|
|
270
|
-
import { Registry } from 'crowdbox';
|
|
275
|
+
import { Registry } from '@thisiscrowd/crowdbox';
|
|
271
276
|
|
|
272
277
|
const WatermarkPlugin = {
|
|
273
278
|
pluginName: 'watermark',
|
|
@@ -296,7 +301,7 @@ const gallery = new Crowdbox({ watermark: true });
|
|
|
296
301
|
### Custom media adapter
|
|
297
302
|
|
|
298
303
|
```js
|
|
299
|
-
import { Registry } from 'crowdbox';
|
|
304
|
+
import { Registry } from '@thisiscrowd/crowdbox';
|
|
300
305
|
|
|
301
306
|
Registry.registerAdapter('soundcloud', {
|
|
302
307
|
type: 'soundcloud',
|
package/dist/crowdbox.esm.js
CHANGED
package/dist/crowdbox.umd.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@thisiscrowd/crowdbox",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "A modern, lightweight, extensible Crowdbox gallery plugin supporting images and video",
|
|
6
6
|
"main": "dist/crowdbox.umd.js",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"license": "MIT",
|
|
44
44
|
"repository": {
|
|
45
45
|
"type": "git",
|
|
46
|
-
"url": "https://github.com/thisiscrowd/crowdbox.git"
|
|
46
|
+
"url": "git+https://github.com/thisiscrowd/crowdbox.git"
|
|
47
47
|
},
|
|
48
48
|
"homepage": "https://github.com/thisiscrowd/crowdbox#readme",
|
|
49
49
|
"bugs": {
|
|
@@ -61,7 +61,11 @@
|
|
|
61
61
|
"react-dom": ">=17.0.0"
|
|
62
62
|
},
|
|
63
63
|
"peerDependenciesMeta": {
|
|
64
|
-
"react": {
|
|
65
|
-
|
|
64
|
+
"react": {
|
|
65
|
+
"optional": true
|
|
66
|
+
},
|
|
67
|
+
"react-dom": {
|
|
68
|
+
"optional": true
|
|
69
|
+
}
|
|
66
70
|
}
|
|
67
71
|
}
|