@renge-ui/vue

@renge-ui/vue

Vue 3 composables and components for the Renge design system.

Installation

pnpm add @renge-ui/vue @renge-ui/tokens

Usage

Import the stylesheet

Import the token stylesheet once at your app's entry point. This defines every design token — spacing, type, motion, the palette, and the semantic color variables (--renge-color-bg, --renge-color-fg, --renge-color-accent, …).

// main.ts
import '@renge-ui/tokens/renge.css';

The color system works immediately on import — it ships with the ocean profile as the default (and follows the system light/dark preference). RengeProvider and switchProfile only change which profile is active; you do not need them for var(--renge-color-*) to resolve.

Setup with RengeProvider

Wrap your app with RengeProvider to switch profile/mode at runtime:

<script setup lang="ts">
import { RengeProvider } from '@renge-ui/vue';
</script>

<template>
  <RengeProvider profile="ocean" mode="light">
    <YourApp />
  </RengeProvider>
</template>

useRengeTheme Composable

Access theme state and switching functions in any component:

<script setup lang="ts">
import { useRengeTheme } from '@renge-ui/vue';

const { profile, mode, switchProfile, switchMode } = useRengeTheme();

const handleProfileChange = (newProfile: string) => {
  switchProfile(newProfile);
};

const toggleMode = () => {
  switchMode(mode === 'light' ? 'dark' : 'light');
};
</script>

<template>
  <div>
    <p>Current profile: {{ profile }}</p>
    <p>Current mode: {{ mode }}</p>
    
    <button @click="handleProfileChange('ocean')">Ocean</button>
    <button @click="handleProfileChange('earth')">Earth</button>
    <button @click="handleProfileChange('twilight')">Twilight</button>
    
    <button @click="toggleMode">Toggle {{ mode === 'light' ? 'Dark' : 'Light' }}</button>
  </div>
</template>

useRengeInject Composable

Inject theme context without providing it (useful in deeply nested components):

<script setup lang="ts">
import { useRengeInject } from '@renge-ui/vue';

const { profile, mode } = useRengeInject();
</script>

<template>
  <p>Theme: {{ profile }} / {{ mode }}</p>
</template>

Token References

Use rengeVars to reference design tokens in your components:

<script setup lang="ts">
import { rengeVars } from '@renge-ui/vue';

const spacingToken = rengeVars.spacing.md;
const colorToken = rengeVars.colors.surface;
</script>

<template>
  <div :style="{ padding: `var(${spacingToken})` }">
    Styled with Renge tokens
  </div>
</template>

API

RengeProvider

A Vue component that provides theme context to child components.

Props:

• profile (string, default: "ocean") — The color profile to use ("ocean", "earth", "twilight", "fire", "void", "leaf")
• mode ("light" | "dark", default: "light") — The color mode

useRengeTheme()

A composable that creates and provides theme context.

Returns:

• profile (string) — Current profile
• mode ("light" | "dark") — Current mode
• switchProfile(name: string) — Change the profile
• switchMode(mode: "light" | "dark") — Change the mode

useRengeInject()

A composable that injects an existing theme context.

Returns:

• Same interface as useRengeTheme()

Throws: Error if not used inside a component with theme context

Theme Switching

When you call switchProfile() or switchMode(), the composable updates the data-profile and data-mode attributes on the document root. Your Renge tokens use CSS custom properties scoped by these attributes.

License

MIT