https://github.com/beyonk-group/svelte-social-auth

Social Auth for Svelte v3
https://github.com/beyonk-group/svelte-social-auth

authentication beyonk facebook facebook-login google google-login signin social social-authentication social-network sso svelte svelte-v3 vanilla-js

Last synced: 9 days ago
JSON representation

Social Auth for Svelte v3

• Host: GitHub
• URL: https://github.com/beyonk-group/svelte-social-auth
• Owner: beyonk-group
• Created: 2019-04-29T11:54:07.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-06T18:10:55.000Z (about 1 year ago)
• Last Synced: 2024-10-07T15:02:31.486Z (27 days ago)
• Topics: authentication, beyonk, facebook, facebook-login, google, google-login, signin, social, social-authentication, social-network, sso, svelte, svelte-v3, vanilla-js
• Language: Svelte
• Size: 266 KB
• Stars: 168
• Watchers: 8
• Forks: 20
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    


    


    

    


    




## Svelte Social Auth

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com) [![svelte-v3](https://img.shields.io/badge/svelte-v3-blueviolet.svg)](https://svelte.dev) [![publish](https://github.com/beyonk-adventures/svelte-social-auth/actions/workflows/deploy.yml/badge.svg)](https://github.com/beyonk-adventures/svelte-social-auth/actions/workflows/deploy.yml)

Google and Facebook Auth

SvelteKit

SSR Ready

Svelte v3

## installation

````npm i @beyonk/svelte-social-auth --save-dev````

## Usage

```jsx

 console.dir(e.detail.user)} />

 console.dir(e.detail.user)} />

  import { GoogleAuth, FacebookAuth } from '@beyonk/svelte-social-auth'

```

### Customising the buttons

Buttons have default graphics and text, however, both buttons are slotted, so simply put the button content you want inside:

```

  
my custom content


```

### Attributes

Common attributes:

| Attribute | Description | Type | Default |

|---|---|---| --- |

| text | Text of the sign-in button | string | 'Sign in with ' |

The attributes for the GoogleAuth component are:

| Attribute | Description | Type | Default |

|---|---|---| --- |

| clientId | Google service account client id | string | - |

The attributes for the FacebookAuth component are:

| Attribute | Description | Type | Default |

|---|---|---| --- |

| appId | Facebook app id | string | - |

### Events

The events fired by the GoogleAuth component are:

| Event | Purpose | Properties |

|---|---|---|

| on:auth-success | User authentication success | { user } |

| on:auth-failure | User authentication failure | { error } |

| on:init-error | Google Auth initialisation failure | { error } |

The events fired by the FacebookAuth component are:

| Event | Purpose | Properties |

|---|---|---|

| on:auth-success | User authentication success | { user } |

| on:auth-failure | User authentication failure | { error } |

### Developing / Contributing

Note that Facebook requires that you have HTTPS locally, despite their documentation to the contrary, so you will need to generate some SSL certs and point rollup config at them.

Put your app and client ids in an `.env` file

```bash

.env.local

VITE_GOOGLE_CLIENT_ID=

VITE_FACEBOOK_APP_ID=

``

```bash

pnpm dev

```