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

@rsiqueira/use-viacep

v1.5.3

Published

React hook to fetch Brazilian CEP's using ViaCEP api.

Downloads

191

Readme

useViaCep

use-viacep

React hook to fetch Brazilian CEP's using ViaCEP api.

Install

Use your prefer package manager

npm i --save @rsiqueira/use-viacep
# or
yarn add @rsiqueira/use-viacep
# or
pnpm add @rsiqueira/use-viacep

Usage

import * as React from 'react';
import * as ReactDOM from 'react-dom';
import useViaCep from '@rsiqueira/use-viacep';

const App = () => {
  const [data, setData] = React.useState('');
  const { cep, loading, error } = useViaCep(data);

  if (loading) {
    return <p>loading...</p>;
  }

  return (
    <div>
      <input placeholder="cep" onChange={(e) => setData(e.target.value)} />
    </div>
  );
};

ReactDOM.render(<App />, document.getElementById('root'));

Contributing

Clone this repository and run pnpm install. If you don't have pnpm, install it with npm install -g pnpm.

Folder structure

  • example - A folder with an example project. Think as playground.
  • lib - The source of @rsiqueira/use-viacep.

What is in this repository?

  • PNPM as workspace manager and package manager.
  • TSUP as a TypeScript universal package.
  • Vitest as a test runner.
  • Size Limit as a size limit plugin.
  • Prettier as a code formatter.
  • ESLint as a code linter.

Using the Playground

In the root of the repository, run the following command:

pnpm run dev # to build the library (with --watch flag)
pnpm -F example dev

The command will run the example project with Vite.

Sponsors

Sponsors

License

MIT @ Rai Siqueira