Git Product home page Git Product logo

angular2-mdl's Introduction

Angular 5 components, directives and styles based on material design lite https://getmdl.io (v: 1.3.0). This package assumes that you are building an Angular app with TypeScript. Angular CLI makes it even easier but isn't required.

If you are looking for a stable Angular 4 compatible version please refer to this branch: https://github.com/mseemann/angular2-mdl/tree/angular4. master is compatible with Angular 5.

If you are looking for a stable Angular 2 compatible version please refer to this branch: https://github.com/mseemann/angular2-mdl/tree/angular2. master is compatible with Angular 5.

Build Status CircleCI npm version Downloads Coverage Status Dependencies peerDependencies Status DevDependencies Code Climate

Status of the npm package version 4 (mdl version 1.3.0; angular 5)

  • Badges
  • Buttons
  • Cards
  • Chips
  • Dialogs (imperative and declarative)
  • Icons
  • Loading
  • Shadow
  • Toggle (Checkbox, Radio, Icon Toggle, Switch)
  • Lists
  • Slider
  • Snackbar
  • Table
  • Tooltips
  • Menu
  • Layout (standard, scroll, waterfall, tabs)
  • Tabs
  • Textfields (multiline, expandable)

Installation

npm install @angular-mdl/core --save

How to use the mdl components with webpack

Just use it. Add the MdlModule to your NgModule imports and you are done!

How to use the mdl components with system js

You need to configure your system-config.js file:

const map: any = {
  '@angular-mdl/core': 'vendor/@angular-mdl/core'
};

/** User packages configuration. */
const packages: any = {
  '@angular-mdl/core': { main: 'bundle/core.js'}
};

css from material-design-lite

You may include the material-design-lite css in your html and you're done!

<link rel="stylesheet" href="https://code.getmdl.io/1.1.3/material.indigo-pink.min.css" />
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">

Under http://mseemann.io/angular2-mdl/theme you'll find a customizing tool to change the theme colors.

How to use the scss files from material-design-lite

This package includes the scss files from material-design-lite. With these files you are able to change the colors and other variables in your own scss files:

@import "~@angular-mdl/core/scss/color-definitions";

$color-primary: $palette-blue-500;
$color-primary-dark: $palette-blue-700;
$color-accent: $palette-amber-A200;
$color-primary-contrast: $color-dark-contrast;
$color-accent-contrast: $color-dark-contrast;

@import '~@angular-mdl/core/scss/material-design-lite';

To make this working you need to find out the way how you could tell your build system where the scss is located. For example with webpack you can use the special ~@angular-mdl/core syntax used above. Or you can configure the includePaths:

sassLoader: {
	includePaths: [util.root('node_modules', '@angular-mdl/core', 'scss')]
}

Contributing

Every contribution is welcome. Please checkout the CONTRIBUTION.md file.

Remarks

If you need a working example for the current angular-cli with the current angular-mdl and angular versions please have a look at: https://github.com/mseemann/angular-mdl-a4-angular-cli.

And if you would like to see a real world app that uses this package have a look at https://www.yovelino.de/apps/tour-planner/.

angular2-mdl's People

Contributors

abdulqadir93 avatar aklaus avatar alexey-vykhrystyuk-arcadia avatar andrewbents avatar angular-cli avatar crystalraebryant avatar greenkeeper[bot] avatar greenkeeperio-bot avatar guzmo avatar hanzubon avatar janpio avatar jlee1201 avatar joevanwanzeele avatar jsmike avatar leojpod avatar leolorenzoluis avatar mgiuliani avatar mseemann avatar paullryan avatar tb avatar tomicasoft avatar zskhan 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.