state-toggle
Advanced tools
Package description
The state-toggle npm package provides a simple utility to manage toggle states. It is particularly useful for managing binary states such as on/off, true/false, or active/inactive in applications. This package helps in creating a toggle function that can switch between two states and also provides a method to get the current state.
Creating a toggle
This feature allows you to create a toggle between two states. The `toggle` function initializes the state and provides a method to switch between the initialized states. The example demonstrates initializing a toggle between 'on' and 'off' and toggling between these states.
const toggle = require('state-toggle');
const myToggle = toggle('on', 'off');
console.log(myToggle()); // 'on'
console.log(myToggle.toggle()); // 'off'
console.log(myToggle()); // 'off'Getting the current state
This feature is used to retrieve the current state of the toggle. The example shows how to initialize a toggle and retrieve the state before and after toggling.
const toggle = require('state-toggle');
const myToggle = toggle('active', 'inactive');
console.log(myToggle()); // 'active'
myToggle.toggle();
console.log(myToggle()); // 'inactive'Similar to state-toggle, flip-toggle allows for toggling between two states. However, flip-toggle might offer additional features or a different API design, which could be preferred depending on specific project requirements.
Switchery is another package that provides functionality for creating switch controls that can toggle between two states. Unlike state-toggle, which is more focused on state management, Switchery also integrates visual components for web interfaces.
Readme
Enter/exit a state.
npm:
npm install state-toggle
var toggle = require('state-toggle')
var ctx = {on: false}
var enter = toggle('on', ctx.on, ctx)
var exit
// Entering:
exit = enter()
console.log(ctx.on) // => true
// Exiting:
exit()
console.log(ctx.on) // => false
toggle(key, initial[, ctx])Create a toggle, which when entering toggles key on ctx (or this, if ctx
is not given) to !initial, and when exiting, sets key on the context back to
the value it had before entering.
Function — enter.
enter()Enter the state.
If no ctx was given to toggle, the context object (this) of enter() is
used to toggle.
Function — exit.
exit()Exit the state, reverting key to the value it had before entering.
FAQs
Enter/exit a state
The npm package state-toggle receives a total of 1,385,996 weekly downloads. As such, state-toggle popularity was classified as popular.
We found that state-toggle demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.