Ugrás a fő tartalomhoz Ugrás a dokumentumok navigációjához
Check
in English

Érvényesítés

Adjon értékes, gyakorlatias visszajelzést a felhasználóknak a HTML5 űrlap érvényesítésével, a böngésző alapértelmezett viselkedésén vagy egyéni stílusokon és JavaScripten keresztül.

Tisztában vagyunk azzal, hogy jelenleg az ügyféloldali egyéni érvényesítési stílusok és eszköztippek nem érhetők el, mivel nincsenek kitéve segítő technológiáknak. Amíg a megoldáson dolgozunk, azt javasoljuk, hogy használja a szerveroldali beállítást, vagy az alapértelmezett böngésző-ellenőrzési módszert.

Hogyan működik

A következőképpen működik az űrlapellenőrzés a Bootstrappel:

  • A HTML-űrlap érvényesítése a CSS két álosztályán keresztül történik, :invalidés :valid. <input>, <select>, és <textarea>elemekre vonatkozik .
  • A Bootstrap a :invalidés a :validstílusokat a szülőosztályba helyezi .was-validated, általában a <form>. Ellenkező esetben minden érték nélküli kötelező mező érvénytelenként jelenik meg az oldal betöltésekor. Ily módon kiválaszthatja, hogy mikor aktiválja őket (általában az űrlap beküldésének kísérlete után).
  • Az űrlap megjelenésének visszaállításához (például AJAX-ot használó dinamikus űrlap-beküldések esetén) a beküldés után távolítsa el újra az .was-validatedosztályt <form>.
  • Tartalékként osztályok használhatók a pszeudoosztályok helyett a .is-invalidszerveroldali érvényesítéshez . Nem igényelnek szülői osztályt..is-valid.was-validated
  • A CSS működésének korlátai miatt (jelenleg) nem tudunk stílusokat alkalmazni <label>a DOM-ban az űrlapvezérlők elé kerülő stílusokra egyéni JavaScript segítsége nélkül.
  • Minden modern böngésző támogatja a kényszerérvényesítési API -t , egy sor JavaScript-módszert az űrlapvezérlők érvényesítésére.
  • A visszajelzési üzenetek használhatják a böngésző alapértelmezett beállításait (minden böngészőnél eltérőek, és CSS-en keresztül nem stílusozhatók), vagy egyéni visszajelzési stílusainkat további HTML és CSS segítségével.
  • Egyéni érvényességi üzeneteket adhat setCustomValiditymeg JavaScriptben.

Ezt szem előtt tartva tekintse meg az alábbi bemutatókat az egyéni űrlapérvényesítési stílusainkhoz, az opcionális szerveroldali osztályainkhoz és a böngésző alapértelmezett beállításaihoz.

Egyedi stílusok

Egyéni Bootstrap űrlap érvényesítő üzeneteihez hozzá kell adnia a novalidatelogikai attribútumot a <form>. Ezzel letiltja a böngésző alapértelmezett visszajelzési eszköztippjeit, de továbbra is hozzáférést biztosít a JavaScript űrlapellenőrző API-jához. Próbálja meg elküldeni az alábbi űrlapot; JavaScriptünk elfogja a küldés gombot, és visszajelzést küld Önnek. Amikor megpróbál beküldeni, látni fogja az űrlapvezérlőkre alkalmazott :invalidés stílusokat.:valid

Az egyéni visszajelzési stílusok egyéni színeket, kereteket, fókuszstílusokat és háttérikonokat alkalmaznak a visszajelzés jobb kommunikálása érdekében. Az s háttérikonjai <select>csak a -val érhetők el .form-select, és nem .form-control.

Jól néz ki!
Jól néz ki!
@
Kérjük, válasszon felhasználónevet.
Adjon meg egy érvényes várost.
Kérjük, válasszon érvényes államot.
Kérjük, adjon meg egy érvényes zip-címet.
Beküldés előtt el kell fogadnia.
html
<form class="row g-3 needs-validation" novalidate>
  <div class="col-md-4">
    <label for="validationCustom01" class="form-label">First name</label>
    <input type="text" class="form-control" id="validationCustom01" value="Mark" required>
    <div class="valid-feedback">
      Looks good!
    </div>
  </div>
  <div class="col-md-4">
    <label for="validationCustom02" class="form-label">Last name</label>
    <input type="text" class="form-control" id="validationCustom02" value="Otto" required>
    <div class="valid-feedback">
      Looks good!
    </div>
  </div>
  <div class="col-md-4">
    <label for="validationCustomUsername" class="form-label">Username</label>
    <div class="input-group has-validation">
      <span class="input-group-text" id="inputGroupPrepend">@</span>
      <input type="text" class="form-control" id="validationCustomUsername" aria-describedby="inputGroupPrepend" required>
      <div class="invalid-feedback">
        Please choose a username.
      </div>
    </div>
  </div>
  <div class="col-md-6">
    <label for="validationCustom03" class="form-label">City</label>
    <input type="text" class="form-control" id="validationCustom03" required>
    <div class="invalid-feedback">
      Please provide a valid city.
    </div>
  </div>
  <div class="col-md-3">
    <label for="validationCustom04" class="form-label">State</label>
    <select class="form-select" id="validationCustom04" required>
      <option selected disabled value="">Choose...</option>
      <option>...</option>
    </select>
    <div class="invalid-feedback">
      Please select a valid state.
    </div>
  </div>
  <div class="col-md-3">
    <label for="validationCustom05" class="form-label">Zip</label>
    <input type="text" class="form-control" id="validationCustom05" required>
    <div class="invalid-feedback">
      Please provide a valid zip.
    </div>
  </div>
  <div class="col-12">
    <div class="form-check">
      <input class="form-check-input" type="checkbox" value="" id="invalidCheck" required>
      <label class="form-check-label" for="invalidCheck">
        Agree to terms and conditions
      </label>
      <div class="invalid-feedback">
        You must agree before submitting.
      </div>
    </div>
  </div>
  <div class="col-12">
    <button class="btn btn-primary" type="submit">Submit form</button>
  </div>
</form>
// Example starter JavaScript for disabling form submissions if there are invalid fields
(() => {
  'use strict'

  // Fetch all the forms we want to apply custom Bootstrap validation styles to
  const forms = document.querySelectorAll('.needs-validation')

  // Loop over them and prevent submission
  Array.from(forms).forEach(form => {
    form.addEventListener('submit', event => {
      if (!form.checkValidity()) {
        event.preventDefault()
        event.stopPropagation()
      }

      form.classList.add('was-validated')
    }, false)
  })
})()

A böngésző alapértelmezett beállításai

Nem érdekelnek az egyéni érvényesítési visszajelzések vagy JavaScript írása az űrlap viselkedésének megváltoztatásához? Minden rendben, használhatja a böngésző alapértelmezett beállításait. Próbálja meg elküldeni az alábbi űrlapot. A böngészőtől és az operációs rendszertől függően kissé eltérő stílusú visszajelzést fog látni.

Bár ezek a visszajelzési stílusok nem alakíthatók CSS-sel, a visszajelzés szövegét továbbra is személyre szabhatja a JavaScript segítségével.

@
html
<form class="row g-3">
  <div class="col-md-4">
    <label for="validationDefault01" class="form-label">First name</label>
    <input type="text" class="form-control" id="validationDefault01" value="Mark" required>
  </div>
  <div class="col-md-4">
    <label for="validationDefault02" class="form-label">Last name</label>
    <input type="text" class="form-control" id="validationDefault02" value="Otto" required>
  </div>
  <div class="col-md-4">
    <label for="validationDefaultUsername" class="form-label">Username</label>
    <div class="input-group">
      <span class="input-group-text" id="inputGroupPrepend2">@</span>
      <input type="text" class="form-control" id="validationDefaultUsername"  aria-describedby="inputGroupPrepend2" required>
    </div>
  </div>
  <div class="col-md-6">
    <label for="validationDefault03" class="form-label">City</label>
    <input type="text" class="form-control" id="validationDefault03" required>
  </div>
  <div class="col-md-3">
    <label for="validationDefault04" class="form-label">State</label>
    <select class="form-select" id="validationDefault04" required>
      <option selected disabled value="">Choose...</option>
      <option>...</option>
    </select>
  </div>
  <div class="col-md-3">
    <label for="validationDefault05" class="form-label">Zip</label>
    <input type="text" class="form-control" id="validationDefault05" required>
  </div>
  <div class="col-12">
    <div class="form-check">
      <input class="form-check-input" type="checkbox" value="" id="invalidCheck2" required>
      <label class="form-check-label" for="invalidCheck2">
        Agree to terms and conditions
      </label>
    </div>
  </div>
  <div class="col-12">
    <button class="btn btn-primary" type="submit">Submit form</button>
  </div>
</form>

Szerver oldal

Javasoljuk, hogy használja a kliensoldali érvényesítést, de ha szerveroldali érvényesítésre van szüksége, az érvénytelen és érvényes űrlapmezőket és a gombokkal .is-invalidjelezheti .is-valid. Vegye figyelembe, hogy .invalid-feedbackezek az osztályok is támogatottak.

Érvénytelen mezők esetén győződjön meg arról, hogy az érvénytelen visszajelzés/hibaüzenet a megfelelő űrlapmezőhöz van társítva aria-describedby(figyelembe véve, hogy ez az attribútum lehetővé teszi egynél több idhivatkozást, ha a mező már további űrlapszövegre mutat).

A szegélysugárral kapcsolatos problémák megoldásához a beviteli csoportokhoz további .has-validationosztályra van szükség.

Jól néz ki!
Jól néz ki!
@
Kérjük, válasszon felhasználónevet.
Adjon meg egy érvényes várost.
Kérjük, válasszon érvényes államot.
Kérjük, adjon meg egy érvényes zip-címet.
Beküldés előtt el kell fogadnia.
html
<form class="row g-3">
  <div class="col-md-4">
    <label for="validationServer01" class="form-label">First name</label>
    <input type="text" class="form-control is-valid" id="validationServer01" value="Mark" required>
    <div class="valid-feedback">
      Looks good!
    </div>
  </div>
  <div class="col-md-4">
    <label for="validationServer02" class="form-label">Last name</label>
    <input type="text" class="form-control is-valid" id="validationServer02" value="Otto" required>
    <div class="valid-feedback">
      Looks good!
    </div>
  </div>
  <div class="col-md-4">
    <label for="validationServerUsername" class="form-label">Username</label>
    <div class="input-group has-validation">
      <span class="input-group-text" id="inputGroupPrepend3">@</span>
      <input type="text" class="form-control is-invalid" id="validationServerUsername" aria-describedby="inputGroupPrepend3 validationServerUsernameFeedback" required>
      <div id="validationServerUsernameFeedback" class="invalid-feedback">
        Please choose a username.
      </div>
    </div>
  </div>
  <div class="col-md-6">
    <label for="validationServer03" class="form-label">City</label>
    <input type="text" class="form-control is-invalid" id="validationServer03" aria-describedby="validationServer03Feedback" required>
    <div id="validationServer03Feedback" class="invalid-feedback">
      Please provide a valid city.
    </div>
  </div>
  <div class="col-md-3">
    <label for="validationServer04" class="form-label">State</label>
    <select class="form-select is-invalid" id="validationServer04" aria-describedby="validationServer04Feedback" required>
      <option selected disabled value="">Choose...</option>
      <option>...</option>
    </select>
    <div id="validationServer04Feedback" class="invalid-feedback">
      Please select a valid state.
    </div>
  </div>
  <div class="col-md-3">
    <label for="validationServer05" class="form-label">Zip</label>
    <input type="text" class="form-control is-invalid" id="validationServer05" aria-describedby="validationServer05Feedback" required>
    <div id="validationServer05Feedback" class="invalid-feedback">
      Please provide a valid zip.
    </div>
  </div>
  <div class="col-12">
    <div class="form-check">
      <input class="form-check-input is-invalid" type="checkbox" value="" id="invalidCheck3" aria-describedby="invalidCheck3Feedback" required>
      <label class="form-check-label" for="invalidCheck3">
        Agree to terms and conditions
      </label>
      <div id="invalidCheck3Feedback" class="invalid-feedback">
        You must agree before submitting.
      </div>
    </div>
  </div>
  <div class="col-12">
    <button class="btn btn-primary" type="submit">Submit form</button>
  </div>
</form>

Támogatott elemek

Érvényesítési stílusok állnak rendelkezésre a következő űrlapvezérlőkhöz és összetevőkhöz:

  • <input>s és <textarea>s with .form-control(beleértve legfeljebb egyet .form-controla beviteli csoportokban)
  • <select>s vele.form-select
  • .form-checks
Kérjük, írjon be egy üzenetet a szövegmezőbe.
Példa érvénytelen visszajelzési szövegre
További példa érvénytelen visszajelzési szövegre
Példa érvénytelen kiválasztási visszajelzés
Példa érvénytelen űrlapfájl-visszajelzés
html
<form class="was-validated">
  <div class="mb-3">
    <label for="validationTextarea" class="form-label">Textarea</label>
    <textarea class="form-control" id="validationTextarea" placeholder="Required example textarea" required></textarea>
    <div class="invalid-feedback">
      Please enter a message in the textarea.
    </div>
  </div>

  <div class="form-check mb-3">
    <input type="checkbox" class="form-check-input" id="validationFormCheck1" required>
    <label class="form-check-label" for="validationFormCheck1">Check this checkbox</label>
    <div class="invalid-feedback">Example invalid feedback text</div>
  </div>

  <div class="form-check">
    <input type="radio" class="form-check-input" id="validationFormCheck2" name="radio-stacked" required>
    <label class="form-check-label" for="validationFormCheck2">Toggle this radio</label>
  </div>
  <div class="form-check mb-3">
    <input type="radio" class="form-check-input" id="validationFormCheck3" name="radio-stacked" required>
    <label class="form-check-label" for="validationFormCheck3">Or toggle this other radio</label>
    <div class="invalid-feedback">More example invalid feedback text</div>
  </div>

  <div class="mb-3">
    <select class="form-select" required aria-label="select example">
      <option value="">Open this select menu</option>
      <option value="1">One</option>
      <option value="2">Two</option>
      <option value="3">Three</option>
    </select>
    <div class="invalid-feedback">Example invalid select feedback</div>
  </div>

  <div class="mb-3">
    <input type="file" class="form-control" aria-label="file example" required>
    <div class="invalid-feedback">Example invalid form file feedback</div>
  </div>

  <div class="mb-3">
    <button class="btn btn-primary" type="submit" disabled>Submit form</button>
  </div>
</form>

Eszköztippek

Ha az űrlap elrendezése lehetővé teszi, az .{valid|invalid}-feedbackosztályokat .{valid|invalid}-tooltiposztályokra cserélheti, hogy az érvényesítési visszajelzéseket stílusos elemleírásban jelenítse meg. Ügyeljen arra, hogy szülője legyen position: relativerajta az eszköztipp elhelyezéséhez. Az alábbi példában oszloposztályaink már rendelkeznek ezzel, de a projektje alternatív beállítást igényelhet.

Jól néz ki!
Jól néz ki!
@
Kérjük, válasszon egyedi és érvényes felhasználónevet.
Adjon meg egy érvényes várost.
Kérjük, válasszon érvényes államot.
Kérjük, adjon meg egy érvényes zip-címet.
html
<form class="row g-3 needs-validation" novalidate>
  <div class="col-md-4 position-relative">
    <label for="validationTooltip01" class="form-label">First name</label>
    <input type="text" class="form-control" id="validationTooltip01" value="Mark" required>
    <div class="valid-tooltip">
      Looks good!
    </div>
  </div>
  <div class="col-md-4 position-relative">
    <label for="validationTooltip02" class="form-label">Last name</label>
    <input type="text" class="form-control" id="validationTooltip02" value="Otto" required>
    <div class="valid-tooltip">
      Looks good!
    </div>
  </div>
  <div class="col-md-4 position-relative">
    <label for="validationTooltipUsername" class="form-label">Username</label>
    <div class="input-group has-validation">
      <span class="input-group-text" id="validationTooltipUsernamePrepend">@</span>
      <input type="text" class="form-control" id="validationTooltipUsername" aria-describedby="validationTooltipUsernamePrepend" required>
      <div class="invalid-tooltip">
        Please choose a unique and valid username.
      </div>
    </div>
  </div>
  <div class="col-md-6 position-relative">
    <label for="validationTooltip03" class="form-label">City</label>
    <input type="text" class="form-control" id="validationTooltip03" required>
    <div class="invalid-tooltip">
      Please provide a valid city.
    </div>
  </div>
  <div class="col-md-3 position-relative">
    <label for="validationTooltip04" class="form-label">State</label>
    <select class="form-select" id="validationTooltip04" required>
      <option selected disabled value="">Choose...</option>
      <option>...</option>
    </select>
    <div class="invalid-tooltip">
      Please select a valid state.
    </div>
  </div>
  <div class="col-md-3 position-relative">
    <label for="validationTooltip05" class="form-label">Zip</label>
    <input type="text" class="form-control" id="validationTooltip05" required>
    <div class="invalid-tooltip">
      Please provide a valid zip.
    </div>
  </div>
  <div class="col-12">
    <button class="btn btn-primary" type="submit">Submit form</button>
  </div>
</form>

Sass

Változók

$form-feedback-margin-top:          $form-text-margin-top;
$form-feedback-font-size:           $form-text-font-size;
$form-feedback-font-style:          $form-text-font-style;
$form-feedback-valid-color:         $success;
$form-feedback-invalid-color:       $danger;

$form-feedback-icon-valid-color:    $form-feedback-valid-color;
$form-feedback-icon-valid:          url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 8 8'><path fill='#{$form-feedback-icon-valid-color}' d='M2.3 6.73.6 4.53c-.4-1.04.46-1.4 1.1-.8l1.1 1.4 3.4-3.8c.6-.63 1.6-.27 1.2.7l-4 4.6c-.43.5-.8.4-1.1.1z'/></svg>");
$form-feedback-icon-invalid-color:  $form-feedback-invalid-color;
$form-feedback-icon-invalid:        url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 12 12' width='12' height='12' fill='none' stroke='#{$form-feedback-icon-invalid-color}'><circle cx='6' cy='6' r='4.5'/><path stroke-linejoin='round' d='M5.8 3.6h.4L6 6.5z'/><circle cx='6' cy='8.2' r='.6' fill='#{$form-feedback-icon-invalid-color}' stroke='none'/></svg>");

Mixins

Két mixint kombinálunk a hurkon keresztül , hogy létrehozzuk az űrlapellenőrzési visszajelzési stílusainkat.

@mixin form-validation-state-selector($state) {
  @if ($state == "valid" or $state == "invalid") {
    .was-validated #{if(&, "&", "")}:#{$state},
    #{if(&, "&", "")}.is-#{$state} {
      @content;
    }
  } @else {
    #{if(&, "&", "")}.is-#{$state} {
      @content;
    }
  }
}

@mixin form-validation-state(
  $state,
  $color,
  $icon,
  $tooltip-color: color-contrast($color),
  $tooltip-bg-color: rgba($color, $form-feedback-tooltip-opacity),
  $focus-box-shadow: 0 0 $input-btn-focus-blur $input-focus-width rgba($color, $input-btn-focus-color-opacity)
) {
  .#{$state}-feedback {
    display: none;
    width: 100%;
    margin-top: $form-feedback-margin-top;
    @include font-size($form-feedback-font-size);
    font-style: $form-feedback-font-style;
    color: $color;
  }

  .#{$state}-tooltip {
    position: absolute;
    top: 100%;
    z-index: 5;
    display: none;
    max-width: 100%; // Contain to parent when possible
    padding: $form-feedback-tooltip-padding-y $form-feedback-tooltip-padding-x;
    margin-top: .1rem;
    @include font-size($form-feedback-tooltip-font-size);
    line-height: $form-feedback-tooltip-line-height;
    color: $tooltip-color;
    background-color: $tooltip-bg-color;
    @include border-radius($form-feedback-tooltip-border-radius);
  }

  @include form-validation-state-selector($state) {
    ~ .#{$state}-feedback,
    ~ .#{$state}-tooltip {
      display: block;
    }
  }

  .form-control {
    @include form-validation-state-selector($state) {
      border-color: $color;

      @if $enable-validation-icons {
        padding-right: $input-height-inner;
        background-image: escape-svg($icon);
        background-repeat: no-repeat;
        background-position: right $input-height-inner-quarter center;
        background-size: $input-height-inner-half $input-height-inner-half;
      }

      &:focus {
        border-color: $color;
        box-shadow: $focus-box-shadow;
      }
    }
  }

  // stylelint-disable-next-line selector-no-qualifying-type
  textarea.form-control {
    @include form-validation-state-selector($state) {
      @if $enable-validation-icons {
        padding-right: $input-height-inner;
        background-position: top $input-height-inner-quarter right $input-height-inner-quarter;
      }
    }
  }

  .form-select {
    @include form-validation-state-selector($state) {
      border-color: $color;

      @if $enable-validation-icons {
        &:not([multiple]):not([size]),
        &:not([multiple])[size="1"] {
          padding-right: $form-select-feedback-icon-padding-end;
          background-image: escape-svg($form-select-indicator), escape-svg($icon);
          background-position: $form-select-bg-position, $form-select-feedback-icon-position;
          background-size: $form-select-bg-size, $form-select-feedback-icon-size;
        }
      }

      &:focus {
        border-color: $color;
        box-shadow: $focus-box-shadow;
      }
    }
  }

  .form-control-color {
    @include form-validation-state-selector($state) {
      @if $enable-validation-icons {
        width: add($form-color-width, $input-height-inner);
      }
    }
  }

  .form-check-input {
    @include form-validation-state-selector($state) {
      border-color: $color;

      &:checked {
        background-color: $color;
      }

      &:focus {
        box-shadow: $focus-box-shadow;
      }

      ~ .form-check-label {
        color: $color;
      }
    }
  }
  .form-check-inline .form-check-input {
    ~ .#{$state}-feedback {
      margin-left: .5em;
    }
  }

  .input-group {
    > .form-control:not(:focus),
    > .form-select:not(:focus),
    > .form-floating:not(:focus-within) {
      @include form-validation-state-selector($state) {
        @if $state == "valid" {
          z-index: 3;
        } @else if $state == "invalid" {
          z-index: 4;
        }
      }
    }
  }
}

Térkép

Ez az érvényesítési Sass térkép innen _variables.scss. Ezt felülbírálhatja vagy kiterjesztheti különböző vagy további állapotok létrehozásához.

$form-validation-states: (
  "valid": (
    "color": $form-feedback-valid-color,
    "icon": $form-feedback-icon-valid
  ),
  "invalid": (
    "color": $form-feedback-invalid-color,
    "icon": $form-feedback-icon-invalid
  )
);

A térképek $form-validation-stateshárom választható paramétert tartalmazhatnak az eszköztippek és fókuszstílusok felülbírálásához.

Hurok

A leképezési értékek átiterálására $form-validation-statesszolgál az érvényesítési stílusaink generálásához. A fenti Sass térkép bármilyen módosítása ezen a hurkon keresztül megjelenik a lefordított CSS-ben.

@each $state, $data in $form-validation-states {
  @include form-validation-state($state, $data...);
}

Testreszabás

Az érvényesítési állapotok testreszabhatók a Sass segítségével a $form-validation-statestérképpel. Ez a fájlunkban található _variables.scssSass térkép az alapértelmezett valid/ invalidérvényesítési állapotok generálását mutatja. Tartalmaz egy beágyazott térképet az egyes állapotok színének, ikonjának, eszköztipp-színének és fókuszárnyékának testreszabásához. Míg a böngészők nem támogatnak más állapotokat, az egyéni stílusokat használók könnyen hozzáadhatnak összetettebb űrlap-visszajelzéseket.