welcome-ui

Welcome UI

Welcome to the Welcome UI library create by Welcome to the jungle, a customizable design system with react • styled-components • styled-system and reakit.

Here you'll find all the core components you need to create a delightful webapp.

🌴 Discover all the components

Install

npm install welcome-ui

or

yarn add welcome-ui

Import library & Theme

You can find all the theme properties here.

import React from 'react'
import { ThemeProvider } from '@xstyled/styled-components'
import { createTheme, GlobalStyle, Text } from 'welcome-ui'

const options = {
  defaultFontFamily: 'Helvetica',
  headingFontFamily: 'Georgia',
  colors: {
    primary: {
      500: '#FF0000'
    },
    secondary: {
      500: '#00FF00'
    }
  }
}
const theme = createTheme(options)

export default function Root() {
  // Wrap your component with ThemeProvider
  return (
    <ThemeProvider theme={theme}>
      <>
        <GlobalStyle />
        <Text variant="h1">Welcome!</Text>
      </>
    </ThemeProvider>
  )
}