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

use-local-credential-storage

v0.1.0

Published

React hook for storing and retrieving login credentials for a web app using localStorage

Downloads

3

Readme

use-local-credential-storage

version license

React hook for storing and retrieving login credentials for a web app using window.localStorage.

Works well with Create React App / Gatsby / JAMstack or any kind of app which needs to authenticate requests to some kind of API.

Usage

// Setting this to something unique to your app avoids pulling credentials for
// the wrong app, even if both apps occasionally run on e.g. localhost:3000.
const AUTH_NAMESPACE = 'com.yourcompany.yourapp';

Example login page

export function AuthPage(): JSX.Element {
  const {
    username: storedUsername,
    password: storedPassword,
    setCredentials,
    clearCredentials,
    credentialsAreSet,
  } = useLocalCredentialStorage({ namespace: AUTH_NAMESPACE });
  const [username, setUsername] = useState(() => storedUsername || '');
  const [password, setPassword] = useState(() => storedPassword || '');

  function handleSave(): void {
    setCredentials(username, password);
  }

  function handleClear(): void {
    clearCredentials();
    setUsername('');
    setPassword('');
  }

  return (
    <main>
      {credentialsAreSet ? (
        <p>Credentials are set</p>
      ) : (
        <p>Credentials are not set</p>
      )}
      <form onSubmit={event => event.preventDefault()}>
        <label htmlFor="username">Username</label>
        <input
          name="username"
          type="string"
          autoComplete="off"
          value={username}
          onChange={({ target: { value } }) => setUsername(value)}
        />
        <label htmlFor="password">Password</label>
        <input
          name="password"
          type="password"
          value={password}
          onChange={({ target: { value } }) => setPassword(value)}
        />
        <button onClick={handleSave}>Save</button>
        <p>
          {credentialsAreSet ? (
            <button onClick={handleClear}>Clear Credentials</button>
          ) : null}
        </p>
      </form>
    </main>
  );
}

Example component using credentials

export function ExamplePage(): JSX.Element {
  const { credentialsAreSet, username, password } = useLocalCredentialStorage({
    namespace: AUTH_NAMESPACE,
  });

  if (!credentialsAreSet) {
    return <div>Not logged in!</div>
  }

  // Do something with `username` and `password`.
  return ...
}

useLocalCredentialStorage() has a notification method built in. Whenever the credentials are set or cleared, any mounted component which invokes useLocalCredentialStorage() will re-render.

API

Parameters

  • namespace: An optional unique string to identify the app.

Return value

  • setCredentials(username?: string, password?: string)
  • clearCredentials()
  • credentialsAreSet: true if the username and password are both set.
  • username: The stored username.
  • password: The stored password.

License

This project is licensed under the 2-clause BSD license.