# @tim-mhn/ng-forms

> Angular UI library for forms components built with Material CDK, Tailwindcss and Reactive Forms

Latest version **0.8.3** (published 2023-05-14) · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.3 |
| Published | 2023-05-14 |
| First published | 2023-01-03 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 2.3 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | tim-mhn |

## Links

- npm: https://www.npmjs.com/package/@tim-mhn/ng-forms
- 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-forms

## Dependencies (5)

- [tslib](https://npm.io/package/tslib.md) ^2.3.0
- [file-type](https://npm.io/package/file-type.md) ^16.5.1
- [@tim-mhn/ng-ui](https://npm.io/package/@tim-mhn/ng-ui.md) ^1.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.4.4

## Recent versions

- 0.8.3 (latest) — 2023-05-14
- 0.8.2 — 2023-04-03
- 0.8.1 — 2023-04-03
- 0.8.0 — 2023-04-03
- 0.7.0 — 2023-04-03
- 0.6.1 — 2023-03-27
- 0.6.0 — 2023-02-14
- 0.5.15 — 2023-02-13
- 0.5.14 — 2023-02-13
- 0.5.13 — 2023-02-13
- 0.5.12 — 2023-02-13
- 0.5.11 — 2023-02-13
- 0.5.10 — 2023-02-13
- 0.5.9 — 2023-02-11
- 0.5.8 — 2023-02-11
- … 27 more at https://npm.io/package/@tim-mhn/ng-forms/versions

## README

# TimForms

Angular UI library for forms components built with Material CDK, Tailwindcss and Reactive Forms

### only works with Angular Reactive Forms

## Get started

##### Download the package from NPM

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

##### Import the stylesheet

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

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

Example with `TimInputModule`

```
// example.module.ts
import { TimInputModule } from '@tim-mhn/ng-forms/input';

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

// example.component.html
<tim-input [formControl]="fc"></tim-input>

// example.component.ts
@Component({})
export class ExampleComponent {

  constructor(private fb: FormBuilder) {}

  fc = this.fb.control('')
}
```

_List of modules_

- `TimUIButtonToggleModule`
- `TimCheckboxModule`
- `TimDateRangePickerModule`
- `TimDaysPickerModule`
- `TimEditableHeaderInputModule`
- `TimEmailListInputModule`
- `TimImageUploadModule`
- `TimInputModule`
- `TimInputFieldModule`
- `TimPasswordInputModule`
- `TimRadioModule`
- `TimSelectModule`
- `TimSliderModule`
- `TimTextEditorModule`
- `TimTimeInputModule`
- `TimToggleModule`

## Build

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

## Build & Publish

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

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

## Running unit tests

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

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