# @tim-mhn/ng-ui

> Angular UI library built with Material CDK and Tailwindcss

Latest version **1.6.1** (published 2023-03-31) · 0 weekly downloads

## Install

```sh
npm install @tim-mhn/ng-ui
pnpm add @tim-mhn/ng-ui
yarn add @tim-mhn/ng-ui
bun add @tim-mhn/ng-ui
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.6.1 |
| Published | 2023-03-31 |
| First published | 2023-01-02 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | tim-mhn |

## Links

- npm: https://www.npmjs.com/package/@tim-mhn/ng-ui
- Repository: https://github.com/Tim-mhn/ng-libs.git#master
- Homepage: https://github.com/Tim-mhn/ng-libs/tree/master#readme
- Issues: https://github.com/Tim-mhn/ng-libs/issues
- npm.io page: https://npm.io/package/@tim-mhn/ng-ui

## Dependencies (3)

- [tslib](https://npm.io/package/tslib.md) ^2.3.0
- [iqair-tailwind](https://npm.io/package/iqair-tailwind.md) ^1.0.3
- [@tim-mhn/common](https://npm.io/package/@tim-mhn/common.md) ^1.3.4

## Recent versions

- 1.6.1 (latest) — 2023-03-31
- 1.6.0 — 2023-03-31
- 1.5.8 — 2023-03-27
- 1.5.7 — 2023-02-08
- 1.5.6 — 2023-02-08
- 1.5.5 — 2023-01-29
- 1.5.4 — 2023-01-29
- 1.5.3 — 2023-01-29
- 1.5.2 — 2023-01-28
- 1.5.1 — 2023-01-28
- 1.5.0 — 2023-01-28
- 1.4.3 — 2023-01-25
- 1.4.2 — 2023-01-25
- 1.4.1 — 2023-01-24
- 1.4.0 — 2023-01-16
- … 19 more at https://npm.io/package/@tim-mhn/ng-ui/versions

## README

# TimUI

Angular UI library built with Material CDK and Tailwindcss

## Get started

##### Download the package from NPM

`npm install @tim-mhn/ng-ui`

##### Import the stylesheet

In your global `.scss` or `.css` file, add
`@import "@tim-mhn/ng-ui/styles.css"`

##### Import the modules you want to use

Example with `TimUIButtonModule` and `TimUIChipModule`

```
// example.module.ts
import { TimUIButtonModule } from 'tim-ui/button';
  import { TimUIChipModule } from 'tim-ui/chip'

@NgModule({
  imports: [TimUIButtonModule, TimUIChipModule],
  declarations: [ExampleComponent]
})
export class ExampleModule {}

// example.component.html
<button tim-flat-button color="primary" size="md">Click</button>
<tim-chip color="destructive" size="sm">chip</tim-chip>
```

_List of modules_

- `TimUIAlertModule`
- `TimUIAvatarModule`
- `TimUIButtonModule`
- `TimUICardModule`
- `TimUIChipModule`
- `TimUICoreModule`
- `TimUIDialogModule`
- `TimUIDividerModule`
- `TimUIDropdownMenuModule`
- `TimUIFeaturedIconModule`
- `TimUILinkModule`
- `TimUISnackbarModule`
- `TimUISpinnerModule`
- `TimUITabsModule`
- `TimUITooltipModule`

## Build

Run `npm run build:ui` to build the project.

## Build & Publish

- **Bump the version**: `npm version major|minor|patch`
- **Build the library**: `npm run build:ui`
  The build artifacts will be stored in the `dist/` directory.
  This will also run the _tailwind_ command to generate the `.css` file reusing the `tim-tailwind` config.

- **Publish to NPM**: go to the dist folder `cd dist/ui` run `npm publish`

## Running unit tests

Run `ng test ui` to execute the unit tests via [Karma](https://karma-runner.github.io).

---
_Source: https://npm.io/package/@tim-mhn/ng-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._