Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/vinayakkulkarni/v-pip

🖼 Tiny vue wrapper for supporting native picture-in-picture mode.
https://github.com/vinayakkulkarni/v-pip

composition-api picture-in-picture pip vue vue-components vue2 vue3 vue3-demo vuejs

Last synced: 4 months ago
JSON representation

🖼 Tiny vue wrapper for supporting native picture-in-picture mode.

Host: GitHub
URL: https://github.com/vinayakkulkarni/v-pip
Owner: vinayakkulkarni
License: mit
Created: 2020-05-03T17:49:05.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-04-11T20:00:30.000Z (10 months ago)
Last Synced: 2024-04-14T09:51:39.079Z (10 months ago)
Topics: composition-api, picture-in-picture, pip, vue, vue-components, vue2, vue3, vue3-demo, vuejs
Language: Vue
Homepage: https://v-pip.netlify.app/
Size: 6.6 MB
Stars: 34
Watchers: 3
Forks: 6
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # [V-pip 🖼](https://github.com/vinayakkulkarni/v-pip#readme)

[![Continuous Integration](https://github.com/vinayakkulkarni/v-pip/actions/workflows/ci.yml/badge.svg)](https://github.com/vinayakkulkarni/v-pip/actions/workflows/ci.yml)

[![CodeQL](https://github.com/vinayakkulkarni/v-pip/actions/workflows/codeql.yml/badge.svg)](https://github.com/vinayakkulkarni/v-pip/actions/workflows/codeql.yml)

[![Ship js trigger](https://github.com/vinayakkulkarni/v-pip/actions/workflows/shipjs-trigger.yml/badge.svg)](https://github.com/vinayakkulkarni/v-pip/actions/workflows/shipjs-trigger.yml)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/vinayakkulkarni/v-pip?sort=semver&logo=github)](https://github.com/vinayakkulkarni/v-pip/releases)

[![npm](https://img.shields.io/npm/v/v-pip?logo=npm)](https://www.npmjs.com/package/v-pip)

[![npm](https://img.shields.io/npm/dm/v-pip?logo=npm)](http://npm-stat.com/charts.html?package=v-pip)

[![npm (downloads)](https://img.shields.io/npm/dm/v-pip.svg)](https://npm-stat.com/charts.html?package=v-pip)

[![npm bundle size (version)](https://img.shields.io/bundlephobia/min/v-pip/latest)](https://bundlephobia.com/package/v-pip@latest)

[![npm type definitions](https://img.shields.io/npm/types/v-pip)](https://github.com/vinayakkulkarni/v-pip/blob/master/package.json)

[![DeepScan grade](https://deepscan.io/api/teams/9055/projects/17923/branches/426854/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=9055&pid=17923&bid=426854)

[![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/vinayakkulkarni/v-pip)](https://snyk.io/test/github/vinayakkulkarni/v-pip)

[![license](https://img.shields.io/npm/l/v-pip)](https://github.com/vinayakkulkarni/v-pip/blob/master/LICENSE)

[![GitHub contributors](https://img.shields.io/github/contributors/vinayakkulkarni/v-pip)](https://github.com/vinayakkulkarni/v-pip/graphs/contributors)

[![eslint](https://img.shields.io/npm/dependency-version/v-pip/dev/eslint?logo=eslint)](https://eslint.org/)

[![prettier](https://img.shields.io/npm/dependency-version/v-pip/dev/prettier?logo=prettier)](https://prettier.io/)

[![vite](https://img.shields.io/npm/dependency-version/v-pip/dev/vite?logo=vite)](https://vitejs.dev/)

[![vue](https://img.shields.io/npm/dependency-version/v-pip/dev/vue?logo=vue.js)](https://vuejs.org/)

[![typescript](https://img.shields.io/npm/dependency-version/v-pip/dev/typescript?logo=TypeScript)](https://www.typescriptlang.org/)

---

## Demo

[![Edit v-pip](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/edit/v-pip?file=src/App.vue)

---

## Features

- Vue 💚 Picture-in-picture!

- Built from scratch using [TypeScript](https://www.typescriptlang.org)

---

### Versions

- For Vue 3.x version – `npm i v-pip`

- For Vue 2.x version – `npm i v-pip@1`

## Table of Contents

- [V-pip 🖼](#v-pip-)

  - [Demo](#demo)

  - [Features](#features)

    - [Versions](#versions)

  - [Table of Contents](#table-of-contents)

  - [Demo](#demo-1)

  - [Requirements](#requirements)

    - [Installation](#installation)

    - [Build Setup](#build-setup)

  - [Usage](#usage)

    - [Globally](#globally)

      - [As a component](#as-a-component)

      - [As a plugin](#as-a-plugin)

    - [Locally](#locally)

    - [HTML](#html)

    - [JS](#js)

    - [HTML](#html-1)

    - [JS](#js-1)

    - [Props](#props)

    - [Events](#events)

  - [Contributing](#contributing)

  - [Author](#author)

  - [License](#license)

## Demo

[![Edit v-pip demo](https://codesandbox.io/static/img/play-codesandbox.svg)](https://bit.ly/v-pip)

## Requirements

- [vue](https://vuejs.org/) `^3.x`

### Installation

```bash

npm install v-pip # yarn add v-pip

```

CDN: [UNPKG](https://unpkg.com/v-pip/dist/) | [jsDelivr](https://cdn.jsdelivr.net/npm/v-pip/dist/) (available as `window.VPip`)

### Build Setup

```bash

# install dependencies

$ npm ci

# package the library

$ npm run build

```

## Usage

### Globally

#### As a component

```javascript

import { VPip } from 'v-pip';

Vue.component('VPip', VPip);

```

#### As a plugin

```javascript

import Vue from 'vue';

import VPip from 'v-pip';

Vue.use(VPip);

```

### Locally

```javascript

import { VPip } from 'v-pip';

```

Example 1 (refer App.vue)

### HTML

```html

```

### JS

```javascript

import { VPip } from 'v-pip';

Vue.component('example-component', {

  components: {

    VPip,

  },

  data: () => ({

    isPip: false,

    videoOptions: {

      src: 'http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4',

      poster:

        'http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/images/BigBuckBunny.jpg',

      wrapper: '',

      class: '',

      height: '',

      width: '',

    },

    buttonOptions: {

      wrapper: '',

      type: 'button',

      class: '',

      label: 'Toggle picture-in-picture',

    },

  }),

  methods: {

    handlePIP(e) {

      this.isPip = e;

    },

    handlePipOpenFailure(err) {

      console.log('Video failed to enter Picture-in-Picture mode.', err);

    },

    handlePipExitFailure(err) {

      console.log('Video failed to leave Picture-in-Picture mode.', err);

    },

  },

});

```

Example 2 (minimal)

### HTML

```html

```

### JS

```javascript

import { VPip } from 'v-pip';

Vue.component('example-component', {

  components: {

    VPip,

  },

  data: () => ({

    videoOptions: {

      src: 'http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4',

    },

  }),

});

```

### Props

| Name             | Type   | Required? | Description                                               |

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

| `video-options`  | Object | Yes       | The set of options required to setup the V-Pip component. |

| `button-options` | Object | No        | The set of options for the toggle button                  |

### Events

| Name                     | Description                                                              |

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

| `video-in-pip`           | Emits an `Boolean` whether the Video is in PIP or not                    |

| `requesting-pip-failure` | Emits an `Object` when the video fails to enter Picture-in-Picture mode. |

| `exiting-pip-failure`    | Emits an `Object` when the video fails to leave Picture-in-Picture mode. |

## Contributing

1. Fork it ( [https://github.com/vinayakkulkarni/v-pip/fork](https://github.com/vinayakkulkarni/v-pip/fork) )

2. Create your feature branch (`git checkout -b feat/new-feature`)

3. Commit your changes (`git commit -Sam 'feat: add feature'`)

4. Push to the branch (`git push origin feat/new-feature`)

5. Create a new [Pull Request](https://github.com/vinayakkulkarni/v-pip/compare)

_Note_:

1. Please contribute using [GitHub Flow](https://web.archive.org/web/20191104103724/https://guides.github.com/introduction/flow/)

2. Commits & PRs will be allowed only if the commit messages & PR titles follow the [conventional commit standard](https://www.conventionalcommits.org/), _read more about it [here](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum)_

3. PS. Ensure your commits are signed. _[Read why](https://withblue.ink/2020/05/17/how-and-why-to-sign-git-commits.html)_

## Author

**v-pip** © [Vinayak](https://vinayakkulkarni.dev), Released under the [MIT](./LICENSE) License.


Authored and maintained by Vinayak Kulkarni with help from contributors ([list](https://github.com/vinayakkulkarni/v-pip/contributors)).

> [vinayakkulkarni.dev](https://vinayakkulkarni.dev) · GitHub [@vinayakkulkarni](https://github.com/vinayakkulkarni) · Twitter [@\_vinayak_k](https://twitter.com/_vinayak_k)

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvinayakkulkarni%2Fv-pip.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvinayakkulkarni%2Fv-pip?ref=badge_large)