Verwendung von CSS-Benutzereigenschaften (Variablen)

In CSS können Sie eine Benutzereigenschaft deklarieren, indem Sie zwei Bindestriche als Präfix für den Eigenschaftsnamen verwenden oder durch die Verwendung der @property At-Regel. Die folgenden Abschnitte beschreiben, wie Sie diese beiden Methoden einsetzen können.

Eine Benutzereigenschaft, die mit zwei Bindestrichen beginnt, beginnt mit --, gefolgt vom Eigenschaftsnamen (z.B. --my-property) und einem Eigenschaftswert, der jeden gültigen CSS-Wert darstellen kann. Wie jede andere Eigenschaft wird dies innerhalb eines Regelsets geschrieben. Das folgende Beispiel zeigt, wie man eine Benutzereigenschaft --main-bg-color erstellt und einen <named-color> Wert von brown verwendet:

section {
  --main-bg-color: brown;
}

Der Selektor, der dem Regelset zugewiesen ist (z.B. <section> Elemente im obigen Beispiel), definiert den Bereich, in dem die Benutzereigenschaft verwendet werden kann. Aus diesem Grund ist es eine gängige Praxis, Benutzereigenschaften auf der :root Pseudoklasse zu definieren, damit sie global referenziert werden können:

:root {
  --main-bg-color: brown;
}

Das muss nicht immer der Fall sein: Sie haben möglicherweise einen guten Grund, den Bereich Ihrer Benutzereigenschaften zu begrenzen.

Die @property At-Regel ermöglicht es Ihnen, mit der Definition einer Benutzereigenschaft ausdrucksstärker zu sein, indem Sie die Möglichkeit haben, einen Typ mit der Eigenschaft zu assoziieren, Standardwerte festzulegen und die Vererbung zu steuern. Das folgende Beispiel erstellt eine Benutzereigenschaft namens --logo-color, die eine <color> erwartet:

@property --logo-color {
  syntax: "<color>";
  inherits: false;
  initial-value: #c0ffee;
}

Wenn Sie Benutzereigenschaften in JavaScript anstelle von direkt in CSS definieren oder verwenden möchten, gibt es eine entsprechende API zu diesem Zweck. Sie können darüber, wie dies funktioniert, auf der Seite CSS Properties and Values API lesen.

Unabhängig davon, welche Methode Sie wählen, um eine Benutzereigenschaft zu definieren, verwenden Sie sie, indem Sie die Eigenschaft in einer var() Funktion anstelle eines Standard-Eigenschaftswertes referenzieren:

details {
  background-color: var(--main-bg-color);
}

Beginnen wir mit etwas HTML, das wir mit einigen Stilen versehen möchten. Es gibt ein <div>, das als Container fungiert und einige Kindelemente enthält, einige davon mit verschachtelten Elementen:

<div class="container">
  <div class="one">
    <p>One</p>
  </div>
  <div class="two">
    <p>Two</p>
    <div class="three">
      <p>Three</p>
    </div>
  </div>
  <input class="four" placeholder="Four" />
  <textarea class="five">Five</textarea>
</div>

Wir werden das folgende CSS verwenden, um verschiedene Elemente basierend auf ihren Klassen zu gestalten (einige Layoutregeln werden unten nicht gezeigt, damit wir uns auf die Farben konzentrieren können). Je nach ihren Klassen geben wir Elementen Hintergrundfarben in cornflowerblue oder aquamarine:

/* Set fonts, borders and padding */
body {
  font-family: sans-serif;
  color: white;
}

div,
input,
textarea {
  border: 2px black solid;
  padding: 4px;
  margin: 4px;
}

.container {
  display: grid;
  gap: 10px;
}

/* For each class, set some colors */
.one {
  background-color: cornflowerblue;
}
.two {
  color: black;
  background-color: aquamarine;
}
.three {
  background-color: cornflowerblue;
}
.four {
  background-color: cornflowerblue;
}
.five {
  background-color: cornflowerblue;
}

Das ergibt folgendes Ergebnis:

Es besteht die Möglichkeit, Benutzereigenschaften zu verwenden, um sich wiederholende Werte in diesen Regeln zu ersetzen. Nachdem --main-bg-color im .container-Bereich definiert und sein Wert an mehreren Stellen referenziert wurde, sehen die aktualisierten Stile so aus:

/* Define --main-bg-color here */
.container {
  --main-bg-color: cornflowerblue;
}

/* For each class, set some colors */
.one {
  background-color: var(--main-bg-color);
}
.two {
  color: black;
  background-color: aquamarine;
}
.three {
  background-color: var(--main-bg-color);
}
.four {
  background-color: var(--main-bg-color);
}
.five {
  background-color: var(--main-bg-color);
}

Für einige CSS-Deklarationen ist es möglich, diese weiter oben in der Kaskade zu deklarieren und die CSS-Vererbung dieses Problems lösen zu lassen. Bei nicht-trivialen Projekten ist dies jedoch nicht immer möglich. Durch die Deklaration einer Benutzereigenschaft auf der :root Pseudoklasse und durch ihre Verwendung, wo immer nötig, im gesamten Dokument, kann ein CSS-Autor die Notwendigkeit zur Wiederholung reduzieren:

/* Define --main-bg-color here */
:root {
  --main-bg-color: cornflowerblue;
}

/* For each class, set some colors */
.one {
  background-color: var(--main-bg-color);
}
.two {
  color: black;
  background-color: aquamarine;
}
.three {
  background-color: var(--main-bg-color);
}
.four {
  background-color: var(--main-bg-color);
}
.five {
  background-color: var(--main-bg-color);
}

Das führt zum selben Ergebnis wie das vorherige Beispiel, erlaubt aber eine kanonische Deklaration des gewünschten Eigenschaftswertes (--main-bg-color: cornflowerblue;), was sehr nützlich ist, wenn Sie den Wert später im gesamten Projekt ändern möchten.

Eine Benutzereigenschaft, die mit zwei Bindestrichen -- anstelle von @property definiert wird, erbt immer den Wert ihres Elternteils. Dies wird im folgenden Beispiel dargestellt:

<div class="one">
  <p>One</p>
  <div class="two">
    <p>Two</p>
    <div class="three"><p>Three</p></div>
    <div class="four"><p>Four</p></div>
  </div>
</div>

div {
  color: black;
  font-family: sans-serif;
  width: 75%;
  height: 80%;
  margin: 4px;
  border: 2px black solid;
  display: inline-block;
}

p {
  margin: 0;
}

.one {
  height: 250px;
}

.two {
  height: 80%;
}

.three {
  height: 40%;
}

.four {
  height: 40%;
}

div {
  background-color: var(--box-color);
}

.two {
  --box-color: cornflowerblue;
}

.three {
  --box-color: aquamarine;
}

Die Ergebnisse von var(--box-color) abhängend von der Vererbung sind wie folgt:

• class="one": ungültiger Wert, welcher der Standardwert einer so definierten Benutzereigenschaft ist
• class="two": cornflowerblue
• class="three": aquamarine
• class="four": cornflowerblue (vom Elternteil geerbt)

Ein Aspekt von Benutzereigenschaften, den die obigen Beispiele demonstrieren, ist, dass sie sich nicht genau wie Variablen in anderen Programmiersprachen verhalten. Der Wert wird dort berechnet, wo er benötigt wird, und nicht gespeichert und in anderen Bereichen eines Stylesheets wiederverwendet. Zum Beispiel können Sie nicht den Wert einer Eigenschaft setzen und erwarten, den Wert in der Regel eines Geschwisterelements eines Nachfahren wiederzugewinnen. Die Eigenschaft wird nur für den passenden Selektor und seine Nachfahren festgesetzt.

Die @property At-Regel lässt Sie explizit angeben, ob die Eigenschaft vererbt wird oder nicht. Das folgende Beispiel erstellt eine Benutzereigenschaft unter Verwendung der @property At-Regel. Die Vererbung wird deaktiviert, ein <color> Datentyp wird festgelegt und ein anfänglicher Wert von cornflowerblue wird gesetzt.

Das Elternelement setzt --box-color auf einen Wert von green und verwendet --box-color als Wert für seine Hintergrundfarbe. Das Kindelement verwendet ebenfalls background-color: var(--box-color), und wir würden erwarten, dass es die Farbe green hat, wenn die Vererbung aktiviert wäre (oder wenn es mit der Doppelpunktsyntax definiert wäre).

<div class="parent">
  <p>Parent element</p>
  <div class="child">
    <p>Child element with inheritance disabled for --box-color.</p>
  </div>
</div>

div {
  color: white;
  font-family: sans-serif;
  width: 200px;
  height: 200px;
  margin: 4px;
  padding: 8px;
  border: 2px black solid;
  display: inline-block;
}

@property --box-color {
  syntax: "<color>";
  inherits: false;
  initial-value: cornflowerblue;
}

.parent {
  --box-color: green;
  background-color: var(--box-color);
}

.child {
  width: 80%;
  height: 40%;
  background-color: var(--box-color);
}

Da inherits: false; in der At-Regel gesetzt ist und innerhalb des .child-Bereichs kein Wert für die Eigenschaft --box-color deklariert ist, wird der Initialwert cornflowerblue anstelle von green verwendet, der vom Elternteil vererbt worden wäre:

Sie können Fallback-Werte für Benutzereigenschaften unter Verwendung der var() Funktion und des initial-value der @property At-Regel definieren.

Mit der var() Funktion können Sie mehrere Fallback-Werte definieren, wenn die gegebene Variable noch nicht definiert ist; dies kann nützlich sein, wenn man mit Custom Elements und Shadow DOM arbeitet.

Das erste Argument der Funktion ist der Name der Benutzereigenschaft. Das zweite Argument der Funktion ist ein optionaler Fallback-Wert, der als Substitutionswert verwendet wird, wenn die referenzierte Benutzereigenschaft ungültig ist. Die Funktion akzeptiert zwei Parameter, wobei alles nach dem ersten Komma als zweiter Parameter zugewiesen wird. Wenn der zweite Parameter ungültig ist, schlägt der Fallback fehl. Zum Beispiel:

.one {
  /* Red if --my-var is not defined */
  color: var(--my-var, red);
}

.two {
  /* pink if --my-var and --my-background are not defined */
  color: var(--my-var, var(--my-background, pink));
}

.three {
  /* Invalid: "--my-background, pink" */
  color: var(--my-var, --my-background, pink);
}

Einen Fallback für Benutzereigenschaften wie im zweiten Beispiel oben (var(--my-var, var(--my-background, pink))) zu inkludieren, ist die korrekte Weise, mehr als einen Fallback mit var() bereitzustellen. Sie sollten sich jedoch der Leistungsauswirkungen dieser Methode bewusst sein, da es mehr Zeit benötigt, um durch die verschachtelten Variablen zu parsen.

Abgesehen von der Verwendung von var() kann der initial-value, der in der @property At-Regel definiert ist, als Fallback-Mechanismus verwendet werden. Tatsächlich haben wir dies bereits im Abschnitt @property Vererbung gesehen.

Das folgende Beispiel setzt einen Initialwert von --box-color auf cornflowerblue unter Verwendung der @property At-Regel. Im Regelset, das der At-Regel folgt, wollen wir --box-color auf aquamarine setzen, aber es gibt einen Tippfehler im Wertnamen. Das gleiche gilt für das dritte <div>, wo wir 2rem für die Benutzereigenschaft verwendet haben, die einen gültigen <color> Wert erwartet. Sowohl 2rem als auch aqumarine sind ungültige Farbwerte, so dass der Initialwert cornflowerblue angewendet wird:

@property --box-color {
  syntax: "<color>";
  initial-value: cornflowerblue;
  inherits: false;
}

.one {
  --box-color: aquamarine;
  background-color: var(--box-color);
}

.two {
  --box-color: aqumarine;
  background-color: var(--box-color);
}

.three {
  --box-color: 2rem;
  background-color: var(--box-color);
}

div {
  color: white;
  font-family: sans-serif;
  width: 100px;
  height: 100px;
  margin: 4px;
  padding: 8px;
  border: 2px black solid;
  display: inline-block;
}
.one {
  color: black;
}

<div class="one">
  <p>One</p>
</div>
<div class="two">
  <p>Two.</p>
</div>
<div class="three">
  <p>Three.</p>
</div>

Jede CSS-Eigenschaft kann eine definierte Gruppe von Werten zugewiesen bekommen. Wenn Sie versuchen, einer Eigenschaft einen Wert zuzuweisen, der außerhalb dieser Gruppe gültiger Werte liegt, wird sie als ungültig betrachtet.

Wenn dem Browser ein ungültiger Wert für eine reguläre CSS-Eigenschaft begegnet (zum Beispiel ein Wert von 16px für die color Eigenschaft), verwirft er die Deklaration, und die Elemente erhalten die Werte, die sie gehabt hätten, wenn die Deklaration nicht existiert hätte. Im folgenden Beispiel sehen wir, was passiert, wenn eine reguläre CSS-Deklaration ungültig ist; color: 16px; wird verworfen und die vorherige color: blue Regel wird stattdessen angewendet:

<p>This paragraph is initially black.</p>

p {
  color: blue;
}

p {
  /* oops, not a valid color */
  color: 16px;
}

Wenn die Werte von Benutzereigenschaften jedoch analysiert werden, weiß der Browser noch nicht, wo sie verwendet werden, daher müssen fast alle Werte als gültig betrachtet werden. Leider können diese gültigen Werte über die var() Funktionsnotation in einem Kontext verwendet werden, in dem sie möglicherweise keinen Sinn ergeben. Eigenschaften und benutzerdefinierte Variablen können zu ungültigen CSS-Anweisungen führen, die zum Konzept von gültig zur berechneten Zeit führen.

Wenn der Browser auf eine ungültige var()-Ersetzung trifft, wird dann der initiale oder geerbte Wert der Eigenschaft verwendet. Dieses Beispiel ist genauso wie das letzte, außer dass wir eine benutzerdefinierte Eigenschaft verwenden.

Der Browser ersetzt den Wert von --text-color anstelle von var(--text-color), aber 16px ist kein gültiger Eigenschaftswert für color. Nach der Ersetzung ergibt die Eigenschaft keinen Sinn, daher handelt der Browser diese Situation in zwei Schritten ab:

1. Überprüfen Sie, ob die Eigenschaft color vererbbar ist. Sie ist, aber dieses <p> hat kein übergeordnetes Element mit der festgelegten color Eigenschaft. Also gehen wir zum nächsten Schritt über.
2. Setzen Sie den Wert auf seinen standardmäßigen Anfangswert, der schwarz ist.

<p>This paragraph is initially black.</p>

:root {
  --text-color: 16px;
}

p {
  color: blue;
}

p {
  color: var(--text-color);
}

Für solche Fälle kann die @property At-Regel unerwartete Ergebnisse verhindern, indem sie den Anfangswert der Eigenschaft definiert:

<p>This paragraph is initially black.</p>

@property --text-color {
  syntax: "<color>";
  inherits: false;
  initial-value: cornflowerblue;
}

:root {
  --text-color: 16px;
}

p {
  color: blue;
}

p {
  color: var(--text-color);
}

Um die Werte von Benutzereigenschaften in JavaScript zu verwenden, ist es genauso wie bei Standard-Eigenschaften.

// get variable from inline style
element.style.getPropertyValue("--my-var");

// get variable from wherever
getComputedStyle(element).getPropertyValue("--my-var");

// set variable on inline style
element.style.setProperty("--my-var", jsVar + 4);

• Benutzereigenschaftssyntax
• @property At-Regel
• var()
• CSS Properties and Values API
• CSS-Benutzereigenschaften für kaskadierende Variablen Modul