Giter Club home page Giter Club logo

rashi-gupta-2000 / design-system Goto Github PK

View Code? Open in Web Editor NEW

This project forked from innovaccer/design-system

0.0 0.0 0.0 277.93 MB

Masala Design System (MDS) is an open-source design system built at Innovaccer. This is a simple and customisable component library to build faster, beautiful, and more accessible React applications on the guidelines and principles of Masala Design System.

Home Page: https://mds.innovaccer.com

License: MIT License

Shell 0.03% JavaScript 39.84% TypeScript 53.98% CSS 6.14% HTML 0.01%

design-system's Introduction

Masala Design System

Masala Design System (MDS) is an open-source design system built at Innovaccer. This is a simple and customizable component library to build faster, beautiful, and more accessible React applications on the guidelines and principles of Masala Design System.


codecov GitHub GitHub top language Snyk Vulnerabilities for GitHub Repo


๐Ÿš€ Get Up and Running

To install @innovaccer/design-system in your project, you will need to run the following command using npm:

npm install @innovaccer/design-system

If you prefer Yarn, use the following command instead:

yarn add @innovaccer/design-system

Adding style:

Import style at your app's root, it is not included in library bundle and shipped as a single css file. For more details see our styling section

import '@innovaccer/design-system/css';

If you want to try out @innovaccer/design-system, you can also use CodeSandbox.

Edit @innovaccer/design-system

Usage

import { Button } from '@innovaccer/design-system';
const App = () => {
  return <Button>Done</Button>;
};

For more information about each component, check out our Storybook. Check out our Tutorial to guide you in creating an awesome app.

CDN

If you prefer to include library globally by marking it as external in your application, library provides various single-file distributions, which can be used as following:

<!-- style -->
<link href="https://unpkg.com/@innovaccer/[email protected]/css/dist/index.css" rel="stylesheet" />

<!-- un-compressed UMD -->
<script src="https://unpkg.com/browse/@innovaccer/[email protected]/dist/index.umd.js"></script>

<!-- brotli compressed UMD -->
<script src="https://unpkg.com/@innovaccer/[email protected]/dist/index.umd.js.br"></script>

<!-- gzip compressed UMD -->
<script src="https://unpkg.com/@innovaccer/[email protected]/dist/index.umd.js.gz"></script>

Styling

As this component library is part of a framework-agnostic design system used at Innovaccer the styling is done with CSS using CSS variables for theming and BEM methodology for reusable and modular styling. So it requires you to include CSS in your project by either importing or serving it as a static file. The complete stylesheet is published as part of the component library at path @innovaccer/design-system/css. You can include css by importing it or loading it from cdn.

๐Ÿ‘‰ Using Font

The css sets the font family as 'Nunito Sans' for the body. To add this font in your project you need to load this font. The recommended way to do it is by adding the following google font cdn link to your app's head.

<link
  href="https://fonts.googleapis.com/css?family=Nunito+Sans:300,300i,400,400i,600,600i,700,700i,800,800i,900,900i&display=swap"
  rel="stylesheet"
/>

๐Ÿ‘‰ Updating Font:

If you don't add the font described above font family will not be affected by css. However, if you want to update the font family update it via the following css variable.

--font-family

๐Ÿ‘‰ Reset Styles

As BEM is used reset.css is not used and no style reset is done.

๐Ÿ‘‰ Polyfill for IE

For css variables to work on IE we use a polyfill at runtime to achieve dynamic theming through variables. Please add the following polyfill in your page.

<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script>
  cssVars({
    onlyLegacy: true,
  });
</script>

๐Ÿ—ƒ๏ธ Repos

Here are the supporting repositories.

  • MDS Rich Text Editor - Feature-rich WYSIWYG (What You See Is What You Get) HTML editor and WYSIWYG Markdown editor. It is used to create blogs, notes sections, comment sections etc. It has a variety of tools to edit and format rich content.
  • MDS Docs - Documentation site for Masala design system.
  • MDS Helpers - Alert Service.

๐Ÿ“š Documentation

โ— Code of Conduct

We expect everyone participating in the community to abide by our Code of Conduct. Please read it. Please follow it. We work hard to build each other up and create amazing things together. ๐Ÿ’ช๐Ÿ’œ

๐Ÿค How to Contribute

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the community! ๐Ÿ’ช๐Ÿ’œ

Check out our Contributing Guide for ideas on contributing and setup steps for getting our repositories up and running on your local machine.

Contributors โœจ

Thanks goes to these wonderful people (emoji key):


Aditya Kumawat

๐Ÿ’ป

Riya Lohia

๐Ÿ’ป

Satyam Yadav

๐Ÿ’ป ๐Ÿ“– ๐Ÿ‘€

sandeshchoudhary

๐Ÿ’ป

adityajhajharia

๐Ÿ’ป

Anuradha Aggarwal

๐Ÿ’ป

Sidharth

๐Ÿ’ป

stuti1090

๐Ÿ’ป

Vikas Singh

๐Ÿ’ป

SaniyaGupta

๐Ÿ’ป

Parth Chauhan

๐Ÿ’ป

Stuti Pandey

๐Ÿ’ป

Shivam Dwivedi

๐Ÿ’ป

Rahul Gaur

๐Ÿ’ป

atifzaidi92

๐Ÿ’ป

Sumit Dhyani

๐Ÿ’ป

Tanmay Sharma

๐Ÿ’ป

Rashi Gupta

๐Ÿ’ป

Varnika Jain

๐Ÿ’ป

Aman Verma

๐Ÿ’ป

SAMYAK JAIN

๐Ÿ’ป

This project follows the all-contributors specification. Contributions of any kind welcome!

๐Ÿ“ License

Licensed under the MIT License.

design-system's People

Contributors

satyamyadav avatar anuradha9712 avatar aditya-kumawat avatar riyalohia avatar veekays avatar anaghsharma avatar xlreon avatar saniyagupta avatar sandeshchoudhary avatar shubhamahuja1399 avatar adityajhajharia avatar innosatyam avatar nishant1120 avatar mukuljainx avatar stuti1090 avatar samyakinnovaccer avatar aregee avatar chauhanparth210 avatar stutirao avatar shib00 avatar dependabot[bot] avatar 927tanmay avatar snyk-bot avatar aman2810khan avatar tyczynski avatar samyak3009 avatar atifzaidi92 avatar alithanar avatar indremak avatar rashi-gupta-2000 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.