Documentation v8.0.36

Preview Downloads Purchase

Overview

Bootstrap Maxlength is a visual feedback indicator for the maxlength attribute. For more info please visit the plugin's Homeor Github Repo.

Usage

Bootstrap Maxlength's Javascript files are bundled in the global plugin bundles and globally included in all pages. However, the maxlength functionality requires a manual Javascript initialization.

<script src="assets/plugins/global/plugins.bundle.js"></script>

Basic Example

Basic example of a simple input with the maxlengthHTML attribute to control the total number of characters allowed.

Basic example The badge will show up by default when the remaining chars are 10 or less

JAVASCRIPT
HTML

$('#kt_docs_maxlength_basic').maxlength({
    warningClass: "badge badge-warning",
    limitReachedClass: "badge badge-success"
});

<label class="form-label">Basic example</label>
<input type="text" class="form-control" id="kt_docs_maxlength_basic" maxlength="10" />
<span class="fs-6 text-muted">The badge will show up by default when the remaining chars are 3 or less</span>

Threshold Example

An example of Bootstrap Maxlength with a treshold option. The thresholdoption is to set the minimum number of characters that will display the badge.

Threshold example Set threshold value to show there are 20 chars or less left

JAVASCRIPT
HTML

$('#kt_docs_maxlength_threshold').maxlength({
    threshold: 20,
    warningClass: "badge badge-primary",
    limitReachedClass: "badge badge-success"
});

<label class="form-label">Threshold example</label>
<input type="text" class="form-control" id="kt_docs_maxlength_threshold" maxlength="25" />
<span class="fs-6 text-muted">Set threshold value to show there are 20 chars or less left</span>

Always Show Example

An example of Bootstrap Maxlength with an always show option. Add alwaysShow: truein the Javascript.

Always show example Show the counter on input focus

JAVASCRIPT
HTML

$('#kt_docs_maxlength_always_show').maxlength({
    alwaysShow: true,
    threshold: 20,
    warningClass: "badge badge-primary",
    limitReachedClass: "badge badge-success"
});

<label class="form-label">Threshold example</label>
<input type="text" class="form-control" id="kt_docs_maxlength_always_show" maxlength="20" />
<span class="fs-6 text-muted">Show the counter on input focus</span>

Custom Text Example

An example of Bootstrap Maxlength with some custom text in the badge. Please refer to the code sample below for the JS options.

Custom text example Display custom text on input focus

JAVASCRIPT
HTML

$('#kt_docs_maxlength_custom_text').maxlength({
    threshold: 20,
    warningClass: "badge badge-danger",
    limitReachedClass: "badge badge-success",
    separator: ' of ',
    preText: 'You have ',
    postText: ' chars remaining.',
    validate: true
});

<label class="form-label">Custom text example</label>
<input type="text" class="form-control" id="kt_docs_maxlength_custom_text" maxlength="20" />
<span class="fs-6 text-muted">Display custom text on input focus</span>

Textarea Example

Bootstrap Maxlength can also be applied to textarea.

Textarea example Bootstrap maxlength supports textarea as well as inputs

JAVASCRIPT
HTML

$('#kt_docs_maxlength_textarea').maxlength({
    warningClass: "badge badge-primary",
    limitReachedClass: "badge badge-success"
});

<label class="form-label">Textarea example</label>
<textarea class="form-control" id="kt_docs_maxlength_textarea" maxlength="20" placeholder="" rows="6"></textarea>
<span class="fs-6 text-muted">Bootstrap maxlength supports textarea as well as inputs</span>

Set Position Example

Here's an example of predefining the badge position, relative to the input.

Set Position example The field counter can be positioned at the top, bottom, left or right.

JAVASCRIPT
HTML

$('#kt_docs_maxlength_position_top_left').maxlength({
    placement: 'top-left',
    warningClass: "badge badge-danger",
    limitReachedClass: "badge badge-primary"
});

<label class="form-label">Set Position example</label>
<input type="text" class="form-control" id="kt_docs_maxlength_position_top_left" maxlength="20" />
<input type="text" class="form-control" id="kt_docs_maxlength_position_top_right" maxlength="20" />
<input type="text" class="form-control" id="kt_docs_maxlength_position_bottom_left" maxlength="20" />
<input type="text" class="form-control" id="kt_docs_maxlength_position_bottom_right" maxlength="20" />
<span class="fs-6 text-muted">The field counter can be positioned at the top, bottom, left or right.</span>