@getdrip/much-selector-elm

<much-selector>

A web component - powered by Elm - that will create a powerful select menu.

Prior Art/Inspiration/Goals

The project draws heavy inspiration from the jquery based selectize.js.

The need for this project is that we want to use selectize.js however we need the over all app to be built in Elm. Elm needs to "own" the DOM and selectize is built in a way that's not compatible with that.

The goal for this project to achieve near feature parity with selectize using web components. The API will be different, so it will not be a drop in replacement but hopefully it will not be too hard to replace one with the other.

Installation

npm i much-selector-elm

Usage

The npm package gives you the class MuchSelector (which inherits from HTMLElement), what you need to do is use it to define your own element.

import MuchSelector from "@getdrip/much-selector-elm";

if (!customElements.get("much-selector")) {
  // Putting guard rails around this because browsers do not like
  //  having the same custom element defined more than once.
  window.customElements.define("much-selector", MuchSelector);
}

Development

To work on this project, clone the repo to your machine, then.

Initial Setup

Just do like you'd expect to get started. Only development dependencies.

npm install

Watch and Develop

To run a webpack development server with the sandbox/demo page:

npm run watch

Now you can visit http://localhost:8000

Production Build

To do a production build run

npm run build

API

DOM

Attributes

selected

The selected attribute is used to set the value of the <much-selector>.

placeholder

The placeholder attribute is used to set the placeholder in the text input of the <much-selector>. Just like in the <input type="text"> it should only show up if the input is empty.

Options

Events

Functions