MediaAttachmentGrid: use new ~platform/Masonry

* Masonry is a component provides limited masonry
  layout support

.env

@@ -2,3 +2,4 @@ DEV_SERVER_HTTPS_CERT_BASE=
 DEV_SERVER_HTTPS_CERT_PASS=
 DEV_LOCATOR_EDITOR=vscode
 VITE_DEVTOOLS_OVERLAY=true
+VITE_PLATFROM_MASONRY_ALWAYS_COMPAT=

package.json

@@ -18,6 +18,7 @@
     "@solid-devtools/overlay": "^0.30.1",
     "@suid/vite-plugin": "^0.3.1",
     "@types/hammerjs": "^2.0.46",
+    "@types/masonry-layout": "^4.2.8",
     "@vite-pwa/assets-generator": "^0.2.6",
     "postcss": "^8.4.49",
     "prettier": "^3.3.3",
@@ -49,6 +50,7 @@
     "fast-average-color": "^9.4.0",
     "hammerjs": "^2.0.8",
     "iso-639-1": "^3.1.3",
+    "masonry-layout": "^4.2.2",
     "masto": "^6.10.1",
     "nanostores": "^0.11.3",
     "normalize.css": "^8.0.1",

src/overrides.d.ts

@@ -11,6 +11,10 @@ interface ImportMetaEnv {
    * Attach the overlay (in the dev mode) if it's `"true"`.
    */
   readonly VITE_DEVTOOLS_OVERLAY?: string;
+  /**
+   * Always use compatible version of Masonry.
+   */
+  readonly VITE_PLATFROM_MASONRY_ALWAYS_COMPAT?: string
 }
 
 interface ImportMeta {

src/platform/Masonry.css

@@ -0,0 +1,16 @@
+.CompatMasonry>* {
+  margin-bottom: var(--Masonry-row-gap);
+}
+
+@supports (grid-template-rows: masonry) {
+  .NativeMasonry {
+    display: grid;
+    grid-template-columns: repeat(auto-fit, minmax(44px, min-content));
+    grid-template-rows: masonry;
+
+    &:has(> :last-child:nth-child(2n)) {
+      grid-template-columns: repeat(2, minmax(auto, min-content));
+    }
+  }
+}
+

src/platform/Masonry.tsx

@@ -0,0 +1,158 @@
+import {
+  type Component,
+  type JSX,
+  splitProps,
+  type Ref,
+  createRenderEffect,
+  onCleanup,
+  children,
+  createEffect,
+  createSignal,
+  onMount,
+} from "solid-js";
+import { Dynamic, type DynamicProps } from "solid-js/web";
+import MasonryLayout from "masonry-layout";
+import { createElementSize } from "@solid-primitives/resize-observer";
+import "./Masonry.css";
+
+type MasonryContainer =
+  | Exclude<keyof JSX.IntrinsicElements, keyof JSX.SVGElementTags>
+  | Component<{
+      ref?: Ref<Element>;
+      class?: string;
+      children?: JSX.Element;
+    }>;
+
+type ElementOf<T extends MasonryContainer> =
+  T extends Exclude<keyof JSX.IntrinsicElements, keyof JSX.SVGElementTags>
+    ? JSX.IntrinsicElements[T] extends { ref?: Ref<infer E> }
+      ? E
+      : never
+    : T extends Component<{ ref?: Ref<infer E> }>
+      ? E
+      : never;
+
+function forwardRef<T>(value: T, ref?: Ref<T>) {
+  if (!ref) return;
+  (ref as (value: T) => void)(value);
+}
+
+function createMasonry(element: Element, options: () => MasonryLayout.Options) {
+  const layout = new MasonryLayout(element, {
+    initLayout: false,
+  });
+
+  onCleanup(() => layout.destroy?.());
+
+  const size = createElementSize(element);
+
+  createRenderEffect(() => {
+    const opts = options();
+    layout.option?.(opts);
+  });
+
+  createRenderEffect(() => {
+    const width = size.width; // only tracking width
+    layout.layout?.();
+  });
+
+  if (import.meta.hot) {
+    import.meta.hot.on("vite:afterUpdate", () => {
+      layout.layout?.();
+    });
+  }
+
+  return layout;
+}
+
+const supportsCSSMasonryLayout = /* @__PURE__ */ CSS.supports(
+  "grid-template-rows",
+  "masonry",
+);
+
+console.debug("supports css masonry layout", supportsCSSMasonryLayout);
+
+const useNativeImpl = import.meta.env.VITE_PLATFROM_MASONRY_ALWAYS_COMPAT
+  ? false
+  : supportsCSSMasonryLayout;
+
+if (import.meta.env.VITE_PLATFROM_MASONRY_ALWAYS_COMPAT) {
+  console.warn(
+    "Masonry is in compat mode because VITE_PLATFORM_MASONRY_ALWAYS_COMPAT is enabled",
+  );
+}
+
+function MasonryCompat<T extends MasonryContainer>(
+  oprops: DynamicProps<T> & { class?: string },
+) {
+  const [props, rest] = splitProps(oprops, ["ref", "children", "class"]);
+
+  const childrenComponents = children(() => props.children);
+
+  return (
+    <Dynamic
+      ref={(element: ElementOf<T>) => {
+        forwardRef(element, props.ref as Ref<typeof element> | undefined);
+
+        const [columnGap, setColumnGap] = createSignal<number>();
+
+        const layout = createMasonry(element, () => {
+          return {
+            gutter: columnGap(),
+          };
+        });
+
+        createEffect(() => {
+          const computedStyle = window.getComputedStyle(element);
+
+          const rowGap = computedStyle.rowGap;
+          if (element instanceof HTMLElement) {
+            element.style.setProperty("--Masonry-row-gap", rowGap);
+          }
+
+          const colGap = computedStyle.columnGap;
+          if (colGap) {
+            setColumnGap(Number(colGap.slice(0, colGap.length - 2)));
+          }
+        });
+
+        createRenderEffect(() => {
+          childrenComponents(); // just tracks
+          setTimeout(() => {
+            layout.reloadItems?.();
+            layout.layout?.();
+          }, 0);
+        });
+      }}
+      class={`Masonry CompatMasonry ${props.class || ""}`}
+      {...rest}
+      children={childrenComponents}
+    />
+  );
+}
+
+function MasonryNative<T extends MasonryContainer>(
+  oprops: DynamicProps<T> & { class?: string },
+) {
+  const [props, rest] = splitProps(oprops, ["class"]);
+  return (
+    <Dynamic class={`Masonry NativeMasonry ${props.class || ""}`} {...rest} />
+  );
+}
+
+/**
+ * Masonry Layout Container.
+ *
+ * **Native if possible** This component uses css masonry layout
+ * and fallback to masonry-layout if not supported. The children
+ * must have specified width and height.
+ *
+ * **Children Changes** As the children changed, reflow will be triggered,
+ * and there is might be a blink (or transition) for user. If it's not your
+ * intention, don't remove/add the direct children. Instead wraps them under
+ * containers and set the width and height on the container.
+ *
+ * **CSS compatibility** This component compatible to "gap" "row-gap"
+ * "column-gap" property. But they are read only once after the element mounted.
+ */
+export default useNativeImpl ? MasonryNative : MasonryCompat;

src/timelines/toots/MediaAttachmentGrid.css

@@ -3,10 +3,10 @@
   margin-top: 1em;
   margin-left: var(--card-pad, 0);
   margin-right: var(--card-pad, 0);
-  gap: 4px;
   contain: layout style;
+  gap: 4px;
 
-  > :where(img, video, .sensitive-placeholder) {
+  > * {
     max-height: 35vh;
     min-height: 40px;
     min-width: 40px;
@@ -22,12 +22,20 @@
     &:focus-visible {
       outline: 8px solid var(--media-color-accent, var(--tutu-color-surface-d));
       border-color: var(--media-color-accent, var(--tutu-color-surface-d));
+      z-index: calc(var(--tutu-zidx-nav) - 1);
     }
+  }
 
+  > * > * {
+    width: 100%;
+    height: 100%;
+  }
+
+  > * > :where(img, video) {
     object-fit: contain;
   }
 
-  >.sensitive-placeholder {
+  > * >.sensitive-placeholder {
     display: inline-flex;
     display: inline flex;
     align-items: center;
@@ -35,6 +43,6 @@
   }
 }
 
-:where(.thread-top, .thread-mid) > .MediaAttachmentGrid {
+:where(.thread-top, .thread-mid)>.MediaAttachmentGrid {
   margin-left: calc(var(--card-pad, 0) + var(--toot-avatar-size, 0) + 8px);
 }

src/timelines/toots/MediaAttachmentGrid.tsx

@@ -23,6 +23,7 @@ import "./MediaAttachmentGrid.css";
 import cardStyle from "~material/cards.module.css";
 import { Preview } from "@suid/icons-material";
 import { IconButton } from "@suid/material";
+import Masonry from "~platform/Masonry";
 
 type ElementSize = { width: number; height: number };
 
@@ -149,13 +150,13 @@ const MediaAttachmentGrid: Component<{
     }
   };
   return (
-    <section
+    <Masonry
+      component="section"
       ref={setRootRef}
       class={`MediaAttachmentGrid ${cardStyle.cardNoPad}`}
       classList={{
         sensitive: props.sensitive,
       }}
-      style={{ "column-count": columnCount() }}
       onClick={isolateCallback}
     >
       <Index each={props.attachments}>
@@ -164,81 +165,79 @@ const MediaAttachmentGrid: Component<{
 
           const style = createMemo(() => itemStyle(item()));
           return (
-            <Switch>
-              <Match when={props.sensitive && !isReveal(index)}>
-                <div
-                  class="sensitive-placeholder"
-                  style={style()}
-                  data-sort={index}
-                  data-media-type={item().type}
-                >
-                  <IconButton
-                    color="inherit"
-                    size="large"
-                    onClick={[addReveal, index]}
-                    aria-label="Reveal this media"
+            <div style={style()} role="presentation">
+              <Switch>
+                <Match when={props.sensitive && !isReveal(index)}>
+                  <div
+                    class="sensitive-placeholder"
+                    data-sort={index}
+                    data-media-type={item().type}
                   >
-                    <Preview />
-                  </IconButton>
-                </div>
-              </Match>
-              <Match when={itemType() === "image"}>
-                <img
-                  src={item().previewUrl}
-                  width={item().meta?.small?.width}
-                  height={item().meta?.small?.height}
-                  alt={item().description || undefined}
-                  onClick={[openViewerFor, index]}
-                  loading="lazy"
-                  style={style()}
-                  data-sort={index}
-                  data-media-type={item().type}
-                ></img>
-              </Match>
-              <Match when={itemType() === "video"}>
-                <video
-                  src={item().url || undefined}
-                  autoplay={!props.sensitive && settings().autoPlayVideos}
-                  playsinline={settings().autoPlayVideos ? true : undefined}
-                  controls
-                  poster={item().previewUrl}
-                  width={item().meta?.small?.width}
-                  height={item().meta?.small?.height}
-                  style={style()}
-                  data-sort={index}
-                  data-media-type={item().type}
-                  preload="metadata"
-                />
-              </Match>
-              <Match when={itemType() === "gifv"}>
-                <video
-                  src={item().url || undefined}
-                  autoplay={!props.sensitive && settings().autoPlayGIFs}
-                  controls
-                  playsinline /* or safari on iOS will play in full-screen */
-                  loop
-                  poster={item().previewUrl}
-                  width={item().meta?.small?.width}
-                  height={item().meta?.small?.height}
-                  style={style()}
-                  data-sort={index}
-                  data-media-type={item().type}
-                  preload="metadata"
-                />
-              </Match>
-              <Match when={itemType() === "audio"}>
-                <audio
-                  src={item().url || undefined}
-                  controls
-                  data-sort={index}
-                  data-media-type={item().type}
-                ></audio>
-              </Match>
-            </Switch>
+                    <IconButton
+                      color="inherit"
+                      size="large"
+                      onClick={[addReveal, index]}
+                      aria-label="Reveal this media"
+                    >
+                      <Preview />
+                    </IconButton>
+                  </div>
+                </Match>
+                <Match when={itemType() === "image"}>
+                  <img
+                    src={item().previewUrl}
+                    width={item().meta?.small?.width}
+                    height={item().meta?.small?.height}
+                    alt={item().description || undefined}
+                    onClick={[openViewerFor, index]}
+                    loading="lazy"
+                    data-sort={index}
+                    data-media-type={item().type}
+                  ></img>
+                </Match>
+                <Match when={itemType() === "video"}>
+                  <video
+                    src={item().url || undefined}
+                    autoplay={!props.sensitive && settings().autoPlayVideos}
+                    playsinline={settings().autoPlayVideos ? true : undefined}
+                    controls
+                    poster={item().previewUrl}
+                    width={item().meta?.small?.width}
+                    height={item().meta?.small?.height}
+                    data-sort={index}
+                    data-media-type={item().type}
+                    preload="metadata"
+                  />
+                </Match>
+                <Match when={itemType() === "gifv"}>
+                  <video
+                    src={item().url || undefined}
+                    autoplay={!props.sensitive && settings().autoPlayGIFs}
+                    controls
+                    playsinline /* or safari on iOS will play in full-screen */
+                    loop
+                    poster={item().previewUrl}
+                    width={item().meta?.small?.width}
+                    height={item().meta?.small?.height}
+                    data-sort={index}
+                    data-media-type={item().type}
+                    preload="metadata"
+                  />
+                </Match>
+                <Match when={itemType() === "audio"}>
+                  <audio
+                    src={item().url || undefined}
+                    controls
+                    data-sort={index}
+                    data-media-type={item().type}
+                  ></audio>
+                </Match>
+              </Switch>
+            </div>
           );
         }}
       </Index>
-    </section>
+    </Masonry>
   );
 };