npm install origam

Prêt à tourneren quelques minutes.

Installez origam, enregistrez le plugin et commencez à construire avec 218 composants Vue 3 accessibles et pilotés par tokens.

ÉTAPE PAR ÉTAPE

Cinq étapes.C'est parti.

De zéro à une app Vue 3 entièrement thémée avec origam — sans boilerplate.

  1. 1. Installer

    Ajoutez origam à votre projet avec votre gestionnaire de paquets préféré.

  2. 2. Enregistrer le plugin

    Importez les feuilles de tokens et enregistrez origam comme plugin Vue dans votre fichier d'entrée.

    main.ts

    createOrigam() accepte un sac d'options facultatif pour configurer les icônes, la locale, l'affichage, le SSR, les alias et plus encore. Par défaut, tous les composants et directives sont enregistrés globalement — mais aucun thème n'est installé tant que vous n'en passez pas un explicitement, comme ci-dessus.

  3. 3. Utiliser un composant

    Tous les composants sont enregistrés globalement. Placez n'importe quel composant Origam dans vos templates — aucun import par fichier nécessaire.

    App.vue
  4. 4. Thématisation

    origam est livré avec des thèmes clair et sombre. Basculez statiquement via un attribut HTML, ou à l'exécution avec le composable useTheme.

    Bascule statique — attribut HTML (omettre pour suivre la préférence système) :

    index.html

    Bascule à l'exécution — composable useTheme :

    ts

    Surcharge de sous-arbre :

    vue

    Importez origam/tokens/css/dark une fois au démarrage pour activer la feuille de tokens sombre.

  5. 5. Intégration Nuxt

    Vous utilisez Nuxt 3 ou Nuxt 4 ? Le module Nuxt officiel origam est inclus dans le même package — pas d'installation supplémentaire.

    nuxt.config.ts

    Le module Nuxt est livré en sous-export (origam/nuxt) — aucun package séparé à installer. Il auto-importe tous les composants et composables, et résout les thèmes de manière SSR-safe.

PRÉREQUIS

Dépendances pairs.

origam a une empreinte minimale. Vue 3 est le seul peer obligatoire — tout le reste est optionnel et tree-shaké quand non utilisé.

Dépendances pairs
PackageRequisUtilisé par
Toujours — runtime de base
Optionnel — composable locale
Optionnel — composants lien

Node >= 22 est requis pour compiler origam depuis les sources. Les consommateurs n'ont besoin que de Vue 3.5+ à l'exécution.

Prêt à construire ?

Explorez le catalogue complet de composants, parcourez les stories interactives ou plongez dans le code source sur GitHub.