CSS: registerProperty() statische Methode
Baseline
2024
Newly available
Since July 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
Die statische Methode CSS.registerProperty()
registriert
benutzerdefinierte Eigenschaften und ermöglicht die Überprüfung von Eigenschaftstypen, Standardwerte und Eigenschaften, die ihre Werte entweder erben oder nicht.
Durch das Registrieren einer benutzerdefinierten Eigenschaft können Sie dem Browser mitteilen, wie sich die benutzerdefinierte Eigenschaft verhalten soll: welche Typen erlaubt sind, ob die benutzerdefinierte Eigenschaft ihren Wert erbt und was der Standardwert der benutzerdefinierten Eigenschaft ist.
Syntax
CSS.registerProperty(propertyDefinition)
Parameter
propertyDefinition
-
Ein Objekt, das die folgenden Eigenschaften enthält:
name
-
Ein String, der den Namen der definierten Eigenschaft darstellt.
syntax
Optional-
Ein String, der die erwartete Syntax der definierten Eigenschaft darstellt. Standardwert ist
"*"
. inherits
-
Ein boolescher Wert, der definiert, ob die definierte Eigenschaft vererbt werden soll (
true
) oder nicht (false
). Standardwert istfalse
. initialValue
Optional-
Ein String, der den Anfangswert der definierten Eigenschaft darstellt.
Rückgabewert
undefined
.
Ausnahmen
InvalidModificationError
DOMException
-
Der angegebene
name
wurde bereits registriert. SyntaxError
DOMException
-
Der angegebene
name
ist kein gültiger Name für eine benutzerdefinierte Eigenschaft (beginnt mit zwei Bindestrichen, z.B.--foo
). TypeError
-
Die erforderlichen
name
- und/oderinherits
-Einträge im Wörterbuch wurden nicht angegeben.
Beispiele
Das folgende Beispiel registriert eine benutzerdefinierte Eigenschaft,
--my-color
, mit der Methode registerProperty()
, als Farbe, gibt ihr einen
Standardwert und lässt sie ihren Wert nicht erben:
window.CSS.registerProperty({
name: "--my-color",
syntax: "<color>",
inherits: false,
initialValue: "#c0ffee",
});
In diesem Beispiel wurde die benutzerdefinierte Eigenschaft --my-color
mit der Syntax <color>
registriert. Wir können nun diese Eigenschaft nutzen, um einen
Gradienten beim Hover oder Fokus zu überblenden. Beachten Sie, dass mit der registrierten Eigenschaft die Überblendung funktioniert, jedoch nicht mit der nicht registrierten Eigenschaft!
.registered {
--my-color: #c0ffee;
background-image: linear-gradient(to right, white, var(--my-color));
transition: --my-color 1s ease-in-out;
}
.registered:hover,
.registered:focus {
--my-color: #b4d455;
}
.unregistered {
--unregistered: #c0ffee;
background-image: linear-gradient(to right, white, var(--unregistered));
transition: --unregistered 1s ease-in-out;
}
.unregistered:hover,
.unregistered:focus {
--unregistered: #b4d455;
}
button {
font-size: 3vw;
}
Wir können diese Stile zu einigen Buttons hinzufügen:
<button class="registered">Background Registered</button>
<button class="unregistered">Background Not Registered</button>
Spezifikationen
Specification |
---|
CSS Properties and Values API Level 1> # the-registerproperty-function> |
Browser-Kompatibilität
Loading…