react-d3-speedometer/dist/index.d.ts

React library for showing speedometer like gauge using d3.

declare module 'react-d3-speedometer' {
  enum Transition {
    easeLinear = 'easeLinear',
    easeQuadIn = 'easeQuadIn',
    easeQuadOut = 'easeQuadOut',
    easeQuadInOut = 'easeQuadInOut',
    easeCubicIn = 'easeCubicIn',
    easeCubicOut = 'easeCubicOut',
    easeCubicInOut = 'easeCubicInOut',
    easePolyIn = 'easePolyIn',
    easePolyOut = 'easePolyOut',
    easePolyInOut = 'easePolyInOut',
    easeSinIn = 'easeSinIn',
    easeSinOut = 'easeSinOut',
    easeSinInOut = 'easeSinInOut',
    easeExpIn = 'easeExpIn',
    easeExpOut = 'easeExpOut',
    easeExpInOut = 'easeExpInOut',
    easeCircleIn = 'easeCircleIn',
    easeCircleOut = 'easeCircleOut',
    easeCircleInOut = 'easeCircleInOut',
    easeBounceIn = 'easeBounceIn',
    easeBounceOut = 'easeBounceOut',
    easeBounceInOut = 'easeBounceInOut',
    easeBackIn = 'easeBackIn',
    easeBackOut = 'easeBackOut',
    easeBackInOut = 'easeBackInOut',
    easeElasticIn = 'easeElasticIn',
    easeElasticOut = 'easeElasticOut',
    easeElasticInOut = 'easeElasticInOut',
    easeElastic = 'easeElastic',
  }

  enum CustomSegmentLabelPosition {
    Outside = 'OUTSIDE',
    Inside = 'INSIDE',
  }

  type CustomSegmentLabel = {
    text?: string
    position?: CustomSegmentLabelPosition
    fontSize?: string
    color?: string
  }

  type Props = {
    value?: number

    minValue?: number
    maxValue?: number

    segments?: number
    maxSegmentLabels?: number

    forceRender?: boolean

    width?: number
    height?: number

    dimensionUnit?: string
    fluidWidth?: boolean

    needleColor?: string
    startColor?: string
    endColor?: string
    segmentColors?: string[]

    needleTransition?: Transition
    needleTransitionDuration?: number
    needleHeightRatio?: number

    ringWidth?: number
    textColor?: string

    valueFormat?: string
    segmentValueFormatter?: (value: string) => string

    currentValueText?: string
    currentValuePlaceholderStyle?: string

    customSegmentStops?: number[]

    customSegmentLabels?: CustomSegmentLabel[]

    labelFontSize?: string
    valueTextFontSize?: string
    valueTextFontWeight?: string

    paddingHorizontal?: number
    paddingVertical?: number

    // Accessibility releated props
    svgAriaLabel?: string
  }

  const ReactSpeedometer: React.FunctionComponent<Props>

  // named exports of all the types
  export { Props, CustomSegmentLabel, CustomSegmentLabelPosition, Transition }

  export default ReactSpeedometer
}