quasar 2.3.4 → 2.4.3

package/src/components/slider/use-slider.js

@@ -3,41 +3,27 @@ import { h, ref, computed, onBeforeUnmount, getCurrentInstance } from 'vue'
 import TouchPan from '../../directives/TouchPan.js'
 
 import useDark, { useDarkProps } from '../../composables/private/use-dark.js'
+import { useFormProps, useFormInject } from '../../composables/private/use-form.js'
 
 import { between } from '../../utils/format.js'
 import { position } from '../../utils/event.js'
 import { isNumber } from '../../utils/private/is.js'
+import { hDir } from '../../utils/private/render.js'
+
+const markerPrefixClass = 'q-slider__marker-labels'
+const defaultMarkerConvertFn = v => ({ value: v })
+const defaultMarkerLabelRenderFn = ({ marker }) => h('div', {
+  key: marker.value,
+  style: marker.style,
+  class: marker.classes
+}, marker.label)
 
 // PGDOWN, LEFT, DOWN, PGUP, RIGHT, UP
 export const keyCodes = [ 34, 37, 40, 33, 39, 38 ]
 
-export function getRatio (evt, dragging, reverse, vertical) {
-  const
-    pos = position(evt),
-    val = vertical === true
-      ? between((pos.top - dragging.top) / dragging.height, 0, 1)
-      : between((pos.left - dragging.left) / dragging.width, 0, 1)
-
-  return reverse === true ? 1.0 - val : val
-}
-
-export function getModel (ratio, min, max, step, decimals) {
-  let model = min + ratio * (max - min)
-
-  if (step > 0) {
-    const modulo = (model - min) % step
-    model += (Math.abs(modulo) >= step / 2 ? (modulo < 0 ? -1 : 1) * step : 0) - modulo
-  }
-
-  if (decimals > 0) {
-    model = parseFloat(model.toFixed(decimals))
-  }
-
-  return between(model, min, max)
-}
-
 export const useSliderProps = {
   ...useDarkProps,
+  ...useFormProps,
 
   min: {
     type: Number,
@@ -47,30 +33,58 @@ export const useSliderProps = {
     type: Number,
     default: 100
   },
+  innerMin: Number,
+  innerMax: Number,
+
   step: {
     type: Number,
     default: 1,
     validator: v => v >= 0
   },
 
+  snap: Boolean,
+
+  vertical: Boolean,
+  reverse: Boolean,
+
+  hideSelection: Boolean,
+
   color: String,
+  markerLabelsClass: String,
 
+  label: Boolean,
   labelColor: String,
   labelTextColor: String,
-  dense: Boolean,
-
-  label: Boolean,
   labelAlways: Boolean,
+  switchLabelSide: Boolean,
+
   markers: [ Boolean, Number ],
-  snap: Boolean,
+  markerLabels: [ Boolean, Array, Object, Function ],
+  switchMarkerLabelsSide: Boolean,
 
-  vertical: Boolean,
-  reverse: Boolean,
+  trackImg: String,
+  trackColor: String,
+  innerTrackImg: String,
+  innerTrackColor: String,
+  selectionColor: String,
+  selectionImg: String,
+
+  thumbSize: {
+    type: String,
+    default: '20px'
+  },
+  trackSize: {
+    type: String,
+    default: '4px'
+  },
 
   disable: Boolean,
   readonly: Boolean,
+  dense: Boolean,
+
   tabindex: [ String, Number ],
 
+  thumbColor: String,
   thumbPath: {
     type: String,
     default: 'M 4, 10 a 6,6 0 1,0 12,0 a 6,6 0 1,0 -12,0'
@@ -79,16 +93,19 @@ export const useSliderProps = {
 
 export const useSliderEmits = [ 'pan', 'update:modelValue', 'change' ]
 
-export default function ({ updateValue, updatePosition, getDragging }) {
-  const { props, emit, proxy: { $q } } = getCurrentInstance()
+export default function ({ updateValue, updatePosition, getDragging, formAttrs }) {
+  const { props, emit, slots, proxy: { $q } } = getCurrentInstance()
   const isDark = useDark(props, $q)
 
+  const injectFormInput = useFormInject(formAttrs)
+
   const active = ref(false)
   const preventFocus = ref(false)
   const focus = ref(false)
   const dragging = ref(false)
 
   const axis = computed(() => (props.vertical === true ? '--v' : '--h'))
+  const labelSide = computed(() => '-' + (props.switchLabelSide === true ? 'switched' : 'standard'))
 
   const isReversed = computed(() => (
     props.vertical === true
@@ -96,12 +113,64 @@ export default function ({ updateValue, updatePosition, getDragging }) {
       : props.reverse !== ($q.lang.rtl === true)
   ))
 
-  const editable = computed(() => props.disable !== true && props.readonly !== true && props.min < props.max)
+  const innerMin = computed(() => (
+    isNaN(props.innerMin) === true || props.innerMin < props.min
+      ? props.min
+      : props.innerMin
+  ))
+  const innerMax = computed(() => (
+    isNaN(props.innerMax) === true || props.innerMax > props.max
+      ? props.max
+      : props.innerMax
+  ))
+
+  const editable = computed(() => (
+    props.disable !== true && props.readonly !== true
+    && innerMin.value < innerMax.value
+  ))
+
+  const decimals = computed(() => (String(props.step).trim('0').split('.')[ 1 ] || '').length)
+  const step = computed(() => (props.step === 0 ? 1 : props.step))
+  const tabindex = computed(() => (editable.value === true ? props.tabindex || 0 : -1))
+
+  const trackLen = computed(() => props.max - props.min)
+  const innerBarLen = computed(() => innerMax.value - innerMin.value)
+
+  const innerMinRatio = computed(() => convertModelToRatio(innerMin.value))
+  const innerMaxRatio = computed(() => convertModelToRatio(innerMax.value))
+
+  const positionProp = computed(() => (
+    props.vertical === true
+      ? (isReversed.value === true ? 'bottom' : 'top')
+      : (isReversed.value === true ? 'right' : 'left')
+  ))
+
+  const sizeProp = computed(() => (props.vertical === true ? 'height' : 'width'))
+  const thicknessProp = computed(() => (props.vertical === true ? 'width' : 'height'))
+  const orientation = computed(() => (props.vertical === true ? 'vertical' : 'horizontal'))
+
+  const attributes = computed(() => {
+    const acc = {
+      role: 'slider',
+      'aria-valuemin': innerMin.value,
+      'aria-valuemax': innerMax.value,
+      'aria-orientation': orientation.value,
+      'data-step': props.step
+    }
+
+    if (props.disable === true) {
+      acc[ 'aria-disabled' ] = 'true'
+    }
+    else if (props.readonly === true) {
+      acc[ 'aria-readonly' ] = 'true'
+    }
+
+    return acc
+  })
 
   const classes = computed(() =>
-    `q-slider q-slider${ axis.value } q-slider--${ active.value === true ? '' : 'in' }active`
-    + (isReversed.value === true ? ' q-slider--reversed' : '')
-    + (props.color !== void 0 ? ` text-${ props.color }` : '')
+    `q-slider q-slider${ axis.value } q-slider--${ active.value === true ? '' : 'in' }active inline no-wrap `
+    + (props.vertical === true ? 'row' : 'column')
     + (props.disable === true ? ' disabled' : ' q-slider--enabled' + (editable.value === true ? ' q-slider--editable' : ''))
     + (focus.value === 'both' ? ' q-slider--focus' : '')
     + (props.label || props.labelAlways === true ? ' q-slider--label' : '')
@@ -110,19 +179,148 @@ export default function ({ updateValue, updatePosition, getDragging }) {
     + (props.dense === true ? ' q-slider--dense q-slider--dense' + axis.value : '')
   )
 
-  const decimals = computed(() => (String(props.step).trim('0').split('.')[ 1 ] || '').length)
-  const step = computed(() => (props.step === 0 ? 1 : props.step))
-  const minMaxDiff = computed(() => props.max - props.min)
+  function getPositionClass (name) {
+    const cls = 'q-slider__' + name
+    return `${ cls } ${ cls }${ axis.value } ${ cls }${ axis.value }${ labelSide.value }`
+  }
+  function getAxisClass (name) {
+    const cls = 'q-slider__' + name
+    return `${ cls } ${ cls }${ axis.value }`
+  }
+
+  const selectionBarClass = computed(() => {
+    const color = props.selectionColor || props.color
+    return 'q-slider__selection absolute'
+      + (color !== void 0 ? ` text-${ color }` : '')
+  })
+  const markerClass = computed(() => getAxisClass('markers') + ' absolute overflow-hidden')
+  const trackContainerClass = computed(() => getAxisClass('track-container'))
+  const pinClass = computed(() => getPositionClass('pin'))
+  const labelClass = computed(() => getPositionClass('label'))
+  const textContainerClass = computed(() => getPositionClass('text-container'))
+  const markerLabelsContainerClass = computed(() =>
+    getPositionClass('marker-labels-container')
+    + (props.markerLabelsClass !== void 0 ? ` ${ props.markerLabelsClass }` : '')
+  )
+
+  const trackClass = computed(() =>
+    'q-slider__track relative-position no-outline'
+    + (props.trackColor !== void 0 ? ` bg-${ props.trackColor }` : '')
+  )
+  const trackStyle = computed(() => {
+    const acc = { [ thicknessProp.value ]: props.trackSize }
+    if (props.trackImg !== void 0) {
+      acc.backgroundImage = `url(${ props.trackImg }) !important`
+    }
+    return acc
+  })
+
+  const innerBarClass = computed(() =>
+    'q-slider__inner absolute'
+    + (props.innerTrackColor !== void 0 ? ` bg-${ props.innerTrackColor }` : '')
+  )
+  const innerBarStyle = computed(() => {
+    const acc = {
+      [ positionProp.value ]: `${ 100 * innerMinRatio.value }%`,
+      [ sizeProp.value ]: `${ 100 * (innerMaxRatio.value - innerMinRatio.value) }%`
+    }
+    if (props.innerTrackImg !== void 0) {
+      acc.backgroundImage = `url(${ props.innerTrackImg }) !important`
+    }
+    return acc
+  })
+
+  function convertRatioToModel (ratio) {
+    const { min, max, step } = props
+    let model = min + ratio * (max - min)
+
+    if (step > 0) {
+      const modulo = (model - min) % step
+      model += (Math.abs(modulo) >= step / 2 ? (modulo < 0 ? -1 : 1) * step : 0) - modulo
+    }
+
+    if (decimals.value > 0) {
+      model = parseFloat(model.toFixed(decimals.value))
+    }
+
+    return between(model, innerMin.value, innerMax.value)
+  }
+
+  function convertModelToRatio (model) {
+    return trackLen.value === 0
+      ? 0
+      : (model - props.min) / trackLen.value
+  }
+
+  function getDraggingRatio (evt, dragging) {
+    const
+      pos = position(evt),
+      val = props.vertical === true
+        ? between((pos.top - dragging.top) / dragging.height, 0, 1)
+        : between((pos.left - dragging.left) / dragging.width, 0, 1)
+
+    return between(
+      isReversed.value === true ? 1.0 - val : val,
+      innerMinRatio.value,
+      innerMaxRatio.value
+    )
+  }
 
   const markerStep = computed(() => (
     isNumber(props.markers) === true ? props.markers : step.value)
   )
 
+  const markerTicks = computed(() => {
+    const acc = []
+    const step = markerStep.value
+    const max = props.max
+
+    let value = props.min
+    do {
+      acc.push(value)
+      value += step
+    } while (value < max)
+
+    acc.push(max)
+    return acc
+  })
+
+  const markerLabelClass = computed(() => {
+    const prefix = ` ${ markerPrefixClass }${ axis.value }-`
+    return markerPrefixClass
+      + `${ prefix }${ props.switchMarkerLabelsSide === true ? 'switched' : 'standard' }`
+      + `${ prefix }${ isReversed.value === true ? 'rtl' : 'ltr' }`
+  })
+
+  const markerLabelsList = computed(() => {
+    if (props.markerLabels === false) { return null }
+
+    return getMarkerList(props.markerLabels).map((entry, index) => ({
+      index,
+      value: entry.value,
+      label: entry.label || entry.value,
+      classes: markerLabelClass.value
+        + (entry.classes !== void 0 ? ' ' + entry.classes : ''),
+      style: {
+        ...getMarkerLabelStyle(entry.value),
+        ...(entry.style || {})
+      }
+    }))
+  })
+
+  const markerScope = computed(() => ({
+    markerList: markerLabelsList.value,
+    markerMap: markerLabelsMap.value,
+    classes: markerLabelClass.value, // TODO ts definition
+    getStyle: getMarkerLabelStyle
+  }))
+
   const markerStyle = computed(() => {
-    if (minMaxDiff.value !== 0) {
-      const size = 100 * markerStep.value / minMaxDiff.value
+    if (innerBarLen.value !== 0) {
+      const size = 100 * markerStep.value / innerBarLen.value
 
       return {
+        ...innerBarStyle.value,
         backgroundSize: props.vertical === true
           ? `2px ${ size }%`
           : `${ size }% 2px`
@@ -132,37 +330,61 @@ export default function ({ updateValue, updatePosition, getDragging }) {
     return null
   })
 
-  const tabindex = computed(() => (editable.value === true ? props.tabindex || 0 : -1))
+  function getMarkerList (def) {
+    if (def === false) { return null }
 
-  const positionProp = computed(() => (
-    props.vertical === true
-      ? (isReversed.value === true ? 'bottom' : 'top')
-      : isReversed.value === true ? 'right' : 'left'
-  ))
+    if (def === true) {
+      return markerTicks.value.map(defaultMarkerConvertFn)
+    }
 
-  const sizeProp = computed(() => (props.vertical === true ? 'height' : 'width'))
+    if (typeof def === 'function') {
+      return markerTicks.value.map(value => {
+        const item = def(value)
+        return Object(item) === item ? { ...item, value } : { value, label: item }
+      })
+    }
 
-  const orientation = computed(() => (props.vertical === true ? 'vertical' : 'horizontal'))
+    const filterFn = ({ value }) => value >= props.min && value <= props.max
 
-  const attributes = computed(() => {
-    const acc = {
-      role: 'slider',
-      'aria-valuemin': props.min,
-      'aria-valuemax': props.max,
-      'aria-orientation': orientation.value,
-      'data-step': props.step
+    if (Array.isArray(def) === true) {
+      return def
+        .map(item => (Object(item) === item ? item : { value: item }))
+        .filter(filterFn)
     }
 
-    if (props.disable === true) {
-      acc[ 'aria-disabled' ] = 'true'
-    }
-    else if (props.readonly === true) {
-      acc[ 'aria-readonly' ] = 'true'
-    }
+    return Object.keys(def).map(key => {
+      const item = def[ key ]
+      const value = Number(key)
+      return Object(item) === item ? { ...item, value } : { value, label: item }
+    }).filter(filterFn)
+  }
+
+  function getMarkerLabelStyle (val) {
+    return { [ positionProp.value ]: `${ 100 * (val - props.min) / trackLen.value }%` }
+  }
+
+  const markerLabelsMap = computed(() => {
+    if (props.markerLabels === false) { return null }
 
+    const acc = {}
+    markerLabelsList.value.forEach(entry => {
+      acc[ entry.value ] = entry
+    })
     return acc
   })
 
+  function getMarkerLabelsContent () {
+    if (slots[ 'marker-label-group' ] !== void 0) {
+      return slots[ 'marker-label-group' ](markerScope.value)
+    }
+
+    const fn = slots[ 'marker-label' ] || defaultMarkerLabelRenderFn
+    return markerLabelsList.value.map(marker => fn({
+      marker,
+      ...markerScope.value
+    }))
+  }
+
   const panDirective = computed(() => {
     // if editable.value === true
     return [ [
@@ -179,36 +401,6 @@ export default function ({ updateValue, updatePosition, getDragging }) {
     ] ]
   })
 
-  function getThumbSvg () {
-    return h('svg', {
-      class: 'q-slider__thumb absolute',
-      viewBox: '0 0 20 20',
-      width: '20',
-      height: '20',
-      'aria-hidden': 'true'
-    }, [
-      h('path', { d: props.thumbPath })
-    ])
-  }
-
-  function getPinStyle (percent, ratio) {
-    if (props.vertical === true) {
-      return {}
-    }
-
-    const offset = `${ Math.ceil(20 * Math.abs(0.5 - ratio)) }px`
-    return {
-      pin: {
-        transformOrigin: `${ $q.lang.rtl === true ? offset : `calc(100% - ${ offset })` } 50%`
-      },
-
-      pinTextContainer: {
-        [ $q.lang.rtl === true ? 'left' : 'right' ]: `${ percent * 100 }%`,
-        transform: `translateX(${ Math.ceil(($q.lang.rtl === true ? -1 : 1) * 20 * percent) }px)`
-      }
-    }
-  }
-
   function onPan (event) {
     if (event.isFinal === true) {
       if (dragging.value !== void 0) {
@@ -219,6 +411,7 @@ export default function ({ updateValue, updatePosition, getDragging }) {
         emit('pan', 'end')
       }
       active.value = false
+      focus.value = false
     }
     else if (event.isFirst === true) {
       dragging.value = getDragging(event.evt)
@@ -249,10 +442,7 @@ export default function ({ updateValue, updatePosition, getDragging }) {
 
   function onDeactivate () {
     preventFocus.value = false
-
-    if (dragging.value === false) {
-      active.value = false
-    }
+    active.value = false
 
     updateValue(true)
     onBlur()
@@ -271,6 +461,158 @@ export default function ({ updateValue, updatePosition, getDragging }) {
     }
   }
 
+  function getTextContainerStyle (ratio) {
+    if (props.vertical === true) { return null }
+
+    const p = $q.lang.rtl !== props.reverse ? 1 - ratio : ratio
+    return {
+      transform: `translateX(calc(${ 2 * p - 1 } * ${ props.thumbSize } / 2 + ${ 50 - 100 * p }%))`
+    }
+  }
+
+  function getThumbRenderFn (thumb) {
+    const focusClass = computed(() => (
+      preventFocus.value === false && (focus.value === thumb.focusValue || focus.value === 'both')
+        ? ' q-slider--focus'
+        : ''
+    ))
+
+    const classes = computed(() =>
+      `q-slider__thumb q-slider__thumb${ axis.value } q-slider__thumb${ axis.value }-${ isReversed.value === true ? 'rtl' : 'ltr' } absolute non-selectable`
+      + focusClass.value
+      + (thumb.thumbColor.value !== void 0 ? ` text-${ thumb.thumbColor.value }` : '')
+    )
+
+    const style = computed(() => ({
+      width: props.thumbSize,
+      height: props.thumbSize,
+      [ positionProp.value ]: `${ 100 * thumb.ratio.value }%`,
+      zIndex: focus.value === thumb.focusValue ? 2 : void 0
+    }))
+
+    const pinColor = computed(() => (
+      thumb.labelColor.value !== void 0
+        ? ` text-${ thumb.labelColor.value }`
+        : ''
+    ))
+
+    const textContainerStyle = computed(() => getTextContainerStyle(thumb.ratio.value))
+
+    const textClass = computed(() => (
+      'q-slider__text'
+      + (thumb.labelTextColor.value !== void 0 ? ` text-${ thumb.labelTextColor.value }` : '')
+    ))
+
+    return () => {
+      const thumbContent = [
+        h('svg', {
+          class: 'q-slider__thumb-shape absolute-full',
+          viewBox: '0 0 20 20',
+          'aria-hidden': 'true'
+        }, [
+          h('path', { d: props.thumbPath })
+        ]),
+
+        h('div', { class: 'q-slider__focus-ring fit' })
+      ]
+
+      if (props.label === true || props.labelAlways === true) {
+        thumbContent.push(
+          h('div', {
+            class: pinClass.value + ' absolute fit no-pointer-events' + pinColor.value
+          }, [
+            h('div', {
+              class: labelClass.value,
+              style: { minWidth: props.thumbSize }
+            }, [
+              h('div', {
+                class: textContainerClass.value,
+                style: textContainerStyle.value
+              }, [
+                h('span', { class: textClass.value }, thumb.label.value)
+              ])
+            ])
+          ])
+        )
+
+        if (props.name !== void 0 && props.disable !== true) {
+          injectFormInput(thumbContent, 'push')
+        }
+      }
+
+      return h('div', {
+        class: classes.value,
+        style: style.value,
+        ...thumb.getNodeData()
+      }, thumbContent)
+    }
+  }
+
+  function getContent (selectionBarStyle, trackContainerTabindex, trackContainerEvents, injectThumb) {
+    const trackContent = []
+
+    props.innerTrackColor !== 'transparent' && trackContent.push(
+      h('div', {
+        key: 'inner',
+        class: innerBarClass.value,
+        style: innerBarStyle.value
+      })
+    )
+
+    props.selectionColor !== 'transparent' && trackContent.push(
+      h('div', {
+        key: 'selection',
+        class: selectionBarClass.value,
+        style: selectionBarStyle.value
+      })
+    )
+
+    props.markers !== false && trackContent.push(
+      h('div', {
+        key: 'marker',
+        class: markerClass.value,
+        style: markerStyle.value
+      })
+    )
+
+    injectThumb(trackContent)
+
+    const content = [
+      hDir(
+        'div',
+        {
+          key: 'trackC',
+          class: trackContainerClass.value,
+          tabindex: trackContainerTabindex.value,
+          ...trackContainerEvents.value
+        },
+        [
+          h('div', {
+            class: trackClass.value,
+            style: trackStyle.value
+          }, trackContent)
+        ],
+        'slide',
+        editable.value, () => panDirective.value
+      )
+    ]
+
+    if (props.markerLabels !== false) {
+      const action = props.switchMarkerLabelsSide === true
+        ? 'unshift'
+        : 'push'
+
+      content[ action ](
+        h('div', {
+          key: 'markerL',
+          class: markerLabelsContainerClass.value
+        }, getMarkerLabelsContent())
+      )
+    }
+
+    return content
+  }
+
   onBeforeUnmount(() => {
     document.removeEventListener('mouseup', onDeactivate, true)
   })
@@ -282,19 +624,21 @@ export default function ({ updateValue, updatePosition, getDragging }) {
       preventFocus,
       dragging,
 
-      axis,
-      isReversed,
       editable,
       classes,
-      decimals,
-      step,
-      minMaxDiff,
-      markerStyle,
       tabindex,
+      attributes,
+
+      step,
+      decimals,
+      trackLen,
+      innerMin,
+      innerMinRatio,
+      innerMax,
+      innerMaxRatio,
       positionProp,
       sizeProp,
-      attributes,
-      panDirective
+      isReversed
     },
 
     methods: {
@@ -302,8 +646,11 @@ export default function ({ updateValue, updatePosition, getDragging }) {
       onMobileClick,
       onBlur,
       onKeyup,
-      getThumbSvg,
-      getPinStyle
+      getContent,
+      getThumbRenderFn,
+      convertRatioToModel,
+      convertModelToRatio,
+      getDraggingRatio
     }
   }
 }