Merge pull request #50 from askides/feat/alias

feat: add support for the 'as' property
askides · Dec 17, 2024 · ef9558b · ef9558b
2 parents b063368 + 9f0d88f
commit ef9558b
Show file tree

Hide file tree

Showing 4 changed files with 192 additions and 93 deletions.
diff --git a/libs/react-plock/package.json b/libs/react-plock/package.json
@@ -30,5 +30,11 @@
   },
   "peerDependencies": {
     "react": "^18.2.0"
+  },
+  "devDependencies": {
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/react": "^16.1.0",
+    "@types/react": "^19.0.1",
+    "@types/react-dom": "^19.0.2"
   }
 }
diff --git a/libs/react-plock/src/index.spec.tsx b/libs/react-plock/src/index.spec.tsx
@@ -1,5 +1,7 @@
 import { describe, it, expect } from 'vitest';
 import { createChunks, createDataColumns } from '.';
+import { render } from '@testing-library/react';
+import { Masonry } from '.';
 
 describe('Plock', () => {
   it('should create chunks', () => {
@@ -76,3 +78,61 @@ describe('Plock', () => {
     ]);
   });
 });
+
+describe('Integration Tests', () => {
+  it('should render with different HTML elements using "as" prop', () => {
+    const items = [1, 2, 3];
+    const config = { columns: 3, gap: 10 };
+
+    // Test with 'section' element
+    const { container: sectionContainer } = render(
+      <Masonry
+        items={items}
+        render={(item) => <div key={item}>{item}</div>}
+        config={config}
+        as="section"
+      />
+    );
+
+    // Test with 'article' element
+    const { container: articleContainer } = render(
+      <Masonry
+        items={items}
+        render={(item) => <div key={item}>{item}</div>}
+        config={config}
+        as="article"
+      />
+    );
+
+    expect(sectionContainer.querySelector('section')).toBeTruthy();
+    expect(articleContainer.querySelector('article')).toBeTruthy();
+  });
+
+  it('should render with custom React component using "as" prop', () => {
+    const CustomComponent = ({
+      children,
+      className,
+    }: {
+      children: React.ReactNode;
+      className?: string;
+    }) => <div className={`custom-wrapper ${className || ''}`}>{children}</div>;
+
+    const items = [1, 2, 3];
+    const config = { columns: 3, gap: 10 };
+
+    const { container } = render(
+      <Masonry
+        items={items}
+        render={(item) => <div key={item}>{item}</div>}
+        config={config}
+        as={CustomComponent}
+        className="test-class"
+      />
+    );
+
+    const customElement = container.querySelector('.custom-wrapper');
+
+    expect(customElement).toBeTruthy();
+    expect(customElement?.classList.contains('test-class')).toBeTruthy();
+  });
+});
diff --git a/libs/react-plock/src/index.tsx b/libs/react-plock/src/index.tsx
@@ -1,4 +1,4 @@
-import React, { useEffect, useState } from "react";
+import React, { useEffect, useState } from 'react';
 
 export function useMediaValues(
   medias: number[] | undefined,
@@ -36,27 +36,28 @@ export function useMediaValues(
 
     // Apply Listeners
     for (const mediaQuery of mediaQueries) {
-      mediaQuery.addEventListener("change", onSizeChange);
+      mediaQuery.addEventListener('change', onSizeChange);
     }
 
     return () => {
       for (const mediaQuery of mediaQueries) {
-        mediaQuery.removeEventListener("change", onSizeChange);
+        mediaQuery.removeEventListener('change', onSizeChange);
       }
     };
   }, [values.columns, values.gap]);
 
   return values;
 }
 
-export type MasonryProps<T> = React.ComponentPropsWithoutRef<"div"> & {
+export type MasonryProps<T> = React.ComponentPropsWithoutRef<'div'> & {
   items: T[];
   render: (item: T, idx: number) => React.ReactNode;
   config: {
     columns: number | number[];
     gap: number | number[];
     media?: number[];
   };
+  as?: React.ElementType;
 };
 
 export function createSafeArray(data: number | number[]) {
@@ -67,6 +68,7 @@ export function Masonry<T>({
   items = [],
   render,
   config,
+  as: Component = 'div',
   ...rest
 }: MasonryProps<T>) {
   const { columns, gap } = useMediaValues(
@@ -81,11 +83,11 @@ export function Masonry<T>({
   const dataColumns = createDataColumns<T>(chunks, columns);
 
   return (
-    <div
+    <Component
       {...rest}
       style={{
-        display: "grid",
-        alignItems: "start",
+        display: 'grid',
+        alignItems: 'start',
         gridColumnGap: gap,
         gridTemplateColumns: `repeat(${columns}, minmax(0, 1fr))`,
       }}
@@ -95,7 +97,7 @@ export function Masonry<T>({
           {column.map((item, idx) => render(item, idx))}
         </MasonryRow>
       ))}
-    </div>
+    </Component>
   );
 }
 
@@ -109,9 +111,9 @@ export function MasonryRow({
   return (
     <div
       style={{
-        display: "grid",
+        display: 'grid',
         rowGap: gap,
-        gridTemplateColumns: "minmax(0, 1fr)",
+        gridTemplateColumns: 'minmax(0, 1fr)',
       }}
     >
       {children}