Belajar Web Component Dasar

Banyak Web Front-End Framework pada saat ini mempromosikan kemampuannya dalam meminimalisir kode yang berulang karena menerapkan teknik components dan modules.

Component jadi hal yang sangat populer karena dengannya, kita dapat mudah memasang dan mempreteli kumpulan element (component) pada website.

Component bersifat reusable, sehingga kita bisa menggunakanya pada banyak project tanpa harus membuat ulang. Bahkan kita dapat menggunakan component yang dibuat dan dibagikan oleh orang lain.

Inilah mengapa Front-End Framework seperti React, Angular, ataupun Vue sangat populer karena terdapat penerapan component di dalamnya.

Sejak dulu setiap framework atau library pasti memiliki caranya sendiri dalam penggunaan/pembuatannya.

Termasuk dalam penggunaan/pembuatan component-nya. Sehingga component akan bersifat reusable, dengan catatan selama masih dalam framework yang sama. Apakah itu menjadi masalah? Tentu!

Terlalu nyaman dalam salah satu framework yang digunakan akan menjadi masalah. Karena jika kita berada di framework yang berbeda, komponen yang kita biasa gunakan belum tentu dapat digunakan pada framework tersebut.

Contohnya, Jika kita menuliskan library Angular dan kita ingin ia berfungsi pada framework Vue? Apakah bisa? Maka dari itu kita perlu menuliskan berdasarkan standar umum dalam membuat komponen sehingga dapat digunakan oleh framework dan browser manapun.

Web component merupakan salah satu fitur standar yang terdapat pada Browser API. Dengan ini kita jadi mudah membuat component UI yang bersifat reusable.

Pada materi kali ini, kita akan membahas seputar web component mulai dari bagaimana membuatnya hingga menerapkannya pada pada proyek Club Finder

What is Web Component

Web component merupakan salah satu fitur yang ditetapkan standar World Wide Web Consortium (W3C). Fitur ini memudahkan developer dalam membuat komponen UI websitenya menjadi lebih modular.

Dengan semakin pesatnya perkembangan website saat ini kita perlu menetapkan teknik yang lebih modern dalam mengembangkan website. Salah satunya membuat komponen UI pada website agar mampu sesuai dengan kebutuhan dan digunakan ulang. Kebanyakan developer saat ini menggunakan framework untuk membantu pengembangan website menjadi mudah dalam membuat dan menggunakan komponen UI.

Namun apakah Anda tahu beberapa kelebihan web component dibandingkan komponen yang dibuat menggunakan framework?

Standard : Web Component merupakan standar yang ditetapkan oleh WC3 dalam membuat komponen yang reusable.
Compatibility : Karena web component merupakan standard maka dapat digunakan pada framework seperti Angular, React, ataupun Vue.
Simple : Menggunakan web component tidak memerlukan konfigurasi khusus layaknya framework yang ada. Karena web component dibangun tak lain hanya menggunakan JS/CSS/HTML murni.

Web component bersifat reusable. Bahkan dapat digunakan walaupun kita menggunakan framework sekalipun. Apa pasal? Web component dibangun tak lain menggunakan JS/HTML/CSS murni. Terdapat dua API penting dalam menerapkan web component, yakni:

Custom Elements: Digunakan untuk membuat elemen baru (custom element). Kita juga bisa menentukan perilaku element tersebut sesuai kebutuhan.
Shadow DOM: Digunakan untuk membuat HTML element terenkapsulasi dari gangguan luar. Biasanya digunakan pada custom element, agar elemen tersebut tidak terpengaruh oleh styling yang ditetapkan di luar dari custom elemen-nya

Custom Element

HTML memberikan kemudahan dalam mengatur struktur website. Untungnya seluruh browser sepakat untuk menggunakannya. Pada kelas Belajar Dasar Pemrograman Web kita sudah belajar penulisan dan penggunaan tag pada HTML dalam membuat struktur website.

Ada banyak sekali tags HTML yang dapat kita manfaatkan secara langsung. Apakah Anda tahu pada HTML5 hampir terdapat 100 tag standar yang bisa kita gunakan? Karena banyaknya tag HTML yang tersedia, seharusnya kita bisa membuat struktur website yang memiliki arti (semantic meaning).

Untuk membuat struktur website memiliki arti, kita harus tahu HTML tag mana yang tepat untuk digunakan. Sebelum HTML5, hampir seluruh bagian pembentuk layout pada website dibuat menggunakan tag

. Baik itu untuk header, footer, artikel, ataupun konten samping.

Setelah hadirnya HTML5, kita dikenalkan pada beberapa elemen yang dapat digunakan dalam mengelompokkan sebuah elemen dengan lebih jelas dan memiliki arti (semantic meaning). Elemen-elemen ini memiliki nama sesuai dengan fungsi atau peran dari elemen tersebut.

Element

memang digunakan untuk mencakup elemen yang belum atau tidak tersedia. Biasanya kita menyiasati penggunaan tag div dengan menambahkan attribute id ataupun class untuk menunjukkan fungsinya. Namun dalam penulisan nilai atributnya, terkadang kita tidak memiliki standar khusus sehingga kode tersebut akhirnya hanya kita sendirilah yang mengetahuinya.

Namun sekarang, penggunaan elemen

pada website seharusnya dapat lebih diminimalisir lagi. Dengan membuat dan menggunakan custom element, struktur HTML kita dapat dibaca lebih mudah.

(Kiri) Struktur HTML dengan menggunakan tag

. (Kanan) Struktur HTML dengan Custom Element.

Dengan Custom Element kita dapat membuat struktur elemen HTML yang lebih rapi lagi. Karena dengannya, kita dapat membuat DOM element kita sendiri sesuai kebutuhan. Anda melihat contoh penerapannya pada gambar di atas.

Write your first Custom Element

Potongan kode untuk materi ini: https://repl.it/@dicodingacademy/163-03-first-custom-element?lite=true

Dalam membuat custom element, kita menuliskannya dengan menggunakan JavaScript class. Class tersebut mewarisi sifat dari HTMLElement. HTMLElement merupakan interface yang merepresentasikan element HTML. Interface ini biasanya diterapkan pada class JavaScript sehingga terbentuklah element HTML baru melalui class tersebut (custom element).

Berikut contoh penulisan dalam membuat custom element:


class ImageFigure extends HTMLElement {

 

}

Yeay! ImageFigure sekarang merupakan sebuah HTML element baru. Namun tunggu dulu. Untuk menggunakannya pada berkas HTML, kita perlu menetapkan nama tag yang nantinya digunakan pada HTML. Caranya dengan menggunakan variabel customElements seperti ini:


customElements.define("image-figure", ImageFigure);

customElements merupakan global variable yang digunakan untuk mendefinisikan custom element dan memberitahu bahwa terdapat HTML tag baru. Di dalam customElements terdapat method yang bernama define(). Di sinilah kita meletakan tag name baru kemudian diikuti dengan JavaScript class yang menerapkan sifat HTMLElement.

“Dalam penamaan tag untuk custom element, nama tag harus terdiri dari dua kata yang dipisahkan oleh dash (-). Jika tidak, pembuatan custom element tidak akan berhasil. Hal Ini diperlukan untuk memberi tahu browser perbedaan antara elemen asli HTML dan custom element.”

Setelah mendefinisikan custom element, barulah ia siap digunakan pada berkas HTML. Kita cukup menuliskan tagnya layaknya elemen HTML biasa.

Jangan lupa lampirkan script pada berkas yang digunakan untuk menuliskan class ImageFigure.


<script src="image-figure.js">

Berikut kode lengkapnya:

index.html




 

   <meta charset="utf-8">

   <meta name="viewport" content="width=device-width">

   My First Custom Element

 

 

   

   <script src="image-figure.js">

image-figure.js


class ImageFigure extends HTMLElement {

 

}

 

customElements.define("image-figure", ImageFigure);

Coba jalankan kode di atas pada browser, kita tidak akan mendapatkan apapun. Sampai saat ini, element berperan layaknya element

ataupun yang tidak memiliki fungsi khusus.

Karena kita belum menetapkan seperti apa jadinya element baru ini.

Untuk menetapkan seperti apa fungsi dari elemen baru, kita lakukan semuanya dengan menggunakan kode JavaScript yang dituliskan di dalam class ImageFigure. Tapi sebelum itu, kita pelajari dulu siklus hidup (life cycle) dari elemen HTML

Life Cycle of Custom Element

Potongan kode untuk materi ini:
https://repl.it/@dicodingacademy/163-03-element-life-cycle?lite=true

Ketika sebuah JavaScript class mewarisi sifat dari HTMLElement maka class tersebut akan memiliki siklus hidup layaknya sebuah elemen HTML.

Kita dapat menerapkan logika pada setiap siklus hidup yang ada dengan memanfaatkan lifecycle callbacks yang ada. Berikut ini lifecycle callbacks yang ada pada HTMLElement:

connectedCallback() : Akan terpanggil setiap kali elemen berhasil ditambahkan ke dokumen HTML (DOM). Callback ini merupakan tempat yang tepat untuk menjalankan konfigurasi awal seperti mendapatkan data, atau mengatur attribute.
disconnectedCallback() : Akan terpanggil setiap kali elemen dikeluarkan (remove()) dari DOM. Callback ini merupakan tempat yang tepat untuk membersihkan data yang masih disimpan pada elemen. Bisa itu event, state, ataupun objek.
attributeChangedCallback() : Akan terpanggil setiap kali nilai atribut yang di-observe melalui fungsi static get observedAttributes diubah. Callback ini bisa kita manfaatkan untuk memuat ulang data yang ditampilkan oleh elemen.
adoptedCallback() : Akan terpanggil setiap kali elemen dipindahkan pada dokumen baru. Kita relatif jarang menggunakan callback ini, namun jika kita memanfaatkan tag maka callback ini akan terpanggil.

Untuk mempermudah memahami urutan siklus hidup element pada HTML kita bisa lihat pada ilustrasi berikut:

Walaupun sebenarnya constructor() bukan termasuk siklus hidup HTML Element, namun fungsi tersebut sering digunakan untuk melakukan konfigurasi awal ketika pertama kali element dibuat. Seperti menentukan event listener, atau menetapkan Shadow DOM.

Ketika kita mengimplementasikan constructor pada custom element, kita wajib memanggil method super(). Jika tidak, maka akan menghasilkan error:

ReferenceError: Must call super constructor in derived class before accessing ‘this’ or returning from derived constructor

Class yang merupakan custom element lebih ketat dibandingkan class lain. Kita tidak dapat membuat argument pada constructor class-nya. Karena instance dibuat tidak menggunakan keyword new seperti class JavaScript umumnya.

Terdapat dua cara membuat instance dari custom element. Yang pertama adalah menggunakan nama tagnya langsung yang dituliskan pada kode HTML. Contohnya:

Lalu cara kedua adalah dengan menggunakan sintaks JavaScript. Sama seperti membuat element HTML biasa, kita gunakan method document.createElement dalam membuat elemen baru.


const imageFigureElement = document.createElement("image-figure");

document.body.appendChild(imageFigureElement);

Kita bisa mencobanya sendiri dengan menuliskan kode-kode berikut dan menjalankannya pada browser. Kemudian lihat output yang dihasilkan pada browser. Output tersebut akan menunjukan urutan siklus hidup yang terpanggil.

index.html




 

   <meta charset="utf-8">

   <meta name="viewport" content="width=device-width">

   Element life cycle

 


  <!-- silakan hapus tag  untuk membuatnya secara sintaks JavaScript -->

   

   <script src="image-figure.js">

   <script src="main.js">

image-figure.js


class ImageFigure extends HTMLElement {

 constructor() {

   super();

   console.log("constructed!")

 }

 

 

 connectedCallback() {

   console.log("connected!");

 }

 

 

 disconnectedCallback() {

   console.log("disconnected!");

 }

 

 

 adoptedCallback() {

   console.log("adopted!");

 }

 

 

 attributeChangedCallback(name, oldValue, newValue) {

   console.log(`Attribute: ${name} changed!`);

 }

 

 

 // digunakan untuk mengamati perubahan nilai attribute caption

 /* kita bisa menetapkan lebih dari satu atribut yang diamati.

    dengan memisahkan nama atribut menggunakan koma. Contoh: */

 // return ["caption", "title", "src", ...]

 static get observedAttributes() {

   return ["caption"];

 }

}

 

 

customElements.define("image-figure", ImageFigure);

main.js


let imageFigureElement = document.querySelector("image-figure");

 

// Jika tidak tersedia pada DOM maka dibuat secara sintaksis.

if (!imageFigureElement) {

 imageFigureElement = document.createElement("image-figure");

 document.body.appendChild(imageFigureElement);

}

 

// mengubah/manambahkan nilai attribute caption.

setTimeout(() => {

 imageFigureElement.setAttribute("caption", "Gambar 1");

}, 1000);

 

 

// menghapus imageFigureElement dari DOM

setTimeout(() => {

 imageFigureElement.remove();

}, 3000);

output console

html structure

Implementasi lifecycle callback pada custom element bersifat opsional. Kita tidak perlu menuliskannya jika memang tidak diperlukan.

Custom element attribute and method

Potongan kode untuk materi ini: https://repl.it/@dicodingacademy/163-03-attribute-and-method?lite=true

Selain memiliki siklus hidup, class yang mewarisi sifat HTMLElement juga memiliki properti dan method yang sama seperti objek DOM.

Di mana ia memiliki properti dan method seperti innerHTML, innerText, appendChild(), remove(), dan sebagainya.

Melalui properti dan method ini kita dapat menetapkan apa yang harus ditampilkan atau mendapatkan nilai atribut pada custom element. Contohnya seperti ini:

class ImageFigure extends HTMLElement {
connectedCallback() {
this.src = this.getAttribute(“src”) || null;
this.alt = this.getAttribute(“alt”) || null;
this.caption = this.getAttribute(“caption”) || null;
this.innerHTML = `
<img src="${this.src}"
alt=”${this.alt}”>
${this.caption}
`;
}
}
customElements.define(“image-figure”, ImageFigure);

Dari kode di atas ketika element tampak pada DOM, maka ia akan mendapatkan nilai yang ditetapkan pada atribut src, alt, dan caption. Kemudian nilai atribut tersebut akan ditampilkan dalam format elemen

dengan memanfaatkan innerHTML.

Untuk memberikan atribut dan nilainya pada custom element, tidak ada bedanya dengan element HTML biasa. Kita bisa melakukannya langsung pada elemennya, atau melalui JavaScript.

tag-html


<image-figure

     src="https://i.imgur.com/iJq78XH.jpg"

     alt="Dicoding Logo"

     caption="Huruf g dalam logo Dicoding">

JavaScript


const imageFigureElement = document.createElement("image-figure");

 

imageFigureElement.setAttribute("src", "https://i.imgur.com/iJq78XH.jpg");

imageFigureElement.setAttribute("alt", "Dicoding Logo");

imageFigureElement.setAttribute("caption", "Huruf g dalam logo Dicoding");

 

document.body.appendChild(imageFigureElement);

Jika kita lihat hasilnya, maka akan tampak seperti ini:

Dengan custom elemen ini kita bisa membuat elemen

Cukup gunakan custom elemen ini dengan menetapkan nilai atribut yang dibutuhkan. Sudah bisa melihat kerennya custom elemen? Fungsi custom elemen bukan hanya membuat fungsi elemen baru, namun bisa juga dibuat untuk mempermudah penggunaan HTML yang ada.

Observe Attribute Value

Potongan kode untuk materi ini:
https://repl.it/@dicodingacademy/163-03-attribute-observe?lite=true

Ketika elemen sudah tampak pada DOM, tidak jarang kita mengganti nilai dari atributnya karena terdapat data yang perlu diperbaharui.

Jika kita menggunakan elemen HTML standar, perubahan yang diterapkan akan langsung kita bisa lihat hasilnya pada browser. Namun bagaimana dengan custom element? Apakah sama? Mari kita coba bersama.

Pada contoh sebelumnya, kita telah membuat element yang berfungsi layaknya element

dengan penggunaan yang lebih sederhana. Contohnya kita memiliki kode seperti ini:

index.html




 

   <meta charset="utf-8">

   <meta name="viewport" content="width=device-width">

   Attribute Observe

 


   <image-figure

     src="https://i.imgur.com/iJq78XH.jpg"

     alt="Dicoding Logo"

     caption="Huruf g dalam logo Dicoding">

     

   <script src="image-figure.js">

image-figure.js


class ImageFigure extends HTMLElement {

 

 connectedCallback() {

   this.src = this.getAttribute("src") || null;

   this.alt = this.getAttribute("alt") || null;

   this.caption = this.getAttribute("caption") || null;

 

 

   this.innerHTML = `

     

       <img src="${this.src}"

           alt="${this.alt}">

       ${this.caption}

     

   `;

 }

}

 

 

customElements.define("image-figure", ImageFigure);

Lalu kita buka pada browser, maka akan tampak seperti ini:

Lalu mari kita coba mengubah nilai atribut caption dengan nilai baru menggunakan JavaScript melalui console browser.


const element = document.querySelector("image-figure");

element.setAttribute("caption", "Lorem ipsum dolor sit amet");

Kita bisa lihat pada gif di atas bahwa walaupun kita berhasil mengubah nilai atribut caption, pada browser nilai yang ditampilkan tersebut tidak berubah. Kok demikian? Pada custom element kita perlu mengimplementasi dua fungsi dalam kelasnya (ImageFigure) agar kita dapat mengobservasi nilai atribut yang berubah. Yang pertama fungsi attributeChangedCallback, dan yang kedua fungsi static get observedAttributes.

Kedua fungsi tersebut saling terhubung. Fungsi attributeChangedCallback akan terpanggil ketika nilai atribut yang diamati pada fungsi observedAttributes diubah nilainya. Kemudian pada callback fungsi attributeChangedCallback inilah kita menetapkan logika perubahan. Pada fungsi ini juga terdapat 3 (tiga) argument fungsi yang bisa dimanfaatkan yaitu:

name : Nama dari atribut yang berubah
oldValue : Nilai pada atribut sebelum diubah
newValue : Nilai baru yang ditetapkan pada atribut.

Urutan dari ketiga argumen tersebut sangatlah penting, jadi jangan sampai tertukar. Sebenarnya kita dapat memberikan nama apa saja untuk ketiga argumennya namun lebih baik gunakan name, oldValue, newValue guna memudahkan kita dalam penggunaannya.

Berikut contoh implementasi dari kedua fungsi tersebut:

class ImageFigure extends HTMLElement {
connectedCallback() {
this.src = this.getAttribute(“src”) || null;
this.alt = this.getAttribute(“alt”) || null;
this.caption = this.getAttribute(“caption”) || null;
this.render();
}
render() {
this.innerHTML = `
<img src="${this.src}"
alt=”${this.alt}”>
${this.caption}
`;
}
attributeChangedCallback(name, oldValue, newValue) {
this[name] = newValue;
this.render();
}
static get observedAttributes() {
return [“caption”];
}
}
customElements.define(“image-figure”, ImageFigure);

Mari kita telaah kodenya satu persatu. Di dalam fungsi attributeChangedCallback(), kita tuliskan kode untuk mengubah nilai properti this[name] dengan nilai baru yang ditetapkan.

this[name] ini merupakan cara dinamis untuk mengubah nilai properti sesuai dengan nama atribut yang diubah. Misalkan jika kita mengubah atribut “caption” maka akan mengubah nilai this[“caption”], jika kita mengubah atribut “alt” maka akan mengubah nilai this[“alt”].

Setelah mengubah nilainya lalu kita panggil fungsi render(). Perhatikan juga bahwa kita perlu memisahkan kode rendering HTML di browser pada fungsi yang terpisah (tidak dilakukan di connectedCallback). Tujuannya agar kita dapat memanggil fungsi tersebut tidak hanya sekali tapi setiap kali terdapat perubahan data.

Lalu terdapat juga static get observedAttributes(). Apa fungsinya? Fungsi getter statis ini berperan sebagai “seseorang” yang mengamati perubahan nilai pada atribut yang ditentukan.

Jika terjadi perubahan, ia akan memanggil attributeChangedCallback dengan memberitahu nama atribut apa yang berubah, nilai sebelum perubahan, serta nilai baru yang akan ditetapkan. observedAttributes tidak akan mengamati seluruh atribut yang diterapkan pada custom element, hanya atribut yang dituliskan pada nilai kembaliannya yang akan diamati.


return ["caption"];

Nilai kembalian dari observedAttributes merupakan array. Jika kita ingin mengamati lebih dari satu atribut, kita dapat menuliskannya layaknya array literals.


return ["caption", "src", "alt"];

Setelah mengimplementasi kedua fungsi tadi seharusnya custom element sudah dapat bereaksi ketika terjadi perubahan nilai atribut.

Styling Custom Element without Shadow DOM

Potongan kode untuk materi ini: https://repl.it/@dicodingacademy/163-03-styling-without-shadow-dom?lite=true

Tidak ada cara khusus dalam menetapkan styling pada custom elemen jika tidak menerapkan Shadow DOM. Kita dapat menetapkan styling dengan cara yang sama seperti standar element HTML.

Dalam arti kita bisa menggunakan nama tag sebagai selector, atribut id ataupun class sebagai selector-nya.

Pada custom element biasanya kita menuliskan styling dengan menggunakan tag pada saat merender template HTML menggunakan innerHTML.

class ImageFigure extends HTMLElement {
……
render() {
this.innerHTML = `
figure {
border: thin #c0c0c0 solid;
display: flex;
flex-flow: column;
padding: 5px;
max-width: 220px;
margin: auto;
}
figure > img {
max-width: 220px;
}
figure > figcaption {
background-color: #222;
color: #fff;
font: italic smaller sans-serif;
padding: 3px;
text-align: center;
}
<img src="${this.src}"
alt=”${this.alt}”>
${this.caption}
`;
}
……
}
customElements.define(“image-figure”, ImageFigure);

Ataupun dengan menuliskan styling pada berkas css yang ditautkan pada html.

/* Berkas style.css */
figure {
border: thin #c0c0c0 solid;
display: flex;
flex–flow: column;
padding: 5px;
max–width: 220px;
margin: auto;
}
figure > img {
max–width: 220px;
}
figure > figcaption {
background–color: #222;
color: #fff;
font: italic smaller sans–serif;
padding: 3px;
text–align: center;
}

Maka pada browser akan menampilkan hasil seperti berikut:

Kita tidak menetapkan Shadow DOM pada custom element ini sehingga styling pada custom element masih dapat terpengaruh oleh keadaan dari luar. Maksudnya, jika kita menetapkan styling lain dengan menargetkan figure sebagai selector, kemungkinan element

yang terdapat pada custom element akan ikut terpengaruhi walaupun kita sudah menetapkan styling secara eksplisit di dalam fungsi render.

Lantas bagaimana agar custom element dapat terenkapsulasi dari gangguan luar? Kita akan membahas ini lebih detail pada pembahasan Shadow DOM

Handling complex data

Potongan kode untuk materi ini: https://repl.it/@dicodingacademy/163-03-handling-complex-data?lite=true

Sebelumnya kita sudah belajar bagaimana custom element menampilkan data melalui atribut.

Seperti yang kita ketahui, nilai dari atribut pada elemen lazimnya hanya data primitif. Namun bagaimana jika custom elemen membutuhkan data yang kompleks atau memiliki nilai yang banyak seperti ini?


const article = {

 id: 1,

 title: "Lorem Ipsum Dolor",

 featuredImage: "https://i.picsum.photos/id/204/536/354.jpg?grayscale",

 description: "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."

}

Tentu jika kita simpan nilai tersebut pada atribut HTML akan terlihat berantakan pada penulisan elemennya.



<article-item

       id="1"

       title="Lorem Ipsum Dolor"

       featured-image="https://i.picsum.photos/id/204/536/354.jpg?grayscale"

       description="Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.">

Cukup merepotkan bukan? Hal ini malah menghilangkan tujuan dari custom elemen yakni semakin mudah kita baca. Lantas bagaimana cara menangani data kompleks yang dibutuhkan oleh custom element?

Karena pembuatan custom element ini memanfaatkan sebuah JavaScript class, kita bisa memanfaatkan dengan menyimpan data tersebut pada properti class.

Masih ingat pembahasan properti accessor atau getter/setter? Nah, dengan teknik ini kita dapat menetapkan data yang kompleks pada custom element.


class ArticleItem extends HTMLElement {

 set article(article) {

   this._article = article;

   this.render();

 }

 

 render() {

   this.innerHTML = `

     

     

         ${this._article.title}

         ${this._article.description}

}

customElements.define("article-item", ArticleItem);

Dengan begitu tentu kita hanya bisa menetapkan data pada custom element melalui sintaks JavaScript dengan mengakses properti .article seperti ini:


const articleItemElement = document.createElement("article-item");

articleItemElement.article = article;

Cukup mudah bukan? Karena kita memanggil fungsi render() di dalam set article(), maka custom element tidak akan menampilkan apapun pada browser sebelum nilai article-nya ditetapkan. Penasaran? Berikut kode lengkapnya jika Anda ingin mencobanya sendiri:

index.html




 

   <meta charset="utf-8">

   <meta name="viewport" content="width=device-width">

   Handling Complex Data

   <link href="style.css" rel="stylesheet" type="text/css" />

 

 

   <div class="container">

style.css


* {

 padding: 0;

 margin: 0;

 box-sizing: border-box;

}

 

body {

 padding: 16px;

}

 

.container {

 max-width: 800px;

 margin: 0 auto;

}

 

 

article-item {

   display: block;

   margin-bottom: 18px;

   box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2);

   border-radius: 10px;

   overflow: hidden;

}

 

 

article-item > .featured-image {

   width: 100%;

   max-height: 300px;

   object-fit: cover;

   object-position: center;

}

 

 

article-item > .article-info {

 padding: 24px;

}

 

 

article-item > .article-info > p {

 margin-top: 10px;

}

script.js


import "./article-item.js";

import article from "./article.js";

 

const containerElement = document.querySelector(".container");

 

const articleItemElement = document.createElement("article-item");

articleItemElement.article = article;

 

containerElement.appendChild(articleItemElement);

article-item.js


class ArticleItem extends HTMLElement {

 set article(article) {

   this._article = article;

   this.render();

 }

 

 render() {

   this.innerHTML = `

     

     

         ${this._article.title}

         ${this._article.description}

}

customElements.define("article-item", ArticleItem);

article.js


const article = {

 id: 1,

 title: "Lorem Ipsum Dolor",

 featuredImage: "https://i.picsum.photos/id/204/536/354.jpg?grayscale",

 description: "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."

}

 

export default article;

Jika kita jalankan maka browser akan menampilkan element dengan data yang didapat dari article.js.

Nested Custom Element

Potongan kode untuk materi ini: https://repl.it/@dicodingacademy/163-03-nested-custom-element?lite=true

Ketika menggunakan custom element, mungkin terdapat keadaan di mana kita membutuhkan custom element berada di dalam custom element lain. Contohnya, banyak website saat ini yang menampilkan data berupa list, entah itu daftar artikel ataupun item belanja.

Biasanya setiap daftar yang ditampilkan ditampung dalam sebuah container

. Kemudian item yang sama ditampilkan secara berulang dengan data yang berbeda pada container tersebut.

Web component dapat memudahkan dalam mengorganisir daftar item yang ditampilkan dalam bentuk list menggunakan container.

Caranya kita membuat dua custom element yatu container, dan itemnya. Container digunakan untuk menampung elemen item di dalamnya. Selain itu pada container juga data (array) diberikan.

Nantinya container-lah yang akan membuat elemen item di dalamnya berdasarkan data yang diberikan.

Belum terbayang seperti apa? Berikut contohnya:

index.html




 

   <meta charset="utf-8">

   <meta name="viewport" content="width=device-width">

   repl.it

   <link href="style.css" rel="stylesheet" type="text/css" />

 

 

   <script src="script.js" type="module">

script.js


import "./article-list.js";

import articles from "./articles.js";

 

 

const articleListElement = document.createElement("article-list");

articleListElement.articles = articles;

 

 

document.body.appendChild(articleListElement);

article-list.js


import "./article-item.js"

 

 

class ArticleList extends HTMLElement {

 set articles(articles) {

   this._articles = articles;

   this.render();

 }

 

 

 render() {

   this._articles.forEach(article => {

     const articleItemElement = document.createElement("article-item");

     // memanggil fungsi setter article() pada article-item.

     articleItemElement.article = article;

     this.appendChild(articleItemElement);

   })

 }

}

 

customElements.define("article-list", ArticleList);

article-item.js


class ArticleItem extends HTMLElement {

 set article(article) {

   this._article = article;

   this.render();

 }

 

 

 render() {

   this.innerHTML = `

    

    

        ${this._article.title}

        ${this._article.description}

}

customElements.define("article-item", ArticleItem);

articles.js


const articles = [

 {

   id: 1,

   title: "Lorem Ipsum Dolor",

   featuredImage: "https://i.picsum.photos/id/204/536/354.jpg",

   description: "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."

 

 

 },

 {

   id: 2,

   title: "Lorem Ipsum Dolor",

   featuredImage: "https://i.picsum.photos/id/209/536/354.jpg",

   description: "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."

 

 

 },

 {

   id: 3,

   title: "Lorem Ipsum Dolor",

   featuredImage: "https://i.picsum.photos/id/206/536/354.jpg",

   description: "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."

 

 

 },

 {

   id: 4,

   title: "Lorem Ipsum Dolor",

   featuredImage: "https://i.picsum.photos/id/212/536/354.jpg",

   description: "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."

 

 

 }

]

 

 

export default articles;

style.css


* {

    padding: 0;

    margin: 0;

    box-sizing: border-box;

  }

  

  body {

    padding: 16px;

  }

  

  article-list {

    display: block;

    max-width: 800px;

    margin: 0 auto;

  }

  

  article-item {

    display: block;

    margin-bottom: 18px;

    box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2);

    border-radius: 10px;

    overflow: hidden;

  }

  

  article-item > .featured-image {

    width: 100%;

    max-height: 300px;

    object-fit: cover;

    object-position: center;

  }

  

  article-item > .article-info {

    padding: 24px;

  }

  

  article-item > .article-info > p {

    margin-top: 10px;

  }

Pada kode di atas kita bisa melihat bahwa terdapat dua buah custom component yaitu dan . Pada article-list.js terdapat fungsi setter articles yang berfungsi untuk menyimpan nilai articles pada properti this._articles.


 set articles(articles) {

   this._articles = articles;

   this.render();

 }

Kemudian properti tersebut digunakan pada fungsi render() untuk ditampilkan satu persatu melalui .


render() {

   this._articles.forEach(article => {

     const articleItemElement = document.createElement("article-item");

     // memanggil fungsi setter article() pada article-item.

     articleItemElement.article = article;

     this.appendChild(articleItemElement);

   })

 }

Dengan begitu, untuk menampilkan data pada script.js akan lebih mudah. Kita tidak perlu melakukan proses perulangan lagi di sana karena proses tersebut langsung dilakukan ketika menggunakan element . Kita cukup memberikan nilai array yang akan ditampilkan.


import "./article-list.js";

import articles from "./articles.js";

 

const articleListElement = document.createElement("article-list");

articleListElement.articles = articles;

 

document.body.appendChild(articleListElement);

Semakin mudah kita menggunakan sebuah element maka akan semakin baik bukan? Walaupun terlihat agak sedikit merepotkan dalam membuatnya, perlu Anda ingat bahwa web component ini bersifat reusable. Artinya, jika kita ingin membuat komponen serupa, kita tidak perlu membuatnya dari awal.

Dengan menjalankan kode di atas, maka hasilnya akan tampak seperti ini:

Potongan kode untuk seluruh contoh custom element yang digunakan pada materi ini: https://repl.it/@dicodingacademy/163-03-custom-element?lite=true

Solution: Membuat app-bar Component

Apakah Anda berhasil menerapkan custom element pada proyek Club Finder? Jika belum, mari kita lakukan bersama-sama. Kita mulai dari komponen termudah terlebih dahulu yaitu App Bar.

Agar mengelola berkas pada proyek jadi lebih mudah, kita perlu membuat folder baru dengan nama “component” di dalam folder src -> script.

Folder ini akan menampung berkas JavaScript yang digunakan dalam membuat custom element.

Lalu di dalam folder component, buat berkas JavaScript baru dengan nama “app-bar.js”. Kemudian kita buat class dengan nama AppBar yang mewarisi sifat HTMLElement.


class AppBar extends HTMLElement {

  

}

Kemudian di dalam body block classnya, kita implementasi method connectedCallback dan membuat fungsi render.


class AppBar extends HTMLElement {

   connectedCallback(){

 

   }

 

   render() {

      

   }

}

Seperti yang sudah kita ketahui, connectedCallback() akan terpanggil ketika element telah diterapkan pada DOM. Jika kita ingin element ini ketika diterapkan langsung melakukan rendering maka kita dapat memanggil fungsi this.render() di dalam connectedCallback.


class AppBar extends HTMLElement {

   connectedCallback(){

       this.render();

   }

 

   render() {

 

   }

}

Lalu pada fungsi render, kita tuliskan kode yang berfungsi untuk menampilkan elemen yang dibutuhkan pada melalui properti this.innerHTML. Apa saja yang dibutuhkan? Kita bisa melihatnya pada berkas index.html.



       <div id="appBar" class="app-bar">

           Club Finder

Di dalam elemen

terdapat elemen

yang menerapkan class “app-bar”. Nah kita copy element di dalam app-bar, dan paste untuk dijadikan nilai pada this.innerHTML di fungsi render().


class AppBar extends HTMLElement {

   connectedCallback(){

       this.render();

   }

 

   render() {

       this.innerHTML = `Club Finder
`;

   }

}

Lalu di akhir berkas app-bar.js, jangan lupa untuk definisikan custom element yang kita buat agar dapat digunakan pada DOM.


class AppBar extends HTMLElement {

   connectedCallback(){

       this.render();

   }

 

   render() {

       this.innerHTML = `Club Finder
`;

   }

}

 

customElements.define("app-bar", AppBar);

Dengan begitu kita dapat mengubah penerapan app-bar pada index.html dengan menggunakan tag .

Terakhir, agar kode pada berkas app-bar.js tereksekusi, impor berkas app-bar.js pada berkas app.js, seperti ini:


import "./src/script/component/app-bar.js";

Tuliskan kode tersebut pada awal berkas app.js, sehingga keseluruhan kode pada berkasnya akan tampak seperti ini:


import "./src/script/component/app-bar.js";

import main from "./src/script/view/main.js";

 

document.addEventListener("DOMContentLoaded", main);

Kemudian coba kita buka proyeknya menggunakan local server. Inilah tampilan hasilnya:

Oops, tampilan App Bar tampak berantakan. Kita perlu memperbaiki css yang digunakan pada elemen App Bar sebelumnya. Buka berkas appbar.css lalu ubah selector-nya dari .app-bar menjadi app-bar.


app-bar {

   padding: 16px;

   width: 100%;

   background-color: cornflowerblue;

   color: white;

   box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2);

}

Lalu lihat kita lihat hasilnya.

Yah, kini teks “Club Finder” tidak tampak karena background element tidak bekerja dengan baik. Kenapa begini yah? Pasalnya, custom element standarnya merupakan inline element, sehingga tidak akan mengisi panjang lebar parent element-nya. Solusinya adalah dengan mengubah sifat inline pada custom element menjadi block dengan cara menambahkan properti display dengan nilai block pada selector app-bar.


app-bar {

   display: block;

   padding: 16px;

   width: 100%;

   background-color: cornflowerblue;

   color: white;

   box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2);

}

Dengan begitu tampilan kita berhasil membuat custom element dengan baik!

Solution: Membuat search-bar Component

Pembuatan elemen lebih sedikit rumit dari pembuatan komponen sebelumnya, karena di dalam komponen search bar terdapat element dan . Kombinasi kedua element tersebut digunakan dalam mencari data club. Sebisa mungkin kita membuat custom element sehingga mempermudah kala menggunakan komponen tersebut.

Mari kita mulai dengan membuat berkas JavaScript baru dengan nama search-bar.js. Kemudian di dalamnya kita membuat class SearchBar dengan mewarisi sifat HTMLElement.


class SearchBar extends HTMLElement {

  

}

Kemudian kita implementasi method connectedCallback dan membuat fungsi render.


class SearchBar extends HTMLElement {

   connectedCallback(){

 

   }

  

   render() {

      

   }

}

Lalu panggil fungsi render() di dalam connectedCallback().


class SearchBar extends HTMLElement {

   connectedCallback(){

       this.render();

   }

  

   render() {

 

   }

}

Di dalam fungsi render kita ambil elemen yang dibutuhkan untuk ditampilkan dari berkas index.html.


<div id="search-container" class="search-container">

   <input placeholder="Search football club" id="searchElement" type="search">

    <button id="searchButtonElement" type="submit">Search

Agar mudah, copy seluruh kode tersebut dan paste untuk dijadikan nilai this.innerHTML di dalam fungsi render.


class SearchBar extends HTMLElement {

   connectedCallback(){

       this.render();

   }

  

   render() {

       this.innerHTML = `

       

           

           Search

}

Site Title

Belajar Web Component Dasar

What is Web Component

Custom Element

Write your first Custom Element

Life Cycle of Custom Element

Custom element attribute and method

Observe Attribute Value

Styling Custom Element without Shadow DOM

Handling complex data

${this._article.title}

${this._article.title}

Nested Custom Element

${this._article.title}

Solution: Membuat app-bar Component

Club Finder

Club Finder

Club Finder

Solution: Membuat search-bar Component

${name}

${message}

Solution: Membuat club-list dan club-item Component

Membuat element

${message}

${message}

${message}

Membuat element

${name}

${name}

${this._club.name}

${this._club.name}

Menggunakan element

${name}

Leave a comment Cancel reply

What is Web Component

Custom Element

Write your first Custom Element

Life Cycle of Custom Element

Custom element attribute and method

Observe Attribute Value

Styling Custom Element without Shadow DOM

Handling complex data

${this._article.title}

${this._article.title}

Nested Custom Element

${this._article.title}

Solution: Membuat app-bar Component

Club Finder

Solution: Membuat search-bar Component

${name}

${message}

Solution: Membuat club-list dan club-item Component

Membuat element

${message}

${message}

${message}

Membuat element

${name}

${name}

${this._club.name}

${this._club.name}

Menggunakan element

${name}

Share this:

Related

Leave a comment Cancel reply