Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/angular-extensions/elements

Lazy load Angular Elements (or any other web components / custom elements ) with ease!
https://github.com/angular-extensions/elements

angular angular-elements custom-elements lazy-loading micro-frontends microfrontends web-components

Last synced: 27 days ago
JSON representation

Lazy load Angular Elements (or any other web components / custom elements ) with ease!

Host: GitHub
URL: https://github.com/angular-extensions/elements
Owner: angular-extensions
License: mit
Created: 2019-06-27T07:43:59.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-09-02T10:21:21.000Z (2 months ago)
Last Synced: 2024-10-01T02:41:37.131Z (about 1 month ago)
Topics: angular, angular-elements, custom-elements, lazy-loading, micro-frontends, microfrontends, web-components
Language: TypeScript
Homepage: https://angular-extensions.github.io/elements/
Size: 10.6 MB
Stars: 317
Watchers: 9
Forks: 40
Open Issues: 30
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        


  



# ANGULAR EXTENSIONS ELEMENTS

### The easiest way to lazy-load Angular Elements or any other web components in your Angular application!

by [@tomastrajan](https://twitter.com/tomastrajan)

[![npm](https://img.shields.io/npm/v/@angular-extensions/elements.svg)](https://www.npmjs.com/package/@angular-extensions/elements) [![npm](https://img.shields.io/github/license/angular-extensions/elements.svg)](https://github.com/angular-extensions/elements/blob/master/LICENSE) [![npm](https://img.shields.io/npm/dm/@angular-extensions/elements.svg)](https://www.npmjs.com/package/@angular-extensions/elements) [![Build Status](https://travis-ci.org/angular-extensions/elements.svg?branch=master)](https://travis-ci.org/angular-extensions/elements) [![codecov](https://codecov.io/gh/angular-extensions/elements/branch/master/graph/badge.svg)](https://codecov.io/gh/angular-extensions/elements) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![Twitter Follow](https://img.shields.io/twitter/follow/tomastrajan.svg?style=social&label=Follow)](https://twitter.com/tomastrajan)

## Documentation

- [Docs](https://angular-extensions.github.io/elements/)

- [Getting started](https://angular-extensions.github.io/elements/#/docs/getting-started)

- [Use cases](https://angular-extensions.github.io/elements/#/docs/use-cases)

- [FAQ](https://angular-extensions.github.io/elements/#/docs/faq)

- [API](https://angular-extensions.github.io/elements/#/docs/api)

- [Examples](https://angular-extensions.github.io/elements/#/examples)

- [Blog post](https://medium.com/@tomastrajan/the-best-way-to-lazy-load-angular-elements-97a51a5c2007)

- [Meetup presentation (video)](https://www.youtube.com/watch?v=X__jkPGYRUs)

## Quickstart

1. Install `npm i @angular-extensions/elements`

2. Add `import { LazyElementsModule } from '@angular-extensions/elements';`

3. Append `LazyElementsModule` to the `imports: []` of your `AppModule`

4. Add new `schemas: []` property with `CUSTOM_ELEMENTS_SCHEMA` value to `@NgModule` decorator of your `AppModule`

5. Use `*axLazyElement` directive on an element you wish to load and pass in the url of the element bundle

Example of module implementation...

```typescript

import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';

import { BrowserModule } from '@angular/platform-browser';

import { LazyElementsModule } from '@angular-extensions/elements';

@NgModule({

  schemas: [CUSTOM_ELEMENTS_SCHEMA],

  imports: [BrowserModule, LazyElementsModule],

  declarations: [AppComponent, FeatureComponent],

  bootstrap: [AppComponent],

})

export class AppModule {}

```

Example of component implementation

```typescript

import { Component } from '@angular/core';

@Component({

  selector: 'your-org-feature',

  template: `

    

    

    

  `,

})

export class FeatureComponent {

  elementUrl = 'https://your-org.com/elements/some-element.js';

  data: SomeData;

  handleChange(change: Partial) {

    // ...

  }

}

```

## Supported Angular versions

Library was tested with the following versions of Angular and is meant to be used

with the corresponding major version (`"@angular/core"": "^15.0.0"` with `"@angular-extensions/elements": "^15.0.0"` ).

- 9.x (full IVY support, using renderers so careful with SSR)

- 8.x (partial IVY support, `axLazyElement` works but `axLazyElementDynamic` does NOT work with IVY)

- 7.x

- 6.x (eg `npm i @angular-extensions/elements@^6.0.0`)

## Internal dep graph

![Internal dep graph](https://raw.githubusercontent.com/angular-extensions/elements/master/dep-graph.png)

## Become a contributor

#### Missing a feature, found bug or typo in docs?

Please, feel free to open an [issue](https://github.com/angular-extensions/elements/issues)

or submit a [pull request](https://github.com/angular-extensions/elements/pulls) to make this project better for everyone! 🤗

  

    

      
_{Tomas Trajan}
💻 🎨 💡 📖 🤔 🚇 ⚠️

      
_{Artur Androsovych}
💻 🐛

      
_{Wayne Maurer}
🐛 💻

      
_{Santosh Yadav}
💻 📦

      
_{David Dal Busco}
💻 💡

      
_{Zama Khan Mohammed}
💻 🤔 ⚠️

    

    

      
_{Angel Fraga Parodi}
💡 🤔

      
_ye3i
💻 🤔

      
_{Heorhi Shakanau}
💻 🤔

      
_{Felipe Plets}
💻 🎨 💡 📖 🤔 ⚠️

      
_jkubiszewski
💻

      
_{Heorhi Shakanau}
💻

    

    

      
_NagornovAlex
💻

      
_{Joseph Davis}
💻

      
_{Arooba Shahoor}
💻

      
_{Maximilian Wright}
📖

      
_{Jakub Stawiarski}
💻

      
_{Paweł Kubiak}
💻

    

    

      
_{Egor Volvachev}
💻

      
_{Daniel Bou}
💻

    

  

## Sponsors

> Are you currently working in an **enterprise polyrepo environment** with many applications and found yourself thinking you could provide so much more value only if you had better overview to plan, track progress and just get things done?

Try _[Omniboard](https://omniboard.dev), the best tool for lead software engineers and architects_

that helps them to get an overview to drive change in **enterprise polyrepo environments** by querying and tracking all their code bases!

The free plan let's you get a full overview of all your projects with your first dashboard, tracking up to 3 different things!