JSPM

welcome-ui

0.27.10
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 724
  • Score
    100M100P100Q85047F
  • License MIT

A delightful UI system from Welcome to the Jungle

Package Exports

  • welcome-ui

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (welcome-ui) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Welcome UI

License npm package downloads npm Code formating Code style PRs Welcome Conventional Commits

Welcome to the Welcome UI library create by Welcome to the jungle with react and styled components 💅

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 'styled-components'
import { createTheme, GlobalStyle } 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 />
        <div>Welcome!</div>
      </>
    </ThemeProvider>
  )
}