# GameClubButton

游戏圈按钮。游戏圈按钮被点击后会跳转到小游戏的游戏圈。更多关于游戏圈的信息见 [游戏圈使用指南](/minigame/dev/guide/open-ability/game-club.md)

## 属性

### string icon

游戏圈按钮的图标，仅当 type 参数为 image 时有效。

**icon 的合法值**

| 值 | 说明 | 最低版本 |
| -- | ---- | ---- |
| green | 绿色的图标 |  |
| white | 白色的图标 |  |
| dark | 有黑色圆角背景的白色图标 |  |
| light | 有白色圆角背景的绿色图标 |  |

### string type

按钮的类型。

**type 的合法值**

| 值 | 说明 | 最低版本 |
| -- | ---- | ---- |
| text | 可以设置背景色和文本的按钮 |  |
| image | 只能设置背景贴图的按钮，背景贴图会直接拉伸到按钮的宽高 |  |

### string text

按钮上的文本，仅当 type 为 `text` 时有效

### string image

按钮的背景图片，仅当 type 为 `image` 时有效

### Object style

按钮的样式


```json
[
  {
    "属性": "left",
    "类型": "number",
    "说明": "左上角横坐标"
  },
  {
    "属性": "top",
    "类型": "number",
    "说明": "左上角纵坐标"
  },
  {
    "属性": "width",
    "类型": "number",
    "说明": "宽度"
  },
  {
    "属性": "height",
    "类型": "number",
    "说明": "高度"
  },
  {
    "属性": "backgroundColor",
    "类型": "string",
    "说明": "背景颜色"
  },
  {
    "属性": "borderColor",
    "类型": "string",
    "说明": "边框颜色"
  },
  {
    "属性": "borderWidth",
    "类型": "number",
    "说明": "边框宽度"
  },
  {
    "属性": "borderRadius",
    "类型": "number",
    "说明": "边框圆角"
  },
  {
    "属性": "color",
    "类型": "string",
    "说明": "文本的颜色。格式为 6 位 16 进制数。"
  },
  {
    "属性": "textAlign",
    "类型": "string",
    "说明": "文本的水平居中方式",
    "子项": [
      {
        "合法值": "left",
        "说明": "居左"
      },
      {
        "合法值": "center",
        "说明": "居中"
      },
      {
        "合法值": "right",
        "说明": "居右"
      }
    ]
  },
  {
    "属性": "fontSize",
    "类型": "number",
    "说明": "字号"
  },
  {
    "属性": "lineHeight",
    "类型": "number",
    "说明": "文本的行高"
  }
]
```

## 方法

### [GameClubButton.show()](/minigame/dev/api/open-api/game-club/GameClubButton.show)

显示游戏圈按钮

### [GameClubButton.hide()](/minigame/dev/api/open-api/game-club/GameClubButton.hide)

隐藏游戏圈按钮

### [GameClubButton.destroy()](/minigame/dev/api/open-api/game-club/GameClubButton.destroy)

销毁游戏圈按钮

### [GameClubButton.onTap(function listener)](/minigame/dev/api/open-api/game-club/GameClubButton.onTap)

监听游戏圈按钮的点击事件

### [GameClubButton.offTap(function listener)](/minigame/dev/api/open-api/game-club/GameClubButton.offTap)

移除游戏圈按钮的点击事件的监听函数