Select2 v4 theme for Bootstrap 5, inspired by select2-bootstrap4-theme
Works with Select2 v4.0 and v4.1
https://apalfrey.github.io/select2-bootstrap-5-theme/
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/select2@4.0.13/dist/css/select2.min.css" />
<script src="https://cdn.jsdelivr.net/npm/select2@4.0.13/dist/js/select2.full.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/select2-bootstrap-5-theme@1.1.1/dist/select2-bootstrap-5-theme.min.css" />
<!-- Or for RTL support -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/select2-bootstrap-5-theme@1.1.1/dist/select2-bootstrap-5-theme.rtl.min.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/css/select2.min.css" />
<script src="https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/js/select2.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/select2-bootstrap-5-theme@1.1.1/dist/select2-bootstrap-5-theme.min.css" />
<!-- Or for RTL support -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/select2-bootstrap-5-theme@1.1.1/dist/select2-bootstrap-5-theme.rtl.min.css" />
# npm
$ npm install select2-bootstrap-5-theme
# yarn
$ yarn add select2-bootstrap-5-theme
# composer
$ composer require apalfrey/select2-bootstrap-5-theme
<link rel="stylesheet" href="/path/to/select2.css">
<link rel="stylesheet" href="/path/to/select2-bootstrap-5-theme.min.css">
<!-- Or for RTL support -->
<link rel="stylesheet" href="/path/to/select2-bootstrap-5-theme.rtl.min.css">
@import "node_modules/select2/src/scss/core";
@import "node_modules/select2-bootstrap-5-theme/src/include-all";
// Basic
$("select").select2({
theme: "bootstrap-5",
});
// Small
$("select").select2({
theme: "bootstrap-5",
containerCssClass: "select2--small", // For Select2 v4.0
selectionCssClass: "select2--small", // For Select2 v4.1
dropdownCssClass: "select2--small",
});
// Large
$("select").select2({
theme: "bootstrap-5",
containerCssClass: "select2--large", // For Select2 v4.0
selectionCssClass: "select2--large", // For Select2 v4.1
dropdownCssClass: "select2--large",
});
This repo uses Gulp to compile the assets, see below for the included Gulp tasks and what they do;
Task | Description |
---|---|
gulp |
Cleans the dist directory, lints the scss, compiles the dev and min versions, starts browsersync and starts watching |
gulp clean |
Cleans the dist directory, removing the directory and it's contents |
gulp lint |
Lints the scss files using Stylelint, see .stylelintrc and stylelint-config-twbs-bootstrap for linting rules |
gulp compile |
Lints the scss, compiles the RTL and LTR dev and min versions |
gulp compile:dev |
Compiles the LTR dev version, saving in dist and examples |
gulp compile:min |
Compiles the LTR min version, saving in dist |
gulp compile:rtl:dev |
Compiles the RTL dev version, saving in dist and examples |
gulp compile:rtl:min |
Compiles the RTL min version, saving in dist |
gulp browsersync |
Sets up a browsersync server serving the examples directory for development |
gulp watch |
Watches all files in src , compiling the scss when changes are detected |
If you have ideas for improvements or changes, feel free to submit an issue, or if you have changes you'd like in the project, feel free to submit a pull request. Make sure you run gulp compile
before submitting a pull request to ensure the styles are compiled.
MIT License
Copyright (c) 2020 Andrew Palfrey <apalfrey@apalfrey.me>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.