@getflip/swirl-components 0.137.0 → 0.138.0

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.
@@ -20,6 +20,7 @@
20
20
  "./components/swirl-file-viewer/viewers/swirl-file-viewer-pdf/swirl-file-viewer-pdf.js",
21
21
  "./components/swirl-form-control/swirl-form-control.js",
22
22
  "./components/swirl-form-group/swirl-form-group.js",
23
+ "./components/swirl-image-grid-item/swirl-image-grid-item.js",
23
24
  "./components/swirl-inline-error/swirl-inline-error.js",
24
25
  "./components/swirl-inline-notification/swirl-inline-notification.js",
25
26
  "./components/swirl-inline-status/swirl-inline-status.js",
@@ -221,7 +222,6 @@
221
222
  "./components/swirl-icon/icons/swirl-icon-voice.js",
222
223
  "./components/swirl-icon/icons/swirl-icon-warning.js",
223
224
  "./components/swirl-image-grid/swirl-image-grid.js",
224
- "./components/swirl-image-grid-item/swirl-image-grid-item.js",
225
225
  "./components/swirl-lightbox/swirl-lightbox.js",
226
226
  "./components/swirl-list/swirl-list.js",
227
227
  "./components/swirl-menu-item/swirl-menu-item.js",
@@ -1,6 +1,6 @@
1
1
  import { newSpecPage } from "@stencil/core/testing";
2
- import { SwirlImageGrid } from "./swirl-image-grid";
3
2
  import { SwirlImageGridItem } from "../swirl-image-grid-item/swirl-image-grid-item";
3
+ import { SwirlImageGrid } from "./swirl-image-grid";
4
4
  describe("swirl-image-grid", () => {
5
5
  it("renders a single item", async () => {
6
6
  const page = await newSpecPage({
@@ -23,6 +23,9 @@ describe("swirl-image-grid", () => {
23
23
  <button class="image-grid-item" type="button">
24
24
  <div class="image-grid-item__background" style="background-image: url(/sample.jpg);"></div>
25
25
  <img alt="Cute dog in a blanket" class="image-grid-item__image" src="/sample.jpg">
26
+ <div class="image-grid-item__spinner">
27
+ <swirl-spinner></swirl-spinner>
28
+ </div>
26
29
  </button>
27
30
  </mock:shadow-root>
28
31
  </swirl-image-grid-item>
@@ -18,7 +18,9 @@ const Template = (args) => {
18
18
  export const SwirlImageGrid = Template.bind({});
19
19
  SwirlImageGrid.args = {
20
20
  aspectRatio: "16 / 9",
21
- slot: `<swirl-image-grid-item alt="Cute dog in a blanket" interactive src="/sample.jpg"></swirl-image-grid-item>
22
- <swirl-image-grid-item alt="Another cute dog in a blanket" icon="<swirl-icon-play-arrow></swirl-icon-play-arrow>" interactive src="/sample-2.jpg"></swirl-image-grid-item>
23
- <swirl-image-grid-item alt="Third cute dog in a blanket" interactive src="/sample-3.jpg"></swirl-image-grid-item>`,
21
+ slot: `
22
+ <swirl-image-grid-item alt="Cute dog in a blanket" interactive src="/sample.jpg"></swirl-image-grid-item>
23
+ <swirl-image-grid-item alt="Cute dog in a blanket" interactive src="/sample-2.jpg"></swirl-image-grid-item>
24
+ <swirl-image-grid-item alt="Cute dog in a blanket" interactive src="/sample-3.jpg"></swirl-image-grid-item>
25
+ `,
24
26
  };
@@ -101,3 +101,13 @@ button.image-grid-item:focus-visible {
101
101
  font-size: var(--s-font-size-2xl);
102
102
  inset: 0;
103
103
  }
104
+
105
+ .image-grid-item__spinner {
106
+ position: absolute;
107
+ z-index: 3;
108
+ display: flex;
109
+ justify-content: center;
110
+ align-items: center;
111
+ background-color: rgba(0, 0, 0, 0.4);
112
+ inset: 0;
113
+ }
@@ -2,18 +2,51 @@ import { h, Host } from "@stencil/core";
2
2
  import classnames from "classnames";
3
3
  export class SwirlImageGridItem {
4
4
  constructor() {
5
+ this.onLoad = () => {
6
+ this.loaded = true;
7
+ console.log(this.loaded);
8
+ };
5
9
  this.alt = undefined;
6
10
  this.icon = undefined;
7
11
  this.interactive = undefined;
12
+ this.loading = undefined;
8
13
  this.overlay = undefined;
9
14
  this.src = undefined;
15
+ this.loaded = false;
16
+ this.inViewport = false;
17
+ }
18
+ componentDidLoad() {
19
+ this.setupIntersectionObserver();
20
+ }
21
+ disconnectedCallback() {
22
+ this.intersectionObserver?.disconnect();
23
+ }
24
+ setupIntersectionObserver() {
25
+ if (this.loading !== "intersecting") {
26
+ return;
27
+ }
28
+ this.intersectionObserver = new IntersectionObserver(this.onVisibilityChange.bind(this), {
29
+ threshold: 0,
30
+ });
31
+ this.intersectionObserver.observe(this.el);
32
+ }
33
+ onVisibilityChange(entries) {
34
+ if (entries[0].isIntersecting) {
35
+ this.inViewport = true;
36
+ }
10
37
  }
11
38
  render() {
12
39
  const Tag = this.interactive ? "button" : "div";
13
40
  const className = classnames("image-grid-item", {
14
41
  "image-grid-item--has-overlay": this.overlay,
15
42
  });
16
- return (h(Host, { role: "listitem" }, h(Tag, { class: className, type: this.interactive ? "button" : undefined }, h("div", { class: "image-grid-item__background", style: { backgroundImage: `url(${this.src})` } }), h("img", { alt: this.alt, class: "image-grid-item__image", src: this.src }), this.icon && !Boolean(this.overlay) && (h("div", { class: "image-grid-item__icon", innerHTML: this.icon })), this.overlay && (h("div", { class: "image-grid-item__overlay" }, this.overlay)))));
43
+ return (h(Host, { role: "listitem" }, h(Tag, { class: className, type: this.interactive ? "button" : undefined }, h("div", { class: "image-grid-item__background", style: {
44
+ backgroundImage: !Boolean(this.loading) ||
45
+ this.loading === "eager" ||
46
+ this.loaded
47
+ ? `url(${this.src})`
48
+ : undefined,
49
+ } }), (this.loading !== "intersecting" || this.inViewport) && (h("img", { alt: this.alt, class: "image-grid-item__image", loading: this.loading !== "intersecting" ? this.loading : undefined, onLoad: this.onLoad, src: this.src })), this.loaded && this.icon && !Boolean(this.overlay) && (h("div", { class: "image-grid-item__icon", innerHTML: this.icon })), this.overlay && (h("div", { class: "image-grid-item__overlay" }, this.overlay)), !this.loaded && (h("div", { class: "image-grid-item__spinner" }, h("swirl-spinner", null))))));
17
50
  }
18
51
  static get is() { return "swirl-image-grid-item"; }
19
52
  static get encapsulation() { return "shadow"; }
@@ -80,6 +113,28 @@ export class SwirlImageGridItem {
80
113
  "attribute": "interactive",
81
114
  "reflect": false
82
115
  },
116
+ "loading": {
117
+ "type": "string",
118
+ "mutable": false,
119
+ "complexType": {
120
+ "original": "SwirlImageGridItemLoading",
121
+ "resolved": "\"auto\" | \"eager\" | \"intersecting\" | \"lazy\"",
122
+ "references": {
123
+ "SwirlImageGridItemLoading": {
124
+ "location": "local",
125
+ "path": "/home/runner/work/swirl/swirl/packages/swirl-components/src/components/swirl-image-grid-item/swirl-image-grid-item.tsx"
126
+ }
127
+ }
128
+ },
129
+ "required": false,
130
+ "optional": true,
131
+ "docs": {
132
+ "tags": [],
133
+ "text": ""
134
+ },
135
+ "attribute": "loading",
136
+ "reflect": false
137
+ },
83
138
  "overlay": {
84
139
  "type": "string",
85
140
  "mutable": false,
@@ -116,4 +171,11 @@ export class SwirlImageGridItem {
116
171
  }
117
172
  };
118
173
  }
174
+ static get states() {
175
+ return {
176
+ "loaded": {},
177
+ "inViewport": {}
178
+ };
179
+ }
180
+ static get elementRef() { return "el"; }
119
181
  }
@@ -12,6 +12,9 @@ describe("swirl-image-grid-item", () => {
12
12
  <div class="image-grid-item">
13
13
  <div class="image-grid-item__background" style="background-image: url(/image.jpg);"></div>
14
14
  <img alt="Dog in a blanket" class="image-grid-item__image" src="/image.jpg">
15
+ <div class="image-grid-item__spinner">
16
+ <swirl-spinner></swirl-spinner>
17
+ </div>
15
18
  </div>
16
19
  </mock:shadow-root>
17
20
  </swirl-image-grid-item>