# electrum-field

> Electrum Field handles state associated with form fields.

Latest version **1.7.1** (published 2017-04-02) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install electrum-field
pnpm add electrum-field
yarn add electrum-field
bun add electrum-field
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.7.1 |
| Published | 2017-04-02 |
| First published | 2015-12-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Epsitec SA |
| Maintainers | epsitec, samlebarbare, schroeterm |
| Keywords | electrum |

## Links

- npm: https://www.npmjs.com/package/electrum-field
- Repository: https://github.com/epsitec-sa/electrum-field
- Homepage: https://github.com/epsitec-sa/electrum-field#readme
- Issues: https://github.com/epsitec-sa/electrum-field/issues
- npm.io page: https://npm.io/package/electrum-field

## Dependencies (1)

- [electrum-utils](https://npm.io/package/electrum-utils.md) ^1.6.7

## Recent versions

- 1.7.1 (latest) — 2017-04-02
- 1.7.0 — 2017-04-02
- 1.6.4 — 2017-03-31
- 1.6.3 — 2017-02-26
- 1.6.2 — 2016-09-23
- 1.6.1 — 2016-05-04
- 1.6.0 — 2016-04-19
- 1.5.1 — 2016-04-19
- 1.5.0 — 2016-03-15
- 1.4.1 — 2016-03-14
- 1.4.0 — 2016-03-14
- 1.3.0 — 2016-02-01
- 1.2.3 — 2016-02-01
- 1.2.2 — 2016-01-26
- 1.2.1 — 2016-01-26
- … 5 more at https://npm.io/package/electrum-field/versions

## README

# Electrum Field

[![NPM version](https://img.shields.io/npm/v/electrum-field.svg)](https://www.npmjs.com/package/electrum-field)
[![Build Status](https://travis-ci.org/epsitec-sa/electrum-field.svg?branch=master)](https://travis-ci.org/epsitec-sa/electrum-field)
[![Build status](https://ci.appveyor.com/api/projects/status/8c6nooep3fbnoytc?svg=true)](https://ci.appveyor.com/project/epsitec/electrum-field)

The `electrum-field` module handles state associated with form fields and is
used by `electrum`.

# Manipulating field states

A field can have multiple states associated with it:

* A state describing whether the field is enabled or read-only.
* A state describing the position of the cursor or the selection.
* etc.

Each state is represented as a simple object.

# Fingerprint

The _fingerprint_ of a state is built by concatenating the sorted
names of the state's properties (property `id` is not included in
the computation of the fingerprint).

```javascript
import {FieldStates} from 'electrum-field';

const state = {
  id: '1234',
  begin: 12,
  end: 23
};

expect (FieldStates.fingerprint (state)).to.equal ('begin,end');
```

# FieldStates

The states are managed by class `FieldStates`, which maintains a read-only
array of simple state objects. An instance of `FieldStates` is **immutable**.

To create a `FieldStates` instance, use one of the static methods:

* `FieldStates.create ()` → creates an empty states collection.
* `FieldStates.from (s1, s2, ...)` → create a states collection based
  on the provided states `s1`, `s2`, etc.

To manipulate a `FieldStates` instance:

* `add (state)` → adds or updates the state based; matching with any
  existing states is based on the fingerprint.
* `remove (state)` → removes the state.
* `find (state)` → returns the immutable state (if it is found) or
  `undefined` otherwise.
* `get ()` → returns an immutable array of immutable states, as they
  are stored in the `FieldStates` instance.

Methods `remove()` and `find()` accept either a simple object (the
values of the fields are not used in the comparison) or a fingerprint
to specify the state.

Methods `add()` and `remove()` return a new instance of `FieldStates` if
the state changes; otherwise, they just return the same instance.

> Note: states are considered to be equal if they respond `true` to
> _shallow equality_. Since states should be simple objects where all
> properties are just value types, a shallow comparison is enough.

---
_Source: https://npm.io/package/electrum-field · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._