# ContextMenu

函数式创建右键菜单组件， 只要能拿到 dom 的 `event` 对象就能为其创建右键菜单。

## 代码演示

<CodePreview src="/doc-feat/context-menu" :height="400">
<details>
<summary>展开查看</summary>

```vue
<template>
  <PageWrapper title="右键菜单示例">
    <CollapseContainer title="Simple">
      <a-button type="primary" @contextmenu="handleContext"> Right Click on me </a-button>
    </CollapseContainer>

    <CollapseContainer title="Multiple" class="mt-4">
      <a-button type="primary" @contextmenu="handleMultipleContext"> Right Click on me </a-button>
    </CollapseContainer>
  </PageWrapper>
</template>
<script lang="ts" setup>
  import { PageWrapper, useContextMenu, useMessage } from '@eciol/ant-ui';
  import { CollapseContainer } from '@eciol/share-ui';

  const [createContextMenu] = useContextMenu();
  const { createMessage } = useMessage();
  function handleContext(e: MouseEvent) {
    createContextMenu({
      event: e,
      items: [
        {
          label: 'New',
          icon: 'bi:plus',
          handler: () => {
            createMessage.success('click new');
          },
        },
        {
          label: 'Open',
          icon: 'bx:bxs-folder-open',
          handler: () => {
            createMessage.success('click open');
          },
        },
      ],
    });
  }

  function handleMultipleContext(e: MouseEvent) {
    createContextMenu({
      event: e,
      items: [
        {
          label: 'New',
          icon: 'bi:plus',

          children: [
            {
              label: 'New1-1',
              icon: 'bi:plus',
              divider: true,
              children: [
                {
                  label: 'New1-1-1',
                  handler: () => {
                    createMessage.success('click new');
                  },
                },
                {
                  label: 'New1-2-1',
                  disabled: true,
                },
              ],
            },
            {
              label: 'New1-2',
              icon: 'bi:plus',
            },
          ],
        },
      ],
    });
  }
</script>

```
</details>
</CodePreview>

## Usage

```vue
<template>
  <div>
    <a-button type="primary" @contextmenu="handleContext">Right Click on me</a-button>
  </div>
</template>
<script lang="ts" setup>
  import { CollapseContainer } from '@eciol/share-ui';
  import { useMessage, useContextMenu } from '@eciol/ant-ui';

  const [createContextMenu] = useContextMenu();
  const { createMessage } = useMessage();
  function handleContext(e: MouseEvent) {
    createContextMenu({
      event: e,
      items: [
        {
          label: 'New',
          icon: 'ant-design:plus-outlined',
          handler: () => {
            createMessage.success('click new');
          },
        },
        {
          label: 'Open',
          icon: 'ant-design:folder-open-filled',
          handler: () => {
            createMessage.success('click open');
          },
        },
      ],
    });
  }
</script>
```

## createContextMenu

**Options**

| 属性  | 类型                | 默认值 | 可选值 | 说明                                     |
| ----- | ------------------- | ------ | ------ | ---------------------------------------- |
| event | `Event`             | -      | -      | 需要创建的 dom 的 `Event` 对象           |
| items | `ContextMenuItem[]` | -      | -      | 右键菜单列表，`ContextMenuItem`见下方说明 |

**ContextMenuItem**

| 属性     | 类型       | 说明              |
| -------- | ---------- | ----------------- |
| label    | `string`   | 文本              |
| icon     | `string`   | 图标,参考图标组件 |
| disabled | `boolean`  | 是否禁用          |
| handler  | `()=>void` | 点击触发函数      |
