Giter Club home page Giter Club logo

material's Introduction

Material Design for AngularJS Apps Build Status

Material Design is a specification for a unified system of visual, motion, and interaction design that adapts across different devices. Our goal is to deliver a lean, lightweight set of AngularJS-native UI elements that implement the material design system for use in Angular SPAs.

venn

This project is still in early preview. It is a complementary effort to the Polymer project's paper elements collection.

Please note that using Angular Material requires the use of Angular 1.3.x or higher. These components are intended to work in the latest version of "evergreen" browsers (Chrome, Firefox, Internet Explorer, Safari).

Demo Site

You can see these components in action at http://material.angularjs.org.

Or you run build the docs and demos locally. See the Documentation README for details.

Development

This project is in early development via a small core team of Ionic Framework and AngularJS developers. We don't have guidelines yet for broader community involvement, although we hope to have some soon.

For issues, including progress on accessibility support for these UI elements, see the Issue Tracker.

See CONTRIBUTING.md for information on structure, documentation, and code conventions.

Usage

In its current early state, use AngularJS Material Design at your own risk. APIs are changing rapidly.

If you wish to use angular-material anyway, you can:

  • bower install angular-material to the get latest stable release

    or download the files directly from the bower-material repository.

  • bower install angular-material#master to get the version just committed to master

    Note that master is less stable than a release.

View the README in the bower-material repository for how to get started.

File Structure

  • Components belong in src/components/{componentName}
  • Component modules must be named material.components.{componentName}
  • Templates for directives are declared inline
  • Gulp builds files to dist folder, which is not version controlled (read below)

Commit Conventions

Development

For each milestone release, always run:

  • npm update for gulp deps
  • bower update for angular deps

The following command line tasks are available:

  • gulp build (alias gulp) to build, add --release flag to uglify & strip console.log.
  • gulp watch to build & rebuild on changes
  • gulp validate to test and jshint
  • gulp jshint to run jshint
  • gulp karma to test once
  • gulp karma-watch to test & watch for changes
  • gulp docs to build docs into dist/docs

Documentation

  • See docs/README.md.

material's People

Contributors

ajoslin avatar thomasburleson avatar rschmukler avatar adamdbradley avatar mlynch avatar naomiblack avatar btford avatar robertmesserle avatar petebacondarwin avatar matsko avatar eisenbergeffect avatar raymond-h avatar tbosch avatar trentdavida avatar scarletsky avatar marcysutton avatar kevinwestern avatar campersau avatar belfordz avatar richguan avatar pborreli avatar pandaiolo avatar ocombe avatar mzbyszynski avatar wilsonjackson avatar leendertdommicent avatar jelbourn avatar sly777 avatar igorminar avatar amweiss avatar

Watchers

Robert Fauver avatar James Cloos 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.