React implementation of the Marigold Design System built on Emotion

Marigold

React implementation of the Marigold Design System built on Emotion.

Usage 💡

Use the styles for your component from a global theme object. To provide the theme in context, wrap your component into the MarigoldProvider. You can add custom styles via style props.

// basic usage
import React from 'react'
import { MarigoldProvider } from '@marigold/system'
import { Text, theme } from '@marigold/components'

<MarigoldProvider theme={theme}>
  <Text mx="2">Lorem ipsum</Text>
</MarigoldProvider>

Documentation 📖

Start your local storybook server via

yarn start

to access the Marigold documentation pages.

Setup 🔧

# after first release:
# with npm
npm install marigold-ui --save

# with yarn
yarn add marigold-ui

# for now:
git clone https://github.com/marigold-ui/marigold.git
cd marigold
yarn install

For Developers

• Coverage: yarn coverage
• Linting: yarn lint
• Test: yarn test (with optional --watch)
• Type checking: yarn typecheck
• Create new component: yarn create:component <name>

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Download Details:

Author: marigold-ui

Source Code: https://github.com/marigold-ui/marigold

#react #reactjs #javascript