@swipefindercom/finder-sdk

Embed interactive swipeable card feeds on any website or React app.

Installation

npm install @swipefindercom/finder-sdk

Usage

Vanilla JS / Any framework (SDK)

The SDK build bundles everything (including React) so it works anywhere — plain HTML, Vue, Angular, etc.

<div id="swipefinder"></div>

<script type="module">
  import { initSwipeFinder } from '@swipefindercom/finder-sdk';

  const cleanup = initSwipeFinder({
    backendUrl: 'https://api.swipefinder.com',
    finderId: 'your-finder-id',
    element: document.getElementById('swipefinder'),
  });

  // Call cleanup() to unmount
</script>

UMD (script tag)

<div id="swipefinder"></div>

<script src="https://unpkg.com/@swipefindercom/finder-sdk"></script>
<script>
  const cleanup = SwipeFinderSDK.initSwipeFinder({
    backendUrl: 'https://api.swipefinder.com',
    finderId: 'your-finder-id',
    element: document.getElementById('swipefinder'),
  });
</script>

API

initSwipeFinder(options)

| Option | Type | Required | Description | | ------------ | ------------- | -------- | ---------------------------------- | | backendUrl | string | ✅ | Backend API URL | | finderId | string | ✅ | Finder identifier | | element | HTMLElement | ✅ | DOM element to mount into |

Returns a () => void cleanup function that unmounts the widget.

Builds

| Entry | Format | React bundled? | Use case | | ----------------------- | --------- | -------------- | ------------------------------- | | @swipefindercom/finder-sdk | ESM / UMD | ✅ Yes | Vanilla JS, Vue, Angular, etc. |

Development

npm run dev            # Dev server on :3010
npm run storybook      # Storybook on :6006
npm run build:all      # Build SDK + types
npm run test:e2e       # Playwright E2E tests

License

MIT © SwipeFinder