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-url-sync

v1.3.1

Published

use-url-sync is a utility package that helps you sync your states to url without hassle

Downloads

18

Readme

use-url-sync

npm CI minizip

use-url-sync is a set of tools that help you sync your state to URL. Along with this package, you can do some awesome stuff, such as:

  • Use state hook useUrlState to get value from current page path
  • Sync your states's values to path using useUrlSync or getUrlString

🖥️ Example

Let's say that the path is /user?name=andy&page=1&isEmployee=false

import React from 'react';
import { useLocation } from 'react-router-dom';
import { useSyncUrl, useUrlState } from 'use-url-sync';

const App = () => {
  const location = useLocation();

  /* Retrieve value from URL */
  const [page, setPage] = useUrlState({
    name: 'page',
    defaultValue: 0,
    onExists: p => parseInt(p, 10)
  });
  const [name, setName] = useUrlState({
    name: 'name',
    defaultValue: ''
  });
  const [isEmployee, setIsEmployee] = useUrlState({
    name: 'isEmployee',
    defaultValue: false,
    onExists: v => v === 'true'
  });

  /* Sync states to path */
  useUrlSync(
    {
      states: {
        name,
        page,
        isEmployee: `${isEmployee}`
      },
      /* Ignored conditions */
      ignore: {
        page: p => p === 0
      }
    },
    nextPath => {
      location.replace(nextPath);
    }
  );

  const incrementPage = () => setPage(p => p + 1);

  const decrementPage = () => setPage(p => p - 1);

  const toggleEmployeeStatus = () => {
    setIsEmployee(v => !v);
  };

  return (
    <>
      <div id="page-togglers">
        <button type="button" id="increase-page" onClick={incrementPage}>
          + 1
        </button>
        <button type="button" id="decrease-page" onClick={decrementPage}>
          - 1
        </button>
      </div>
      <button type="button" id="toggle-status" onClick={toggleEmployeeStatus}>
        Toggle Employee Status
      </button>
      <p id="current-page">{page}</p>
      <p id="current-name">{name}</p>
      <p id="current-isEmployee">{isEmployee ? 'true' : 'false'}</p>
    </>
  );
};

💾 Installation

npm install use-url-sync

or

yarn add use-url-sync

✔️ TypeScript Support

This package contains an index.d.ts type definition file, so you can use it in TypeScript without extra configuration.

  ...

  const [page, setPage] = useUrlState<number>({
    name: 'page',
    defaultValue: 0,
    onExists: (p: any) => parseInt(p, 10)
  });
  const [name, setName] = useUrlState<string>({
    name: 'name',
    defaultValue: ''
  });

  interface IStates {
    page: number;
    name: string;
  }

  useUrlSync<IStates>(
    {
      states: {
        page,
        name
      },
      ignore: {
        page: (p: number) => p === 0
      }
    },
    (nextPath: string) => {
      location.replace(nextPath);
    }
  );

  ...

🏷️ LICENSE

MIT License

Copyright (c) 2021 Ilham-Pratama

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.