An open API service indexing awesome lists of open source software.

https://github.com/almazrpe/ngx-kit

Angular toolkit
https://github.com/almazrpe/ngx-kit

Last synced: about 2 months ago
JSON representation

Angular toolkit

Awesome Lists containing this project

README

        

# ngx-kit: Angular Kit

Utilities for Angular Framework.

## Installation

Currently pack installations are supported:
```sh
# creates a tgz tarball in ./dist directory
make pack

# and installs it at your project
yarn add file:path/to/generated/pack
```

In order to import styles, you need to install `tailwindcss` and specify
library's content in your `tailwind.config.js`:
```js
module.exports = {
content: [
...
"./node_modules/almazrpe/ngx-kit/**/*.{html,ts}"
]
}
```

Tailwind uses as minimal final generated stylesheet as possible, scanning your
files, but it is possible for some styles to not load correctly, for these
cases we recommend to additionally add this safelist configuration:
```js
module.exports = {
...
safelist: [
"bg-sky-200",
"text-sky-800",
"bg-yellow-200",
"text-yellow-800",
"bg-red-200",
"text-red-800"
]
}
```

> ⚠️ In order to import other assets, you need to copy-paste them into your
> app's `assets/ngx-kit` directory.

## Contributing

The library itself is located inside `projects/ngx-kit`. For manual
testing and checking things out, the `projects/testground` is used.

For the invited contributors, each feature is implemented in a separate branch,
then a pull request to `main` is dropped.