swift-select v1.1.1

SwiftSelect

SwiftSelect is a customizable plugin to enhance select elements with support for multi-selection, searching, custom events, and keyboard navigation.

Installation

Install via npm:

npm install swift-select

Usage

Initialization

To initialize SwiftSelect, pass in the wrapper element, options array, and (optionally) settings and events.

import SwiftSelect from 'swift-select';

const options = [
  { label: 'Option 1', value: 'option1' },
  { label: 'Option 2', value: 'option2' },
  { label: 'Option 3', value: 'option3' }
];

const settings = {
  multiple: true,             // Enables multi-selection
  searchable: true,           // Adds a search input field
  placeholder: 'Select...',   // Placeholder text
};

const events = {
  onSelectChange: (value) => {
    console.log('Selected value:', value);
  }
};

// Initialization
const selectWrapper = document.querySelector('#select-wrapper');
const swiftSelect = new SwiftSelect(selectWrapper, options, settings, events);

HTML Structure

Ensure the element you want to transform into a select has a wrapper:

<div id="select-wrapper"></div>

Options

SwiftSelect supports the following settings:

Events

You can hook into different events by passing an events object during initialization. For example:

• onSelectChange: Triggered when an option is selected or deselected.

const events = {
  onSelectChange: (value) => {
    console.log('Current selected value:', value);
  }
};

License

This project is licensed under the MIT License. See the LICENSE file for details.