Auth-tap NPM | npm.io

Auth-Tap

Auth-Tap is a lightweight library designed to integrate one-tap social login functionality, starting with Google and extendable to support other providers like Facebook, Twitter, and more in the future.

Features

Google One Tap Login: Quickly integrate Google One Tap sign-in.
Extendable: Designed to support additional providers such as Facebook and Twitter.
Easy to Use: Minimal configuration required for fast implementation.
TypeScript Support: Fully typed for a better developer experience.

Installation

Install the library via npm or yarn:

npm install auth-tap

or 

yarn add auth-tap

Usage

Google One Tap Integration

Here’s an example of how to use auth-tap to integrate Google One Tap:

import authTap from "auth-tap";

authTap(
  {
    client_id: "your-google-client-id",
    auto_select: true,
    context: "signup",
  },
  (response) => {
    console.log("User signed in:", response);
  }
);

Options

Name	Type	Default	Description
client_id	String	Required	The client ID of your Google application.
auto_select	Boolean	false	Enables automatic selection.	null
cancel_on_tap_outside	Boolean	false	Cancels the prompt if the user clicks outside the prompt.
context	String	false	The title in the One Tap prompt. Allowed parameters: "signin", "signup", "use"
login_uri	URL	false	The URL of your login endpoint. The Sign In With Google button redirect UX mode uses this attribute.
prompt_parent_id	String	false	The DOM ID of the One Tap prompt container element
nonce	String	false	A random string for ID tokens
ux_mode	String	false	The Sign In With Google button UX flow Allowed parameters: "redirect", "popup"

Callback

The callback function is invoked when the user successfully signs in. The response contains the user credentials or token, which you can use for further authentication or API requests.

Extendability

Future versions of auth-tap will include support for other social login providers, such as Facebook and Twitter. Stay tuned!

TypeScript

auth-tap is fully typed, and TypeScript developers will benefit from the provided type definitions. Here's an example:

import authTap, { GoogleOneTapOptions } from "auth-tap";

const options: GoogleOneTapOptions = {
  client_id: "your-google-client-id",
  context: "signin",
};

authTap(options, (response) => {
  console.log("Signed in:", response);
});

Contributing

We welcome contributions! If you'd like to add support for additional social login providers or improve the library, feel free to fork the repository and submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

google one-tap signin typescript

0.0.2

8 months ago

0.0.1

8 months ago