@vega-ui/react
v2.4.0
Published
Vega UI Kit for React
Readme
@vega-ui/react
React component library for VegaUI.
Requirements
react^19.0.0react-dom^19.0.0- a bundler that can import package CSS
Installation
Install the component package together with the global theme package:
pnpm add @vega-ui/react @vega-ui/theme-coreWhy both:
@vega-ui/reactprovides components and compiled component CSS@vega-ui/theme-coreprovides the semantic theme variables those components rely on
Styles
Import the theme and component stylesheet once near the application entrypoint:
import '@vega-ui/theme-core';
import '@vega-ui/react/style.css';If your app uses CSS layers, keep VegaUI below app-specific overrides:
@import url('@/shared/styles/normalize.css') layer(reset);
@import url('@vega-ui/theme-core') layer(theme);
@import url('@vega-ui/react/style.css') layer(library);
@layer reset, theme, library, app, overrides;Quick Start
Apply a theme class at the app boundary, then render components normally:
import '@vega-ui/theme-core';
import '@vega-ui/react/style.css';
import { Button } from '@vega-ui/react';
export function App() {
return (
<div className='light'>
<Button>Save changes</Button>
</div>
);
}Built-in theme classes are .light and .dark.
Common Import Paths
import { Button, Dialog, Select, TextField } from '@vega-ui/react';
import type { ButtonProps, SelectProps } from '@vega-ui/react';The package also exposes per-component entrypoints:
import { Button } from '@vega-ui/react/Button';Local Development
From the repository root:
pnpm install
pnpm storybook
pnpm --filter @vega-ui/react test
pnpm docs:validatePackage-local scripts:
pnpm --filter @vega-ui/react build
pnpm --filter @vega-ui/react test
pnpm --filter @vega-ui/react check-typesDocumentation
Common Mistakes
- importing
@vega-ui/react/style.csswithout@vega-ui/theme-core - applying
.lightor.darktoo deep in the tree instead of around the app shell - using raw palette tokens in app overrides instead of semantic theme variables
- assuming the component package is fully themed without an app-level theme class
