Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mirari/vue3-fullscreen
A simple Vue 3.x component for fullscreen, based on screenfull.
https://github.com/mirari/vue3-fullscreen
Last synced: 3 months ago
JSON representation
A simple Vue 3.x component for fullscreen, based on screenfull.
- Host: GitHub
- URL: https://github.com/mirari/vue3-fullscreen
- Owner: mirari
- License: mit
- Created: 2021-05-30T14:18:26.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-26T11:26:58.000Z (about 1 year ago)
- Last Synced: 2024-06-29T11:33:51.877Z (4 months ago)
- Language: Vue
- Size: 401 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vue-3 - vue3-fullscreen - A simple Vue 3 component for fullscreen. (Packages)
README
# vue-fullscreen
A simple Vue.js component for fullscreen, based on [screenfull.js](https://github.com/sindresorhus/screenfull.js)
[](https://www.npmjs.com/package/vue-fullscreen)
[](https://www.npmjs.com/package/vue-fullscreen)
[](https://www.npmjs.com/package/vue-fullscreen)
[](https://www.npmjs.com/package/vue-fullscreen)
[](https://www.npmjs.com/package/vue-fullscreen)
[](https://mit-license.org/)
## [vue-fullscreen for vue2](https://github.com/mirari/vue-fullscreen)
## [Live demo](http://mirari.github.io/vue3-fullscreen/)
## Quick Example
- [Component](https://codepen.io/mirari/pen/LYWeNZM)
- [Api](https://codepen.io/mirari/pen/abJENpa)
- [Directive](https://codepen.io/mirari/pen/yLoQZLp)
- [Compatible handling in iPhone & Popups in fullscreen](https://codepen.io/mirari/pen/abJEVNe)
- [Navigate to a new page without exiting fullscreen](https://codepen.io/mirari/pen/oNZEOEw)
## [中文文档](https://mirari.cc/posts/vue3-fullscreen)
## Support
[Supported browsers](http://caniuse.com/fullscreen)
**Note**: In order to use this package in Internet Explorer, you need a Promise polyfill.
**Note**: Safari is supported on desktop and iPad, but not on iPhone.
**Note:** Navigating to another page, changing tabs, or switching to another application using any application switcher (or Alt-Tab) will likewise exit full-screen mode.
[Learn more](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API)
## Installation
Install from NPM
```bash
npm install vue-fullscreen@next
```
## Usage
To use `vue-fullscreen`, simply import it, and call `app.use()` to install.
The component, directive and api will be installed together in the global.
```ts
import { createApp } from 'vue'
import VueFullscreen from 'vue-fullscreen'
import App from './App.vue'
export const app = createApp(App)
app.use(VueFullscreen)
app.mount('#app')
```
```vue
content
FullscreenApi
FullscreenDirective
import {
ref,
defineComponent,
toRefs,
reactive
} from 'vue'
export default defineComponent({
methods: {
toggleApi () {
this.$fullscreen.toggle()
}
},
setup () {
const root = ref()
const state = reactive({
fullscreen: false,
})
function toggle () {
state.fullscreen = !state.fullscreen
}
return {
root,
...toRefs(state),
toggle
}
}
})
```
**Caution:** Because of the browser security function, you can only call these methods by a user gesture(`click` or `keypress`).
### Usage of api
In your vue component, You can use `this.$fullscreen` to get the instance.
```javascript
this.$fullscreen.toggle()
```
Or you can just import the api method and call it.
```vue
Content
Fullscreen
import {
ref,
defineComponent,
toRefs,
reactive,
} from 'vue'
import { api as fullscreen } from 'vue-fullscreen'
export default defineComponent({
setup() {
const root = ref()
const state = reactive({
fullscreen: false,
teleport: true,
})
async function toggle () {
await fullscreen.toggle(root.value.querySelector('.fullscreen-wrapper'), {
teleport: state.teleport,
callback: (isFullscreen) => {
// state.fullscreen = isFullscreen
},
})
state.fullscreen = fullscreen.isFullscreen
}
return {
root,
...toRefs(state),
toggle,
}
},
})
```
### Methods & Attributes
#### toggle([target, options, force])
Toggle the fullscreen mode.
- **target**:
- Type: `Element`
- Default: `document.body`
- The element target for fullscreen.
- **options** (optional):
- Type: `Object`
- The fullscreen options.
- **force** (optional):
- Type: `Boolean`
- Default: `undefined`
- pass `true` to force enter , `false` to exit fullscreen mode.
#### request([target, options])
enter the fullscreen mode.
- **target**:
- Type: `Element`
- Default: `document.body`
- The element target for fullscreen.
- **options** (optional):
- Type: `Object`
- The fullscreen options.
#### exit()
exit the fullscreen mode.
**Note:** Each of these methods returns a promise object, and you can get the state after the promise has been resolved, or you can pass a callback function in options to get.
```javascript
async toggle () {
await this.$fullscreen.toggle()
this.fullscreen = this.$fullscreen.isFullscreen
}
```
#### isFullscreen
get the fullscreen state.
- Type: `Boolean`
**Caution:** The action is asynchronous, you can not get the expected state immediately following the calling method.
#### isEnabled
check browser support for the fullscreen API.
- Type: `Boolean`
#### element
get the fullscreen element.
- Type: `Element | null`
### Options
### callback
- Type: `Function`
- Default: `null`
It will be called when the fullscreen mode changed.
### fullscreenClass
- Type: `String`
- Default: `fullscreen`
The class will be added to target element when fullscreen mode is on.
#### pageOnly
- Type: `Boolean`
- Default: `false`
If `true`, only fill the page with current element.
**Note:** If the browser does not support full-screen Api, this option will be automatically enabled.
#### teleport
- Type: `Boolean`
- Default: `true`
If `true`, the target element will be appended to `document.body` when it is fullscreen.
This can avoid some pop-ups not being displayed.
## Use as directive
You can use `v-fullscreen` to make any element have the effect of switching to full screen with a click.
```html
FullScreen
```
Or you can just import the directive and install it.
```vue
Content
Fullscreen
import {
ref,
defineComponent,
toRefs,
reactive
} from 'vue'
import { directive as fullscreen } from 'vue-fullscreen'
export default defineComponent({
directives: {
fullscreen
},
setup () {
const root = ref()
const state = reactive({
options: {
target: ".fullscreen-wrapper",
callback (isFullscreen) {
console.log(isFullscreen)
},
},
})
return {
root,
...toRefs(state),
toggle
}
}
})
```
### Modifiers
#### pageOnly
only fill the page with current element.
#### teleport
the component will be appended to `document.body` when it is fullscreen.
This can avoid some pop-ups not being displayed.
### Options
#### target
- Type: `String | Element`
- Default: `document.body`
The element can be specified using a style selector string, equivalent to `document.querySelector(target)`. Note that when passing an element object directly, you need to make sure that the element already exists. The internal elements of the current component may not be initialized when the directive is initialized.
#### callback
- Type: `Function`
- Default: `null`
It will be called when the fullscreen mode changed.
#### fullscreenClass
- Type: `String`
- Default: `fullscreen`
The class will be added to target element when fullscreen mode is on.
## Usage of component
You can simply import the component and register it locally too.
```vue
Content
Fullscreen
import {
defineComponent,
toRefs,
reactive,
} from 'vue'
import { component } from 'vue-fullscreen'
export default defineComponent({
name: 'ComponentExample',
components: {
fullscreen: component,
},
setup() {
const state = reactive({
fullscreen: false,
teleport: true,
pageOnly: false,
})
function toggle() {
state.fullscreen = !state.fullscreen
}
return {
...toRefs(state),
toggle,
}
},
})
```
### Props
#### fullscreen-class
- Type: `String`
- Default: `fullscreen`
The class will be added to the component when fullscreen mode is on.
#### exit-on-click-wrapper
- Type: `Boolean`
- Default: `true`
If `true`, clicking wrapper will exit fullscreen.
#### page-only
- Type: `Boolean`
- Default: `false`
If `true`, only fill the page with current element.
**Note:** If the browser does not support full-screen Api, this option will be automatically enabled.
#### teleport
- Type: `Boolean`
- Default: `true`
If `true`, the component will be appended to `document.body` when it is fullscreen.
This can avoid some pop-ups not being displayed.
### Events
#### change
- **isFullscreen**: The current fullscreen state.
This event fires when the fullscreen mode changed.
## Plugin options
### name
- Type: `String`
- Default: `fullscreen`
If you need to avoid name conflict, you can import it like this:
```ts
import { createApp } from 'vue'
import VueFullscreen from 'vue-fullscreen'
import App from './App.vue'
export const app = createApp(App)
app.use(VueFullscreen, {
name: 'fs',
})
app.mount('#app')
```
```vue
content
FullscreenApi
FullscreenDirective
import {
ref,
defineComponent,
toRefs,
reactive
} from 'vue'
export default defineComponent({
methods: {
toggleApi () {
this.$fs.toggle()
}
},
setup () {
const root = ref()
const state = reactive({
fullscreen: false,
})
function toggle () {
state.fullscreen = !state.fullscreen
}
return {
root,
...toRefs(state),
toggle
}
}
})
```