---
title: useComponentHideState
summary: 介绍 useComponentHideState hook 用于获取 Widget 显示或隐藏状态。
---

# useComponentHideState

> useComponentHideState 需要在注册到播放器里的 Widget 组件内部才能使用


播放器内置实现了以下逻辑：点击播放器，隐藏所有 **Widget**, 再次点击显示所有 **Widget**、或者连续一段时间不操作隐藏所有 **Widget** 的逻辑。

该 hooks 用于获取当前屏幕上的 **Widget** 是否应该显示的状态，true 为需要显示, false 为不需要显示

## 类型定义

```tsx
export type useComponentHideState = () => [boolean];
```

## 使用示例

```jsx
import React, { useEffect } from 'react';
import { View } from '@ray-js/components';
import {
  ComponentConfigProps,useComponentHideState
} from '@ray-js/ipc-player-integration';

function Widget1(props: ComponentConfigProps) {
  const [state] = useComponentHideState()
  console.log(state, 'state')
  
  return null;
}
```