SOptionGroup <s-option-group>

Groups related options inside a select under a shared label. SOptionGroup is the typed Vue 3 wrapper for Shopify's Polaris <s-option-group> web component.

import { SOptionGroup } from 'polaris-vue-elements'

Example

<SOptionGroup> doesn't render on its own — it groups related <SOption> children under a label inside an <SSelect>.

United StatesCanadaFranceGermany

Value: (none)

<script setup>
import { ref } from 'vue'
import { SSelect, SOption, SOptionGroup } from 'polaris-vue-elements'

const value = ref('')
</script>

<template>
  <SSelect label="Shipping region" placeholder="Select a region" v-model="value">
    <!-- SOptionGroup labels a cluster of SOption children -->
    <SOptionGroup label="North America">
      <SOption value="us">United States</SOption>
      <SOption value="ca">Canada</SOption>
    </SOptionGroup>
    <SOptionGroup label="Europe">
      <SOption value="fr">France</SOption>
      <SOption value="de">Germany</SOption>
    </SOptionGroup>
  </SSelect>
  <p>Value: {{ value }}</p>
</template>

Props

Prop	Type	Description
disabled	boolean	Whether the options within this group can be selected or not.
label	string	The user-facing label for this group of options.

Slots

Slot	Description
default	The selectable options displayed in the dropdown list. Accepts option components for individual selectable items within this group.