@portaki/module-appliances
v1.2.4
Published
Module Portaki — guide des appareils du logement
Readme
🔌 Module Appareils
@portaki/module-appliances
Four, lave-linge, chauffage… guide éditorial par équipement
Aperçu (illustration)
Rendu factice pour la documentation — aligné sur la maquette
guest-modules-section.jsx, pas une capture du build npm actuel.
🎯 En une phrase — Aide les voyageurs à utiliser les équipements avec consignes courtes et contenu enrichissable.
👥 Pour qui ?
| Persona | Besoin | |---------|--------| | 🏠 Voyageurs | Mode d’emploi express sur place | | 📝 Contenu | Liste d’appareils + médias par propriété |
✨ Ce que le module apporte
- [x] Section « Appareils » dans la nav guest
- [x] Structure pour guide riche (TipTap, médias, FAQ courte)
🧭 Fiche technique
| Clé | Valeur |
|-----|--------|
| 📦 npm | @portaki/module-appliances |
| 🆔 id | appliances |
| 📍 Slot nav | section |
| 🎨 Icône | plug |
| 📄 Manifeste | ../portaki.module.json |
| 👁️ Visibilité | Toujours affiché |
| 🗺️ Carte | Non |
🔌 Intégration Portaki
Branche CMS / JSON propriété dans le JSX pour remplacer la démo.
📡 Données & API
Contenus par propriété : le configurateur hôte enregistre devices_json (tableau JSON) et safety_notice (optionnel). Chaque appareil supporte title {fr,en}, tips, manualUrl, icon.
Exemple devices_json
[
{
"id": "lave-vaisselle",
"title": { "fr": "Lave-vaisselle", "en": "Dishwasher" },
"tips": { "fr": "Programme Éco — pastilles dans le tiroir.", "en": "Eco cycle — tabs in the drawer." },
"manualUrl": "",
"icon": "utensils"
}
]La page invité reçoit la config déchiffrée via GET /api/v1/guest/{slug}/{code} (moduleConfigs).
🛠️ Développement local
pnpm install # racine du monorepo portaki-sdkDépend de @portaki/module-sdk → portaki-sdk.
📄 Licence
AGPL-3.0 — voir package.json.
