https://github.com/rachitgupta98/angular-mui

A UI Library for Angular version >= 8.x.x
https://github.com/rachitgupta98/angular-mui

angular angular-cli angular-ui framework npm npm-package typescript ui-components ui-library

Last synced: about 2 months ago
JSON representation

A UI Library for Angular version >= 8.x.x

• Host: GitHub
• URL: https://github.com/rachitgupta98/angular-mui
• Owner: rachitgupta98
• License: mit
• Created: 2021-04-19T13:27:41.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-04-21T11:03:22.000Z (over 3 years ago)
• Last Synced: 2024-11-14T13:48:21.099Z (about 2 months ago)
• Topics: angular, angular-cli, angular-ui, framework, npm, npm-package, typescript, ui-components, ui-library
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/angular-mui
• Size: 35.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# angular-mui

[![NPM version](https://img.shields.io/npm/v/angular-mui.svg)](https://npmjs.org/package/angular-mui)

[![NPM Downloads](https://img.shields.io/npm/dt/angular-mui.svg?style=flat)](https://www.npmjs.com/package/angular-mui?minimal=true)

This is UI library for [Angular](https://angular.io/)

## Requirements

```json

{

  "@angular/cli": ">=8.0.0",

}

```

## Installation

### yarn

```bash

yarn add angular-mui

```

### npm

```bash

npm i --save angular-mui

```

## Import MuiModule

```typescript

// app.module.ts

import { MuiModule } from 'angular-mui';

@NgModule({

  imports: [

    MuiModule // add MuiModule to your imports

  ]

})

export class AppModule {}

```

## Mui Components

### Buttons

![mui buttons](https://github.com/rachitgupta98/angular-mui/blob/master/assets/mui-buttons.png)

| Attribute | Description |

| --- | --- |

| `mui-btn` | It will enhance button to mui button |

| `variant="text"` | mui text button with no elevation |

| `variant="contained"` | mui contained button with elevation |

| `variant="outline"` | mui outline button with no elevation |

### Theming

Buttons background can be colored using color attribute to predefined color(primay,secondary,success) or any other color.

## Usage Example

```typescript

// app.component.html

Primary // text button

Primary // contained button

Primary  // outline button

```

### Cards

Mui Cards will be uploaded in next version.

## License

[MIT](https://github.com/rachitgupta98/angular-mui/blob/master/LICENSE)