holey-shapes 0.1.0 → 0.1.2

package/README.md

@@ -1,15 +1,49 @@
 # holey-shapes
 
-Solid, perforated SVG shapes with a connected extrusion and a built-in hover spin. Pick from 15 shapes, set the face and shadow colors, and control the hole layout. No framework or stylesheet required.
+Solid, perforated shapes for the web and SwiftUI, with a connected extrusion and a built-in hover spin. Pick from 15 shapes, set the face and shadow colors, and control the hole layout.
 
-[npm package](https://www.npmjs.com/package/holey-shapes) · [source](https://github.com/skyaara/holey-shapes)
+[live playground](https://holey-shapes.aakashreddy.com) · [npm package](https://www.npmjs.com/package/holey-shapes) · [source](https://github.com/skyaara/holey-shapes)
 
 ## Install
 
+### JavaScript
+
 ```sh
 npm install holey-shapes
 ```
 
+### Swift Package Manager
+
+In Xcode, add `https://github.com/skyaara/holey-shapes` as a package dependency, or add it to `Package.swift`:
+
+```swift
+dependencies: [
+    .package(url: "https://github.com/skyaara/holey-shapes.git", from: "0.1.2")
+]
+```
+
+Then render any catalog shape directly in SwiftUI:
+
+```swift
+import HoleyShapes
+import SwiftUI
+
+struct Logo: View {
+    var body: some View {
+        HoleyShapeView(
+            .flower,
+            faceColor: HoleyColor(hex: "#FF4FA3"),
+            shadowColor: HoleyColor(hex: "#7A1748"),
+            holes: 6,
+            seed: 2
+        )
+        .frame(width: 240, height: 240)
+    }
+}
+```
+
+The Swift SDK supports iOS 16+, macOS 13+, tvOS 16+, and visionOS 1+. It uses asynchronous SwiftUI `Canvas` rendering and caches the immutable shape paths, packing candidates, and finished hole layouts. The pointer hover animation follows Reduce Motion automatically.
+
 ## Render an SVG string
 
 ```js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "holey-shapes",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Colorful perforated SVG shapes with solid extrusion and hover animation.",
   "type": "module",
   "license": "MIT",
@@ -19,6 +19,7 @@
   },
   "main": "./index.js",
   "types": "./index.d.ts",
+  "sideEffects": false,
   "exports": {
     ".": {
       "types": "./index.d.ts",
@@ -36,8 +37,13 @@
   ],
   "keywords": [
     "svg",
+    "svg-generator",
+    "svg-animation",
     "shapes",
     "animation",
+    "perforated",
+    "extrusion",
+    "creative-coding",
     "generative-art",
     "web"
   ],
@@ -51,7 +57,7 @@
     "dev": "vite --host 127.0.0.1",
     "build": "vite build",
     "preview": "vite preview --host 127.0.0.1",
-    "test": "node tests/package.test.mjs",
+    "test": "node tests/package.test.mjs && node tests/site.test.mjs",
     "prepublishOnly": "npm test && npm run build"
   },
   "devDependencies": {

package/script.js

@@ -26,6 +26,24 @@ if (themeToggle) {
   });
 }
 
+const installButton = isHoleyApp ? document.querySelector('.install-command') : null;
+
+if (installButton) {
+  installButton.addEventListener('click', async () => {
+    const label = installButton.querySelector('.install-copy-label');
+    try {
+      await navigator.clipboard.writeText('npm install holey-shapes');
+      if (label) label.textContent = 'COPIED';
+      window.setTimeout(() => {
+        if (label) label.textContent = 'COPY';
+      }, 1400);
+    } catch {
+      if (label) label.textContent = 'SELECT';
+      window.getSelection()?.selectAllChildren(installButton.querySelector('code'));
+    }
+  });
+}
+
 export const shapes = [
   {
     key: 'disc', name: 'Perforated disc', color: '#6337FF', bg: '#D7CEFF', initial: 5,
@@ -112,6 +130,37 @@ const SHADOW_STEPS = 12;
 const states = new Map();
 let packingContext = null;
 const packingCache = new Map();
+const SHOWCASE_MOTIONS = [
+  ['scatter', '4.2s', '-1.4s'],
+  ['magnet', '4.6s', '-3.2s'],
+  ['blinkwave', '3.7s', '-2.1s'],
+  ['orbit', '5.2s', '-.6s'],
+  ['hop', '3.5s', '-1.9s'],
+  ['scan', '4.3s', '-.8s'],
+  ['wobble', '4.8s', '-2.4s'],
+  ['pinch', '3.9s', '-1.1s'],
+  ['carousel', '5.6s', '-4.1s'],
+  ['heartbeat', '3.8s', '-2.2s'],
+  ['peek', '4.5s', '-3.5s'],
+  ['shuffle', '4.1s', '-1.7s'],
+  ['tumble', '4.7s', '-3.3s'],
+  ['ripple', '3.6s', '-1.2s'],
+  ['breathe', '5s', '-2.5s']
+];
+const showcaseObserver = isBrowser && typeof IntersectionObserver === 'function'
+  ? new IntersectionObserver((entries) => {
+      entries.forEach((entry) => entry.target.classList.toggle('is-showcase-visible', entry.isIntersecting));
+    }, { rootMargin: '120px 0px', threshold: 0.05 })
+  : null;
+
+function applyShowcaseMotion(element, index) {
+  const [name, duration, delay] = SHOWCASE_MOTIONS[index % SHOWCASE_MOTIONS.length];
+  element.dataset.motion = name;
+  element.style.setProperty('--motion-duration', duration);
+  element.style.setProperty('--motion-delay', delay);
+  if (showcaseObserver) showcaseObserver.observe(element);
+  else element.classList.add('is-showcase-visible');
+}
 
 function getPackingContext() {
   if (packingContext) return packingContext;
@@ -124,7 +173,32 @@ function getPackingContext() {
 }
 
 const holeMarkup = ({ cx, cy, rx, ry, rotate }) =>
-  `<ellipse cx="${cx}" cy="${cy}" rx="${rx}" ry="${ry}"${rotate ? ` transform="rotate(${rotate} ${cx} ${cy})"` : ''} fill="black"/>`;
+  `<ellipse cx="${cx}" cy="${cy}" rx="${rx}" ry="${ry}"${rotate ? ` transform="rotate(${rotate} ${cx} ${cy})"` : ''}/>`;
+
+const showcaseHoleMarkup = (hole, index) => {
+  const angle = (index * 137.5 * Math.PI) / 180;
+  const scatterX = Math.round(Math.cos(angle) * 17);
+  const scatterY = Math.round(Math.sin(angle) * 17);
+  const inwardX = Math.round((210 - hole.cx) * .26);
+  const inwardY = Math.round((210 - hole.cy) * .26);
+  const outwardX = Math.round((hole.cx - 210) * .11);
+  const outwardY = Math.round((hole.cy - 210) * .11);
+  const turn = (index % 2 ? 1 : -1) * (14 + (index % 3) * 7);
+  const variables = [
+    `--hole-origin:${hole.cx}px ${hole.cy}px`,
+    `--scatter-x:${scatterX}px`,
+    `--scatter-y:${scatterY}px`,
+    `--scatter-back-x:${Math.round(scatterX * -.3)}px`,
+    `--scatter-back-y:${Math.round(scatterY * -.3)}px`,
+    `--in-x:${inwardX}px`,
+    `--in-y:${inwardY}px`,
+    `--out-x:${outwardX}px`,
+    `--out-y:${outwardY}px`,
+    `--turn:${turn}deg`,
+    `--turn-back:${turn * -1}deg`
+  ].join(';');
+  return `<g class="hole-motion" style="${variables}">${holeMarkup(hole)}</g>`;
+};
 
 function darkShadow(color, factor = 0.52) {
   const value = color.replace('#', '');
@@ -271,13 +345,15 @@ function packedHoleLayout(shape, count, seed) {
 function svgMarkup(shape, holes, className, maskSuffix, accessible = false) {
   const maskId = `mask-${shape.key}-${maskSuffix}`;
   const fill = className === 'shape-shadow' ? darkShadow(shape.color) : shape.color;
-  return `<svg class="shape-layer ${className}" viewBox="0 0 420 420" ${accessible ? `role="img" aria-label="${shape.name} with ${holes.length} holes"` : 'aria-hidden="true"'}>
-    <defs><mask id="${maskId}"><rect width="420" height="420" fill="white"/>${holes.map(holeMarkup).join('')}</mask></defs>
-    <path d="${shape.path}" fill="${fill}" mask="url(#${maskId})"/>
-  </svg>`;
+  return `<svg class="shape-layer ${className}" viewBox="0 0 420 420" ${accessible ? `role="img" aria-label="${shape.name} with ${holes.length} holes"` : 'aria-hidden="true"'}><defs><mask id="${maskId}"><rect width="420" height="420" fill="white"/>${holes.map(holeMarkup).join('')}</mask></defs><path d="${shape.path}" fill="${fill}" mask="url(#${maskId})"/></svg>`;
+}
+
+function compactNumber(value) {
+  const rounded = Math.round(value * 100) / 100;
+  return String(Object.is(rounded, -0) ? 0 : rounded);
 }
 
-function extrusionFilterMarkup(shape, suffix, options = {}) {
+function extrusionFilterMarkup(shape, filterId, options = {}) {
   const shadowX = options.shadowX ?? SHADOW_X;
   const shadowY = options.shadowY ?? SHADOW_Y;
   const shadowSteps = options.shadowSteps ?? SHADOW_STEPS;
@@ -285,29 +361,18 @@ function extrusionFilterMarkup(shape, suffix, options = {}) {
   const offsets = Array.from({ length: shadowSteps }, (_, index) => {
     const step = index + 1;
     const ratio = step / shadowSteps;
-    return `<feOffset in="shadow-color" dx="${(shadowX * ratio).toFixed(2)}" dy="${(shadowY * ratio).toFixed(2)}" result="shadow-${step}"/>`;
+    return `<feOffset in="s" dx="${compactNumber(shadowX * ratio)}" dy="${compactNumber(shadowY * ratio)}" result="s${step}"/>`;
   }).join('');
   const merge = Array.from({ length: shadowSteps }, (_, index) =>
-    `<feMergeNode in="shadow-${shadowSteps - index}"/>`
+    `<feMergeNode in="s${shadowSteps - index}"/>`
   ).join('');
-  return `<filter id="extrusion-${shape.key}-${suffix}" x="-20%" y="-20%" width="160%" height="160%" color-interpolation-filters="sRGB">
-    <feFlood flood-color="${shadowColor}" result="shadow-paint"/>
-    <feComposite in="shadow-paint" in2="SourceGraphic" operator="in" result="shadow-color"/>
-    ${offsets}
-    <feMerge>${merge}<feMergeNode in="SourceGraphic"/></feMerge>
-  </filter>`;
+  return `<filter id="${filterId}" x="-20%" y="-20%" width="160%" height="160%" color-interpolation-filters="sRGB"><feFlood flood-color="${shadowColor}" result="p"/><feComposite in="p" in2="SourceGraphic" operator="in" result="s"/>${offsets}<feMerge>${merge}<feMergeNode in="SourceGraphic"/></feMerge></filter>`;
 }
 
 function objectMarkup(shape, holes, suffix, accessible = false) {
   const maskId = `mask-${shape.key}-${suffix}`;
   const filterId = `extrusion-${shape.key}-${suffix}`;
-  return `<svg class="shape-layer shape-object" viewBox="0 0 420 420" ${accessible ? `role="img" aria-label="${shape.name} with ${holes.length} holes"` : 'aria-hidden="true"'}>
-    <defs>
-      <mask id="${maskId}"><rect width="420" height="420" fill="white"/>${holes.map(holeMarkup).join('')}</mask>
-      ${extrusionFilterMarkup(shape, suffix)}
-    </defs>
-    <g filter="url(#${filterId})"><g class="shape-spin"><path d="${shape.path}" fill="${shape.color}" mask="url(#${maskId})"/></g></g>
-  </svg>`;
+  return `<svg class="shape-layer shape-object" viewBox="0 0 420 420" ${accessible ? `role="img" aria-label="${shape.name} with ${holes.length} holes"` : 'aria-hidden="true"'}><defs><mask id="${maskId}"><rect width="420" height="420" fill="white"/>${holes.map(showcaseHoleMarkup).join('')}</mask>${extrusionFilterMarkup(shape, filterId)}</defs><g filter="url(#${filterId})"><g class="shape-spin"><path d="${shape.path}" fill="${shape.color}" mask="url(#${maskId})"/></g></g></svg>`;
 }
 
 function renderShape(card, shape, state) {
@@ -319,12 +384,12 @@ function renderShape(card, shape, state) {
 
 function exportSvg(shape, holes, options = {}) {
   const maskHoles = holes.map(holeMarkup).join('');
-  const filter = extrusionFilterMarkup(shape, 'download', options).replaceAll(`extrusion-${shape.key}-download`, 'extrusion');
+  const filter = extrusionFilterMarkup(shape, 'e', options);
   const duration = Math.max(100, Math.min(10000, Number(options.duration) || 900));
   const animation = options.animated === false
     ? ''
     : `<style>.spin-group{transform-box:fill-box;transform-origin:center;will-change:transform}svg:hover .spin-group{animation:spin ${duration}ms cubic-bezier(.33,0,.2,1) both}@keyframes spin{to{transform:rotate(360deg)}}@media(prefers-reduced-motion:reduce){svg:hover .spin-group{animation:none}}</style>`;
-  return `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 420 420" role="img" aria-label="${shape.name} with ${holes.length} holes">${animation}<defs><mask id="holes"><rect width="420" height="420" fill="white"/>${maskHoles}</mask>${filter}</defs><g filter="url(#extrusion)"><g class="spin-group"><path d="${shape.path}" fill="${shape.color}" mask="url(#holes)"/></g></g></svg>`;
+  return `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 420 420" role="img" aria-label="${shape.name} with ${holes.length} holes">${animation}<defs><mask id="h"><rect width="420" height="420" fill="white"/>${maskHoles}</mask>${filter}</defs><g filter="url(#e)"><g class="spin-group"><path d="${shape.path}" fill="${shape.color}" mask="url(#h)"/></g></g></svg>`;
 }
 
 function normalizeColor(color, fallback) {
@@ -419,6 +484,7 @@ if (collection) shapes.forEach((shape, index) => {
       <button class="download" type="button">GET SVG <span>↓</span></button>
     </div>`;
   collection.append(card);
+  applyShowcaseMotion(card, index);
 
   const state = { count: Math.min(shape.initial, holeLimit), seed: 0, limit: holeLimit };
   states.set(shape.key, state);
@@ -475,6 +541,7 @@ if (presentApp) {
   function renderPresent() {
     const shape = activeShape();
     const holes = packedHoleLayout(shape, presentState.count, presentState.seed);
+    applyShowcaseMotion(art, presentState.index);
     art.innerHTML = objectMarkup(shape, holes, 'present', true);
     syncPresentControls();
   }