<mat-tristate-checkbox> provides the same functionality as the Angular Material checkbox enhanced with 3 states. This repository contains the checkbox component and a demo project.
The package can be used in Angular apps with Angular Material installed. This Version requires Angular 16.
npm install mat-tristate-checkboxNow you can use the mat-tristate-checkbox component in your app components, for example in app.module.ts:
import { MatTristateCheckboxComponent } from 'mat-tristate-checkbox';
...
@NgModule({
declarations: [
AppComponent
],
imports: [
...
MatTristateCheckboxComponent
],
...
})
export class AppModule { }And in template file app.component.html:
<form [formGroup]="form">
<mat-tristate-checkbox formControlName="keepMeLoggedIn">remember me</mat-tristate-checkbox>
</form>Try out the demo page.
| Name | Description |
|---|---|
| @Input() color: ThemePalette |
Theme color palette for the component. Defaults to 'accent' |
| @Input() disabled: any |
Whether the checkbox is disabled. |
| @Input() labelPosition: 'before' | 'after' |
Whether the label should appear after or before the checkbox. Defaults to 'after' |
The value aof the checkbox cycle through these values:
undefined > false > true
npm install
npm run startnpm run testFor list of changes and bugfixes, see CHANGELOG.md.
Starting with version 16 the generated package on npm is unscoped (i.e. is named 'mat-image-overflow' not '@bepo65/mat-image-overflow').
The project uses 'standard-version' to create the changelog. To enable this system, commit messages are linted before commits are executed by git.
The structure of commit messages is:
<header>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
header
<type>(<scope>): <short summary>
type and scope
- build: Changes that affect the build system or external dependencies (example scope: npm)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding missing tests or correcting existing tests (example scopes: demo, lib, e2e)
footer
BREAKING CHANGE: ... (requires MAJOR in Semantic Versioning)
For details of the commit messages format see Contributing to Angular.
Copyright © 2024 Bernhard Pottler.
Distributed under the MIT License. See LICENSE for more information.
This project uses the fonts 'Roboto' and 'Material Icons' from the Google Fonts Library that are licensed under the Apache License Version 2.0.
As eslint V9 requires a fundamental change to the configuration files, the update will be done in a later version.