SInputCheckboxes

<SInputCheckbox> is a single checkbox input component.

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

Item 001

Usage

Import <SInputCheckbox> component and pass in value props.

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

const input = ref(false)
</script>

<template>
  <SInputCheckbox text="Item 001" v-model="input" />
</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'
}

<SInputCheckbox size="small" v-model="..." />

:label

Defines the label text of the input.

interface Props {
  label?: string
}

<SInputCheckbox label="Agreement" 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
}

<SInputCheckbox
  label="Agreement"
  info="Some helpful information."
  v-model="..."
/>

:note

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

interface Props {
  note?: string
}

<SInputCheckbox
  label="Agreement"
  note="Optional"
  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
}

<SInputCheckbox :check-icon="IconCheckCircle" v-model="..." />

:check-text

Text to display alongside check-icon.

interface Props {
  checkText?: string
}

<SInputCheckbox :check-text="Saved" v-model="..." />

: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'

<SInputCheckbox
  :check-icon="IconCheckCircle"
  check-text="Uploaded"
  check-color="success"
  v-model="..."
/>

:text

The text for the checkbox.

interface Props {
  text?: string
}

<SInputCheckbox
  text="Agree to our privacy policy"
  v-model="..."
/>

:disabled

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

interface Props {
  disabled?: boolean
}

<SInputCheckbox 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 {
  value?: boolean | 'indeterminate'
}

<SInputCheckbox :value="true" />

:model-value

The v-model binding for the input.

interface Props {
  modelValue?: boolean | 'indeterminate'
}

<SInputCheckbox v-model="true" />

: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
}

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

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

<SInputCheckbox
  v-model="..."
  :validation="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
}

<SInputCheckbox
  v-model="..."
  :validation="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.

<SInputCheckbox label="Agreement" v-model="...">
  <template #info>
    Learn more about this field <SLink href="...">here</SLink>.
  </template>
</SInputCheckbox>

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 {
  (e: 'update:model-value', value: boolean): void
}

@change

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

interface Emits {
  (e: 'change', value: boolean): void
}

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.