-
-
Notifications
You must be signed in to change notification settings - Fork 100
/
Img.stories.tsx
513 lines (451 loc) · 14.6 KB
/
Img.stories.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
import React, {
ReactElement,
CSSProperties,
useEffect,
useLayoutEffect,
useMemo,
useState,
} from 'react'
import { ComponentStory, ComponentMeta } from '@storybook/react'
import { waitFor, within, userEvent } from '@storybook/testing-library'
import { expect } from '@storybook/jest'
import Zoom, { UncontrolledProps } from '../source'
import '../source/styles.css'
import './base.css'
import {
imgEarth,
imgGlenorchyLagoon,
imgHookerValleyTrack,
imgKeaLarge,
imgKeaSmall,
imgNzMap,
imgTeAraiPoint,
imgTekapo,
imgThatWanakaTree,
} from './images'
export default {
title: '<img>',
component: Zoom,
parameters: {},
} as ComponentMeta<typeof Zoom>
// =============================================================================
export const Regular: ComponentStory<typeof Zoom> = (props) => (
<main aria-label="Story">
<h1>Zooming a regular image</h1>
<div className="mw-600">
<Zoom {...props}>
<img
alt={imgThatWanakaTree.alt}
src={imgThatWanakaTree.src}
height="320"
loading="lazy"
/>
</Zoom>
</div>
</main>
)
// =============================================================================
export const ZoomMargin: ComponentStory<typeof Zoom> = (props) => (
<main aria-label="Story">
<h1>Setting a zoomMargin of 45(px)</h1>
<div className="mw-600">
<p>This example should always be offset from the window by at least 45px</p>
<Zoom {...props} zoomMargin={45}>
<img
alt={imgThatWanakaTree.alt}
src={imgThatWanakaTree.src}
height="320"
loading="lazy"
/>
</Zoom>
</div>
</main>
)
// =============================================================================
export const SmallPortrait: ComponentStory<typeof Zoom> = (props) => (
<main aria-label="Story">
<h1>A portrait image with a small width specified</h1>
<div className="mw-600">
<p>Small size specifications scale well, too — even on mobile.</p>
<Zoom {...props}>
<img
alt={imgTeAraiPoint.alt}
src={imgTeAraiPoint.src}
height="112"
loading="lazy"
/>
</Zoom>
</div>
</main>
)
// =============================================================================
export const SVGSource: ComponentStory<typeof Zoom> = (props) => (
<main aria-label="Story">
<h1>An image with an SVG src</h1>
<div className="mw-600">
<Zoom {...props}>
<img
alt={imgNzMap.alt}
src={imgNzMap.src}
width="150"
loading="lazy"
/>
</Zoom>
</div>
</main>
)
// =============================================================================
export const DataSVGSource: ComponentStory<typeof Zoom> = () => (
<main aria-label="Story">
<h1>An image with a <code>data:image/svg+xml</code> <code>src</code></h1>
<div className="data-uri-img mw-600">
<Zoom>
<img
alt="Gatsby G Logo"
src="data:image/svg+xml,%3Csvg width='24' height='24' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 2a10 10 0 110 20 10 10 0 010-20zm0 2c-3.73 0-6.86 2.55-7.75 6L14 19.75c3.45-.89 6-4.02 6-7.75h-5.25v1.5h3.45a6.37 6.37 0 01-3.89 4.44L6.06 9.69C7 7.31 9.3 5.63 12 5.63c2.13 0 4 1.04 5.18 2.65l1.23-1.06A7.959 7.959 0 0012 4zm-8 8a8 8 0 008 8c.04 0 .09 0-8-8z' fill='%23639'/%3E%3C/svg%3E"
/>
</Zoom>
</div>
</main>
)
// =============================================================================
export const ProvideZoomImg: ComponentStory<typeof Zoom> = (props) => (
<main aria-label="Story">
<h1>An image with a larger <code>zoomImg</code></h1>
<div className="mw-600">
<p>
When zoomed, the original image will scale to as large as the window will
allow, and then it will be replaced by an image that is downloaded in the
background.
</p>
<Zoom
{...props}
zoomImg={{
alt: imgKeaLarge.alt,
src: imgKeaLarge.src,
}}
>
<img
alt={imgKeaSmall.alt}
src={imgKeaSmall.src}
width="150"
/>
</Zoom>
</div>
</main>
)
// =============================================================================
export const SmallSrcSize: ComponentStory<typeof Zoom> = (props) => (
<main aria-label="Story">
<h1>An image with a small size</h1>
<div className="mw-600">
<p>
In order to prevent blurry images, An image won't scale up larger
than its natural dimensions.
</p>
<Zoom {...props}>
<img
alt={imgKeaSmall.alt}
src={imgKeaSmall.src}
width="150"
/>
</Zoom>
</div>
</main>
)
// =============================================================================
export const CustomModalStyles: ComponentStory<typeof Zoom> = (props) => {
return (
<main aria-label="Story">
<h1>Custom Modal Styles</h1>
<div className="mw-600">
<p>Use CSS to customize the zoom modal styles.</p>
<p>Here, we slow down the transition time and use a different overlay color.</p>
<div>
<Zoom {...props} classDialog="custom-zoom">
<img
alt={imgGlenorchyLagoon.alt}
src={imgGlenorchyLagoon.src}
width="400"
/>
</Zoom>
</div>
<p>
The CSS class, <code>custom-zoom</code>, is sent to the component via
the <code>classDialog</code> string prop. Here are the styles used:
</p>
<pre>
<code>{`
.custom-zoom [data-rmiz-modal-overlay],
.custom-zoom [data-rmiz-modal-img] {
transition-duration: 0.8s;
transition-timing-function: linear;
}
.custom-zoom [data-rmiz-modal-overlay="hidden"] {
background-color: rgb(56, 58, 89, 0);
}
.custom-zoom [data-rmiz-modal-overlay="visible"] {
background-color: rgb(56, 58, 89, 1);
}
.custom-zoom [data-rmiz-btn-unzoom] {
background-color: #bd93f9;
color: #000;
}
.custom-zoom [data-rmiz-btn-unzoom]:focus-visible {
outline-offset: 0.4rem;
outline: 0.2rem solid #bd93f9;
}
`}
</code>
</pre>
</div>
</main>
)
}
// =============================================================================
export const ModalFigureCaption: ComponentStory<typeof Zoom> = (props) => (
<main aria-label="Story">
<h1>Modal With Figure And Caption</h1>
<p>
If you want more control over the zoom modal's content, you can pass
a <code>ZoomContent</code> component
</p>
<div className="mw-600">
<Zoom {...props} ZoomContent={CustomZoomContent}>
<img
alt={imgThatWanakaTree.alt}
src={imgThatWanakaTree.src}
height="320"
loading="lazy"
/>
</Zoom>
</div>
</main>
)
const CustomZoomContent: UncontrolledProps['ZoomContent'] = ({
buttonUnzoom,
modalState,
img,
//onUnzooom, // Not used here, but could be
}) => {
const [isLoaded, setIsLoaded] = useState(false)
const imgProps = (img as ReactElement<HTMLImageElement>)?.props
const imgWidth = imgProps?.width
const imgHeight = imgProps?.height
const classCaption = useMemo(() => {
const hasWidthHeight = imgWidth && imgHeight
const imgRatioLargerThanWindow = imgWidth / imgHeight > window.innerWidth / window.innerHeight
return cx({
'zoom-caption': true,
'zoom-caption--loaded': isLoaded,
'zoom-caption--bottom': hasWidthHeight && imgRatioLargerThanWindow,
'zoom-caption--left': hasWidthHeight && !imgRatioLargerThanWindow,
})
}, [imgWidth, imgHeight, isLoaded])
useLayoutEffect(() => {
if (modalState === 'LOADED') {
setIsLoaded(true)
} else if (modalState === 'UNLOADING') {
setIsLoaded(false)
}
}, [modalState])
return <>
{buttonUnzoom}
<figure>
{img}
<figcaption className={classCaption}>
That Wanaka Tree, also known as the Wanaka Willow, is a willow tree
located at the southern end of Lake Wānaka in the Otago region of New
Zealand.
<cite className="zoom-caption-cite">
Wikipedia, <a className="zoom-caption-link" href="https://en.wikipedia.org/wiki/That_Wanaka_Tree">
That Wanaka Tree
</a>
</cite>
</figcaption>
</figure>
</>
}
// =============================================================================
type DelayedImgProps = {
timer: number
alt: string
src: string
width: string
height: string
}
const DelayedImg = (props: DelayedImgProps) => {
const { alt, height, src, timer, width } = props
const stylePlaceholder: CSSProperties = timer === 0
? { opacity: 0, visibility: 'hidden', position: 'absolute' }
: { opacity: 1 }
useEffect(() => {
const img = new Image()
img.src = src
img.decode()
}, [src])
return (
<div>
<img /* placeholder */
alt=""
aria-hidden="true"
decoding="async"
height={height}
src="data:image/jpeg;base64,/9j/2wBDABALDA4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVGC8aGi9jQjhCY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2P/wgARCAALABQDASIAAhEBAxEB/8QAFgABAQEAAAAAAAAAAAAAAAAAAgQA/8QAFgEBAQEAAAAAAAAAAAAAAAAAAgED/9oADAMBAAIQAxAAAAFutLOHXan/xAAaEAACAwEBAAAAAAAAAAAAAAAAEwIDEQES/9oACAEBAAEFAmyxnT3YKhiqxcD/xAAYEQADAQEAAAAAAAAAAAAAAAAAAQISUf/aAAgBAwEBPwFKjNdP/8QAFxEBAAMAAAAAAAAAAAAAAAAAAAERIf/aAAgBAgEBPwHFw//EABcQAQEBAQAAAAAAAAAAAAAAAAAxATL/2gAIAQEABj8Cq6qOUf/EAB0QAQACAgIDAAAAAAAAAAAAAAEAETFBIVFhcYH/2gAIAQEAAT8hLTa9xQK5/MRwq9wB94FrKsV+z//aAAwDAQACAAMAAAAQg+//xAAYEQACAwAAAAAAAAAAAAAAAAAAARFB0f/aAAgBAwEBPxBCxzaP/8QAFhEBAQEAAAAAAAAAAAAAAAAAAQAx/9oACAECAQE/EEUAZf/EAB0QAAICAgMBAAAAAAAAAAAAAAERADEhQVGRocH/2gAIAQEAAT8QrTbZUQmHR1CiO0TexMDR5OfZSZbuE1IcAh9n/9k="
style={stylePlaceholder}
width={width}
/>
{timer === 0 && <img
alt={alt}
decoding="async"
loading="lazy"
src={src}
width={width}
/>}
</div>
)
}
export const DelayedImageRender: ComponentStory<typeof Zoom> = (props) => {
const { timer } = useTimer(5000)
return (
<main aria-label="Story">
<h1>A sub-component which delays rendering</h1>
<div className="mw-600">
<p>
This examples simulates an issue caused by the gatsby-plugin-image
(and potentially others) where the actual image element isn't
found on the first render.
</p>
<div>
Image loads in: <span role="timer">{timer / 1000}</span>
</div>
<Zoom {...props}>
<DelayedImg
timer={timer}
alt={imgEarth.alt}
src={imgEarth.src}
height="200"
width="400"
/>
</Zoom>
</div>
</main>
)
}
// =============================================================================
export const DelayedDisplayNone: ComponentStory<typeof Zoom> = (props) => {
const { timer } = useTimer(5000)
const classImg = timer === 0 ? undefined : 'display-none'
return (
<main aria-label="Story">
<h1>A delayed <code>display: none;</code> image</h1>
<div className="mw-600">
<p>
This examples simulates an image being hidden with CSS and then shown
after the countdown.
</p>
<div>
Image loads in: <span role="timer">{timer / 1000}</span>
</div>
<Zoom {...props}>
<img
alt={imgTekapo.alt}
src={imgTekapo.src}
className={classImg}
decoding="async"
height="320"
loading="lazy"
/>
</Zoom>
</div>
</main>
)
}
// =============================================================================
export const CustomButtonIcons: ComponentStory<typeof Zoom> = (props) => (
<main aria-label="Story">
<h1>An image with custom zoom & unzoom icons</h1>
<div className="mw-600">
<p>Press TAB to activate the zoom button</p>
<div className="change-icons">
<Zoom {...props} IconZoom={() => <>+</>} IconUnzoom={() => <>-</>}>
<img
alt={imgHookerValleyTrack.alt}
src={imgHookerValleyTrack.src}
width="400"
/>
</Zoom>
</div>
</div>
</main>
)
// =============================================================================
export const InlineImage: ComponentStory<typeof Zoom> = (props) => (
<main aria-label="Story">
<h1>Inline Image</h1>
<p className="inline">
This example is of an image that is inline with text.
<Zoom {...props} wrapElement="span">
<img
alt={imgThatWanakaTree.alt}
src={imgThatWanakaTree.src}
decoding="async"
height="320"
loading="lazy"
/>
</Zoom>
</p>
</main>
)
// =============================================================================
// INTERACTIONS
export const AutomatedTest = Regular.bind({}, { title: '(Automated Test)' })
AutomatedTest.storyName = '(Automated Test)'
AutomatedTest.play = async ({ canvasElement }) => {
const canvas = within(canvasElement)
await waitFor(async () => {
await expect(canvas.getByLabelText(`Expand image: ${imgThatWanakaTree.alt}`)).toBeVisible()
})
await delay(1000)
// TAB to expand button and press ENTER
await userEvent.tab()
await userEvent.keyboard('{Enter}', { delay: 1000 })
await waitFor(async () => {
await expect(document.querySelector('dialog')).toHaveAttribute('open')
await expect(document.querySelector('dialog').querySelector(`img[alt="${imgThatWanakaTree.alt}"]`)).toBeVisible()
await expect(document.querySelector('dialog').querySelector('[aria-label="Minimize image"')).toHaveFocus()
})
await delay(1000)
await userEvent.keyboard('{Escape}', { delay: 1000 })
await waitFor(async () => {
await expect(document.querySelector('dialog')).not.toHaveAttribute('open')
await expect(canvas.getByLabelText(`Expand image: ${imgThatWanakaTree.alt}`)).toHaveFocus()
})
}
// =============================================================================
// HELPERS
const cx = (mods) => {
const cns = []
for (const k in mods) {
if (mods[k]) {
cns.push(k)
}
}
return cns.join(' ')
}
const delay = (duration) =>
new Promise(resolve => setTimeout(resolve, duration))
const useTimer = (duration: number) => {
const [timer, setTimer] = useState(duration)
useEffect(() => {
const interval = setInterval(function () {
if (timer === 0) {
clearInterval(this)
} else {
setTimer(timer - 1000)
}
}, 1000)
return () => clearInterval(interval)
}, [timer])
return { timer }
}