كيفية إنشاء Angular 6 Custom Elements و Web Components

6 خطوات لإنشاء عناصر Angular باستخدام Angular CLI

العناصر الزاويّة هي مكوّنات زاويّة تحمل النسخة المصغّرة من الإطار بأكمله. إنها تسمح لك بإنشاء عناصر مخصصة (أحد مكونات الويب) بطريقة لا تعتمد على إطار العمل. يمكن استخدامها في مشاريع الويب البسيطة ولكن مع صلاحيات Angular في الداخل.

بعد قراءة الوثائق الرسمية لعناصر Angular ، أدركت أنها تفتقر إلى جزء التنفيذ بطريقة منظمة. هذا هو السبب في أنني أذكر خطوات البدء!

1. قم بتثبيت Angular CLI 6 وإنشاء مشروع جديد

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

نظرًا لأن Angular قدم مفهوم العناصر المخصصة في Angular 6 ، يجب أن يكون لدينا الإصدار 6 أو أحدث مثبتًا. يمكنك أيضًا إضافة --styleالعلم لتعيين امتداد النمط الافتراضي.

2. إضافة حزمة العناصر

لا يتم تنفيذ العناصر المخصصة بالكامل بواسطة جميع المتصفحات. ومن ثم فإننا نطلب Polyfills لجعلها تعمل. باستخدام أمر CLI الجديد ، ng addيمكنك إضافة مكتبة Angular و polyfills المطلوبة:

ng add @angular/elements

3. إنشاء مكون

لنقم بإنشاء مكون يعمل كعنصر مخصص بنهاية هذا المنشور:

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

نحن نستخدم ViewEncapsulation.Nativeلمنع أنماط المكون من النزيف والتأثير على العناصر الأخرى. سيؤدي هذا إلى عرض مكوننا في التنفيذ الأصلي للمتصفح لـ shadow DOM (v0 ؛ بالنسبة لـ v1 الذي نستخدمه ViewEncapsulation.ShadowDOM) عن طريق تجميع جميع الأنماط والقالب ورمز فئة المكون في ملف واحد.

4. أضف خصائص إلى المكون

بعد إجراء بعض التغييرات ، يبدو مكون الأزرار كما يلي:

وبحسب الوثائق الرسمية:

تحلل واجهة برمجة التطبيقات للإنشاء المكون بحثًا عن خصائص الإدخال ، وتحدد السمات المقابلة للعنصر المخصص.

يقوم بتحويل أسماء الخصائص لجعلها متوافقة مع العناصر المخصصة ، والتي لا تتعرف على اختلافات الحالة. تستخدم أسماء السمات الناتجة أحرفًا صغيرة مفصولة بشرطة. على سبيل المثال ، بالنسبة للمكون ذي @Input('myInputProp') inputProp، يحدد العنصر المخصص المقابل السمة "" my-input-prop”.

و أيضا:

يتم إرسال مخرجات المكون كأحداث مخصصة لـ HTML ، مع تطابق اسم الحدث المخصص مع اسم الإخراج.

على سبيل المثال ، بالنسبة للمكون ذي @Output() valueChanged = new EventEmitter()، فإن العنصر المخصص المقابل سيرسل الأحداث بالاسم "valueChanged". سيتم تخزين البيانات المنبعثة في detailخاصية الحدث . إذا قمت بتوفير اسم مستعار ، فسيتم استخدام هذه القيمة. فمثلا،@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.