Usage

Adjust volume and show its percentage

This type is used by Slider

tsx
import { Slider, Text, VStack, signal } from 'kuito';

export default function Volume() {
  const volume = signal(0.5);

  return (
    <VStack gap={8} padding={16}>
      <Slider label="Volume" value={volume} height={40} />
      <Text>{Math.round(volume.value * 100) + '%'}</Text>
    </VStack>
  );
}

Type declaration

ts
export type SliderProps = {
  /** Two-way when given a signal: the slider writes it as the user drags. */
  value?: number;
  /** 0 by default. */
  min?: number;
  /** 1 by default. */
  max?: number;
  /** The value snaps to multiples of `step` from `min`; 0 slides freely. */
  step?: number;
  disabled?: boolean;
  /** The track before the thumb. */
  fillColor?: string;
  /** The track after the thumb. */
  trackColor?: string;
  /** The value, while the user drags. */
  onChange?: (value: number) => void;
  /** When the user lets go. */
  onChangeEnd?: (event: SliderEvent) => void;
};

Members 9

NameTypeRequiredDescription
valuenumberNoTwo-way when given a signal: the slider writes it as the user drags.
minnumberNo0 by default.
maxnumberNo1 by default.
stepnumberNoThe value snaps to multiples of step from min; 0 slides freely.
disabledbooleanNo—
fillColorstringNoThe track before the thumb.
trackColorstringNoThe track after the thumb.
onChange(value: number) => voidNoThe value, while the user drags.
onChangeEnd(event: SliderEvent) => voidNoWhen the user lets go.
onChange — method signatures

Signatures

ts
(value: number): void

Parameters

NameTypeRequiredDescription
valuenumberYes—

Returns

void

onChangeEnd — method signatures

Signatures

ts
(event: SliderEvent): void

Parameters

NameTypeRequiredDescription
eventSliderEventYes—

Returns

void

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.