https://github.com/ryanve/ux

Website user preference API
https://github.com/ryanve/ux

javascript preferences

Last synced: 16 days ago
JSON representation

Website user preference API

• Host: GitHub
• URL: https://github.com/ryanve/ux
• Owner: ryanve
• License: 0bsd
• Created: 2014-03-25T18:58:51.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2020-09-10T23:09:34.000Z (about 4 years ago)
• Last Synced: 2024-05-02T00:08:57.942Z (7 months ago)
• Topics: javascript, preferences
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/ux
• Size: 17.6 KB
• Stars: 30
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# ux

#### website user preference API

ux uses `localStorage` to remember features such as user preferences or display modes.

## API

#### Methods

- [ux.enabled(feature?)](#enabled)

- [ux.disabled(feature?)](#disabled)

- [ux.known(feature?)](#known)

- [Emitters](#emitters)

  - [ux.enable(feature)](#enable)

  - [ux.disable(feature)](#disable)

  - [ux.toggle(feature)](#toggle)

  - [ux.forget(feature?)](#forget)

#### Notes

- feature can be any string

- features are either *enabled*, *disabled*, or *unknown*



#### `ux.enabled(feature?)`

- `ux.enabled()`: Get an array containing the names of all enabled features

- `ux.enabled(feature)`: Test if feature is enabled. Return boolean



#### `ux.disabled(feature?)`

- `ux.disabled()`: Get an array containing the names of all disabled features

- `ux.disabled(feature)`: Test if feature is disabled. Return boolean



#### `ux.known(feature?)`

- `ux.known()`: Get an array containing the names of all known features

- `ux.known(feature)`: Test if feature is known. Return boolean



#### `ux.enable(feature)`

- Enable feature, and trigger associated listeners



#### `ux.disable(feature)`

- Disable feature, and trigger associated listeners



#### `ux.toggle(feature)`

- Toggle (either enable or disable) feature, and trigger associated listeners



#### `ux.forget(feature)`

- Forget feature, and trigger associated listeners

#### `ux.forget()`

- Forget *all* features



### [Emitters](#emitters-group) have [emitter methods](https://github.com/ryanve/energy/tree/0.4.0#methods)

 - `.on(feature, listener)`

 - `.off(feature?, listener?)`

 - `.once(feature, listener)`

 - `.emit(feature, ...args)`

#### Emitter syntax

 - `ux.enable.on(feature, listener)`

 - `ux.disable.on(feature, listener)`

 - `ux.forget.on(feature, listener)`

 - `ux.enable.off(feature?, listener?)`

 - `ux.disable.off(feature?, listener?)`

 - `ux.forget.off(feature?, listener?)`

 - etc.

#### Emitter example

```js

// Listen for when 'crazycolors' is enabled

ux.enable.on('crazycolors', function(feature) {

  document.querySelector('html').classList.add(feature)

  console.log(feature + ' enabled')

})

// Enable 'crazycolors'

ux.enable('crazycolors')

```

You normally would want to also listen for when the same feature is disabled and do an opposing action. You're also likely to have multiple (and maybe related) features. `ux` doesn't care what your features do. It only provides the API for enabling, disabling, and remembering them. Do what makes sense for your features and users :)