README.md

Ng-Matero Extensions

The Ng-Matero Extensions is an extended component library for Angular Material.

Documentation

Check out the demos and APIs.

Installation

At first, you should install the Angular Material and setup it. Learn more about the setup.

Install the Extensions library:

$ npm install @ng-matero/extensions --save

Setup

Import the modules you need, e.g. data-grid and select.

import { MtxGridModule } from '@ng-matero/extensions/grid';
import { MtxSelectModule } from '@ng-matero/extensions/select';

@NgModule({
  ...
  imports: [MtxGridModule, MtxSelectModule, ...],
  ...
})
export class YourAppModule {
}

Theming

After import modules, you must define a theme. More about theming.

M2 theme

@use '@angular/material' as mat;
@use '@ng-matero/extensions' as mtx;

$theme: mat.define-light-theme(...);

@include mat.all-component-themes($theme);
@include mtx.all-component-themes($theme);

M3 theme

@use '@angular/material' as mat;
@use '@ng-matero/extensions' as mtx;

$config: (...);

$theme: mat.private-deep-merge-all(
  mat.define-theme($config),
  mtx.define-theme($config)
);

html {
  @include mat.all-component-themes($theme);
  @include mtx.all-component-themes($theme);
}

The @use-based Sass API is only available in the version 12.0.0 and above.

You can also using a pre-built theme which in the "prebuilt-themes" directory of the npm package (@ng-matero/extensions/prebuilt-themes).

@import '@ng-matero/extensions/prebuilt-themes/azure-blue.css'

Development

$ git clone [email protected]:ng-matero/extensions.git
$ cd extensions
$ yarn
$ yarn run start

Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

License

MIT