Welcome UI logo
FOUNDATIONSCOMPONENTSBLOG650+
10.0.0

Menu

    • Getting started
    • How to contribute

    Theming

    • Basics

    Upgrades

    • Olders
    • V10
    • V9

Getting started

Getting started

Installation

1 - Install the welcome-ui package and peer dependencies listed below:

yarn add welcome-ui tailwindcss react@^19.0.0
yarn add postcss --dev

2 - Add dependencies for vite project

yarn add @tailwindcss/vite sass-embedded --dev

3 - Add on your vite config tailwindcss plugin

import { defineConfig } from 'vite'
import tailwindcss from '@tailwindcss/vite'
export default defineConfig({
plugins: [
tailwindcss(),
],
})

Import library & Theme

On your theme or global css import:

  • TailwindCSS
  • Welcome UI Theme
@import 'tailwindcss';
@import 'welcome-ui/theme.css';

Enjoy! 🌞

import { Button } from 'welcome-ui/Button'
return <Button>Ok let's go</Button>
How to contribute
Made with by
Welcome to the jungle logo

Documentations

  • Foundations
  • Components
  • Source code

Updates

  • Releases
  • Issues

Community

  • Github
  • Twitter
  • Medium
  • Jobs