JSPM

welcome-ui

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

Customizable design system with react • styled-components • styled-system and reakit.

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

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


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


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>
  )
}