Skip to content

Interface: SliderSchema

A schema representing a return value or object property that is a number that should be rendered as a slider.

Extends

Properties

codaType

codaType: Slider

Instructs Superhuman Docs to render this value as a slider.

Overrides

BaseNumberSchema.codaType


description?

optional description: string

A explanation of this object schema property shown to the user in the UI.

If your pack has an object schema with many properties, it may be useful to explain the purpose or contents of any property that is not self-evident.

Inherited from

BaseNumberSchema.description


maximum?

optional maximum: string | number

The maximum value selectable by this slider (supports number or formula).


minimum?

optional minimum: string | number

The minimum value selectable by this slider (supports number or formula).


showValue?

optional showValue: boolean

Whether to display the underlying numeric value in addition to the slider.


step?

optional step: string | number

The minimum amount the slider can be moved when dragged (supports number or formula).


type

type: Number

Identifies this schema as relating to a number value.

Inherited from

BaseNumberSchema.type