layzeedk / ngx-material-components Goto Github PK

View Code? Open in Web Editor NEW

[WIP] Material Components for Angular

License: MIT License

JavaScript 20.77% TypeScript 69.46% HTML 8.90% CSS 0.87%

ngx-material-components's Introduction

Material Components for Angular (ngx-material-components)

Material Components for Angular web apps.

Angular Components implementing Material Components for the Web Adapters.

Installation

Install using NPM CLI

npm install --save ngx-material-components

or using Yarn CLI

yarn add ngx-material-components

Checkbox

Sass imports

// styles.scss
@import "~@material/ripple/mdc-ripple";
@import "~@material/checkbox/mdc-checkbox";
@import "~@material/form-field/mdc-form-field"; // Optional - for example below

Angular Module import

// my-feature.module.ts
import { NgModule } from '@angular/core';
import { MdcCheckboxModule } from 'ngx-material-components';

@NgModule({
  imports: [
    MdcCheckboxModule,
  ],
})
export class MyFeatureModule {}

Template usage

<!-- my-feature.component.html -->
<div class="mdc-form-field">
  <mdc-checkbox
    [checked]="true"
    controlId="my-checkbox"
    [disabled]="false"
    [indeterminate]="false"
    name="post-name"
    value="post-value"
    (checkedChange)="onCheckedChange($event)"></mdc-checkbox>

  <label for="my-checkbox">
    My checkbox
  </label>
</div>

Component usage

Component template

<!-- my-feature.component.html -->
<div class="mdc-form-field">
  <mdc-checkbox
    [(checked)]="checked"
    controlId="my-checkbox"
    [disabled]="false"
    [indeterminate]="false"
    name="post-name"
    value="post-value""></mdc-checkbox>

  <label for="my-checkbox">
    My checkbox
  </label>
</div>

Component model

// my-feature.component.ts
import { Component } from '@angular/core';

@Component({
  selector: 'app-my-feature',
  templateUrl: './my-feature.component.html',
})
export class MyFeatureComponent {
  checked: boolean = false;
}

Recommend Projects