env()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

Die env() CSS Funktion kann verwendet werden, um den Wert einer vom Benutzeragenten definierten Umgebungsvariablen in Ihr CSS einzufügen, ähnlich wie die var()-Funktion und benutzerdefinierte Eigenschaften. Der Unterschied besteht darin, dass Umgebungsvariablen, zusätzlich zu ihrer Definition durch den Benutzeragenten statt durch den Autor, auf ein Dokument global wirken, während benutzerdefinierte Eigenschaften auf das Element oder die Elemente beschränkt sind, auf denen sie deklariert werden.

Darüber hinaus kann, im Gegensatz zu benutzerdefinierten Eigenschaften, die nicht außerhalb von Deklarationen verwendet werden können, die env()-Funktion anstelle eines Teils eines Eigenschaftswertes oder eines Teils eines Deskriptors verwendet werden (z. B. in Media-Query-Regeln). Wenn sich die Spezifikation weiterentwickelt, könnte sie auch an anderen Stellen wie Selektoren verwendbar sein.

Ursprünglich von iOS-Browsern bereitgestellt, um Entwicklern die Möglichkeit zu geben, ihren Inhalt in einem sicheren Bereich des Ansichtsfensters zu platzieren, können die in der Spezifikation definierten safe-area-inset-* Werte verwendet werden, um sicherzustellen, dass Inhalte auch für Betrachter mit nicht rechteckigen Displays sichtbar sind.

Ein häufiges Problem, das env() löst, ist beispielsweise, dass Gerätebenachrichtigungen Teile der App-Benutzeroberfläche verdecken. Indem feste Elemente mit env() positioniert werden, können Sie sicherstellen, dass sie in einem sicheren Bereich des Ansichtsfensters angezeigt werden.

Ein weiterer Anwendungsfall für env()-Variablen sind Desktop-Progressive-Web-Apps (PWAs), die die Window Controls Overlay-Funktion nutzen, um die gesamte Anwendungsfensterfläche zu nutzen. Mit den titlebar-area-* Werten können sie Elemente dort positionieren, wo sich die Titelleiste befunden hätte, und sicherstellen, dass Inhalte nicht mit den Fenstersteuerungsschaltflächen überlappen.

Syntax

css
/* Using the four safe area inset values with no fallback values */
env(safe-area-inset-top);
env(safe-area-inset-right);
env(safe-area-inset-bottom);
env(safe-area-inset-left);

/* Using them with fallback values */
env(safe-area-inset-top, 20px);
env(safe-area-inset-right, 1em);
env(safe-area-inset-bottom, 0.5vh);
env(safe-area-inset-left, 1.4rem);

Werte

safe-area-inset-top, safe-area-inset-right, safe-area-inset-bottom, safe-area-inset-left

Die safe-area-inset-* Variablen sind vier Umgebungsvariablen, die ein Rechteck durch ihre oberen, rechten, unteren und linken Einzüge vom Rand des Ansichtsfensters definieren. Es ist sicher, Inhalte in diese Bereiche zu platzieren, ohne zu riskieren, dass sie durch die Form eines nicht-rechteckigen Displays abgeschnitten werden. Für rechteckige Ansichtsfenster, wie Ihr durchschnittlicher Laptop-Monitor, beträgt ihr Wert null. Für nicht-rechteckige Displays — wie ein rundes Uhrendisplay — bilden die vier vom Benutzeragenten gesetzten Werte ein Rechteck, so dass alle Inhalte innerhalb des Rechtecks sichtbar sind.

titlebar-area-x, titlebar-area-y, titlebar-area-width, titlebar-area-height

Die titlebar-area-* Variablen sind nützlich für PWAs, die auf Desktopgeräten installiert sind. Wenn eine Desktop-PWA den window-controls-overlay display_override Wert verwendet, kann sie die titlebar-area-* Variablen nutzen, um sicherzustellen, dass Inhalte nicht mit den Fenstersteuerungsschaltflächen (d. h. Minimieren, Maximieren und Schließen) überlappen.

keyboard-inset-top, keyboard-inset-right, keyboard-inset-bottom, keyboard-inset-left, keyboard-inset-width, keyboard-inset-height

Die keyboard-inset-* Variablen liefern Informationen über das Erscheinen der virtuellen Bildschirmtastatur. Sie definieren ein Rechteck durch seine oberen, rechten, unteren und linken Einzüge vom Rand des Ansichtsfensters (die Breiten- und Höheneinzüge werden von den anderen Einzügen berechnet). Weitere Informationen finden Sie in der VirtualKeyboard API.

Hinweis: Im Gegensatz zu anderen CSS-Eigenschaften sind vom Benutzeragenten definierte Eigenschaftsnamen groß- und kleinschreibungsempfindlich.

Formale Syntax

Verwendung

Um dem Browser mitzuteilen, den gesamten verfügbaren Platz auf dem Bildschirm zu verwenden und uns so zu ermöglichen, die env()-Variablen zu nutzen, müssen wir einen neuen viewport-Meta-Wert hinzufügen:

html
<meta name="viewport" content="viewport-fit=cover" />

Sie können dann env() in Ihrem CSS verwenden:

css
body {
  padding: env(safe-area-inset-top, 20px) env(safe-area-inset-right, 20px)
    env(safe-area-inset-bottom, 20px) env(safe-area-inset-left, 20px);
}

Beispiele

Verwendung von env(), um sicherzustellen, dass Schaltflächen nicht von der Gerätebenutzeroberfläche verdeckt werden

Im folgenden Beispiel wird env() verwendet, um sicherzustellen, dass feste App-Werkzeugleistenschaltflächen nicht von Gerätebenachrichtigungen verdeckt werden, die am unteren Rand des Bildschirms erscheinen. Auf dem Desktop ist safe-area-inset-bottom 0. Bei Geräten, die Benachrichtigungen am unteren Bildschirmrand anzeigen, wie iOS, enthält es jedoch einen Wert, der Platz für die Anzeige der Benachrichtigung lässt. Dieser Wert kann dann im Wert von padding-bottom verwendet werden, um eine Lücke zu schaffen, die auf diesem Gerät natürlich erscheint.

html
<main>Main content of app here</main>
<footer>
  <button>Go here</button>
  <button>Or here</button>
</footer>
css
body {
  display: flex;
  flex-direction: column;
  min-height: 100vh;
  font: 1em system-ui;
}

main {
  flex: 1;
  background-color: #eee;
  padding: 1em;
}

footer {
  flex: none;
  display: flex;
  gap: 1em;
  justify-content: space-evenly;
  background: black;
  padding: 1em 1em calc(1em + env(safe-area-inset-bottom));
  /* adds the safe-area-inset-bottom value to the initial 1em of padding.
  a larger black area will display for a device that has a positive value for this variable. */
  position: sticky;
  bottom: 0;
}

button {
  padding: 1em;
  background: white;
  color: black;
  margin: 0;
  width: 100%;
  border: none;
  font: 1em system-ui;
}

Verwendung des Fallback-Werts

Das unten stehende Beispiel nutzt den optionalen zweiten Parameter von env(), der es ermöglicht, einen Ersatzwert anzugeben, falls die Umgebungsvariable nicht verfügbar ist.

html
<p>
  If the <code>env()</code> function is supported in your browser, this
  paragraph's text will have 50px of padding between it and the left border —
  but not the top, right and bottom. This is because the accompanying CSS is the
  equivalent of <code>padding: 0 0 0 50px</code>, because, unlike other CSS
  properties, user agent property names are case-sensitive.
</p>
css
p {
  width: 300px;
  border: 2px solid red;
  padding: env(safe-area-inset-top, 50px) env(safe-area-inset-right, 50px)
    env(safe-area-inset-bottom, 50px) env(SAFE-AREA-INSET-LEFT, 50px);
}

Beispielwerte

css
/* zero for all rectangular user agents */
padding: env(safe-area-inset-bottom, 50px);

/* 50px because UA properties are case sensitive */
padding: env(Safe-area-inset-bottom, 50px);

/* as if padding: '50px 20px' were set because x is not a valid environment variable */
padding: env(x, 50px 20px);

/* ignored because '50px, 20px' is not a valid padding value and x is not a valid environment variable */
padding: env(x, 50px, 20px);

Die Syntax des Fallbacks, ähnlich wie bei benutzerdefinierten Eigenschaften, erlaubt Kommata. Wenn der Eigenschaftswert jedoch keine Kommata unterstützt, ist der Wert ungültig.

Hinweis: Benutzeragenten-Eigenschaften werden nicht durch die all Eigenschaft zurückgesetzt.

Verwendung von env(), um sicherzustellen, dass Inhalte nicht von den Fenstersteuerungsschaltflächen in Desktop-PWAs verdeckt werden

Im folgenden Beispiel stellt env() sicher, dass Inhalte, die in einer Desktop-Progressive-Web-App angezeigt werden, die die Window Controls Overlay API verwendet, nicht von den Fenstersteuerungsschaltflächen des Betriebssystems verdeckt werden. Die titlebar-area-* Werte definieren ein Rechteck, wo die Titelleiste normalerweise angezeigt worden wäre. Auf Geräten, die das Window Controls Overlay-Feature nicht unterstützen, wie Mobilgeräte, werden die Fallback-Werte verwendet.

So sieht eine auf einem Desktopgerät installierte PWA normalerweise aus:

Illustration, wie eine auf einem Desktop installierte PWA normalerweise aussieht, mit Fenstersteuerungsschaltflächen, einer Titelleiste und Webinhalt darunter

Mit dem Window Controls Overlay-Feature decken die Webinhalte die gesamte Anwendungsfensterfläche ab, wobei die Fenstersteuerungsschaltflächen und PWA-Schaltflächen als Überlagerungen angezeigt werden:

Illustration, wie eine auf einem Desktop installierte PWA mit dem Window Controls Overlay-Feature aussieht, mit Fenstersteuerungsschaltflächen, keiner Titelleiste und Webinhalt, der das gesamte Fenster überspannt

html
<header>Title of the app here</header>
<main>Main content of app here</main>
css
header {
  position: fixed;
  left: env(titlebar-area-x);
  top: env(titlebar-area-y);
  width: env(titlebar-area-width);
  height: env(titlebar-area-height);
}

main {
  margin-top: env(titlebar-area-height);
}

Hinweis: Die Verwendung von position:fixed stellt sicher, dass der Header nicht mit dem Rest des Inhalts scrollt und stattdessen mit den Fenstersteuerungsschaltflächen ausgerichtet bleibt, selbst auf Geräten/Browsern, die elastisches Overscrollen (auch als Rubber-Banding bekannt) unterstützen.

Spezifikationen

Specification
CSS Environment Variables Module Level 1
# env-function

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch