Segmented

A segmented control for displaying multiple options and allowing users to select a single option.

When to Use

• When you need to display multiple options and allow users to select a single option;
• When switching between selected options changes the content of the associated area.

Component Types

Basic Usage

Set the options list through options and bind the currently selected item through v-model:value.

<wd-segmented :options="list" v-model:value="current"></wd-segmented>

const list = ref<string[]>(['Comments', 'Likes', 'Contributions', 'Tips'])

const current = ref('Likes')

Component States

Disabled

Set the disabled property to disable the entire segmented control.

<wd-segmented :options="list" v-model:value="current" disabled></wd-segmented>

Component Variants

Outline Theme

Switch to outline style through theme="outline".

<wd-segmented :options="list" v-model:value="current" theme="outline"></wd-segmented>

Component Styles

Custom Render Segmented Labels

Use the label slot to customize the rendering of segmented control label content.

<wd-segmented :options="list" v-model:value="current" :vibrate-short="true">
  <template #label="{ option }">
    <view class="section-slot">
      <image style="border-radius: 50%; width: 32px; height: 32px" :src="option.payload.avatar" />
      <view class="name">{{ option.value }}</view>
    </view>
  </template>
</wd-segmented>

const list = ref([
  {
    value: 'Li Lei',
    disabled: false,
    payload: {
      avatar: 'https://wot-ui.cn/assets/redpanda.jpg'
    }
  },
  {
    value: 'Han Meimei',
    disabled: false,
    payload: {
      avatar: 'https://wot-ui.cn/assets/capybara.jpg'
    }
  }
])

.section {
  width: 100%;
  padding: 0 24rpx;
  box-sizing: border-box;
  &-slot {
    padding: 4px;
  }
}

Special Styles

Segmented with Vibration Effect

After setting vibrate-short, a short vibration feedback will be triggered when switching options.

<wd-segmented :options="list" v-model:value="current" :vibrate-short="true"></wd-segmented>

Using in Popup

In WeChat Mini Program, when using this component in a popup, you need to call the updateActiveStyle method to update the segmented control style. See Common Problems.

<wd-button @click="handleClick">Open Popup</wd-button>
<wd-popup v-model="showPopup" position="bottom" @after-enter="handlePopupShow" closable custom-style="height: 200px;padding: 0 24rpx;">
  <view class="title">Using in Popup</view>
  <wd-segmented :options="list" v-model:value="current" ref="segmentedRef"></wd-segmented>
</wd-popup>

const list = ref<string[]>(['Comments', 'Likes', 'Contributions', 'Tips'])
const current = ref('Likes')

const segmentedRef = ref<SegmentedInstance>() // Get segmented control instance
const showPopup = ref(false) // Control popup display
/**
 * Click button to open popup
 */
function handleClick() {
  showPopup.value = true
}
/**
 * Update segmented control style after popup opens
 */
function handlePopupShow() {
  segmentedRef.value?.updateActiveStyle()
}

.title {
  display: flex;
  font-size: 32rpx;
  align-items: center;
  justify-content: center;
  padding: 24rpx 0;
}

Attributes

Parameter	Description	Type	Default Value
value / v-model:value	Currently selected value	string | number	-
disabled	Whether to disable the segmented control	boolean	false
options	Data collection	string[] | number[] | SegmentedOption[]	[]
theme	Segmented control theme, optional values are card, outline	string	'card'
vibrate-short	Whether to trigger short vibration when switching options	boolean	false
custom-class	Root node custom class name	string	''
custom-style	Root node custom style	string	''

SegmentedOption

Parameter	Description	Type	Default Value
value	Option value	string | number	-
disabled	Whether to disable this option	boolean	false
payload	Additional data, can be used for slot rendering	any	-

Events

Event Name	Description	Parameters
change	Triggered when option switches	SegmentedOption
click v1.2.20	Triggered when option is clicked	SegmentedOption

Methods

Method Name	Description	Type
updateActiveStyle	Update slider offset, parameter animation is used to control whether to enable animation, enabled by default	(animation?: boolean) => void

Slots

Name	Description	Parameters
label	Option label content	{ option: SegmentedOption }

主题定制

CSS 变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 全局配置。

名称	默认值	描述
--wot-segmented-bg	$filled-content	组件背景色
--wot-segmented-border-width	$stroke-main	组件边框宽度
--wot-segmented-padding	$padding-super-tight	组件内边距
--wot-segmented-radius	$radius-main	组件圆角
--wot-segmented-item-color	$text-secondary	选项文字颜色
--wot-segmented-item-font-size	$typography-body-size-extra-large	选项文字字号
--wot-segmented-item-line-height	$typography-body-line--height-size-extra-large	选项文字行高
--wot-segmented-item-padding	$padding-ultra-tight $padding-loose	选项内边距
--wot-segmented-item-font-weight	$font-weight-regular	选项文字字重
--wot-segmented-item-font-weight-active	$font-weight-medium	选项激活字重
--wot-segmented-item-bg-active	$filled-oppo	选项激活背景色
--wot-segmented-item-color-active	$primary-6	选项激活文字颜色
--wot-segmented-item-disabled-opacity	$opacity-disabled	选项禁用透明度
--wot-segmented-outline-border-color	$border-main	轮廓模式边框颜色
--wot-segmented-outline-radius	$radius-zero	轮廓模式圆角
--wot-segmented-outline-bg	$filled-zero	轮廓模式背景色
--wot-segmented-outline-padding	$padding-zero	轮廓模式内边距
--wot-segmented-outline-item-padding	$padding-extra-tight $padding-extra-loose	轮廓模式选项内边距
--wot-segmented-outline-item-color	$text-secondary	轮廓模式选项文字颜色
--wot-segmented-outline-item-bg-active	$primary-6	轮廓模式选项激活背景色
--wot-segmented-outline-item-color-active	$text-white	轮廓模式选项激活文字颜色
--wot-segmented-outline-item-disabled-color	$text-disabled	轮廓模式选项禁用文字颜色
--wot-segmented-outline-item-bg-active-disabled	$filled-content	轮廓模式选项激活禁用背景色

Source Code

Documentation

• Component