Web Components: Bygg gjenbrukbare UI-komponenter med Vanilla JavaScript
Lær Web Components trinn for trinn ved å bygge et gjenbrukbart UI-kort med Custom Elements, Shadow DOM, HTML Templates, slots og JavaScript-moduler. Ingen rammeverk eller byggeverktøy er nødvendig.
Nettkomponenter: Bygg gjenbrukbare UI-komponenter med vanlig JavaScript
Tenk deg at du lager et kort for nettstedet ditt og deretter bruker det i et WordPress-tema, en Joomla-utvidelse eller et frittstående program, uten å skrive det om for hvert miljø.
Det er løftet fra Web Components: nettleserinnebygde verktøy for å bygge gjenbrukbare HTML-elementer. Eksemplet vi skal bygge, krever ingen React, Vue, npm-pakker eller bundler.
Når du er ferdig med denne opplæringen, har du en fungerende <ui-card>-komponent med tilpassbart innhold, isolerte stiler, en fremhevet variant, en avvisingsknapp og en offentlig hendelse. Vi bygger den i små steg slik at du kan se hva hver teknologi bidrar med.
Hva du skal bygge
Den ferdige komponenten vår vil støtte denne HTML-en:
<ui-card variant="featured">
<span slot="title">Learn Web Components</span>
<p>Build reusable interfaces with native JavaScript.</p>
<a slot="action" href="/tutorial">Read the tutorial</a>
</ui-card>
Visuell forhåndsvisning — standard- og fremhevede kort
Denne forhåndsvisningen er designmålet, ikke et skjermbilde av et urelatert bibliotek. Vi skal gjenskape den ved hjelp av koden nedenfor.
1. Forstå de fire byggesteinene
Custom Elements lar oss registrere et nytt HTML-tagg og dets JavaScript-oppførsel. Shadow DOM gir elementet sin egen interne DOM og begrensede stiler. HTML-maler og slots lar oss gjenbruke struktur samtidig som vi setter inn ulikt innhold i hver forekomst. ES Modules lar oss laste komponenten fra en vanlig JavaScript-fil.
Dette er separate funksjoner. En Custom Element trenger ikke å bruke Shadow DOM, og du trenger ikke et rammeverk for å bruke noen av dem.
2. Opprett prosjektfilene
Opprett denne strukturen i editoren din:
web-components-demo/
├── index.html
├── components/
│ └── ui-card.js
└── css/
└── main.css
Legg dette inn i index.html:
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Web Components Demo</title>
<link rel="stylesheet" href="./css/main.css">
<script type="module" src="./components/ui-card.js"></script>
</head>
<body>
<main class="container">
<h1>Reusable UI Components</h1>
<p>Let's build a reusable card without a framework.</p>
<ui-card></ui-card>
</main>
</body>
</html>
Legg til sidestilene i css/main.css:
body {
margin: 0;
background: #f4f6f9;
color: #1f2937;
font-family: system-ui, sans-serif;
}
.container {
max-width: 900px;
margin: 60px auto;
padding: 0 20px;
}
ui-card {
display: block;
margin-top: 24px;
}
Kjør en lokal HTTP-server fra prosjektkatalogen, for eksempel:
python -m http.server 8000
Besøk http://localhost:8000. Overskriften vises, men kortet har ikke noe synlig innhold ennå. Bruk en HTTP-server i stedet for å åpne index.html med file://: nettleserens regler for modulinnlasting kan blokkere lokale filimporter.
3. Registrer din første Custom Element
Opprett components/ui-card.js:
class UiCard extends HTMLElement {
connectedCallback() {
this.textContent = 'Hello from a Web Component!';
}
}
customElements.define('ui-card', UiCard);
Oppdater siden. Du skal nå se:
Forventet resultat — Steg 3
HTMLElement gir normal DOM-oppførsel. connectedCallback() kjøres når elementet kobles til dokumentet. customElements.define() knytter klassen til HTML-taggen.
Bindestreken i ui-card er påkrevd for autonome navn på Custom Elements. Tilbakekallet kan kjøre igjen hvis elementet kobles fra og settes inn på nytt, noe som betyr noe når vi legger til initialiseringslogikk.
4. Gi kortet sitt eget design med Shadow DOM
Erstatt ui-card.js med:
class UiCard extends HTMLElement {
connectedCallback() {
if (this.shadowRoot) return;
const shadow = this.attachShadow({ mode: 'open' });
shadow.innerHTML = `
<style>
article {
padding: 24px;
background: white;
border: 1px solid #dce3ec;
border-radius: 12px;
}
h2 {
margin: 0 0 12px;
color: #2563eb;
}
</style>
<article>
<h2>My reusable card</h2>
<p>This content lives inside Shadow DOM.</p>
</article>
`;
}
}
customElements.define('ui-card', UiCard);
Forventet resultat — Steg 4
Åpne DevTools, inspiser <ui-card> og utvid #shadow-root (open). Du vil se den interne article-en og stilarket.
I motsetning til vanlige dokumentvelgere når global CSS, for eksempel article { border: none }, normalt ikke dette skyggetreet. Arvede egenskaper og CSS-custom properties kan fortsatt krysse grensen. Shadow DOM innkapsler presentasjon; det er ikke en sikkerhetssandkasse.
Vakten if (this.shadowRoot) forhindrer at et andre skyggerot festes hvis elementet kobles til igjen.
5. Skill ut layouten med en HTML-mal
Å bygge alt inn i connectedCallback() blir tungvint etter hvert som en komponent vokser. La oss definere markeringen én gang og klone den for hvert kort.
Erstatt filen med:
const template = document.createElement('template');
template.innerHTML = `
<style>
article {
padding: 24px;
background: white;
border: 1px solid #dce3ec;
border-radius: 12px;
}
h2 {
margin: 0 0 12px;
color: #2563eb;
}
</style>
<article>
<h2>My reusable card</h2>
<p>Created from an HTML template.</p>
</article>
`;
class UiCard extends HTMLElement {
connectedCallback() {
if (this.shadowRoot) return;
const shadow = this.attachShadow({ mode: 'open' });
shadow.appendChild(template.content.cloneNode(true));
}
}
customElements.define('ui-card', UiCard);
template.content er et dokumentfragment. cloneNode(true) kopierer hele strukturen inn i hvert korts skyggetre. Selve malen gjengis ikke før vi kloner og setter den inn.
Denne versjonen ser nesten identisk ut. Forbedringen er arkitektonisk: én mal kan betjene mange forekomster.
6. Sett inn ulikt innhold ved hjelp av slots
Et gjenbrukbart kort er ikke nyttig hvis hver forekomst har samme overskrift. Erstatt bare maldeklarasjonen øverst i ui-card.js med følgende; behold klassen og registreringskoden fra steg 5.
const template = document.createElement('template');
template.innerHTML = `
<style>
article {
padding: 24px;
background: white;
border: 1px solid #dce3ec;
border-radius: 12px;
}
h2 { margin: 0 0 12px; color: #2563eb; }
.content { line-height: 1.6; }
.action { margin-top: 16px; }
</style>
<article>
<h2><slot name="title">Untitled card</slot></h2>
<div class="content"><slot></slot></div>
<div class="action"><slot name="action"></slot></div>
</article>
`;
Erstatt nå <ui-card></ui-card> i index.html med:
<ui-card>
<span slot="title">Learn Web Components</span>
<p>Build reusable interfaces with native JavaScript.</p>
<a slot="action" href="/tutorial">Read the tutorial</a>
</ui-card>
Forventet resultat — Steg 6
Den navngitte slot-en mottar elementet merket slot="title". Den unavngitte slot-en mottar avsnittet. Handlingsslot-en mottar lenken. En slots erstatningstekst vises hvis ingenting tildeles den.
Layouten bor i komponenten; de faktiske ordene og lenkene forblir i sidens HTML. Dette er spesielt nyttig for CMS-innhold. Erstatt /tutorial med en virkelig destinasjon i prosjektet ditt.
7. Lag en fremhevet variant med CSS
Inne i malens <style>-blokk, legg til:
:host {
display: block;
}
:host([variant="featured"]) article {
background: #eff6ff;
border-color: #93c5fd;
}
Erstatt deretter det ene kortet i index.html med to kort:
<ui-card>
<span slot="title">Standard card</span>
<p>This card uses the default appearance.</p>
</ui-card>
<ui-card variant="featured">
<span slot="title">Featured card</span>
<p>This card has a highlighted appearance.</p>
</ui-card>
Forventet resultat — Steg 7
Dette er en spesielt nyttig funksjon i :host(): den gir stiler til komponenten basert på attributtene til custom element-et. Hvis JavaScript endrer variant senere, oppdateres CSS automatisk. Ingen attributeChangedCallback() er nødvendig for en rent CSS-drevet endring.
8. Legg til en avvisingsknapp og en offentlig hendelse
La oss gjøre kortet interaktivt. Inne i malens <article>, legg til denne knappen før overskriften:
<button class="dismiss" type="button" aria-label="Dismiss card">
×
</button>
Legg til disse reglene i malens CSS:
article { position: relative; }
.dismiss {
position: absolute;
top: 12px;
right: 12px;
width: 32px;
height: 32px;
border: 0;
border-radius: 6px;
background: transparent;
color: #475569;
font-size: 24px;
cursor: pointer;
}
.dismiss:focus-visible {
outline: 2px solid #2563eb;
outline-offset: 2px;
}
Erstatt connectedCallback() i klassen med:
connectedCallback() {
if (this.shadowRoot) return;
const shadow = this.attachShadow({ mode: 'open' });
shadow.appendChild(template.content.cloneNode(true));
shadow.querySelector('.dismiss').addEventListener('click', () => {
this.dispatchEvent(new CustomEvent('card-dismissed', {
bubbles: true,
composed: true
}));
this.remove();
});
}
I index.html, legg til dette skriptet før </body>:
<script type="module">
document.addEventListener('card-dismissed', () => {
console.log('A card was dismissed.');
});
</script>
Åpne nettleserkonsollen og klikk på ×. Kortet forsvinner, og konsollen viser meldingen.
Hendelsen gir et offentlig integrasjonspunkt: det omkringliggende programmet trenger ikke å vite noe om kortets interne knapp. bubbles får hendelsen til å boble; composed tillater kryssing av en skyggegrense der det er aktuelt. Her oppstår hendelsen på selve vertselementet.
9. Fullstendig endelig versjon: kopier og bruk
Du kan nå erstatte hele innholdet i components/ui-card.js med denne konsoliderte versjonen. Den legger til CSS-tilpasning og eksporterte parts, samtidig som den beholder oppførselen som ble bygget i tidligere steg.
const template = document.createElement('template');
template.innerHTML = `
<style>
:host {
display: block;
color: #1f2937;
font-family: system-ui, sans-serif;
}
article {
position: relative;
box-sizing: border-box;
padding: 24px;
background: var(--card-background, #fff);
border: 1px solid var(--card-border, #dce3ec);
border-radius: 12px;
}
:host([variant="featured"]) article {
background: var(--card-featured-background, #eff6ff);
border-color: var(--card-featured-border, #93c5fd);
}
h2 {
margin: 0 36px 12px 0;
color: var(--card-title-color, #2563eb);
font-size: 1.25rem;
}
.content { line-height: 1.6; }
.action { margin-top: 16px; }
.dismiss {
position: absolute;
top: 12px;
right: 12px;
width: 32px;
height: 32px;
border: 0;
border-radius: 6px;
background: transparent;
color: #475569;
font-size: 24px;
cursor: pointer;
}
.dismiss:hover { background: rgba(0, 0, 0, 0.06); }
.dismiss:focus-visible {
outline: 2px solid #2563eb;
outline-offset: 2px;
}
</style>
<article part="container">
<button class="dismiss" type="button"
aria-label="Dismiss card">×</button>
<h2 part="title"><slot name="title">Untitled card</slot></h2>
<div class="content"><slot></slot></div>
<div class="action"><slot name="action"></slot></div>
</article>
`;
class UiCard extends HTMLElement {
connectedCallback() {
if (this.shadowRoot) return;
const shadow = this.attachShadow({ mode: 'open' });
shadow.appendChild(template.content.cloneNode(true));
shadow.querySelector('.dismiss').addEventListener('click', () => {
this.dispatchEvent(new CustomEvent('card-dismissed', {
bubbles: true,
composed: true,
detail: {
variant: this.getAttribute('variant') || 'default'
}
}));
this.remove();
});
}
}
if (!customElements.get('ui-card')) {
customElements.define('ui-card', UiCard);
}
I motsetning til en rask demo, forsøker ikke denne versjonen å feste skyggeroten to ganger, setter ikke inn upålitelig innhold med innerHTML, og er ikke avhengig av et rammeverk. Malstrengen er utviklerkontrollert; interpoler aldri upålitelig brukerinndata inn i den.
10. Styl det fra vertsnettstedet
Shadow DOM er ikke ment å gjøre tilpasning umulig. Det oppfordrer deg til å definere et bevisst grensesnitt for styling.
I css/main.css, legg til:
ui-card {
--card-border: #cbd5e1;
--card-title-color: #0f766e;
}
ui-card::part(container) {
box-shadow: 0 8px 24px rgba(0, 0, 0, 0.08);
}
Custom properties-arves av skyggetreet og styrer verdiene vi eksponerte. Attributtet part="container" lar ekstern CSS målrette et valgt internt element med ::part(container).
Hvis du trenger en annen fremhevet bakgrunn, bruk --card-featured-background. Dette er å foretrekke fremfor å tvinge forbrukere til å være avhengige av den nøyaktige interne DOM-strukturen.
11. Gjenbruk kortet i WordPress, Joomla eller vanlig HTML
Kopier ui-card.js inn i målnettstedet og last det som en JavaScript-modul:
<script type="module" src="/assets/js/ui-card.js"></script>
Bruk deretter <ui-card> i sidemarkeringen. I WordPress registrerer du ressurser gjennom temaets eller utvidelsens støttede API-er for skriptinnlasting, ved å bruke modulstøtte som passer til din WordPress-versjon. I Joomla bruker du Web Asset Manager for å registrere og laste modulen. Ikke spre hardkodede skripttagger gjennom produksjonsmaler.
For et CMS-generert kort, gjengi tittelen, avsnittet og lenken som slottet HTML. Escap innhold og attributter i henhold til CMS-ens utdataregler.
Praktisk fordel: en Joomla-modul og en WordPress-blokk kan begge generere den samme custom tag-gen samtidig som de deler én komponentimplementasjon. Hvert CMS forblir ansvarlig for å hente og escape sitt eget innhold.
12. Tilgjengelighet, SEO og progressiv forbedring
Bruk innfødte HTML-kontroller inne i komponenter når det er mulig. Avvisingshandlingen vår bruker en ekte button, som gir semantikk for tastaturaktivering, og en aria-label fordi × alene ikke er beskrivende.
Hvis en bruker avviser et kort med tastaturfokus, vurder hvor fokuset skal gå videre i et mer komplekst grensesnitt. Dialoger, menyer og kombinasjonsbokser trenger mye mer tilgjengelighetsatferd enn dette eksemplet.
Hold viktig innhold i meningsfull light-DOM-markering der det er praktisk. Hvis JavaScript mislykkes, vil ikke nettleseren oppgradere <ui-card>; den slottede overskriften og avsnittet forblir i dokumentet, selv om komponentens stylede skall og avvisingsknapp ikke vil eksistere.
For søkemotorer, ikke anta at kun JavaScript-innhold indekseres identisk i hver crawler. Kritisk innhold bør være tilgjengelig i den opprinnelige HTML-en eller gjennom en passende gjengivelsesstrategi.
Shadow DOM har også begrensninger: vanlige dokument-CSS-velgere gir ikke stiler til interne noder, og noen ARIA ID-relasjoner kan ikke krysse skyggegrenser. Design komponent-API-er med disse begrensningene i tankene.
13. Er Web Components alltid raskere?
Ikke nødvendigvis. Web Components unngår å kreve en bestemt rammeverkskjøretid, men ytelsen avhenger av mengden JavaScript, DOM-kompleksitet, gjengivelsesfrekvens og programarkitektur.
Et lite kort er en god kandidat. Hundrevis av komplekse elementer med unødvendig DOM-gjenoppbygging kan fortsatt være tregt. Gjenbruk maler, unngå gjentatt fullstendig gjengivelse, og mål reell ytelse.
For et stort program som allerede er bygget rundt et rammeverks tilstandshåndtering og ruting, kan det være enklere å bruke rammeverkets egne komponenter. Web Components skinner når et stabilt UI-element må krysse rammeverks- eller CMS-grenser.
14. Feilsøking
| Symptom | Sannsynlig årsak | Hva du bør sjekke |
|---|---|---|
| Kortet er tomt | Modulen lastet ikke | DevTools-konsoll, URL, serverens MIME-type |
customElements.define kaster feil |
Ugyldig eller duplikat navn | Bindestrek-kravet og registreringsvakten |
| CSS brukes ikke inne i kortet | Shadow DOM-grense | Bruk custom properties, :host, eller ::part |
| Innhold vises på feil sted | Slot-navn samsvarer ikke | Sammenlign slot="title" med <slot name="title"> |
| Å klikke på avvis gjør ingenting | Malknappen mangler | Inspiser skyggetreet og konsollen |
| Komponenten feiler når den flyttes | Initialisering kjøres to ganger | Beskytt oppretting av skyggerot |
| Lenken fører til 404 | Eksempel-URL-en ble ikke erstattet | Bruk en eksisterende destinasjon |
Husk at connectedCallback() kan kjøre mer enn én gang. Vakten i det endelige eksemplet vårt holder initialiseringen engangs; mer avanserte komponenter kan trenge å feste og fjerne eksterne observatører eller globale hendelseslyttere i løpet av tilkoblingslivssyklusen sin.
15. Når bør du bruke Web Components?
Velg dem når en komponent trenger et gjenbrukbart, dokumentert HTML-grensesnitt på tvers av flere nettsteder, rammeverk eller CMS-miljøer. Kort, varsler, produktelementer og små interaktive verktøy er gode kandidater.
Hopp over abstraksjonen når noen få linjer med vanlig HTML og CSS allerede løser problemet. Og ikke gjenskap innfødte kontroller uten en sterk grunn.
En nyttig test: ville et annet program ha nytte av å bruke dette elementet uten å vite hvordan det ble implementert? Hvis ja, er en Web Component verdt å vurdere.
Konklusjon
Du har bygget en ekte gjenbrukbar komponent, ikke bare lest om en nettleser-API. Den har en custom tag, begrenset styling, konfigurerbart innhold, en fremhevet variant og en hendelse som annen kode kan lytte til.
Start med én komponent som vises gjentatte ganger i prosjektene dine. Gi den et lite offentlig API, test den i mer enn ett layout, og hold avhengighetene minimale.
Den langsiktige verdien av Web Components er ikke at de erstatter hvert rammeverk. Det er at de lar nyttige grensesnittelementer leve lenger enn rammeverket eller CMS-et som først huset dem.