vue-slider-component

  • Version 3.2.24
  • Published
  • 1.79 MB
  • 2 dependencies
  • MIT license

Install

npm i vue-slider-component
yarn add vue-slider-component
pnpm add vue-slider-component

Overview

A highly customized slider component

Index

Classes

class VueSlider

class VueSlider extends Vue {}

    property $el

    $el: HTMLDivElement;

      property $refs

      $refs: { container: HTMLDivElement; rail: HTMLDivElement };

        property adsorb

        adsorb?: boolean;

          property animateTime

          readonly animateTime: number;

            property canSort

            readonly canSort: boolean;

              property clickable

              clickable: boolean;

                property contained

                contained: boolean;

                  property containerClasses

                  readonly containerClasses: (
                  | string
                  | string[]
                  | { 'vue-slider-disabled': boolean }
                  )[];

                    property containerStyles

                    readonly containerStyles: { padding: string; width: string; height: string };

                      property control

                      control: Control;

                        property data

                        data?: Value[] | object[] | DataObject;

                          property dataLabel

                          dataLabel: string;

                            property dataValue

                            dataValue: string;

                              property direction

                              direction: Direction;

                                property disabled

                                disabled: boolean;

                                  property dotAttrs

                                  dotAttrs?: {};

                                    property dotBaseStyle

                                    readonly dotBaseStyle: { width: string; height: string };

                                      property dotOptions

                                      dotOptions?: DotOption | DotOption[];

                                        property dots

                                        readonly dots: Dot[];

                                          property dotSize

                                          dotSize: number | [number, number];

                                            property dotStyle

                                            dotStyle?: Styles;

                                              property dragOnClick

                                              dragOnClick: boolean;

                                                property duration

                                                duration: number;

                                                  property enableCross

                                                  enableCross: boolean;

                                                    property fixed

                                                    fixed: boolean;

                                                      property focusDotIndex

                                                      focusDotIndex: number;

                                                        property height

                                                        height?: string | number;

                                                          property hideLabel

                                                          hideLabel?: boolean;

                                                            property included

                                                            included?: boolean;

                                                              property interval

                                                              interval: number;

                                                                property isHorizontal

                                                                readonly isHorizontal: boolean;

                                                                  property isReverse

                                                                  readonly isReverse: boolean;

                                                                    property keydownHook

                                                                    keydownHook: (e: KeyboardEvent) => HandleFunction | boolean;

                                                                      property labelActiveStyle

                                                                      labelActiveStyle?: Styles;

                                                                        property labelStyle

                                                                        labelStyle?: Styles;

                                                                          property lazy

                                                                          lazy: boolean;

                                                                            property mainDirection

                                                                            readonly mainDirection: string;

                                                                              property marks

                                                                              marks?: MarksProp;

                                                                                property max

                                                                                max: number;

                                                                                  property maxRange

                                                                                  maxRange?: number;

                                                                                    property min

                                                                                    min: number;

                                                                                      property minRange

                                                                                      minRange?: number;

                                                                                        property order

                                                                                        order: boolean;

                                                                                          property process

                                                                                          process?: ProcessProp;

                                                                                            property processArray

                                                                                            readonly processArray: Process[];

                                                                                              property processStyle

                                                                                              processStyle?: Styles;

                                                                                                property railStyle

                                                                                                railStyle?: Styles;

                                                                                                  property scale

                                                                                                  scale: number;

                                                                                                    property silent

                                                                                                    silent: boolean;

                                                                                                      property sliderData

                                                                                                      readonly sliderData: Value[];

                                                                                                        property sliderMarks

                                                                                                        readonly sliderMarks: MarksProp;

                                                                                                          property sliderTooltipFormatter

                                                                                                          readonly sliderTooltipFormatter: TooltipFormatter | TooltipFormatter[];

                                                                                                            property states

                                                                                                            states: State;

                                                                                                              property stepActiveStyle

                                                                                                              stepActiveStyle?: Styles;

                                                                                                                property stepStyle

                                                                                                                stepStyle?: Styles;

                                                                                                                  property tailSize

                                                                                                                  readonly tailSize: string;

                                                                                                                    property tooltip

                                                                                                                    tooltip: TooltipProp;

                                                                                                                      property tooltipDirections

                                                                                                                      readonly tooltipDirections: Position[];

                                                                                                                        property tooltipFormatter

                                                                                                                        tooltipFormatter?: TooltipFormatter | TooltipFormatter[];

                                                                                                                          property tooltipPlacement

                                                                                                                          tooltipPlacement?: Position | Position[];

                                                                                                                            property tooltipStyle

                                                                                                                            tooltipStyle?: Styles;

                                                                                                                              property useKeyboard

                                                                                                                              useKeyboard?: boolean;

                                                                                                                                property value

                                                                                                                                value: Value | Value[];

                                                                                                                                  property width

                                                                                                                                  width?: string | number;

                                                                                                                                    property zoom

                                                                                                                                    zoom?: number;

                                                                                                                                      method beforeDestroy

                                                                                                                                      beforeDestroy: () => void;

                                                                                                                                        method bindEvent

                                                                                                                                        bindEvent: () => void;

                                                                                                                                          method blur

                                                                                                                                          blur: () => void;

                                                                                                                                            method created

                                                                                                                                            created: () => void;

                                                                                                                                              method focus

                                                                                                                                              focus: (index?: number) => void;

                                                                                                                                                method getIndex

                                                                                                                                                getIndex: () => number | number[];

                                                                                                                                                  method getValue

                                                                                                                                                  getValue: () => string | number | (string | number)[];

                                                                                                                                                    method initControl

                                                                                                                                                    initControl: () => void;

                                                                                                                                                      method isObjectArrayData

                                                                                                                                                      isObjectArrayData: (data?: Value[] | object[] | DataObject) => data is object[];

                                                                                                                                                        method isObjectData

                                                                                                                                                        isObjectData: (data?: Value[] | object[] | DataObject) => data is DataObject;

                                                                                                                                                          method keydownHandle

                                                                                                                                                          keydownHandle: (e: KeyboardEvent) => false | undefined;

                                                                                                                                                            method mounted

                                                                                                                                                            mounted: () => void;

                                                                                                                                                              method onValueChanged

                                                                                                                                                              onValueChanged: () => void;

                                                                                                                                                                method render

                                                                                                                                                                render: () => JSX.Element;

                                                                                                                                                                  method setIndex

                                                                                                                                                                  setIndex: (index: number | number[]) => void;

                                                                                                                                                                    method setScale

                                                                                                                                                                    setScale: () => void;

                                                                                                                                                                      method setValue

                                                                                                                                                                      setValue: (value: Value | Value[]) => void;

                                                                                                                                                                        method setValueByPos

                                                                                                                                                                        setValueByPos: (pos: number) => false | undefined;

                                                                                                                                                                          method unbindEvent

                                                                                                                                                                          unbindEvent: () => void;

                                                                                                                                                                            class VueSliderDot

                                                                                                                                                                            class VueSliderDot extends Vue {}

                                                                                                                                                                              property $refs

                                                                                                                                                                              $refs: { dot: HTMLDivElement };

                                                                                                                                                                                property disabled

                                                                                                                                                                                disabled: boolean;

                                                                                                                                                                                  property dotClasses

                                                                                                                                                                                  readonly dotClasses: (
                                                                                                                                                                                  | string
                                                                                                                                                                                  | {
                                                                                                                                                                                  'vue-slider-dot-hover': boolean;
                                                                                                                                                                                  'vue-slider-dot-disabled': boolean;
                                                                                                                                                                                  'vue-slider-dot-focus': boolean;
                                                                                                                                                                                  }
                                                                                                                                                                                  )[];

                                                                                                                                                                                    property dotStyle

                                                                                                                                                                                    dotStyle?: Styles;

                                                                                                                                                                                      property focus

                                                                                                                                                                                      focus: boolean;

                                                                                                                                                                                        property handleClasses

                                                                                                                                                                                        readonly handleClasses: (
                                                                                                                                                                                        | string
                                                                                                                                                                                        | {
                                                                                                                                                                                        'vue-slider-dot-handle-disabled': boolean;
                                                                                                                                                                                        'vue-slider-dot-handle-focus': boolean;
                                                                                                                                                                                        }
                                                                                                                                                                                        )[];

                                                                                                                                                                                          property showTooltip

                                                                                                                                                                                          readonly showTooltip: boolean;

                                                                                                                                                                                            property tooltip

                                                                                                                                                                                            tooltip: TooltipProp;

                                                                                                                                                                                              property tooltipClasses

                                                                                                                                                                                              readonly tooltipClasses: (
                                                                                                                                                                                              | string
                                                                                                                                                                                              | string[]
                                                                                                                                                                                              | { 'vue-slider-dot-tooltip-show': boolean }
                                                                                                                                                                                              )[];

                                                                                                                                                                                                property tooltipFormatter

                                                                                                                                                                                                tooltipFormatter?: TooltipFormatter;

                                                                                                                                                                                                  property tooltipInnerClasses

                                                                                                                                                                                                  readonly tooltipInnerClasses: (
                                                                                                                                                                                                  | string
                                                                                                                                                                                                  | string[]
                                                                                                                                                                                                  | {
                                                                                                                                                                                                  'vue-slider-dot-tooltip-inner-disabled': boolean;
                                                                                                                                                                                                  'vue-slider-dot-tooltip-inner-focus': boolean;
                                                                                                                                                                                                  }
                                                                                                                                                                                                  )[];

                                                                                                                                                                                                    property tooltipPlacement

                                                                                                                                                                                                    tooltipPlacement: Position;

                                                                                                                                                                                                      property tooltipStyle

                                                                                                                                                                                                      tooltipStyle?: Styles;

                                                                                                                                                                                                        property tooltipValue

                                                                                                                                                                                                        readonly tooltipValue: Value;

                                                                                                                                                                                                          property value

                                                                                                                                                                                                          value: Value;

                                                                                                                                                                                                            method dragStart

                                                                                                                                                                                                            dragStart: (e: MouseEvent | TouchEvent) => false | undefined;

                                                                                                                                                                                                              method render

                                                                                                                                                                                                              render: () => JSX.Element;

                                                                                                                                                                                                                class VueSliderMark

                                                                                                                                                                                                                class VueSlideMark extends Vue {}

                                                                                                                                                                                                                  property hideLabel

                                                                                                                                                                                                                  hideLabel?: boolean;

                                                                                                                                                                                                                    property labelActiveStyle

                                                                                                                                                                                                                    labelActiveStyle?: Styles;

                                                                                                                                                                                                                      property labelClasses

                                                                                                                                                                                                                      readonly labelClasses: (
                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                      | { 'vue-slider-mark-label-active': boolean | undefined }
                                                                                                                                                                                                                      )[];

                                                                                                                                                                                                                        property labelStyle

                                                                                                                                                                                                                        labelStyle?: Styles;

                                                                                                                                                                                                                          property mark

                                                                                                                                                                                                                          mark: Mark;

                                                                                                                                                                                                                            property marksClasses

                                                                                                                                                                                                                            readonly marksClasses: (
                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                            | { 'vue-slider-mark-active': boolean | undefined }
                                                                                                                                                                                                                            )[];

                                                                                                                                                                                                                              property stepActiveStyle

                                                                                                                                                                                                                              stepActiveStyle?: Styles;

                                                                                                                                                                                                                                property stepClasses

                                                                                                                                                                                                                                readonly stepClasses: (
                                                                                                                                                                                                                                | string
                                                                                                                                                                                                                                | { 'vue-slider-mark-step-active': boolean | undefined }
                                                                                                                                                                                                                                )[];

                                                                                                                                                                                                                                  property stepStyle

                                                                                                                                                                                                                                  stepStyle?: Styles;

                                                                                                                                                                                                                                    method labelClickHandle

                                                                                                                                                                                                                                    labelClickHandle: (e: MouseEvent | TouchEvent) => void;

                                                                                                                                                                                                                                      method render

                                                                                                                                                                                                                                      render: () => JSX.Element;

                                                                                                                                                                                                                                        Enums

                                                                                                                                                                                                                                        enum ERROR_TYPE

                                                                                                                                                                                                                                        const enum ERROR_TYPE {
                                                                                                                                                                                                                                        VALUE = 1,
                                                                                                                                                                                                                                        INTERVAL = 2,
                                                                                                                                                                                                                                        MIN = 3,
                                                                                                                                                                                                                                        MAX = 4,
                                                                                                                                                                                                                                        ORDER = 5,
                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                          member INTERVAL

                                                                                                                                                                                                                                          INTERVAL = 2

                                                                                                                                                                                                                                            member MAX

                                                                                                                                                                                                                                            MAX = 4

                                                                                                                                                                                                                                              member MIN

                                                                                                                                                                                                                                              MIN = 3

                                                                                                                                                                                                                                                member ORDER

                                                                                                                                                                                                                                                ORDER = 5

                                                                                                                                                                                                                                                  member VALUE

                                                                                                                                                                                                                                                  VALUE = 1

                                                                                                                                                                                                                                                    Namespaces

                                                                                                                                                                                                                                                    namespace *.json

                                                                                                                                                                                                                                                    module '*.json' {}

                                                                                                                                                                                                                                                      variable value

                                                                                                                                                                                                                                                      const value: any;

                                                                                                                                                                                                                                                        namespace *.vue

                                                                                                                                                                                                                                                        module '*.vue' {}

                                                                                                                                                                                                                                                          namespace *nav.json

                                                                                                                                                                                                                                                          module '*nav.json' {}

                                                                                                                                                                                                                                                            variable obj

                                                                                                                                                                                                                                                            const obj: NavObj;

                                                                                                                                                                                                                                                              namespace vuep

                                                                                                                                                                                                                                                              module 'vuep' {}

                                                                                                                                                                                                                                                                variable value

                                                                                                                                                                                                                                                                const value: any;

                                                                                                                                                                                                                                                                  Package Files (7)

                                                                                                                                                                                                                                                                  Dependencies (2)

                                                                                                                                                                                                                                                                  Dev Dependencies (25)

                                                                                                                                                                                                                                                                  Peer Dependencies (0)

                                                                                                                                                                                                                                                                  No peer dependencies.

                                                                                                                                                                                                                                                                  Badge

                                                                                                                                                                                                                                                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                                                                                                                                                                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/vue-slider-component.

                                                                                                                                                                                                                                                                  • Markdown
                                                                                                                                                                                                                                                                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/vue-slider-component)
                                                                                                                                                                                                                                                                  • HTML
                                                                                                                                                                                                                                                                    <a href="https://www.jsdocs.io/package/vue-slider-component"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>