Element: checkVisibility() Methode

Baseline 2024

Newly available

Since March 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Die checkVisibility() Methode des Element-Interfaces prüft, ob das Element sichtbar ist.

Die Methode gibt false in einer der folgenden Situationen zurück:

  • Das Element hat keinen zugeordneten Kasten, zum Beispiel weil die CSS-Eigenschaft display auf none oder contents gesetzt ist.
  • Das Element wird nicht gerendert, weil das Element oder ein übergeordnetes Element die Eigenschaft content-visibility auf hidden gesetzt hat.

Der optionale Parameter ermöglicht zusätzliche Prüfungen für andere Interpretationen dessen, was "sichtbar" bedeutet. Beispielsweise können Sie weiter prüfen, ob ein Element eine Opazität von 0 hat, ob der Wert der visibility-Eigenschaft des Elements es unsichtbar macht oder ob die content-visibility-Eigenschaft des Elements den Wert auto hat und das Rendern derzeit übersprungen wird.

Syntax

js
checkVisibility(options)

Parameter

options Optional

Ein Objekt, das zusätzliche auszuführende Prüfungen angibt. Die möglichen Optionen sind:

contentVisibilityAuto

true, um zu prüfen, ob die Eigenschaft content-visibility des Elements den Wert auto hat (oder erbt) und das Rendern derzeit übersprungen wird. Standardmäßig false.

opacityProperty

true, um zu prüfen, ob die Eigenschaft opacity des Elements einen Wert von 0 hat (oder erbt). Standardmäßig false.

visibilityProperty

true, um zu prüfen, ob das Element aufgrund des Werts seiner visibility-Eigenschaft unsichtbar ist. Standardmäßig false.

Hinweis: Unsichtbare Elemente umfassen solche, die visibility: hidden haben, und einige Elementtypen, die visibility: collapse haben.

checkOpacity

Ein historisches Alias für opacityProperty.

checkVisibilityCSS

Ein historisches Alias für visibilityProperty.

Rückgabewert

false, wenn eine der folgenden Bedingungen erfüllt ist, andernfalls true:

  • Das Element hat keinen zugeordneten Kasten.
  • Die content-visibility-Eigenschaft des Elements hat (oder erbt) einen Wert von hidden.
  • opacityProperty (oder checkOpacity) ist true und die Eigenschaft opacity des Elements hat (oder erbt) einen Wert von 0.
  • visibilityProperty (oder checkVisibilityCSS) ist true und das Element ist unsichtbar aufgrund des Werts seiner visibility-Eigenschaft.
  • contentVisibilityAuto ist true, die content-visibility-Eigenschaft hat (oder erbt) einen Wert von auto, und das Rendern des Elements wird übersprungen.

Beispiele

Test checkVisibility() mit unterschiedlichem CSS

Das folgende Beispiel ermöglicht es Ihnen zu testen, wie sich das Ergebnis von checkVisibility() bei unterschiedlichen Werten für die CSS-Eigenschaften display, content-visibility, visibility und opacity ändern könnte.

HTML

Das HTML definiert ein <select>-Element für die CSS-Eigenschaften, die die Ergebnisse von checkVisibility() beeinflussen. Die ersten (standardmäßig ausgewählten) Werte sollten dazu führen, dass checkVisibility() bei Anwendung auf ein Element true zurückgibt, während die anderen Werte die Sichtbarkeit beeinflussen.

html
<select id="css_display" name="css_display">
  <option value="block" selected>display: block</option>
  <option value="none">display: none</option>
  <option value="content">display: content</option>
</select>

<select id="css_content_visibility" name="css_content_visibility">
  <option value="visible" selected>content-visibility: visible</option>
  <option value="hidden">content-visibility: hidden</option>
  <option value="auto">content-visibility: auto</option>
</select>

<select id="css_opacity" name="css_opacity">
  <option value="1" selected>opacity: 1</option>
  <option value="0">opacity: 0</option>
</select>

<select id="css_visibility" name="css_visibility">
  <option value="visible" selected>visibility: visible</option>
  <option value="hidden">visibility: hidden</option>
  <option value="collapse">visibility: collapse</option>
</select>

Als nächstes haben wir ein <pre>, das verwendet wird, um das Ergebnis des checkVisibility()-Checks auszugeben, wenn keine Optionen im Parameter übergeben werden, und für jeden einzelnen Optionswert. Am Ende haben wir das zu prüfende Element (auf das wir die ausgewählten CSS-Eigenschaften anwenden werden).

html
<pre id="output_result"></pre>
<div id="test_element">The element to be checked for visibility.</div>

CSS

Das CSS hebt nur das zu prüfende Element hervor.

css
#test_element {
  border: solid;
  border-color: blue;
}

JavaScript

Der folgende Code holt sich jedes der <select>-Elemente. Die Methode updateCSS() wird beim Start und bei jeder Änderung der Auswahl-Elemente aufgerufen, um die ausgewählte CSS auf das Ziel-Element anzuwenden.

js
const displayCssSelect = document.getElementById("css_display");
const contentVisibilityCssSelect = document.getElementById(
  "css_content_visibility",
);
const displayCssOpacity = document.getElementById("css_opacity");
const displayCssVisibility = document.getElementById("css_visibility");

const outputResult = document.getElementById("output_result");
const elementToCheck = document.getElementById("test_element");

updateCSS();

const cssSelectors = document.querySelectorAll("select");
cssSelectors.forEach((select) => {
  select.addEventListener("change", (event) => {
    updateCSS();
  });
});

function updateCSS() {
  // Apply selected CSS properties to target element
  elementToCheck.style.display = displayCssSelect.value;
  elementToCheck.style.contentVisibility = contentVisibilityCssSelect.value;
  elementToCheck.style.opacity = displayCssOpacity.value;
  elementToCheck.style.visibility = displayCssVisibility.value;

  // Call checkVisibility() on element using default and each of options
  const defaultVisibilityCheck = elementToCheck.checkVisibility();
  const opacityVisibilityCheck = elementToCheck.checkVisibility({
    opacityProperty: true,
  });
  const cssVisibilityCheck = elementToCheck.checkVisibility({
    visibilityProperty: true,
  });
  const contentVisibilityAutoCheck = elementToCheck.checkVisibility({
    contentVisibilityAuto: true,
  });

  // Output the results of the tests
  outputResult.innerText = `Checks on element below (may be hidden):
- Result of checkVisibility(): ${defaultVisibilityCheck}
- Result of checkVisibility({opacityProperty: true}): ${opacityVisibilityCheck}
- Result of checkVisibility({visibilityProperty: true}): ${cssVisibilityCheck}
- Result of checkVisibility({contentVisibilityAuto: true}): ${contentVisibilityAutoCheck}`;
}

Ergebnis

Die Ergebnisse werden unten angezeigt. Wenn Sie die Auswahl ändern, werden die Ergebnisse auf das Testelement (blaue Umrandung) angewendet und die Ergebnisse der checkVisibility() für jede Einstellung sollten angezeigt werden. Wenn Sie zum Beispiel opacity: 0 einstellen, sollte dieser Test (nur) false anzeigen. Wenn Sie jedoch display: none einstellen, sollten alle Tests false zurückgeben.

Spezifikationen

Specification
CSSOM View Module
# dom-element-checkvisibility

Browser-Kompatibilität

BCD tables only load in the browser