SInputSegments

<SInputSegments> is used to pick one choice from a linear set of closely related choices.

@globalbrain/sefirot/lib/components/SInputSegments.vue

View in Histoire

Usage

Define options and set value. <SInputSegments> requires an option to be selected. If you do not define either :value or v-model, it will throw an error.

<script setup lang="ts">
import { ref } from 'vue'
import SInputSegments from '@globalbrain/sefirot/lib/components/SInputSegments.vue'

const options = [
  { label: 'Table', value: 'table' },
  { label: 'List', value: 'list' },
  { label: 'Board', value: 'board' },
  { label: 'Card', value: 'card' }
]

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

<template>
  <SInputSegments :options v-model="value" />
</template>

Props

Here are the list of props you may pass to the component.

:size

Defines the size of the input. The default is 'small'.

interface Props {
  size?: 'mini' | 'small' | 'medium'
}

<SInputSegments
  size="small"
  :options="[...]"
  v-model="..."
/>

:label

Defines the label text of the input.

interface Props {
  label?: string
}

<SInputSegments
  label="Project view"
  :options="[...]"
  v-model="..."
/>

:info

Shows help icon after the label and shows info in a tooltip when the user hovers the label.

interface Props {
  info?: string
}

<SInputSegments
  label="Domain"
  info="Some helpful information."
  v-model="..."
/>

:note

Adds small help text after the label. Best used along with :label.

interface Props {
  note?: string
}

<SInputSegments
  label="Project view"
  note="A short note"
  :options="[...]"
  v-model="..."
/>

:check-icon

Icon to display at corner right of label. Useful to show the status of a particular input.

interface Props {
  checkIcon?: Component
}

<SInputSegments :check-icon="IconCheckCircle" />

:check-text

Text to display alongside :check-icon.

interface Props {
  checkText?: string
}

<SInputSegments :check-text="Saved" />

:check-color

Defines the color of :check-icon and :check-text. The default is 'neutral'.

interface Props {
  checkColor?: Color
}

type Color =
  | 'neutral' 
  | 'mute'
  | 'info' 
  | 'success' 
  | 'warning' 
  | 'danger'

<SInputSegments
  :check-icon="IconCheckCircle"
  check-text="Saved"
  check-color="success"
/>

:options

The list of selectable options for the input.

interface Props<T extends string | number | boolean> {
  options?: Option<T>[]
}

interface Option<T extends string | number | boolean> {
  label: string
  value: T
  mode?: Mode
  disabled?: boolean
}

type Mode =
  | 'default'
  | 'mute'
  | 'neutral'
  | 'info'
  | 'success'
  | 'warning'
  | 'danger'

<SInputSegments
  :options="[
    { label: 'Item 001', value: 1 },
    { label: 'Item 002', value: 2 },
    { label: 'Item 003', value: 3 }
  ]"
  v-model="..."
/>

:block

Stretches each button evenly to fill the width of the control's parent. This option is intended to make the input easier to adapt to different layouts.

interface Props {
  block?: boolean
}

<SInputSegments
  :options=""
  block
  v-model="..."
/>

:disabled

Mark all options as disabled. You may also set disabled property on each option to disable specific options.

When this prop is set, users may not be able to focus the element not trigger any events.

interface Props {
  disabled?: boolean
}

<SInputSegments
  :options="[...]"
  disabled
  v-model="..."
/>

:value

Sets the input value. When :model-value prop is set (e.g. via v-model directive), this prop gets ignored.

interface Props<T extends string | number | boolean> {
  value?: T
}

<SInputSegments
  :options="[...]"
  :value="1"
/>

:model-value

The v-model binding for the input.

interface Props<T extends string | number | boolean> {
  modelValue?: T
}

<SInputSegments
  :options="[...]"
  v-model="1"
/>

:validation

The validation object for the input. It accepts Vuelidate like validation object and displays error if there're any.

import { Ref } from 'vue'

interface Props {
  validation?: Validatable
}

interface Validatable {
  readonly $dirty: boolean
  readonly $invalid: boolean
  readonly $errors: ValidatableError[]
  readonly $touch: () => void
}

interface ValidatableError {
  readonly $message: string | Ref<string>
}

<SInputSegments
  :options="[...]"
  v-model="1"
  :validation
/>

:hide-error

Stop showing validation error message even when there are errors. This prop will not prevent the error color from appearing.

interface Props {
  hideError?: boolean
}

<SInputSegments
  :options="[...]"
  v-model="1"
  :validation
  hide-error
/>

Slots

Here are the list of slots you may define within the component.

#info

Same as :info prop. When :info prop and this slot are defined at the same time, this slot will take precedence.

<SInputSegments :options="..." v-model="...">
  <template #info>
    Learn more about this field <SLink href="...">here</SLink>.
  </template>
</SInputSegments>

Events

Here are the list of events the component may emit.

@update:model-value

Emits when the user selects the item. This event is always emitted together with @change event.

interface Emits<T extends string | number | boolean> {
  'update:model-value': [value: T]
}

@change

Emits when the user selects the item. This event is always emitted together with @update:model-value event.

interface Emits<T extends string | number | boolean> {
  change: [value: T]
}

Styles

You may customize the styles by overriding --input prefixed CSS variables.

Global input styles

You may customize the various styles of the component via global input related CSS variables. Please refer to Styles: Input Styles page.

Button styles

Each option styles shares the style of <SButton>. Refer to the component docs for available CSS variables.