j-catania / ngx-apple-signin

An Angular 8+ component for Apple Signin \o/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Angular8+ Apple Sign In component

An Angular 8+ component for Apple Sign In \o/

NPM Version NPM Version NPM Version Dependencies Badge Dev Dependencies Badge Publish to NPMJs

Contributing

Feel free to open issues and pull requests. If you would like to be one of the core creators of this library, please reach out to me at julien.catania@gmail.com

Component versions matches Angular versions

Please note that the ng8-apple-signin package is now deprecated

Angular version NPM version NPM install command
8.x.x 8.0.3 npm install ngx-apple-signin@8.0.3
9.x.x 9.0.0 npm install ngx-apple-signin@9.0.0
10.x.x 10.0.2 npm install ngx-apple-signin@10.0.2

Getting Started

1 - Download the library using npm npm install ngx-apple-signin

2 - Declare the library in your main module

  import {NgModule} from '@angular/core';
  import {BrowserModule} from '@angular/platform-browser';
  import { AppleSigninModule } from 'ngx-apple-signin'

  @NgModule({
    declarations: [...],
    imports: [
      BrowserModule,
      AppleSigninModule
    ],
    bootstrap: [...]
  })
  export class AppModule {
  }

3 - Add the Apple JavaScript file in your index.html (more details here)

  <!doctype html>
  <html lang="en">
  <head>
    <meta charset="utf-8">
    <title>My App</title>
    <base href="/">
  
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script type="text/javascript" src="https://appleid.cdn-apple.com/appleauth/static/jsapi/appleid/1/en_US/appleid.auth.js"></script>
  
  </head>
  <body>
    [...]
  </body>
  </html>

4 - Just call the component

   <apple-signin   [state]="yourStateVar"
                   [redirectURI]="yourRedirectURIVar"
                   [scope]="yourScopeVar"
                   [clientId]="yourClientIdVar"
                   color="light"
                   type="sign up"></apple-signin>

4.1 - This is how Color Enum and Type Enum looks like

enum Color {
 black = 'black',
 light = 'light'
}
enum Type {
 SignIn = 'sign in',
 SignUp = 'sign up',
 Apple = 'apple',
 Continue = 'continue'
}

5 - Enjoy it !


To do list:

  1. Change the Apple Javascript import to the project itself (step 3 will be deleted)

About

An Angular 8+ component for Apple Signin \o/


Languages

Language:TypeScript 71.2%Language:JavaScript 22.3%Language:HTML 5.0%Language:SCSS 1.4%