Skip to content

Latest commit

 

History

History
207 lines (113 loc) · 4.48 KB

CreateScriptOptions.md

File metadata and controls

207 lines (113 loc) · 4.48 KB

@telegram-auth/react / CreateScriptOptions

Interface: CreateScriptOptions

The options to create the script.

Hierarchy

Table of contents

Properties

Properties

botUsername

botUsername: string

The username of the bot that will be used to authenticate the user.

Inherited from

LoginButtonProps.botUsername

Defined in

types.ts:25


authCallbackUrl

Optional authCallbackUrl: string

The URL where the auth data from Telegram will be sent.

Inherited from

LoginButtonProps.authCallbackUrl

Defined in

types.ts:20


buttonSize

Optional buttonSize: "large" | "medium" | "small"

The size of the button.

Default

'large'

Inherited from

LoginButtonProps.buttonSize

Defined in

types.ts:32


cornerRadius

Optional cornerRadius: number

The radius of the button corners.

Inherited from

LoginButtonProps.cornerRadius

Defined in

types.ts:37


lang

Optional lang: string

The language of the button.

Default

"en"

Inherited from

LoginButtonProps.lang

Defined in

types.ts:44


onAuthCallback

Optional onAuthCallback: (data: TelegramAuthData) => void

The callback function that will be called when the user is authenticated.

Type declaration

▸ (data): void

Parameters
Name Type
data TelegramAuthData
Returns

void

Inherited from

LoginButtonProps.onAuthCallback

Defined in

types.ts:49


requestAccess

Optional requestAccess: null | "write"

The access level that the bot will request.

Default

"write"

Inherited from

LoginButtonProps.requestAccess

Defined in

types.ts:56


showAvatar

Optional showAvatar: boolean

Whether to show the user's avatar.

Default

true

Inherited from

LoginButtonProps.showAvatar

Defined in

types.ts:63


widgetVersion

Optional widgetVersion: string | number

The version of the Telegram widget to deal with browser caching.

Inherited from

LoginButtonProps.widgetVersion

Defined in

types.ts:68