Giter Club home page Giter Club logo

uikit's Introduction

Myntra UIKit

A React implementation of Myntra's Design System

The Myntra's UIKit is a design system that aims to establish a common vocabulary between everyone in an organization. It captures repeating design structures, conventions, and, decisions across dozens of applications and builds as a re-usable pattern library.

UIKit is a continuous effort of finding new patterns and decommissioning older irrelevant patterns, so we adopt a component status convention.


Icon Status Description
๐Ÿ’” DEPRECATED DO NOT USE. If you're using DEPRECATED component, it's time to migrate as it would removed in next major release.
โค๏ธ EXPERIMENTAL USE WITH CAUTION. These components are most likely to graduate to REVIEWING state but they can be ocassionally DEPRECATED too. If you're using EXPERIMENTAL component, keep your application up to date.
๐Ÿ’› REVIEWING These components are as good as READY component. They would graduate to READY after a fixed time (approx. 3 months or 3 minor releases or next major release).
๐Ÿ’š READY These components are well tested, stable and proven.

Using the React components

We do offer a varity of components which includes simple one's like Text and Button and complex components Virtual List, Schema Form etc.

Installation

Run the following command using npm:

npm install @myntra/uikit --save

If you prefer Yarn, use the following command instead:

yarn add @myntra/uikit

Usage

  1. Import any of the provided components directly in your project:
import { Button, Layout, Text } from "@myntra/uikit"
  1. Tell React to render the element in the DOM:
ReactDOM.render(
  <Provider>
    <Layout>
        <Text.Title>Page Title</Text.Title>
        <Button onClick={() => alert('Button clicked!')}>Example button</Button>
    </Layout>
  </Provider>,
  document.querySelector('#app'),
);

Using the icon library

We offer integration of icons with some of our components like Button, NavBar, etc. All these icons are passed as a react element to the desired component. We offer some of the basic set of icons that you can use. Apart from that, you can use your own icons as well.

Installation

Run the following command using npm:

npm install @myntra/uikit-icons --save

If you prefer Yarn, use the following command instead:

yarn add @myntra/uikit-icons

Usage

  1. Import any of the provided icons directly in your project:
import BarsSolid from "@myntra/uikit-icons/svgs/BarsSolid"
import Bell from "@myntra/uikit-icons/svgs/Bell"
import BoxSolid from "@myntra/uikit-icons/svgs/BoxSolid"
  1. Pass this icon element as a prop to the component:
<Icon name={BarsSolid} />
<Button icon={Bell}>Pencil</Button>
<NavBar.Item icon={BoxSolid}>Home</NavBar.Item>

Contributing

Pull requests are welcome. See the contribution guidelines for more information.

Contributors


Sunil Jhamnani

uikit's People

Contributors

sunil-jhamnani avatar airishmyntra avatar airishgupta avatar advaitk7 avatar rohankarparag 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.