Code Monkey home page Code Monkey logo

ui's Introduction

Deriv Ui Library (@deriv-com/ui)

NPM Version NPM Downloads @deriv-com/ui is released under the MIT license. Coverage Status

Overview

This is a UI component library made for ReactJS that conforms to the Deriv Design System. Explore our Storybook for for comprehensive development documentation .

Also available on npm.

It features two main sections:

  • components: contains all the components that are built to be used in the deriv platform.
  • hooks: which contains all the hooks that might be needed in deriv projects. for now we only have two hooks (useOnClickOutside and useDevice)

Getting Started

To get started simply install it from the @deriv-com/ui package:

npm i @deriv-com/ui

Usage Example

import {Button} from "@deriv-com/ui"

<Button  color="primary" rounded="sm"  size="md"  type="button"  variant="contained"  >  Click me! </Button>

you can explore the Storybook to learn about the available props for each component.

Development

To get started, first install all of the relevant packages by doing:

npm i

Since this projects uses Storybook to showcase the components. You can serve them by simply running this command:

npm run storybook

Contributing

Contributions to the @deriv-com/ui library are warmly encouraged. If you have suggestions for enhancements or encounter a bug, please feel free to open an issue or submit a pull request (ensure you fork it first).

ui's People

Contributors

shayan-deriv avatar yaswanth-deriv avatar aizad-deriv avatar ali-hosseini-deriv avatar semantic-release-bot avatar niloofar-deriv avatar aum-deriv avatar markw-deriv avatar heorhi-deriv avatar likhith-deriv avatar farhan-slurrp avatar nada-deriv avatar hasan-deriv avatar thisyahlen-deriv avatar ameerul-deriv avatar shahzaib-deriv avatar dependabot[bot] avatar

Stargazers

 avatar  avatar

Watchers

Tom Molesworth avatar  avatar  avatar

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.