0.0.4 • Published 2 years ago

@elum/vkid v0.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

GitHub license npm bundle size npm bundle size

@elum/vkid

Данная библиотека представляет из себя react компонент упрощающий авторизацию через платформу VK ID. Официальный пакет для работы с VK ID

@elum/vkid : ____ npm bundle size @vkontakte/superappkit _ npm bundle size

Установка

YARN

yarn add @elum/vkid

NPM

npm i -s @elum/vkid

Использование

import React, { FC, HTMLAttributes } from  "react";
import { LoginVKID } from  "@elum/vkid";

interface IApp extends HTMLAttributes<HTMLDivElement> { };

const App: FC<IApp> = () => (
	<div className="Login">
		<LoginVKID
			id={11111111}
			redirect={"https://example.com/login"}
			state={"any_data"}
			showAgreements
			showAgreementsDialog
			showAlternativeLogin
			radius={8}
			height={40}
			mode={"default"}
			skin={"primary"}
			scheme={"bright_light"}
			language={0}
			settings={{
				agreements: '',
				promo: '',
				vkc_behavior: '',
				vkc_auth_action: '',
				vkc_brand: '',
				vkc_display_mode: '',
			}}
			authAlternative={() =>  console.log("Альтернативная авторизация")}
			authSuccess={(data) =>  console.log(data)}
		/>
	</div>
);


export  default  App;

ПараметрТипОписаниеdefault
idnumberID приложения, от лица которого будет работать SDK.-
redirectstringURL для перехода в случае если пользователь не зарегистрирован/авторизирован в ВК-
statestringДанные которые будут находится в query в url после успешной авторизации" "
showAgreementsbooleanПоказывать политики под кнопкойfalse
showAlternativeLoginbooleanПоказывать кнопку альтернативной авторизацииfasle
showAgreementsDialogbooleanПоказывать окно подтверждения политик (если выключен showAgreements ) (В разработке)dev
radiusnumberРадиус скругления кнопок8
mode"default" | "name_phone" | "phone_name"Вид отображения данных пользователя"default"
skin"primary" | "flat"Стиль основной кнопки"primary"
scheme"bright_light" | "space_gray"Цветовая схема формы авторизации"bright_light"
languagenumberЯзык0
settings{ *** }Глобальные настройки приложения{}
authAlternative() => {}Событие вызывающее callback при нажатии пользователем на кнопку альтернативной авторизацииnull
authSuccess(data) => {}Событие вызывающее callback при успешной авторизации пользователя методом OneTapnull

Тип ответа authSuccess

payload:
  {
  auth: number;
  token: string;
  ttl: number;
  type: string;
  user:  {
  id: number;
  first_name: string;
  last_name: string;
  avatar: string;
  phone: string;
  };
  uuid: string;
  oauthProvider?: string;
  external_user?:  ExternalUser;
};
0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago