test/element-plus
1
0
Fork 0
mirror of https://gitee.com/element-plus/element-plus.git synced 2024-12-15 09:50:58 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
55348b30b6
element-plus/website/docs/jp/dropdown.md
三咲智子 55348b30b6
style: use prettier (#3228) 
* style: use prettier

* style: just prettier format, no code changes

* style: eslint fix
object-shorthand, prefer-const

* style: fix no-void

* style: no-console
2021-09-04 19:29:28 +08:00

412 lines
15 KiB
Markdown
Raw Blame History

## Dropdown
リンクとアクションのリストを表示するためのトグルメニュー
### 基本的な使い方
dropdown メニューの上にカーソルを置くと、より多くのアクションが展開されます。
:::demo トリガ要素はデフォルトの `slot` でレンダリングされ、dropdown 部分は `dropdown` という名前の `slot` でレンダリングされます。デフォルトでは、トリガーとなる要素にカーソルを合わせたときに dropdown リストが表示され、クリックする必要はありません。
```html
<el-dropdown>
<span class="el-dropdown-link">
Dropdown List<i class="el-icon-arrow-down el-icon--right"></i>
</span>
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item>Action 1</el-dropdown-item>
<el-dropdown-item>Action 2</el-dropdown-item>
<el-dropdown-item>Action 3</el-dropdown-item>
<el-dropdown-item disabled>Action 4</el-dropdown-item>
<el-dropdown-item divided>Action 5</el-dropdown-item>
</el-dropdown-menu>
</template>
</el-dropdown>
<style>
.el-dropdown-link {
cursor: pointer;
color: #409eff;
}
.el-icon-arrow-down {
font-size: 12px;
}
</style>
```
:::
### トリガー要素
dropdown リストを起動するには、ボタンを使用します。
:::demo トリガ要素をボタングループに分割するには `split-button` を使います。項目 3 と項目 4 の間に区切り線を挿入したい場合は、項目 4 にクラス `divider` を追加します。
```html
<el-dropdown>
<el-button type="primary">
Dropdown List<i class="el-icon-arrow-down el-icon--right"></i>
</el-button>
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item>Action 1</el-dropdown-item>
<el-dropdown-item>Action 2</el-dropdown-item>
<el-dropdown-item>Action 3</el-dropdown-item>
<el-dropdown-item>Action 4</el-dropdown-item>
<el-dropdown-item>Action 5</el-dropdown-item>
</el-dropdown-menu>
</template>
</el-dropdown>
<el-dropdown split-button type="primary" @click="handleClick">
Dropdown List
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item>Action 1</el-dropdown-item>
<el-dropdown-item>Action 2</el-dropdown-item>
<el-dropdown-item>Action 3</el-dropdown-item>
<el-dropdown-item>Action 4</el-dropdown-item>
<el-dropdown-item>Action 5</el-dropdown-item>
</el-dropdown-menu>
</template>
</el-dropdown>
<style>
.el-dropdown {
vertical-align: top;
}
.el-dropdown + .el-dropdown {
margin-left: 15px;
}
.el-icon-arrow-down {
font-size: 12px;
}
</style>
<script>
export default {
methods: {
handleClick() {
alert('button click')
},
},
}
</script>
<!--
<setup>
import { defineComponent } from 'vue';
export default defineComponent({
setup() {
const handleClick = () => {
alert('button click');
};
return {
handleClick,
};
},
});
</setup>
-->
```
:::
### トリガーのかけ方
トリガー要素をクリックするか、その上にカーソルを置きます。
:::demo アトリビュート `trigger` を用いる。デフォルトでは `hover` である。
```html
<el-row class="block-col-2">
<el-col :span="8">
<span class="demonstration">hover to trigger</span>
<el-dropdown>
<span class="el-dropdown-link">
Dropdown List<i class="el-icon-arrow-down el-icon--right"></i>
</span>
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item icon="el-icon-plus">Action 1</el-dropdown-item>
<el-dropdown-item icon="el-icon-circle-plus"
>Action 2</el-dropdown-item
>
<el-dropdown-item icon="el-icon-circle-plus-outline"
>Action 3</el-dropdown-item
>
<el-dropdown-item icon="el-icon-check">Action 4</el-dropdown-item>
<el-dropdown-item icon="el-icon-circle-check"
>Action 5</el-dropdown-item
>
</el-dropdown-menu>
</template>
</el-dropdown>
</el-col>
<el-col :span="8">
<span class="demonstration">click to trigger</span>
<el-dropdown trigger="click">
<span class="el-dropdown-link">
Dropdown List<i class="el-icon-arrow-down el-icon--right"></i>
</span>
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item icon="el-icon-plus">Action 1</el-dropdown-item>
<el-dropdown-item icon="el-icon-circle-plus"
>Action 2</el-dropdown-item
>
<el-dropdown-item icon="el-icon-circle-plus-outline"
>Action 3</el-dropdown-item
>
<el-dropdown-item icon="el-icon-check">Action 4</el-dropdown-item>
<el-dropdown-item icon="el-icon-circle-check"
>Action 5</el-dropdown-item
>
</el-dropdown-menu>
</template>
</el-dropdown>
</el-col>
<el-col :span="8">
<span class="demonstration">right click to trigger</span>
<el-dropdown trigger="contextmenu">
<span class="el-dropdown-link">
Dropdown List<i class="el-icon-arrow-down el-icon--right"></i>
</span>
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item icon="el-icon-plus">Action 1</el-dropdown-item>
<el-dropdown-item icon="el-icon-circle-plus"
>Action 2</el-dropdown-item
>
<el-dropdown-item icon="el-icon-circle-plus-outline"
>Action 3</el-dropdown-item
>
<el-dropdown-item icon="el-icon-check">Action 4</el-dropdown-item>
<el-dropdown-item icon="el-icon-circle-check"
>Action 5</el-dropdown-item
>
</el-dropdown-menu>
</template>
</el-dropdown>
</el-col>
</el-row>
<style>
.el-dropdown-link {
cursor: pointer;
color: #409eff;
}
.el-icon-arrow-down {
font-size: 12px;
}
.demonstration {
display: block;
color: var(--el-text-color-secondary);
font-size: 14px;
margin-bottom: 20px;
}
</style>
```
:::
### メニューを非表示にする動作
クリックしたときにメニューが閉じるかどうかを定義するには `hide-on-click` を用いる。
:::demo デフォルトではメニュー項目をクリックするとメニューが閉じますが、hide-on-click を false にすることでオフにできます。
```html
<el-dropdown :hide-on-click="false">
<span class="el-dropdown-link">
Dropdown List<i class="el-icon-arrow-down el-icon--right"></i>
</span>
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item>Action 1</el-dropdown-item>
<el-dropdown-item>Action 2</el-dropdown-item>
<el-dropdown-item>Action 3</el-dropdown-item>
<el-dropdown-item disabled>Action 4</el-dropdown-item>
<el-dropdown-item divided>Action 5</el-dropdown-item>
</el-dropdown-menu>
</template>
</el-dropdown>
<style>
.el-dropdown-link {
cursor: pointer;
color: #409eff;
}
.el-icon-arrow-down {
font-size: 12px;
}
</style>
```
:::
### コマンドイベント
各 dropdown 項目をクリックすると、各項目に割り当てられたパラメータを持つイベントが発生します。
:::demo
```html
<el-dropdown @command="handleCommand">
<span class="el-dropdown-link">
Dropdown List<i class="el-icon-arrow-down el-icon--right"></i>
</span>
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item command="a">Action 1</el-dropdown-item>
<el-dropdown-item command="b">Action 2</el-dropdown-item>
<el-dropdown-item command="c">Action 3</el-dropdown-item>
<el-dropdown-item command="d" disabled>Action 4</el-dropdown-item>
<el-dropdown-item command="e" divided>Action 5</el-dropdown-item>
</el-dropdown-menu>
</template>
</el-dropdown>
<style>
.el-dropdown-link {
cursor: pointer;
color: #409eff;
}
.el-icon-arrow-down {
font-size: 12px;
}
</style>
<script>
export default {
methods: {
handleCommand(command) {
this.$message('click on item ' + command)
},
},
}
</script>
<!--
<setup>
import { defineComponent } from 'vue';
import { ElMessage } from 'element-plus';
export default defineComponent({
setup() {
const handleCommand = (command) => {
ElMessage(`click on item ${command}`);
};
return {
handleCommand,
};
},
});
</setup>
-->
```
:::
### サイズ
デフォルトのサイズの他に、dropdown コンポーネントには 3 つの追加サイズが用意されており、異なるシナリオから選択することができます。
:::demo 追加のサイズを `medium`, `small`, `mini` で設定するには `size` 属性を使います。
```html
<el-dropdown split-button type="primary">
Default
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item>Action 1</el-dropdown-item>
<el-dropdown-item>Action 2</el-dropdown-item>
<el-dropdown-item>Action 3</el-dropdown-item>
<el-dropdown-item>Action 4</el-dropdown-item>
</el-dropdown-menu>
</template>
</el-dropdown>
<el-dropdown size="medium" split-button type="primary">
Medium
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item>Action 1</el-dropdown-item>
<el-dropdown-item>Action 2</el-dropdown-item>
<el-dropdown-item>Action 3</el-dropdown-item>
<el-dropdown-item>Action 4</el-dropdown-item>
</el-dropdown-menu>
</template>
</el-dropdown>
<el-dropdown size="small" split-button type="primary">
Small
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item>Action 1</el-dropdown-item>
<el-dropdown-item>Action 2</el-dropdown-item>
<el-dropdown-item>Action 3</el-dropdown-item>
<el-dropdown-item>Action 4</el-dropdown-item>
</el-dropdown-menu>
</template>
</el-dropdown>
<el-dropdown size="mini" split-button type="primary">
Mini
<template #dropdown>
<el-dropdown-menu>
<el-dropdown-item>Action 1</el-dropdown-item>
<el-dropdown-item>Action 2</el-dropdown-item>
<el-dropdown-item>Action 3</el-dropdown-item>
<el-dropdown-item>Action 4</el-dropdown-item>
</el-dropdown-menu>
</template>
</el-dropdown>
```
:::
### dropdown 属性
| Attribute | Description | Type | Accepted Values | Default |
| ------------- | --------------------------------------------------------------------------------------------------- | --------------- | ---------------------------------------------------- | ------- |
| type | `split-button` が `true`のとき、メニューボタンのタイプは `Button` コンポーネントを参照する。 | string | — | — |
| size | メニューのサイズ(分割ボタンでも動作) | string | medium / small / mini | — |
| max-height | the max height of menu | string / number | — | — |
| split-button | ボタングループの表示の有無 | boolean | — | false |
| disabled | 無効にするかどうか | boolean | — | false |
| placement | ポップメニューの配置 | string | top/top-start/top-end/bottom/bottom-start/bottom-end | bottom |
| trigger | トリガーのきっかけ | string | hover/click/contextmenu | hover |
| hide-on-click | メニューアイテムをクリックした後にメニューを非表示にするかどうか | boolean | — | true |
| show-timeout | dropdown を表示するまでの遅延時間 (トリガーが `hover` の場合のみ動作) | number | — | 250 |
| hide-timeout | dropdown を非表示にするまでの遅延時間 (トリガーが `hover` の場合のみ動作) | number | — | 150 |
| tabindex | dropdown の[tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) | number | — | 0 |
### dropdown スロット
| Name | Description |
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| — | dropdown の内容 Notice: トリガーリスナーをアタッチするには、有効な html dom 要素 (例: `<span>, <button> etc.`) または `el-component` でなければなりません。 |
| dropdown | dropdown メニューの内容、通常は `<el-dropdown-menu>` 要素 |
### dropdown イベント
| Event Name | Description | Parameters |
| -------------- | ------------------------------------------------------------------------------- | --------------------------------------------- |
| click | `split-button` が `true` の場合、左ボタンがクリックされたときにトリガされます。 | — |
| command | dropdown 項目がクリックされたときにトリガーする | the command dispatched from the dropdown item |
| visible-change | dropdown が表示/非表示になったときにトリガされます。 | true when it appears, and false otherwise |
### dropdown メニュー項目の属性
| Attribute | Description | Type | Accepted Values | Default |
| --------- | -------------------------------------------------------------------------- | -------------------- | --------------- | ------- |
| command | dropdown の `command` コールバックにディスパッチするコマンドを指定します。 | string/number/object | — | — |
| disabled | 項目が無効化されているかどうか | boolean | — | false |
| divided | 仕切り表示の有無 | boolean | — | false |
| icon | アイコンクラス名 | string | — | — |
Reference in New Issue View Git Blame Copy Permalink