Skip to content

Material-Addons is an addon to Angular Material which is based on the Material Design system.

Notifications You must be signed in to change notification settings

stefan-isakovic/material-addons

 
 

Repository files navigation

About

The goal of "material addons" is to achieve a stylesheet similar to Clarity Addons for Angular Material.

The package can be found on npmjs.

The demo uses the material-addons stylesheet and shows some basic layouting and css usage. Source of the demo website is found in the src directory.

Changelog

Requirements

Material addons requires an already set-up Angular Material project. To do a fresh start please follow the official Angular Material guide before you continue, but exclude step 4 ("include a theme").

Installation

  1. Install Material Addons package using npm:

    npm install @porscheinformatik/material-addons --save
    
  2. Add the stylesheet at the top of your projects from the folder themes, for example:

    @import '~@porscheinformatik/material-addons/themes/poa';
    
  3. To use a component, you need to import the Module of the component in your app.module.ts or in any other module, which needs the component.

Development instructions

Please follow the Contribution guidelines.

Set correct registry for publishing material-addons

Use npm config set registry https://registry.npmjs.org/ to set registry on the official npm registry.

Getting to run as developer

Run the following commands in the correct order:

npm install

npm run build:mat-add

npm install --no-optional

npm install

ng serve

One-liner for command line: npm install && npm run build:mat-add && npm install --no-optional && npm install && ng serve

Check eslint

Use npm run eslint in the root directory to run the linter over your code.

Pre commit hooks

Eslint and prettier are used as precommit hooks to enable a consistency of code format and quality in this repository. I'd also recommend to add the prettier extension in your editor, so that you get early feedback on your code. I use VS Code with the Prettier Extension and the auto format on save.

Build material addons package

Use npm run build:mat-add in the root directory to build the package to your local dist directory.

Install material addons in demo application

Use npm install --no-optional to remove old versions of the package in the demo. Afterwards, use normal npm install to get the newest version of the package from the dist directory.

Publish

Use npm run publish:mat-add to publish a new version on npm. The script bumps the version, builds it and then publishs it to the npm registry.

Deploy demo

Use npm run publish:demo to deploy a new version to github pages of the demno.

About

Material-Addons is an addon to Angular Material which is based on the Material Design system.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 59.9%
  • HTML 28.1%
  • SCSS 9.2%
  • JavaScript 1.9%
  • CSS 0.9%