Git Product home page Git Product logo

mofo-ui's Introduction

Uses Mofo Standards Build Status

mofo-ui

Mozilla Foundation React components.

Purpose

mofo-ui is a library of React UI components primarily for usage by the various Mozilla Foundation hubs. It's designed to complement mofo-bootstrap, but doesn't require it. It can also be used alongside stock Boostrap versions 3 and 4 or with no additional CSS framework.

Usage

In your target project, do the following:

  1. npm i mofo-ui --save
  2. Include the compiled CSS and JS located in dist in your app.
  3. If you're using Webpack, you can require mofo-ui and pick which components you want to use.

For example:

import { RadioFilter } from "mofo-ui";

<RadioFilter options={radioOptions} initialChoice={`foo`}></RadioFilter>

Development

Run the following commands in your terminal:

  1. git clone https://github.com/mozilla/mofo-ui.git
  2. cd mofo-ui
  3. npm start
  4. Navigate to http://127.0.0.1:1615 to view the demo page.

File Structure

├── demo <- A page with all components for dev and demo purposes
│   ├── css <- Compiled code. Don't edit.
│   ├── img <- Image assets for demo page.
│   ├── index.html <- Wrapper for demo.jsx injection
│   └── js <- Compiled code. Don't edit.
├── dist <- Compiled code. Don't edit.
├── src
│   ├── components <- All the mofo-ui library components
│   ├── demo.jsx <- JSX code for demo page
│   ├── exports.js <- Entry point for exported components.
│   └── main.scss
└── webpack.config.js

CSS Class Names

To reduce conflicts with other CSS, prefix all class names with mui- (eg: mui-tabs).

mofo-ui's People

Contributors

alanmoo avatar arrizalamin avatar gvn avatar hassenpy avatar mmmavis avatar pomax avatar

Watchers

 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.