Krowdy-UI

React components that implement Google's Material Design.

This project based on Material-UI

Installation

Krowyd-UI is available as an npm package.

Web site

// with npm
npm install @krowdy-ui/core

// with yarn
yarn add @krowdy-ui/core

Please note that @next will only point to pre-releases; to get the latest stable release use @latest instead.

Usage

Here is a quick example to get you started, it's all you need:

import React from 'react';
import ReactDOM from 'react-dom';
import { ThemeProvider } from '@krowdy-ui/styles';
import { Button, createMuiTheme, krowdyTheme } from '@krowdy-ui/core';


function App() {
  return (
    <ThemeProvider theme={createMuiTheme(krowdyTheme)}>
      <Button variant="contained" color="krowdy">
        Hello World
      </Button>
    </ThemeProvider>
  );
}

ReactDOM.render(<App />, document.querySelector('#app'));

Yes, it's really all you need to get started as you can see in this live and interactive demo:

Questions

For how-to questions and other non-issues, please use StackOverflow instead of Github issues. There is a StackOverflow tag called "krowdy-ui" that you can use to tag your questions.

Examples

Are you looking for an example project to get started? We host some.

Documentation

Check out our documentation website.

Changelog

Recently Updated? Please read the changelog.

Contributing

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Krowdy-UI.

License

This project is licensed under the terms of the MIT license.