@mypixia/simplex-kiosk
v0.2.0
Published
Kiosk-tuned wrapper around the MyPixia simplex-designer editor: touch-first sizing, idle-timeout reset, fullscreen helper. Built for in-store self-service kiosks.
Maintainers
Readme
@mypixia/simplex-kiosk
Kiosk-tuned wrapper around @mypixia/simplex-designer for in-store
self-service touch screens (the MyPixia merchant kiosk feature).
What it adds on top of the designer:
- Touch-first: 44px minimum touch targets, no text selection / touch callouts / pinch-zoom inside the editor, 16px inputs (no zoom-on-focus).
- Idle reset:
onIdlefires afteridleTimeoutSecondsof inactivity so the kiosk shell can reset to its attract screen. - Locked-down mode: always
mode="customize"— kiosk customers never see the merchant authoring toolset. enterKioskFullscreen()helper for true kiosk presentation.
Everything else passes through: theme, product, aiEnabled,
onAIImageGenerate, onUploadImage, initialColor, ... and the ref exposes
the designer's imperative API (exportAllDesignsAsJSON, addImageFromUrl,
exportDesign, ...).
Usage
import KioskDesigner, { enterKioskFullscreen } from '@mypixia/simplex-kiosk';
<KioskDesigner
ref={designerRef}
idleTimeoutSeconds={120}
onIdle={resetToAttractScreen}
theme={{ primaryColor: '#6a45d2' }}
product={product}
aiEnabled={config.aiEnabled}
onAIImageGenerate={generateKioskAIImage}
/>Build / publish
npm install # once (uses the widget2 toolchain versions)
npm run build # → dist/index.es.js + dist/index.cjs.js
npm publish # done by the maintainerThe package bundles the designer source from ../src, so consumers install
only @mypixia/simplex-kiosk. Until it is on npm, the merchant portal's
kiosk runtime embeds @mypixia/simplex-designer directly with the same props
(see mypixia-merchant/frontend/src/pages/kiosk-runtime/KioskRun.jsx — the
swap is a one-line import change).
