npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mathdoy/toggle

v1.1.0

Published

Toggle feature, a feature flag library for your backend and react frontend

Downloads

7

Readme

Installation

$ npm install --save @mathdoy/toggle

Note: This package povides the core functionality for toggle, but you might not to want to install it alone. If you are writing an application that will run react you should install @mathdoy/toggle-react next to this one. If you want to use it for your backend node server, we have an restify middleware that you should install @mathdoy/toggle-restify

import { createToggle } from "@mathdoy/toggle";

const toggle = createToggle({
  prefix: "X-FEAT-",
  features: {
    logo: false,
    foo: false,
  },
});

// Register new feature into Toggle
toggle.register("foo", true);

// Look if the feature is enabled or not return Boolean
toggle.isEnabled("foo"); // true

// Remove feature from registry
toggle.unregister("foo");

Using it with React

$ npm install --save @mathdoy/toggle @mathdoy/toggle-react
import React from "react";
import ReactDOM from "react-dom";
import { createToggle } from "@mathdoy/toggle";
import { ToggleProvider } from "@mathdoy/toggle-react";
import "./index.css";
import App from "./App";

const toggle = createToggle({
  features: {
    logo: false,
    foo: true,
    // ...features
  },
});

ReactDOM.render(
  <ToggleProvider toggle={toggle}>
    <App />
  </ToggleProvider>,
  document.getElementById("root")
);

Then in your components files

import React, { Component } from "react";
import { Toggle } from "@mathdoy/toggle-react";
import FeatureDisable from "./FeatureDisable";

// ...

class App extends Component {
  render() {
    return (
      <div className="App">
        <header className="App-header">
          <Toggle isEnabled="logo" disableComponent={<FeatureDisable />}>
            <img src={logo} className="App-logo" alt="logo" />
          </Toggle>
          <p>
            Edit <code>src/App.js</code> and save to reload.
          </p>
          <a
            className="App-link"
            href="https://reactjs.org"
            target="_blank"
            rel="noopener noreferrer"
          >
            Learn React
          </a>
        </header>
      </div>
    );
  }
}

export default App;

You can also bind toggle into your component props with withToggle

import {
  ToggleProvider,
  withToggle,
  togglePropType,
} from "@mathdoy/toggle-react";

// ...

class App extends Component {
  static propTypes = {
    toggle: togglePropType.isRequired,
  };

  render() {
    const { toggle } = this.props;

    return (
      <div className="App">{toggle.isEnabled("foo") && <div>foo</div>}</div>
    );
  }
}

export default withToggle(App);

See more information for toggle-react

Using it with restify

$ npm install --save @mathdoy/toggle @mathdoy/toggle-restify

See more information for toggle-restify

License

Toggle is licensed under the MIT License.