Giter VIP home page Giter VIP logo

design-system's Introduction

EBTH's Design System

CircleCI npm version Netlify Status

UI Component library and style helper mixins for SCSS.

Usage

  1. Install library

    yarn add @ebth/design-system
  2. Import components

    import * as React from 'react';
    import { Button } from '@ebth/design-system';
    
    type Props = {
        label: string;
    }
    
    export const MyButton: React.FC<Props> = ({ label }) => (
        <Button>{label}</Button>
    );
  3. Import shared utility classes (optional)

    @import '@ebth/design-system/dist/utility';

Creating your own components

  1. Define your styles

    // import base utility mixins and variables (if needed)
    @import '@ebth/design-system/dist/base';
    
    .my-button {
        background-color: $green-300;
        color: $text-color;
    }
  2. Create your component

    import * as React from 'react';
    import { Button } from '@ebth/design-system';
    
    type Props = {
        label: string;
    }
    
    export const MyButton: React.FC<Props> = ({ label }) => (
        <Button className="my-button">{label}</Button>
    );

Contributing

Please see documentation for contributing here.

License

MIT License.

design-system's People

Contributors

bpatram avatar dependabot-preview[bot] avatar dependabot-support avatar mizuti avatar ryanahamilton avatar

Watchers

 avatar

Forkers

coleary005

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.