use-bootstrap-tag
v2.2.2
Published
Tag input for Bootstrap 5
Downloads
1,218
Maintainers
use-bootstrapReadme
use-bootstrap-tag
Tag input for Bootstrap 5
Demo and documentation: https://use-bootstrap-tag.js.org
Features
- Custom separator: Set a specific delimiter character between tag elements.
- Enable/disable duplicates: Toggle the allowance of duplicate tags.
- Custom transformation: Define personalized modifications to input tag entries.
- Max limit: Set a maximum limit of tags that can be added.
- Sizing: Adjustable sizing to match user preferences or layouts.
- Validation: Reflects validation states visually to align with Bootstrap's form validation feedback.
Installation
Install use-bootstrap-tag from npm:
npm install use-bootstrap-tagUsage/Examples
After installation, you can import the library into your project as follows
import 'use-bootstrap-tag/dist/use-bootstrap-tag.css'
import UseBootstrapTag from 'use-bootstrap-tag'or, since it also comes with an IIFE bundle, you can insert it directly into your HTML
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Use Bootstrap Tag demo</title>
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet">
<link href="node_modules/use-bootstrap-tag/dist/use-bootstrap-tag.min.css" rel="stylesheet">
</head>
<body>
<input type="text" class="form-control" id="example">
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js"></script>
<script src="node_modules/use-bootstrap-tag/dist/use-bootstrap-tag.min.js"></script>
</body>
</html>Once you imported the library, you can initiate it
const example = UseBootstrapTag(document.getElementById('example'))Options
All options can be embedded in attributes:
data-ub-tag-separator
data-ub-tag-duplicate
data-ub-tag-transform
data-ub-tag-variant
data-ub-tag-x-position
data-ub-tag-max
data-ub-tag-no-input-onblur<!-- example -->
<input
class="form-control"
data-ub-tag-separator=" "
data-ub-tag-duplicate
data-ub-tag-transform="input => input.toUpperCase()"
data-ub-tag-variant="primary"
data-ub-tag-x-position="left"
data-ub-tag-max="5"
data-ub-tag-no-input-onblur
>Methods
| Name | Params | Returns | Example |
|---------|-----------------|-----------------|-----------------------------------|
| addValue | string | array | void | example.addValue('react')example.addValue('vue,svelte')example.addValue(['solid', 'qwik']) |
| removeValue | string | array | void | example.removeValue('react')example.removeValue('vue,svelte')example.removeValue(['solid', 'qwik']) |
| getValue | null | string | example.getValue() |
| getValues | null | array | example.getValues() |