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

https://github.com/pansyjs/react-fullscreen

react fullscreen component
https://github.com/pansyjs/react-fullscreen

alitajs component fullscreen pansy react

Last synced: 6 months ago
JSON representation

react fullscreen component

Awesome Lists containing this project

README

        

# React Fullscreen(React 全屏组件)

[![Alita](https://img.shields.io/badge/alitajs-react%20fullscreen-blue.svg)](https://github.com/alitajs)
[![NPM version](https://img.shields.io/npm/v/@pansy/react-fullscreen.svg?style=flat)](https://npmjs.org/package@pansy/react-fullscreen)
[![NPM downloads](http://img.shields.io/npm/dm/@pansy/react-fullscreen.svg?style=flat)](https://npmjs.org/package/@pansy/react-fullscreen)

## ✨ 特性

- 🚀 基于 screenfull 封装
- 📦 基于 rollup 进行打包,提供`cjs`、`es`格式
- 💻 使用 TypeScript 构建,提供完整的类型定义文件

## 🏗 安装

```
# npm 安装
npm install @pansy/react-fullscreen --save

# yarn 安装 推荐
yarn add @pansy/react-fullscreen
```

## Props

### enabled

- 数据类型: `boolean`
- 默认值: `false`
- 描述: 是否全屏

### target

- 数据类型: `HTMLElement`
- 默认值: 无
- 描述: 需要控制的目标元素

## onClose

- 数据类型: `function`
- 默认值: 无
- 描述: 关闭全屏的回调

## ⌨️ 本地开发

```
# 克隆项目到本地
[email protected]:pansyjs/react-fullscreen.git

# 切换到项目目录
cd ./react-fullscreen

# 安装依赖
yarn
```

## 🌟 社区互助

| Github Issue | 钉钉群 | 微信群 |
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
| [issues](https://github.com/pansyjs/react-fullscreen/issues) | | |