Référence API · Vue

@oriatheme/vue

Connectez un environnement d'exécution à un plug-in Vue, fournissez et Composable sans mettre en miroir l'état d'exécution.

Forfait et environnement

Plugin de navigateur/fournir pour Vue 3.5 ; le module lui-même peut être importé en toute sécurité via SSR.

bash

pnpm add @oriatheme/presets @oriatheme/runtime-dom @oriatheme/vue

bash

npm install @oriatheme/presets @oriatheme/runtime-dom @oriatheme/vue

bash

yarn add @oriatheme/presets @oriatheme/runtime-dom @oriatheme/vue

bash

bun add @oriatheme/presets @oriatheme/runtime-dom @oriatheme/vue

Utilisez le gestionnaire de packages et le fichier de verrouillage déjà choisis par le projet consommateur. Les exemples utilisent uniquement les exportations racine du package ; n'effectuez pas d'importation approfondie à partir de modèles src, dist ou de registre.

Exports

Exporter	Signature	Descriptif
`createOriaTheme`	`(config: OriaThemeConfig) => Plugin`	Crée un plugin qui possède le runtime qu'il construit.
`provideOriaTheme`	`(config \| runtime) => OriaThemeRuntime`	Fournit un environnement d’exécution détenu ou fourni par l’appelant dans l’arborescence actuelle.
`useOriaTheme`	`() => { snapshot, runtime, setTheme, setAppearance }`	Renvoie le temps d'exécution et une référence d'instantané superficiel en lecture seule.

vue

<script setup lang="ts">
import { useOriaTheme } from "@oriatheme/vue";
const { snapshot, setAppearance } = useOriaTheme();
</script>
<template><button @click="setAppearance('system')">{{ snapshot.resolvedMode }}</button></template>

Types et limites importants

l'instantané est un DeepReadonly<ShallowRef<ThemeSnapshot>>. Ne reflète pas le thème, l'apparence ou le mode résolu dans Pinia ou un autre magasin.