Giter VIP home page Giter VIP logo

apple-sign-in's Introduction

Capacitor Sign in With Apple

All Contributors

All Contributors

Capacitor plugin to support Sign in With Apple

Maintainers

Maintainer GitHub Social Sponsoring Company
Max Lynch mlynch @maxlynch Ionic

Maintenance Status: Partially Maintained (help wanted)

Installation

To use npm

npm install @capacitor-community/apple-sign-in

To use yarn

yarn add @capacitor-community/apple-sign-in

Sync native files

npx cap sync

Usage (iOS)

import { Plugins } from "@capacitor/core";
import { ResponseSignInWithApplePlugin } from "@capacitor-community/apple-sign-in";

const { SignInWithApple } = Plugins;

try {
  const response: ResponseSignInWithApplePlugin = await SignInWithApple.authorize();
} catch (e) {
  console.error(e);
}

Usage (Web)

  1. Initialize the plugin
import {
  SignInResponse,
  SignInError,
} from "@capacitor-community/apple-sign-in";

const { Device } = Plugins;

let device = await Device.getInfo();

if (device.platform === "web") {
  // Configure and initialize the plugin with correct values
  SignInWithApple.init({
    clientId: "[CLIENT_ID]",
    scope: "[SCOPES]", // scope=name email
    redirectURI: "[REDIRECT_URI]",
    state: "[STATE]",
    usePopup: true, //or false defaults to false
  });
}
  1. Call the plugin when need to authorize user. You can either...
    • Request to Sign in programically
    SignInWithApple.authorize()
      .then((response: SignInResponse) => {
        console.log(response);
      })
      .catch((error: SignInError) => {
        console.error(error);
      });
    • Or, use the default apple button style by adding the HTML below to your desired location of where the login button would appear
    <div
      id="appleid-signin"
      data-color="black"
      data-border="true"
      data-type="sign in"
    ></div>

Authorization callback listeners can be configured by adding AppleIDSignInOnSuccess and AppleIDSignInOnFailure

//Listen for authorization success
document.addEventListener("AppleIDSignInOnSuccess", (data) => {
  console.log(data);
});

//Listen for authorization failures
document.addEventListener("AppleIDSignInOnFailure", (error) => {
  console.error(error);
});

Contributors โœจ

Thanks goes to these wonderful people (emoji key):


Masahiko Sakakibara

๐Ÿ’ป

This project follows the all-contributors specification. Contributions of any kind welcome!

apple-sign-in's People

Contributors

allcontributors[bot] avatar galvingao avatar mlynch avatar priyankpat avatar rdlabo avatar rlfrahm avatar vildhjarta8 avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.