CustomElementRegistry.define()
Die define()
Methode der CustomElementRegistry
Schnittstelle beschreibt ein neues benutzerdefiniertes Element.
Es gibt zwei Arten von benutzerdefinierten Elementen, die erstellt werden können:
- Autonomes benutzerdefiniertes Element: Eigenständige Elemente; Sie erben nicht von eingebauten HTML-Elementen.
- Angepasstes integriertes Element: Diese Elemente erben und erweitern eingebaute HTML-Elemente.
Syntax
customElements.define(name, constructor, options);
Parameter
- name
- Name des neuen benutzerdefinierten Elements. Beachte, dass Namen von benutzerdefinierten Elementen einen Bindestrich enthalten müssen.
- constructor
- Konstruktor für das neue, benutzerdefinierte Element.
- options Optional
- Objekt, das steuert, wie das Element definiert ist. Eine Option wird derzeit unterstützt:
extends
: String des Namens eines integrierten Elements das erweitert werden soll. Wird verwendet um ein angepasstes integriertes Element zu erzeugen.
Return value
Void.
Ausnahmebehandlung
Exception | Description |
---|---|
NotSupportedError |
Das |
SyntaxError |
Der angegebene Name ist kein gültiger benutzerdefinierter Elementname. |
TypeError |
Der referenzierte Konstruktor ist kein Konstruktor. |
Hinweis: Du wirst oftmals NotSupportedError
s geworfen bekommen, die so erscheinen als würde define()
fehlschlagen, aber stattdessen wahrscheinlich ein Problem mit {domxref("Element.attachShadow()")}} sind.
Beispiele
Autonomes benutzerdefiniertes Element
Der folgende Code entstammt dem popup-info-box-web-component Beispiel (siehe Live).
// Create a class for the element
class PopUpInfo extends HTMLElement {
constructor() {
// Always call super first in constructor
super();
// Create a shadow root
var shadow = this.attachShadow({mode: 'open'});
// Create spans
var wrapper = document.createElement('span');
wrapper.setAttribute('class','wrapper');
var icon = document.createElement('span');
icon.setAttribute('class','icon');
icon.setAttribute('tabindex', 0);
var info = document.createElement('span');
info.setAttribute('class','info');
// Take attribute content and put it inside the info span
var text = this.getAttribute('text');
info.textContent = text;
// Insert icon
var imgUrl;
if(this.hasAttribute('img')) {
imgUrl = this.getAttribute('img');
} else {
imgUrl = 'img/default.png';
}
var img = document.createElement('img');
img.src = imgUrl;
icon.appendChild(img);
// Create some CSS to apply to the shadow dom
var style = document.createElement('style');
style.textContent = '.wrapper {' +
'position: relative;' +
'}' +
'.info {' +
'font-size: 0.8rem;' +
'width: 200px;' +
'display: inline-block;' +
'border: 1px solid black;' +
'padding: 10px;' +
'background: white;' +
'border-radius: 10px;' +
'opacity: 0;' +
'transition: 0.6s all;' +
'position: absolute;' +
'bottom: 20px;' +
'left: 10px;' +
'z-index: 3;' +
'}' +
'img {' +
'width: 1.2rem' +
'}' +
'.icon:hover + .info, .icon:focus + .info {' +
'opacity: 1;' +
'}';
// attach the created elements to the shadow dom
shadow.appendChild(style);
shadow.appendChild(wrapper);
wrapper.appendChild(icon);
wrapper.appendChild(info);
}
}
// Define the new element
customElements.define('popup-info', PopUpInfo);
<popup-info img="img/alt.png" text="Your card validation code (CVC) is an extra
security feature — it is the last 3 or 4
numbers on the back of your card.">
Hinweis: Konstruktoren für autonome benutzerdefinierte Elemente müssen HTMLElement
(en-US) extenden.
Benutzerdefiniertes integriertes Element
Der folgende Code entstammt dem word-count-web-component Beispiel (siehe Live).
// Create a class for the element
class WordCount extends HTMLParagraphElement {
constructor() {
// Always call super first in constructor
super();
// count words in element's parent element
var wcParent = this.parentNode;
function countWords(node){
var text = node.innerText || node.textContent
return text.split(/\s+/g).length;
}
var count = 'Words: ' + countWords(wcParent);
// Create a shadow root
var shadow = this.attachShadow({mode: 'open'});
// Create text node and add word count to it
var text = document.createElement('span');
text.textContent = count;
// Append it to the shadow root
shadow.appendChild(text);
// Update count when element content changes
setInterval(function() {
var count = 'Words: ' + countWords(wcParent);
text.textContent = count;
}, 200)
}
}
// Define the new element
customElements.define('word-count', WordCount, { extends: 'p' });
<p is="word-count"></p>
Spezifikationen
Spezifikation | Status | Kommentar |
---|---|---|
HTML Living Standard Die Definition von 'customElements.define()' in dieser Spezifikation. |
Lebender Standard | Initial definition. |
Browserkompatibilität
BCD tables only load in the browser