Number.vue 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  1. <!--
  2. An input for numeric values
  3. -->
  4. <!-- eslint-disable vue/valid-v-bind -->
  5. <template>
  6. <v-text-field
  7. ref="input"
  8. :model-value.number="modelValue"
  9. :label="label || field ? $t(label ?? field) : undefined"
  10. :rules="rules"
  11. type="number"
  12. :variant="variant"
  13. density="compact"
  14. :error="error || !!fieldViolations"
  15. :error-messages="
  16. errorMessage || (fieldViolations ? $t(fieldViolations) : '')
  17. "
  18. @update:model-value="onModelUpdate($event)"
  19. @change="onChange($event)"
  20. />
  21. </template>
  22. <script setup lang="ts">
  23. import type { PropType, Ref } from 'vue'
  24. import {useFieldViolation} from "~/composables/form/useFieldViolation";
  25. type ValidationRule = (value: string | number | null) => boolean | string
  26. const props = defineProps({
  27. modelValue: {
  28. type: Number,
  29. required: true,
  30. default: null,
  31. },
  32. /**
  33. * Nom de la propriété d'une entité lorsque l'input concerne cette propriété
  34. * - Utilisé par la validation
  35. * - Laisser null si le champ ne s'applique pas à une entité
  36. */
  37. field: {
  38. type: String,
  39. required: false,
  40. default: null,
  41. },
  42. /**
  43. * Label du champ
  44. * Si non défini, c'est le nom de propriété qui est utilisé
  45. */
  46. label: {
  47. type: String,
  48. required: false,
  49. default: null,
  50. },
  51. default: {
  52. type: Number,
  53. required: false,
  54. default: 0,
  55. },
  56. min: {
  57. type: Number,
  58. required: false,
  59. default: null,
  60. },
  61. max: {
  62. type: Number,
  63. required: false,
  64. default: null,
  65. },
  66. /**
  67. * @see https://vuetifyjs.com/en/api/v-autocomplete/#props-variant
  68. */
  69. variant: {
  70. type: String as PropType<
  71. | 'filled'
  72. | 'outlined'
  73. | 'plain'
  74. | 'underlined'
  75. | 'solo'
  76. | 'solo-inverted'
  77. | 'solo-filled'
  78. | undefined
  79. >,
  80. required: false,
  81. default: 'outlined',
  82. },
  83. /**
  84. * Règles de validation
  85. * @see https://vuetify.cn/en/components/forms/#validation-with-submit-clear
  86. */
  87. rules: {
  88. type: Array as PropType<ValidationRule[]>,
  89. required: false,
  90. default: () => [],
  91. },
  92. /**
  93. * Le champ est-il actuellement en état d'erreur
  94. */
  95. error: {
  96. type: Boolean,
  97. required: false,
  98. default: false,
  99. },
  100. /**
  101. * Si le champ est en état d'erreur, quel est le message d'erreur?
  102. */
  103. errorMessage: {
  104. type: String,
  105. required: false,
  106. default: null,
  107. },
  108. })
  109. /**
  110. * Reference to the v-text-field
  111. */
  112. // eslint-disable-next-line
  113. const input: Ref<any> = ref(null)
  114. const { fieldViolations, updateViolationState } = useFieldViolation(props.field)
  115. /**
  116. * Cast the value to a number, or fallback on default value
  117. * @param val
  118. */
  119. const cast = (val: number | string): number => {
  120. val = Number(val)
  121. if (isNaN(val)) {
  122. return props.default
  123. }
  124. return val
  125. }
  126. /**
  127. * Ensure the value is between min and max values
  128. * @param val
  129. */
  130. const keepInRange = (val: number) => {
  131. if (props.min !== null && props.max !== null && props.min >= props.max) {
  132. console.warn('Number input: minimum value is greater than maximum value')
  133. }
  134. if (props.min !== null && val < props.min) {
  135. val = props.min
  136. }
  137. if (props.max !== null && val > props.max) {
  138. val = props.max
  139. }
  140. return val
  141. }
  142. const emit = defineEmits(['update:modelValue', 'change'])
  143. const onModelUpdate = (event: string) => {
  144. emit('update:modelValue', keepInRange(cast(event)))
  145. }
  146. const onChange = (event: Event | undefined) => {
  147. updateViolationState()
  148. emit('change', event)
  149. }
  150. /**
  151. * Setup min and max values at the input level
  152. */
  153. onMounted(() => {
  154. const inputElement = input.value!.$el.querySelector('input')
  155. if (props.min !== null) {
  156. inputElement.min = props.min
  157. }
  158. if (props.max !== null) {
  159. inputElement.max = props.max
  160. }
  161. })
  162. onUnmounted(() => {
  163. updateViolationState()
  164. })
  165. </script>