Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/vchaptsev/vue-telegram-passport

Vue component for Telegram passport
https://github.com/vchaptsev/vue-telegram-passport

telegram telegram-passport vue vue-component

Last synced: 26 days ago
JSON representation

Vue component for Telegram passport

Lists

README 

        
Vue Telegram Passport




    

    


    


    

        

    

    

        

    

    

        

    





**vue-telegram-passport** is a Vue component for [Telegram Passport](https://telegram.org/blog/passport)



## Installation



Install with [npm](https://npmjs.com):



  ```bash

  $ npm i vue-telegram-passport

  ```



Install with [yarn](https://yarnpkg.com):



  ```bash

  $ yarn add vue-telegram-passport

  ```



or if you just want to try it out, [unpkg](https://unpkg.com/#/) has ready-to-use packages.



```html



```

## Usage



Import `vue-telegram-passport`, pass it to the `components` and use in your template



```html



  ...

  

    ...



import {vueTelegramPassport} from 'vue-telegram-passport'



export default {

  ...

  components: {vueTelegramPassport},

  ...

}



```



## Props

You can play around with options on the official [passport page](https://core.telegram.org/passport/example)



| Name              | Description                                                                   | Required | Default     |

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

| authParameters    | [docs](https://core.telegram.org/passport/sdk-javascript#authparameters)      | True     | null        |

| authButtonOptions | [docs](https://core.telegram.org/passport/sdk-javascript#authbuttonoptions)   | False    | {}          |



## Links

+ [Official blog post](https://telegram.org/blog/passport) – basic description and examples

+ [Official docs](https://core.telegram.org/passport) – bot preparation instructions

+ [Official JS SDK docs](https://core.telegram.org/passport/sdk-javascript) – fields, options descriptions