Interface IIgrSliderProps

Hierarchy

Hierarchy

Properties

change?: ((s, e) => void)

Type declaration

    • (s, e): void
    • Emitted when a value change is committed on a thumb drag end or keyboard interaction.

      Parameters

      Returns void

children?: ReactNode
className?: string
disabled?: string | boolean

Disables the UI interactions of the slider.

discreteTrack?: string | boolean

Marks the slider track as discrete so it displays the steps. If the step is 0, the slider will remain continuos even if discreteTrack is true.

hidePrimaryLabels?: string | boolean

Hides the primary tick labels.

hideSecondaryLabels?: string | boolean

Hides the secondary tick labels.

hideTooltip?: string | boolean

Hides the thumb tooltip.

id?: string
input?: ((s, e) => void)

Type declaration

    • (s, e): void
    • Emitted when a value is changed via thumb drag or keyboard interaction.

      Parameters

      Returns void

invalid?: string | boolean

Control the validity of the control.

locale?: string

The locale used to format the thumb and tick label values in the slider.

lowerBound?: string | number

The lower bound of the slider value. If not set, the min value is applied.

max?: string | number

The maximum value of the slider scale. Defaults to 100. If max is less than min the call is a no-op. If labels are provided (projected), then max is always set to the number of labels. If upperBound ends up being greater than than the current max value, it is automatically assigned the new max value.

min?: string | number

The minimum value of the slider scale. Defaults to 0. If min is greater than max the call is a no-op. If labels are provided (projected), then min is always set to 0. If lowerBound ends up being less than than the current min value, it is automatically assigned the new min value.

name?: string

The name attribute of the control.

primaryTicks?: string | number

The number of primary ticks. It defaults to 0 which means no primary ticks are displayed.

secondaryTicks?: string | number

The number of secondary ticks. It defaults to 0 which means no secondary ticks are displayed.

step?: string | number

Specifies the granularity that the value must adhere to. If set to 0 no stepping is implied and any value in the range is allowed. If labels are provided (projected) then the step is always assumed to be 1 since it is a discrete slider.

style?: CSSProperties
tickLabelRotation?: string | TickLabelRotation

The degrees for the rotation of the tick labels. Defaults to 0.

tickOrientation?: string | SliderBaseTickOrientation

Changes the orientation of the ticks.

upperBound?: string | number

The upper bound of the slider value. If not set, the max value is applied.

value?: string | number

The current value of the component.

valueFormat?: string

String format used for the thumb and tick label values in the slider.

valueFormatOptions?: NumberFormatOptions

Number format options used for the thumb and tick label values in the slider.