@marwes-ui/react
v1.3.0
Published
React components for the Marwes design system with default styling, typed theme tokens, accessibility contracts, and AI-readable semantics.
Readme
React components for the Marwes design system with default styling, typed theme tokens, accessibility contracts, and AI-readable semantics.
Marwes Design System - React
React components with default Marwes styling, typed theme tokens, accessibility contracts, and AI-readable semantics built in.
React 18+ • TypeScript-first • Default CSS included • ThemeInput • Google Fonts DX • Purpose components
Documentation • React Storybook • GitHub
Why Use It
Marwes is built for teams and AI-assisted workflows that need a component system that is easy to install, easy to theme, and hard to misuse.
- One package for React apps: components, provider, default preset CSS, theme helpers, and typed props.
- Beautiful defaults: install the adapter, wrap your app, and start building without a separate CSS setup.
- Consequential theming: a
ThemeInputobject changes colors, fonts, radius, density, typography, and component visuals through shared CSS variables. - Purpose components:
SubmitButton,CancelButton, andDestructiveButtonmake intent machine-readable so tests, audits, and AI agents can handle actions safely. - Shared core contracts: every React component is backed by the same framework-agnostic recipes, a11y mapping, and theme shape.
Package Map
For a React app, install this package first. It includes the React adapter, loads the default preset CSS, and re-exports the core theme helpers you normally need.
| Package | Use it when |
| --- | --- |
| @marwes-ui/react | You are building a React app. |
| @marwes-ui/vue | You are building a Vue app instead. |
| @marwes-ui/core | You are building adapters, tests, tooling, or framework-agnostic integrations. |
| @marwes-ui/presets | You need standalone preset CSS or preset theme exports. |
This split keeps installation simple for app teams while giving humans and AI agents clear package boundaries: adapters render, core defines contracts, presets style.
Install
pnpm add @marwes-ui/react react react-domNo preset CSS import is needed. @marwes-ui/react depends on @marwes-ui/presets and loads the default Marwes CSS automatically.
Quick Start
import {
Button,
ButtonVariant,
Checkbox,
Input,
MarwesProvider,
SubmitButton,
} from "@marwes-ui/react"
export function App() {
return (
<MarwesProvider>
<Input placeholder="Email" ariaLabel="Email" />
<Checkbox ariaLabel="Subscribe" />
<Button variant={ButtonVariant.secondary}>Preview</Button>
<SubmitButton>Save</SubmitButton>
</MarwesProvider>
)
}Style App-Owned UI
Marwes components pick up provider tokens automatically. Your own React styling can use the same tokens by importing mwThemeVars. This example uses styled-components, but the same values work in Emotion, vanilla-extract, inline style objects, CSS Modules, and plain CSS.
import { Button, ButtonVariant, MarwesProvider, mwThemeVars } from "@marwes-ui/react"
import styled from "styled-components"
const AppShell = styled.main`
min-height: 100dvh;
padding: ${mwThemeVars.spacing.sp24};
color: ${mwThemeVars.color.text};
background: ${mwThemeVars.color.background};
`
const FeaturePanel = styled.section`
padding: ${mwThemeVars.spacing.sp24};
background: ${mwThemeVars.color.surface};
border: 1px solid ${mwThemeVars.color.border};
border-radius: ${mwThemeVars.ui.radius};
`
const PrimaryCallout = styled.aside`
background: ${mwThemeVars.color.primary.base};
color: ${mwThemeVars.color.primary.label};
`
export function App() {
return (
<MarwesProvider>
<AppShell>
<PrimaryCallout>Launch workspace</PrimaryCallout>
<FeaturePanel>
<Button variant={ButtonVariant.primary}>Save</Button>
</FeaturePanel>
</AppShell>
</MarwesProvider>
)
}Plain CSS and CSS Modules can use the raw custom properties directly:
.app-shell {
min-height: 100dvh;
padding: var(--mw-spacing-sp-24);
color: var(--mw-color-text);
background: var(--mw-color-background);
}Use Typed Components
Import components, enums, and prop types from the same package. The values line up with the same core recipes and preset CSS.
import {
BadgeVariant,
Button,
ButtonSize,
ButtonVariant,
Card,
H1,
InputField,
Paragraph,
Spacer,
Spacings,
StatusBadge,
SubmitButton,
type ButtonProps,
type H1Props,
type InputFieldProps,
type ParagraphProps,
} from "@marwes-ui/react"
const primaryAction: ButtonProps = {
variant: ButtonVariant.primary,
size: ButtonSize.md,
children: "Create project",
}
const emailField: InputFieldProps = {
label: "Email",
helperText: "Used for project notifications.",
input: {
type: "email",
placeholder: "[email protected]",
},
}
const titleProps: H1Props = {
size: "h2",
}
const descriptionProps: ParagraphProps = {
size: "md",
}
export function ProjectPanel() {
return (
<Card title="Project setup">
<StatusBadge variant={BadgeVariant.success}>Ready</StatusBadge>
<Spacer spacing={Spacings.sp16} />
<H1 {...titleProps}>Launch workspace</H1>
<Paragraph {...descriptionProps}>
Components share theme tokens, typed variants, spacing, and semantic metadata.
</Paragraph>
<InputField {...emailField} />
<Spacer spacing={Spacings.sp24} />
<Button {...primaryAction} />
<SubmitButton>Save changes</SubmitButton>
</Card>
)
}Available Components
Provider and hooks:
MarwesProvideruseThemeuseToast
Actions and buttons:
ButtonPrimaryButton,SecondaryButton,TextButton,SuccessButtonSubmitButton,CancelButton,CreateButton,DestructiveButtonLinkButton,SaveButton,ConfirmButton,VerifyButtonEditButton,CloseButton,RefreshButtonUploadButton,DownloadButton,CopyButtonSearchButton,FilterButton,SortButton,DropdownButton
Forms and inputs:
Input,Textarea,Select,RichText,InputOtpInputField,TextareaField,SelectField,RichTextFieldDropdownField,SearchField,PasswordField,EmailFieldDateOfBirthField,ZipCodeField,PhoneField,URLField,CurrencyFieldCheckbox,CheckboxField,CheckboxGroupFieldRadio,RadioGroupField,YesNoRadioGroup,RatingRadioGroup,OptionRadioGroupSwitch,SwitchField,FeatureToggle,PreferenceSwitch,PermissionSwitchSlider,SliderField,VolumeSlider,BrightnessSlider,RadiusSlider
Content and layout:
Card,ProductCard,ProfileCard,StatCardH1,H2,H3,ParagraphSpacer,Spacing,DividerIconAvatar,AvatarBadge,AvatarGroup,ProfileAvatar,PresenceAvatar,TeamAvatarGroup
Feedback and overlays:
Badge,BadgeGroup,StatusBadge,PriorityBadge,NotificationBadgeSpinner,ButtonSpinner,EmptyStateSpinnerToast,ToastContainer,ToastProviderSuccessToast,ErrorToast,WarningToast,InfoToastTooltip,TooltipGroupDialog,DialogModal,ConfirmDialog,DestructiveDialog,InfoDialogAccordion,AccordionField,FAQAccordion,SettingsAccordion,SectionsAccordionTab,TabGroup,TabPanel,NavigationTabs,ContentTabs,SettingsTabs
Typed tokens and helpers:
ThemeInput,ThemeMode,Density,ToneNamemwAvailableFonts,mwGoogleFontFamilies,mwFontFallbacks,createFontStackmwThemeVars,mwThemeVarNames,mwStyledTheme,mwVarButtonVariant,ButtonSize,ButtonActionBadgeVariant,AvatarSize,AvatarType,SwitchSize,IconName,Spacings
Theme In Seconds
The default Marwes theme is already active. If you already have a good-looking design library or brand system, pass a small typed ThemeInput override instead of rebuilding component CSS.
import { MarwesProvider, mwAvailableFonts, type ThemeInput } from "@marwes-ui/react"
const brandTheme = {
color: {
primary: "#2457FF",
danger: "#D90429",
success: "#15803D",
warning: "#D97706",
background: "#F8FAFC",
surface: "#FFFFFF",
surfaceElevated: "#FFFFFF",
text: "#111827",
textMuted: "#4B5563",
border: "#D1D5DB",
focus: "#2457FF",
},
font: {
primary: mwAvailableFonts.Poppins,
secondary: mwAvailableFonts.Lora,
},
ui: {
radius: 10,
density: "comfortable",
},
} satisfies ThemeInput
export function App() {
return (
<MarwesProvider theme={brandTheme}>
<AppShell />
</MarwesProvider>
)
}The provider resolves ThemeInput into --mw-* CSS variables. Preset CSS consumes those variables across the full component system.
Marwes is designed to look great from the beginning. Start with the default preset, then override only the colors, fonts, radius, or density that belong to your product. Unspecified values keep the polished Marwes defaults.
Light And Dark Mode
MarwesProvider can own the active mode for the app. Use ThemeMode.light and ThemeMode.dark instead of string literals, then read or change the active mode with useThemeMode() anywhere under the provider. Every component under the provider receives the matching --mw-* variables and mw-theme--light / mw-theme--dark class.
import { Button, ButtonVariant, MarwesProvider, ThemeMode, useThemeMode } from "@marwes-ui/react"
function ThemeToggle() {
const { mode, toggleMode } = useThemeMode()
return (
<Button variant={ButtonVariant.secondary} onClick={toggleMode}>
Use {mode === ThemeMode.dark ? ThemeMode.light : ThemeMode.dark} mode
</Button>
)
}
export function App() {
return (
<MarwesProvider defaultMode={ThemeMode.light}>
<ThemeToggle />
<AppShell />
</MarwesProvider>
)
}defaultMode sets the initial uncontrolled mode. toggleMode() updates the provider, so Marwes components, preset CSS, and custom app styles that use --mw-* variables all move together without duplicating local theme state.
System And Persisted Preference
mode is always the rendered visual mode: ThemeMode.light or ThemeMode.dark. preference is the app or user choice: ThemeMode.light, ThemeMode.dark, or "system". Use preference and defaultPreference when your UI needs a system option; keep using mode, defaultMode, and onModeChange when you only need concrete light/dark compatibility.
import { Button, ButtonVariant, MarwesProvider, ThemeMode, useThemeMode } from "@marwes-ui/react"
function ThemeMenu() {
const { mode, preference, systemMode, isSystem, setPreference, setMode } = useThemeMode()
return (
<div>
<p>
Rendering {mode}; preference is {preference}; system is {systemMode}.
</p>
<Button variant={ButtonVariant.secondary} onClick={() => setPreference("system")}>
Use system
</Button>
<Button variant={ButtonVariant.secondary} onClick={() => setMode(ThemeMode.dark)}>
Use dark
</Button>
{isSystem ? "Following system" : null}
</div>
)
}
export function App() {
return (
<MarwesProvider
defaultPreference="system"
storageKey="marwes-theme"
enableSystem
>
<ThemeMenu />
<AppShell />
</MarwesProvider>
)
}useThemeMode().mode never returns "system"; it is always the concrete mode Marwes rendered. useThemeMode().preference returns the active app/user preference, and setPreference("system") is the system-capable setter. setMode(mode) remains a concrete light/dark convenience.
storageKey is opt-in and defaults to false. Storage reads and writes are failure-safe, so private browsing or unavailable storage will fall back to normal provider state. enableSystem defaults to true; set it to false to avoid matchMedia detection and resolve "system" through the light fallback.
This layer does not provide SSR no-flash behavior. Server output can still render the fallback mode before the client applies a stored or system preference. Use it for client-side preference and persistence, not for a no-flash SSR guarantee.
Root Target Sync
By default Marwes keeps theme state scoped to the provider element. If your app shell also needs the resolved mode on html or body, set target and attribute:
<MarwesProvider
defaultPreference="system"
storageKey="marwes-theme"
target="html"
attribute="class"
disableTransitionOnChange
>
<AppShell />
</MarwesProvider>target can be "provider", "html", or "body". attribute can be "class", "data-theme", or "data-mode". Class mode only adds the active light / dark class and removes the opposite one; unrelated classes are preserved. The provider root still keeps mw-theme--light / mw-theme--dark and provider-scoped --mw-* variables in every target mode.
Use one global-target provider per app shell. If multiple providers target html or body, deciding which provider owns that global element is app-owned behavior.
Tailwind And shadcn Compatibility
Marwes is compatible with Tailwind and shadcn-style dark variants through target="html" attribute="class". App-owned Tailwind tokens can also reference Marwes --mw-* variables when rendered inside the provider subtree.
<MarwesProvider
defaultPreference="system"
storageKey="marwes-theme"
target="html"
attribute="class"
>
<AppShell />
</MarwesProvider>Read the Tailwind and shadcn integration guide for Tailwind v3/v4 examples, token mapping, provider-scoped variable limits, and the SSR no-flash boundary.
Next.js App Router SSR
Use MarwesThemeStyle, MarwesThemeScript, and variableStrategy="style-tag" when a server-rendered app needs the correct light or dark variables before hydration. This is opt-in; normal React apps keep inline provider variables by default.
Read the theme SSR no-flash guide for Next.js App Router setup, CSP nonces, suppressHydrationWarning, custom light/dark themes, and stored/system preference behavior.
For a simple brand pass, override shared values once and let Marwes fill the rest. If your product needs different brand colors in light and dark mode, control mode and switch between two small ThemeInput override objects:
import { useState } from "react"
import {
Button,
ButtonVariant,
MarwesProvider,
ThemeMode,
type ThemeInput,
useThemeMode,
} from "@marwes-ui/react"
const themeByMode = {
[ThemeMode.light]: {
color: {
primary: "#2457FF",
background: "#F8FAFC",
surface: "#FFFFFF",
text: "#111827",
border: "#D1D5DB",
focus: "#2457FF",
},
},
[ThemeMode.dark]: {
color: {
primary: "#8BA2FF",
background: "#0B1020",
surface: "#111827",
text: "#F8FAFC",
border: "#334155",
focus: "#93C5FD",
},
},
} satisfies Record<ThemeMode, ThemeInput>
function ThemeToggle() {
const { mode, toggleMode } = useThemeMode()
return (
<Button variant={ButtonVariant.secondary} onClick={toggleMode}>
Use {mode === ThemeMode.dark ? ThemeMode.light : ThemeMode.dark} mode
</Button>
)
}
export function App() {
const [mode, setMode] = useState<ThemeMode>(ThemeMode.light)
return (
<MarwesProvider mode={mode} theme={themeByMode[mode]} onModeChange={setMode}>
<ThemeToggle />
<AppShell />
</MarwesProvider>
)
}Mode-specific defaults fill every omitted token, so each override can stay small. theme={{ mode: ThemeMode.dark }} is still enough for the default dark baseline.
Custom Styling Tokens
MarwesProvider resolves ThemeInput into --mw-* CSS variables. Marwes components and preset CSS consume those variables automatically. The custom styling token helpers let app-owned styles use the same provider-scoped values instead of hard-coding colors, spacing, radius, typography, or duplicated var(...) strings.
Use the helpers by purpose:
mwThemeVarsis the default styling helper. It returns CSSvar(...)references for styled-components, Emotion, vanilla-extract, inline style values, and config files.mwThemeVarNamesreturns raw custom property names for assigning provider-scoped overrides in style objects or tooling.mwVar()wraps custom or advanced--mw-*names when the named token object does not cover a specialized case.mwStyledThemeis a plain object that mirrorsmwThemeVarsfor styled-components or EmotionThemeProviderusage.
import type { ReactNode } from "react"
import { mwStyledTheme, mwThemeVarNames, mwThemeVars, mwVar } from "@marwes-ui/react"
import styled, { ThemeProvider } from "styled-components"
const Panel = styled.section`
padding: ${mwThemeVars.spacing.sp24};
color: ${mwThemeVars.color.text};
background: ${mwThemeVars.color.surface};
border-radius: ${mwThemeVars.ui.radius};
`
const InlinePanel = () => (
<div
style={{
[mwThemeVarNames.color.focus]: "#FF00AA",
color: mwThemeVars.color.text,
outlineColor: mwVar("--mw-color-focus", "#2457FF"),
}}
/>
)
const AppTheme = ({ children }: { children: ReactNode }) => (
<ThemeProvider theme={mwStyledTheme}>{children}</ThemeProvider>
)Plain CSS and CSS Modules do not need a JavaScript bridge:
.panel {
padding: var(--mw-spacing-sp-24);
color: var(--mw-color-text);
border-radius: var(--mw-ui-radius);
}This enables React apps to keep custom panels, local layouts, third-party CSS-in-JS components, and design-tool integrations visually tied to the same active theme as Marwes components. Changing MarwesProvider theme={...} updates both preset components and app-owned styles.
Keep the APIs separate:
- Use
Spacings.sp24for Marwes spacing props such as<Spacer spacing={Spacings.sp24} />. - Use
mwThemeVars.spacing.sp24for custom CSS values. - Use
mwThemeVarNames.spacing.sp24when assigning or inspecting a CSS custom property name. - Use
useTheme()when React logic needs resolved runtime values such as"#2457FF".
Google Fonts DX
Most Google Font use cases only need mwAvailableFonts; no fontLoading prop is needed.
import { MarwesProvider, mwAvailableFonts, type ThemeInput } from "@marwes-ui/react"
const fontTheme = {
font: {
primary: mwAvailableFonts.Poppins,
secondary: mwAvailableFonts.Lora,
},
} satisfies ThemeInput
<MarwesProvider
theme={fontTheme}
>
<App />
</MarwesProvider>For self-hosted or licensed fonts, use BrandSans, BrandSerif, BrandMono, or createFontStack().
Semantic Buttons
Prefer purpose components for common actions. They lock UX intent and emit AI-readable metadata, so the component is not just "a button with red styling" but a known action with known risk.
import {
CancelButton,
CreateButton,
DestructiveButton,
SubmitButton,
} from "@marwes-ui/react"
<CancelButton>Cancel</CancelButton>
<CreateButton>Create</CreateButton>
<SubmitButton>Save</SubmitButton>
<DestructiveButton>Delete</DestructiveButton>That matters for agentic workflows. A human, test, or AI agent can inspect the DOM and see that a destructive button requires confirmation before activation:
<button
data-component="button"
data-purpose="destructive"
data-action="delete"
data-destructive="true"
data-confirmation-required="true"
>
Delete
</button>An agent can then follow a safer rule: if data-confirmation-required="true", ask the user before clicking. A test can assert the same behavior without guessing from the label "Delete" or from a red color.
Use raw Button props when you intentionally need a custom combination.
import { Button, ButtonAction, ButtonSize, ButtonVariant } from "@marwes-ui/react"
<Button
action={ButtonAction.submit}
size={ButtonSize.md}
variant={ButtonVariant.primary}
>
Submit
</Button>Why It Is Accessible
Marwes React components are accessible because the adapter renders a shared core contract, not because each component hand-rolls ARIA in isolation.
- Core recipes produce typed
a11youtput for roles, labels, described-by wiring, invalid state, disabled state, and semantic metadata. - React components prefer native DOM controls first:
button,input,select,textarea,hr, and standard form wiring. - Field components connect visible labels, helper text, and errors through
id,htmlFor,aria-describedby,aria-invalid, and polite error announcements. - Coordinated widgets carry explicit contracts: tabs wire
tablist/tab/tabpanel, dialogs own dialog semantics, toasts expose live-region behavior, and purpose buttons expose risk metadata. - Storybook accessibility smoke checks run through the Storybook a11y addon for the promoted React families, and shared contract tests keep React aligned with Vue.
Example:
import { InputField, type InputFieldProps } from "@marwes-ui/react"
const receiptEmailField = {
label: "Email",
helperText: "Used for receipts.",
error: "Enter a valid email.",
input: { type: "email", placeholder: "[email protected]" },
} satisfies InputFieldProps
<InputField {...receiptEmailField} />That contract resolves to DOM wiring like:
<label for="email">Email</label>
<input
id="email"
type="email"
aria-describedby="email-helper email-error"
aria-invalid="true"
>
<p id="email-helper">Used for receipts.</p>
<p id="email-error" aria-live="polite">Enter a valid email.</p>The important part is that the same label, helper, error, and invalid contract is tested at the shared contract layer and then applied by the React adapter.
Package Boundaries
@marwes-ui/coreowns recipes, theme resolution, a11y mapping, and semantic metadata.@marwes-ui/presetsowns default preset CSS.@marwes-ui/reactowns React rendering and provider behavior.
Scripts
pnpm --filter @marwes-ui/react build
pnpm --filter @marwes-ui/react typecheck
pnpm --filter @marwes-ui/react test