Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/demjhonsilver/embedplay-tiktok-vue

This package provides a flexible and easy way to integrate TikTok videos into your Vue application with customizable display options.
https://github.com/demjhonsilver/embedplay-tiktok-vue

embed embedded iframe player-video tiktok tiktok-video tiktok-videos tiktok-vue3 video-player vue3 vuejs

Last synced: about 1 month ago
JSON representation

This package provides a flexible and easy way to integrate TikTok videos into your Vue application with customizable display options.

Awesome Lists containing this project

README 

        






# Embedplay TikTok Vue



[![npm version](https://img.shields.io/npm/v/embedplay-tiktok-vue.svg?logo=npm&style=flat-square&label=Latest&color=blue)](https://www.npmjs.com/package/embedplay-tiktok-vue)

![Build Status](https://img.shields.io/badge/Build-Passing-brightgreen?style=flat-square)

![Package Size](https://img.shields.io/bundlephobia/minzip/embedplay-tiktok-vue?style=flat-square&color=yellow)

![Downloads](https://img.shields.io/npm/dt/embedplay-tiktok-vue.svg?style=flat-square&label=Downloads&color=orange)

[![License](https://img.shields.io/npm/l/embedplay-tiktok-vue.svg?style=flat-square&label=License&color=green)](https://github.com/demjhonsilver/embedplay-tiktok-vue/blob/main/LICENSE.md)






---------------------



## Table of Contents



- [Description](#description)

- [Release Notes](#release-notes)

- [Installation](#installation)

- [Paradigm](#paradigm)

- [License](#license)

- [Author](#author)



## Description



[Read the Documentation - TikTok Developers](https://developers.tiktok.com/doc/embed-player?enter_method=left_navigation)



This package provides a flexible and easy way to integrate TikTok videos into your Vue application with customizable display options.



This Vue component template is designed to embed a TikTok video player using the EmbedplayTikTokVue component. 



Framework | Supported versions

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

![Vue.js](https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D)  | 3 & above



-----



## Release-notes



Major Changes:



 v1.0.0

 - This Vue component renders a customizable TikTok player within an iframe, allowing users to embed TikTok posts directly into their applications. 



 - The component supports a flexible border radius, allowing you to easily adjust the corner curvature of the iframe to fit your design needs.



___________



## Installation



To install the Embedplay TikTok Vue, you can use the following npm command:



```bash

npm install embedplay-tiktok-vue

```



--------



------------

------------

## Paradigm



```js



  


    

  



import EmbedplayTikTokVue  from 'embedplay-tiktok-vue';



```

For global usage (main.js)



```js

import { createApp } from 'vue';

import './style.css'; 

import App from './App.vue';

import router from './router';

import EmbedplayTikTokVue from 'embedplay-tiktok-vue'; // Import global



createApp(App)

  .component('EmbedplayTikTokVue', EmbedplayTikTokVue) 

  .use(router) 

  .mount('#app');



```



If you choose global, you can use the code below:



```js



    



```



--------

Optional

--------



You can set any number for the border radius parameter:



```js

     :borderRadius="10" // You can set any number value.

```

Example:



```js

    

```



If you don't want to apply a border radius, simply remove the parameter.

______________________________________________



## License



MIT



- This package is distributed under the MIT License, which permits free use, modification, and distribution of the software.



[Source: TikTok Developers ](https://developers.tiktok.com/doc/overview)

----------------------------------------------------

## Author



Demjhon Silver