vant/src/dropdown-menu

DropdownMenu

Install

Register component globally via app.use, refer to Component Registration for more registration ways。

import { createApp } from 'vue';
import { DropdownMenu, DropdownItem } from 'vant';

const app = createApp();
app.use(DropdownMenu);
app.use(DropdownItem);

Usage

Basic Usage

<van-dropdown-menu>
  <van-dropdown-item v-model="state.value1" :options="option1" />
  <van-dropdown-item v-model="state.value2" :options="option2" />
</van-dropdown-menu>

import { reactive } from 'vue';

export default {
  setup() {
    const state = reactive({
      value1: 0,
      value2: 'a',
    });
    const option1 = [
      { text: 'Option1', value: 0 },
      { text: 'Option2', value: 1 },
      { text: 'Option3', value: 2 },
    ];
    const option2 = [
      { text: 'Option A', value: 'a' },
      { text: 'Option B', value: 'b' },
      { text: 'Option C', value: 'c' },
    ];

    return {
      state,
      option1,
      option2,
    };
  },
};

Custom Content

<van-dropdown-menu>
  <van-dropdown-item v-model="state.value" :options="option" />
  <van-dropdown-item title="Title" ref="item">
    <van-cell center title="Title">
      <template #right-icon>
        <van-switch v-model="state.switch1" size="24" active-color="#ee0a24" />
      </template>
    </van-cell>
    <van-cell center title="Title">
      <template #right-icon>
        <van-switch v-model="state.switch2" size="24" active-color="#ee0a24" />
      </template>
    </van-cell>
    <div style="padding: 5px 16px;">
      <van-button type="danger" block round @click="onConfirm">
        Confirm
      </van-button>
    </div>
  </van-dropdown-item>
</van-dropdown-menu>

import { ref, reactive } from 'vue';

export default {
  setup() {
    const item = ref(null);
    const state = reactive({
      value: 0,
      switch1: false,
      switch2: false,
    });
    const options = [
      { text: 'Option1', value: 0 },
      { text: 'Option2', value: 1 },
      { text: 'Option3', value: 2 },
    ];
    const onConfirm = () => {
      item.value.toggle();
    };

    return {
      item,
      state,
      options,
      onConfirm,
    };
  },
};

Custom Active Color

Use active-color prop to custom active color of the title and options.

<van-dropdown-menu active-color="#1989fa">
  <van-dropdown-item v-model="value1" :options="option1" />
  <van-dropdown-item v-model="value2" :options="option2" />
</van-dropdown-menu>

Expand Direction

<van-dropdown-menu direction="up">
  <van-dropdown-item v-model="value1" :options="option1" />
  <van-dropdown-item v-model="value2" :options="option2" />
</van-dropdown-menu>

Disabled

<van-dropdown-menu>
  <van-dropdown-item v-model="value1" disabled :options="option1" />
  <van-dropdown-item v-model="value2" disabled :options="option2" />
</van-dropdown-menu>

API

DropdownMenu Props

Attribute	Description	Type	Default
active-color	Active color of title and option	string	#ee0a24
direction	Expand direction, can be set to up	string	down
z-index	z-index of menu item	number | string	10
duration	Transition duration, unit second	number | string	0.2
overlay	Whether to show overlay	boolean	true
close-on-click-overlay	Whether to close when overlay is clicked	boolean	true
close-on-click-outside	Whether to close when outside is clicked	boolean	true

DropdownItem Props

Attribute	Description	Type	Default
v-model	Value of current option	number | string	-
title	Item title	string	Text of selected option
options	Options	Option[]	[]
disabled	Whether to disable dropdown item	boolean	false
lazy-render	Whether to lazy render util opened	boolean	true
title-class	Title class	string | Array | object	-
teleport	Return the mount node for menu	string | Element	-

DropdownItem Events

Event	Description	Arguments
change	Emitted select option and value changed	value
open	Emitted when opening menu	-
close	Emitted when closing menu	-
opened	Emitted when menu is opened	-
closed	Emitted when menu is closed	-

DropdownItem Slots

Name	Description
default	Content
title	Custom title

DropdownItem Methods

Use ref to get DropdownItem instance and call instance methods.

Name	Description	Attribute	Return value
toggle	Toggle display	show: boolean	-

Data Structure of Option

Key	Description	Type
text	Text	string
value	Value	number | string
icon	Left icon	string

Less Variables

How to use: Custom Theme.

Name	Default Value	Description
@dropdown-menu-height	48px	-
@dropdown-menu-background-color	@white	-
@dropdown-menu-box-shadow	0 2px 12px fade(@gray-7, 12)	-
@dropdown-menu-title-font-size	15px	-
@dropdown-menu-title-text-color	@text-color	-
@dropdown-menu-title-active-text-color	@red	-
@dropdown-menu-title-disabled-text-color	@gray-6	-
@dropdown-menu-title-padding	0 @padding-xs	-
@dropdown-menu-title-line-height	@line-height-lg	-
@dropdown-menu-option-active-color	@red	-
@dropdown-menu-content-max-height	80%	-
@dropdown-item-z-index	10	-