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

https://github.com/nitayneeman/made-with-love

๐Ÿš€ An experimental project which demonstrates an Angular Package which contains Angular Elements and Schematics
https://github.com/nitayneeman/made-with-love

angular angular-elements angular-library angular-package angular-workspace component components custom element elements experimental made-with-love ng-add schematic schematics web

Last synced: 5 months ago
JSON representation

๐Ÿš€ An experimental project which demonstrates an Angular Package which contains Angular Elements and Schematics

Awesome Lists containing this project

README

          


Preview

Made With Love


npm
Demo
Downloads
License


Installation ยท
Usage ยท
Disclaimer

## โ„น๏ธ๏ธ Description

A project that demonstrates how to build an Angular Package which provides a simple Angular Element. Also, it demonstrates how to make it addable with `ng add` using Schematics.

Check out [this](http://nitayneeman.com/posts/making-an-addable-angular-package-using-schematics) article for getting more information about the project.


## ๐Ÿ”ง How to Install

To Install using Angular, simply do:

```
ng add angular-made-with-love
```

This command will:

- Add `@angular/elements`, `@webcomponents/custom-elements` and `angular-made-with-love` into `package.json`.
- Run `npm install`.
- Import `MadeWithLoveModule` into the root module of your host application.
- Inject the polyfillโ€™s script file into the `scripts` of your host application.

In case you want to do it manually, there are available CLI parameters for skipping the steps above: `skipPackageJson`, `skipModuleImport` and `skipPolyfill`.


## ๐Ÿ‘จ๐Ÿปโ€๐Ÿซ How to Use

Apply `CUSTOM_ELEMENTS_SCHEMA` on your host module:

```javascript
@NgModule({
imports: [...],
declarations: [...],
schemas: [CUSTOM_ELEMENTS_SCHEMA]
})
export class HostModule {}
```

Insert the following line into a template:

```html

```


## โš ๏ธ๏ธ Disclaimer

This package is intended to be used inside Angular applications. In case you want to use it as part of an non-Angular application - go to [this](https://github.com/nitayneeman/made-with-love/tree/release/v1.1.0) branch.


## ๐Ÿ’๐Ÿป Contributing

This is an open source project. Any contribution would be greatly appreciated!