Hogyan készítsünk Angular 6 egyedi elemeket és webkomponenseket

6 lépés a szögletes elemek létrehozásához a szögletes CLI használatával

A szögletes elemek olyan szögletes alkatrészek, amelyek a teljes keret minifikált változatát hordozzák. Lehetővé teszik egyedi elemek (az egyik web-összetevő) létrehozását keretrendszer-agnosztikus módon. Használhatók egyszerű webes projektekben, de a Angular belül.

Miután elolvastam a szögletes elemek hivatalos dokumentációját, rájöttem, hogy annak strukturáltan hiányzik a megvalósítási része. Ezért állítom a lépéseket az induláshoz!

1. Telepítse az Angular CLI 6 alkalmazást, és hozzon létre egy új projektet

npm i -g @angular/cli ng new angular-custom-elements

Amint az Angular bevezette az egyedi elemek fogalmát az Angular 6-ban, telepítenünk kell a v6-os vagy újabb verziókat. Az --stylealapértelmezett stílusbővítmény beállításához hozzáadhatja a zászlót is.

2. Add elemek csomagot

Az egyéni elemeket nem minden böngésző hajtja végre teljesen. Ezért megköveteljük, hogy a Polyfills működjön. Az új CLI paranccsal ng addhozzáadhatja az Angular könyvtárat és a szükséges polifill-eket:

ng add @angular/elements

3. Hozzon létre egy összetevőt

Hozzunk létre egy összetevőt, amely e elem végéig egyedi elemként fog működni:

ng g component button --inline-style --inline-template -v Native

Arra használjuk, ViewEncapsulation.Nativehogy megakadályozzuk a komponensek stílusának kiszivárgását és befolyásolják más elemeket. Ez a böngészőben az árnyék DOM natív megvalósításában (v0; az általunk használt v1-hez ViewEncapsulation.ShadowDOM) teszi lehetővé az összes stílus, sablon és komponensosztály kód egyetlen fájlba csomagolását.

4. Adjon tulajdonságokat az összetevőhöz

Néhány változtatás után a gombunk összetevője a következőképpen néz ki:

A hivatalos dokumentumok szerint:

A létrehozás API elemzi a bemeneti tulajdonságokat kereső összetevőt, és meghatározza az egyéni elem megfelelő attribútumait.

Átalakítja a tulajdonságneveket, hogy kompatibilisek legyenek az egyedi elemekkel, amelyek nem ismerik fel az esetkülönbségeket. A kapott attribútumnevek kötőjelekkel elválasztott kisbetűket használnak. Például a (z) összetevő esetén @Input('myInputProp') inputPropa megfelelő egyéni elem meghatározza a '' attribútumot my-input-prop”.

És még:

A komponens kimenetek HTML egyéni eseményként kerülnek elküldésre, az egyéni esemény neve megegyezik a kimenet nevével.

Például a (z) nevű komponens esetében @Output() valueChanged = new EventEmitter()a megfelelő egyéni elem az "valueChanged" nevű eseményeket küldi el. A kibocsátott adatokat az esemény detailtulajdonában tároljuk . Ha álnevet ad meg, akkor ez az érték kerül felhasználásra. Például,@Output('myClick') clicks = new EventEmitter gt;(); results in dispatch events with the name "myClick".

5. Update NgModule

Following are the major steps that need to be followed in app.module.ts:

  1. Remove the default bootstrap array which is set to AppComponent
  2. Since our ButtonComponent is not a part of any other component, and is also not a root of an Angular application, we need to tell Angular to compile it specifically. For this we put it on the entryComponents list. Otherwise Angular tree shaking will drop this component from the prod bundle.
  3. Add ngDoBootstrap() to tell Angular to use this module for bootstrapping.
  4. Angular provides the createCustomElement() function for converting an Angular component, together with its dependencies, to a custom element. The createCustomElement() function is expecting to get two parameter:
  • First, the Angular component which should be used to create the element.
  • Second, a configuration object. This object needs to include the injector property which is set to the current Injector instance.

5. The next step is to register the newly created custom element in the browser. This is done by calling customElements.define(). Please note that this is not Angular. The customElements read-only property belongs to the Window interface. It returns a reference to the CustomElementRegistryobject. This object can be used to register new custom elements. It can also get information about previously registered custom elements in the browser.

The customElements.define() method needs two parameter:

  • The first parameter is of type string and contains the name of the element. Passing the string ‘app-button’ means that the custom element on> will be registered and can be used in the HTML code.
  • The second parameter is the custom element which has been created before.

6. Now replace target value in tsconfig.json from es5 to es2015 as in browsers that support Custom Elements natively, the specification requires developers to use ES2015 classes to define Custom Elements.

6. Build and run

In order to build we will use a standard ng build command. But since it outputs four files (runtime.js , scripts.js, polyfills.js and main.js) and we’d like to distribute our component as a single js file, we need to turn hashing file names off. Let’s modify the scripts in package.json and add package entry:

"scripts": { …, "build": "ng build --prod --output-hashing=none", // For Windows: "package": "jscat ./dist/angular-custom-elements/runtime.js ./dist/angular-custom-elements/polyfills.js ./dist/angular-custom-elements/scripts.js ./dist/angular-custom-elements/main.js > custom-button-element.js", // For Mac or Linux: "package": "cat ./dist/angular-custom-elements/runtime.js ./dist/angular-custom-elements/polyfills.js ./dist/angular-custom-elements/scripts.js ./dist/angular-custom-elements/main.js > custom-button-element.js", …, }

Since Windows OS has no cat command run npm i jscat.

Save all and finally run:

npm run build && npm run package

The command generates custom-button-element.js that you can include in of an HTML page to see our custom element working.

Here is an example:

Summary

In summary we’ve:

  • Added important libraries for implementation
  • Registered the component in browser’s CustomElementRegistry
  • Combined the build artifacts to a single file

Complete source code can be found here.

Did you learn something new? If so please clap ? button below️ so more people can see this.