Skip to content

custom-steps.md

Latest commit

 

History

History
46 lines (30 loc) · 878 Bytes

custom-steps.md

File metadata and controls

46 lines (30 loc) · 878 Bytes
name Custom Steps
route /api/custom-steps
menu API

Examples

Want to skip to the implementation? Check out these examples:

The API below described how to use the custom-steps features.

Options

steps

steps: Array<number>

An array of custom steps to use. This will override stepSize

ticks

ticks: Array<number>

An array of custom ticks to use. This will override tickSize

API

getTicks

getTicks: () =>
  ReadonlyArray<{ value: number; key: number; percentage: number }>

Ticks to be rendered. Each tick has the following props:

  • value: number - The tick number to be displayed
  • key: number - The key of a tick
  • percentage: number - Percentage value of where tick should be placed on ranger