@wavv/ui

Getting Started

Install

// npm
npm i @wavv/ui

// yarn
yarn add @wavv/ui

// pnpm
pnpm add @wavv/ui

Peer Dependencies

@wavv/ui currently has three peer dependencies: react, react-dom, and @emotion/react.

// npm
npm i react react-dom @emotion/react

// yarn
yarn add react react-dom @emotion/react

// pnpm
pnpm add react react-dom @emotion/react

Usage

A ThemeProvider needs to wrap the entire app so that all @wavv/ui components can use those styles.

By default, there is a light and a dark theme on the theme object exported by @wavv/ui. More can be read about the theme and how to customize it here.

import React from 'react';
import { ThemeProvider } from '@emotion/react';
import { theme, ResetStyles, ScrollbarStyles } from '@wavv/ui';

const App = () => {
	const currentTheme = theme.light;
	return (
		<ThemeProvider theme={currentTheme}>
			<ResetStyles />
			<ScrollbarStyles />
			{/* app contents */}
		</ThemeProvider>
	);
};

Documentation

Documentation can be found at ui.wavv.com

License

This project is licensed under the terms of the MIT license.