mobius1-selectr

What is mobius1-selectr?

The mobius1-selectr npm package is a lightweight, dependency-free JavaScript library for creating customizable and feature-rich select boxes. It provides a variety of functionalities to enhance the user experience with dropdowns, including multi-select, search, and custom styling.

What are mobius1-selectr's main functionalities?

Basic Initialization

This code initializes a basic Selectr instance on a select element with the ID 'mySelect'.

const selectr = new Selectr('#mySelect');

Multi-Select

This code initializes a Selectr instance that allows multiple selections.

const selectr = new Selectr('#mySelect', { multiple: true });

Searchable Dropdown

This code initializes a Selectr instance with a search input to filter options.

const selectr = new Selectr('#mySelect', { searchable: true });

Custom Styling

This code initializes a Selectr instance with a custom CSS class for styling.

const selectr = new Selectr('#mySelect', { customClass: 'my-custom-class' });

Option Groups

This code initializes a Selectr instance with grouped options.

const selectr = new Selectr('#mySelect', { data: [{ text: 'Group 1', children: [{ value: '1', text: 'Option 1' }, { value: '2', text: 'Option 2' }] }, { text: 'Group 2', children: [{ value: '3', text: 'Option 3' }, { value: '4', text: 'Option 4' }] }] });

Other packages similar to mobius1-selectr

select2

Select2 is a jQuery-based replacement for select boxes. It supports searching, remote data sets, and infinite scrolling of results. Compared to mobius1-selectr, Select2 is more feature-rich but also heavier due to its jQuery dependency.

chosen-js

Chosen is a JavaScript plugin that makes long, unwieldy select boxes more user-friendly. It supports both single and multi-select options with search functionality. Chosen is similar to mobius1-selectr but has a more classic design and requires jQuery.

selectize

Selectize is a hybrid of a textbox and a select box. It offers tagging, remote data binding, and dynamic dropdowns. Selectize is more versatile than mobius1-selectr but also more complex to configure.

react-select

React-Select is a flexible and customizable select input control for React. It supports multi-select, async options, and custom styling. React-Select is specifically designed for React applications, making it different from the vanilla JavaScript approach of mobius1-selectr.

README

Selectr

A lightweight dependency-free select box replacement written in vanilla javascript. Similar to Select2 and Chosen without the dependencies.

Supports most modern browsers including IE9.

Features:

• Supports single and multiple select boxes
• Supports optgroups
• Searchable options
• Tagging support
• Custom events
• Custom styling
• Much more...

Demos | Documentation | Playground

---

Install

bower

bower install mobius1-selectr --save

npm

npm install mobius1-selectr --save

Browser

Grab the files from the CDN and include them in your page:

<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/selectr/2.1.2/selectr.min.css">

<script type="text/javascript" src="https://cdn.jsdelivr.net/selectr/2.1.2/selectr.min.js"></script>

CDN courtesy of jsDelivr

---

Initialisation

HTML

Start with a standard select box you want to convert:

<select id="mySelect">
	<option vlaue="value-1">Value 1</option>
	<option vlaue="value-2">Value 2</option>
	<option vlaue="value-3">Value 3</option>
	...
</select>

Javascript

You can then instantiate Selectr by passing a reference to your select box as the first parameter:

You can either pass a DOM node or a CSS3 selector string:

new Selectr(document.getElementById('#mySelect'));

// or 

new Selectr('#mySelect');

Selectr accepts a second parameter as an object with the options you want to set:

new Selectr('#mySelect', {
    searchable: false,
    width: 300
});

---

Change Log

v2.1.3

• Fixed bug with tagging system

v2.1.2

• New option closeOnScroll (#11) (see docs)
• Fixed bug with checking dropdown is on-screen (#10)
• Fixed navigation bug (70168f2)

v2.1.1

• new option allowDeselect (see docs)
• tabIndex enabled on th main container
• tabIndex disabled on search input when closed

v2.1.0

• New tagging feature (see docs)

New functions:

• addOption() (see docs)
• serialize() (see docs)
• destroy() (see docs)
• render() (see docs)

New options:

• taggable (see docs)
• tagSeperators (see docs)

Updated options:

• sortSelected (see docs)

v2.0.0

• Complete rewrite
• New options added
• New methods added
• New events added

Updated functions:

• getValue() (see docs)
• setValue() (see docs)

Added options:

• clearable (see docs)
• sortSelected (see docs)

Updated options:

• selectedValue is now used for both single and multi selects (see docs)

Removed options:

• ajax
• minChars
• emptyOption
• selectedValues
• selectedIndex, selectedIndexes

Removed events:

• selectr.change (see docs)

License

Copyright 2016 Karl Saunders

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.