fcad-core-dragon 2.0.1 → 2.0.2-beta.1

package/src/components/AppCompInputCheckBoxNx.vue

@@ -0,0 +1,324 @@
+<!-- About this Component--
+ * Renders a checkboxe input type  for the Quiz component
+ * Related Quiz to question: REPONSE_MULTIPLE
+ * Receives the a data object defined by user
+ * Used by AppCompQuizNx
+-->
+<template>
+  <div :id="id" class="input-box">
+    <fieldset :aria-label="fieldsetLabel">
+      <template
+        v-for="(choixReponse, index) in inputData"
+        :Key="`div_chx_${id}_${choixReponse.id}`"
+      >
+        <div class="box-checkbox" role="group">
+          <label
+            :key="`lbl_chx_${id}-${choixReponse.id}`"
+            :for="`boxchx_${id}_${choixReponse.id}`"
+            class="checkbox-label"
+            :class="[
+              {
+                answerSlct: isSelected(choixReponse.value)
+              },
+              `${retro[index]}`
+            ]"
+          >
+            <input
+              :id="`boxchx_${id}_${choixReponse.id}`"
+              :key="`boxchx_${id}_${id}-${choixReponse.id}`"
+              :checked="isSelected(choixReponse.value)"
+              type="checkbox"
+              :name="`btn-checkbox-${id}`"
+              :aria-labelledby="`span_${id}_${choixReponse.id}`"
+              :aria-describedby="`${id}_${choixReponse.id}-msg-erreur`"
+              @change="onSelectUpdate($event, choixReponse.value)"
+            />
+            <span
+              :id="`span_${id}_${choixReponse.id}`"
+              class="checkbox-contenu"
+              aria-hidden="true"
+              v-html="choixReponse.value"
+            ></span>
+            <span
+              :id="`${id}_${choixReponse.id}-msg-erreur`"
+              :key="`msg_chx_${id}_${choixReponse.id}`"
+              class="sr-only"
+            >
+              {{ messageAccessibility[index] }}
+            </span>
+          </label>
+        </div>
+      </template>
+    </fieldset>
+  </div>
+</template>
+<script>
+import { useQuiz } from '../composables/useQuiz'
+import { validateObjType } from '../shared/validators'
+export default {
+  name: 'AppCompInputCheckBoxNx',
+  /* PROPS USED FOR PARENT TO COMMUNICATE DATA TO CHILD */
+  props: {
+    modelValue: {
+      type: Array,
+      default: () => []
+    },
+    inputData: {
+      type: Array,
+      default: () => []
+    },
+    solution: {
+      type: Array,
+      default: () => []
+    },
+    id: {
+      type: String,
+      default: ''
+    }
+  },
+  emits: ['update:modelValue', 'enable-submit'],
+  setup() {
+    const { retroType, addRetroStyle, resetRetroStyle } = useQuiz()
+
+    return { retroType, addRetroStyle, resetRetroStyle }
+  },
+  data() {
+    return {
+      quizInputDataValue: [],
+      result: null,
+      retro: [],
+      messageAccessibility: [],
+      selectedItems: []
+    }
+  },
+  computed: {
+    fieldsetLabel() {
+      return `${this.$t('quizState.checkboxFieldset')} ${this.inputData.length} ${this.$t('quizState.options')}`
+    },
+    /* INTERNAL REACTIVE VALUE THAT BIND WITH MODELVALUE PROPS */
+    inputsValue: {
+      get() {
+        return this.modelValue
+      },
+
+      set(newValue) {
+        if (
+          (this.$el && this.$el.id !== this.id) ||
+          newValue.constructor !== Array
+        )
+          return
+
+        this.$emit('update:modelValue', newValue)
+      }
+    },
+    /**
+     * internal reactive value that map the options to add SELECTED attribute on each option
+     * this attribute value can be changed when user select the option
+     */
+    mappedOptions() {
+      const options = this.inputData.map((op) => {
+        const selectedItem = this.modelValue.find((i) => i.id === op.id)
+        return {
+          ...op,
+          selected: selectedItem ? selectedItem.selected : false
+        }
+      })
+
+      return options
+    }
+  },
+  watch: {
+    inputsValue: {
+      handler(newVal) {
+        this.$emit('enable-submit', newVal.length > 0)
+      },
+      deep: true,
+      immediate: true
+    }
+  },
+  created() {
+    if (import.meta.env.DEV) {
+      let errors = this.validateInputData()
+
+      if (errors && errors.errorList.length)
+        return this.$bus.$emit('input-error', { e: this.id, errors })
+    }
+
+    this.quizInputDataValue = this.inputData
+  },
+  mounted() {},
+
+  methods: {
+    /**
+     * @description validate the raw data received by the component to render is view
+     * @returns {Object} errors - errorList: to display in view and errorConsole, to be displayed in console
+     */
+    validateInputData() {
+      let errors = null //array for errors dectected
+      let stringType = ['id', 'value']
+
+      if (!this.inputData.length) return errors
+      for (let i = 0; i < this.inputData.length; i++) {
+        errors = validateObjType(
+          this.inputData[i],
+          { stringType },
+          null,
+          `choix_reponse #${i + 1}`
+        )
+        const { errorList, errorInConsole } = errors
+
+        if (errorList.length || errorInConsole.length) return errors
+      }
+
+      return errors
+    },
+
+    /**
+     * @description inicate wether the element is checked or not.
+     * Element is selected if in the modelValue
+     * @param value value of tje element to be checked
+     */
+    isSelected(value) {
+      const existing = this.modelValue.includes(value)
+      return existing
+    },
+
+    /**
+     * @description Method to force update of this.inputsValue.
+     * this force the old value and new value of the input to be tracked by VUE.
+     * @param newValue, the new value of the input
+     * @param index index of the selected element
+     */
+    onSelectUpdate(event, value) {
+      if (this.$el && this.$el.id !== this.id) return //prevent event from firing on other input
+
+      const isChecked = event.target.checked
+      this.resetRetroStyle([this.retro, this.messageAccessibility])
+      let updatedValue = [...this.modelValue]
+
+      if (isChecked) {
+        const existing = updatedValue.includes(value)
+        if (!existing) updatedValue.push(value)
+      } else updatedValue = updatedValue.filter((v) => v !== value)
+
+      this.$emit('update:modelValue', updatedValue)
+    },
+    /**
+     * @description Component validation method to validate the user input against the solution
+     * can handle logic of Css style to apply (correct/wrong Answer) and return the result
+     * @return {Object} result
+     */
+    validateAnswer() {
+      // Validate the user answer
+      //Created a custom validated object for inputData
+      let mappedResults
+      if (this.solution != null) {
+        mappedResults = this.inputData.map(
+          (a) =>
+            (a = {
+              ...a,
+              correct: this.solution.includes(a.id)
+            })
+        )
+      } else {
+        mappedResults = this.inputData.map(
+          (a) =>
+            (a = {
+              ...a,
+              correct: null
+            })
+        )
+      }
+
+      let { classRetro, mesA11y } = this.addRetroStyle(
+        this.solution,
+        mappedResults,
+        this.inputData.length
+      )
+
+      this.retro = classRetro
+      this.messageAccessibility = mesA11y
+
+      //filer mapped to return a customized object of the user selection
+      this.result = mappedResults
+        .filter((a) => this.inputsValue.includes(a.value))
+        .map((a) => {
+          const { id, value, correct } = a
+          return { id, selected: value, correct }
+        })
+
+      let retro = this.retroType(this.solution, this.result)
+
+      let cAns
+      if (this.solution != null) cAns = this.computeResult(this.result)
+      else cAns = false
+
+      //Object to return validation to parent
+      return {
+        userAnswer: this.result,
+        correctAnswer: cAns,
+        retroType: retro
+      }
+    },
+    /**
+     * @description - compute the correct elements in user response
+     * compare with  the solution and return wether user succeeded or failed
+     * @param {Object} result - user responses
+     * @retuns boolean
+     */
+    computeResult(result) {
+      const res = this.result.filter((el) => el.correct)
+
+      return (
+        res.length == this.solution.length &&
+        this.solution.length == this.result.length
+      )
+    }
+  }
+}
+</script>
+<style lang="scss">
+fieldset {
+  border: inherit;
+}
+
+.custom-control-input:focus ~ .custom-control-label::before {
+  border: inherit;
+}
+
+.custom-control-input:focus ~ .custom-control-label::before {
+  box-shadow: inherit;
+  -webkit-box-shadow: inherit;
+}
+
+fieldset {
+  border: inherit;
+}
+
+.custom-checkbox {
+  width: 100%;
+  height: 100%;
+  padding-left: 0;
+
+  input {
+    width: 100%;
+    height: 100%;
+  }
+
+  label {
+    width: 100%;
+    height: 100%;
+
+    &:after,
+    &:before {
+      border: inherit;
+      top: 0px;
+      left: 0px;
+      height: 0;
+      width: 0;
+      background-color: inherit;
+      border: inherit;
+    }
+  }
+}
+</style>

package/src/components/AppCompInputDropdownNx.vue

@@ -0,0 +1,295 @@
+<!-- About this Component--
+ * Renders a SELECT input to display choices of response for the Quiz component
+ * Related Quiz to question: DROPDOWN
+ * Receives the a data object defined by user
+ * Used by AppCompQuizNx
+ * Uses useQuiz composable
+-->
+<template>
+  <div v-if="inputData.length > 0" :id="id" class="input-box">
+    <fieldset :aria-label="fieldsetLabel">
+      <div
+        v-for="(singleDropdown, index) in inputData"
+        :key="singleDropdown.id"
+        class="dropdown-container"
+        :class="`dropdownlist-${singleDropdown.id}`"
+      >
+        <label
+          :id="`label_dropdown_${id}_${singleDropdown.id}`"
+          :for="`dropdown_${id}_${singleDropdown.id}`"
+          v-html="singleDropdown.ennonce"
+        ></label>
+
+        <div class="cnt-input" :class="`${retro[index] ? retro[index] : ''}`">
+          <v-select
+            :id="`dropdown_${id}_${singleDropdown.id}`"
+            :model-value="inputsValue[singleDropdown.id]"
+            item-title="text"
+            :item-props="true"
+            :items="getItemOptions(index)"
+            :open-text="`${$t('message.dropdown_list')}_${singleDropdown.ennonce}`"
+            :aria-describedby="`${id}_${singleDropdown.id}-msg-erreur`"
+            @update:model-value="onSelectUpdate($event, index)"
+          ></v-select>
+
+          <span
+            :id="`${id}_${singleDropdown.id}-msg-erreur`"
+            :key="`msg_chx_${id}_${singleDropdown.id}`"
+            class="sr-only"
+          >
+            {{ messageAccessibility[index] }}
+          </span>
+        </div>
+      </div>
+    </fieldset>
+  </div>
+</template>
+<script>
+import { useQuiz } from '../composables/useQuiz'
+import { validateObjType } from '../shared/validators'
+export default {
+  name: 'AppCompInputDropdown',
+  /* PROPS USED FOR PARENT TO COMMUNICATE DATA TO CHILD */
+  props: {
+    modelValue: {
+      type: Array,
+      default: () => []
+    },
+    inputData: {
+      type: Array,
+      default: () => []
+    },
+    solution: {
+      type: Array,
+      default: () => []
+    },
+    id: {
+      type: String,
+      default: ''
+    }
+  },
+  emits: ['update:modelValue', 'enable-submit'],
+  setup(props) {
+    const { retroType, addRetroStyle, resetRetroStyle } = useQuiz()
+
+    return { retroType, addRetroStyle, resetRetroStyle }
+  },
+  data() {
+    return {
+      retro: [],
+      messageAccessibility: [],
+      result: [],
+      oldValue: null
+    }
+  },
+  computed: {
+    fieldsetLabel() {
+      let label
+      if (this.inputData.length === 1) {
+        label = this.$t('quizState.dropdownFieldsetSingle')
+      } else {
+        label = `${this.$t('quizState.dropdownFieldsetMulti1')} ${this.inputData.length} ${this.$t('quizState.dropdownFieldsetMulti2')}`
+      }
+      return label
+    },
+    /* INTERNAL REACTIVE VALUE THAT BIND WITH MODELVALUE PROPS */
+    inputsValue: {
+      get() {
+        return this.modelValue
+      },
+      set(newValue) {
+        this.$emit('update:modelValue', [...newValue])
+      }
+    },
+    mappedOptions() {
+      if (this.inputData.length === 0) return []
+
+      return this.inputData.map((op) => {
+        const key = Object.keys(op)[0]
+        const values = Object.values(op)[2]
+
+        const newValues = [
+          {
+            value: null,
+            disabled: true,
+            selected: true,
+            text: this.$t('message.first_option_dropdown')
+            // text: 'choisir une option'
+          },
+          ...values.map((el) => ({
+            value: el,
+            text: el,
+            selected: false
+          }))
+        ]
+
+        return {
+          [key]: newValues
+        }
+      })
+    }
+  },
+  watch: {
+    inputsValue: {
+      handler() {
+        if (this.$el && this.$el.id !== this.id) return
+        const filled = this.modelValue.filter((val) => val && val.trim() !== '')
+
+        this.$emit('enable-submit', filled.length === this.inputData.length)
+      },
+      deep: true,
+      immediate: true
+    }
+  },
+  created() {
+    if (import.meta.env.DEV) {
+      let errors = this.validateInputData()
+      if (errors && errors.errorList.length) {
+        return this.$bus.$emit('input-error', { e: this.id, errors })
+      }
+    }
+  },
+  mounted() {},
+
+  methods: {
+    validateInputData() {
+      let errors = null
+      let stringType = ['id', 'ennonce']
+      let arrayType = ['option']
+      let e = null
+
+      if (!this.inputData.length) return errors
+      for (let i = 0; i < this.inputData.length; i++) {
+        e = validateObjType(
+          this.inputData[i],
+          { stringType, arrayType },
+          null,
+          `liste déroulante #${i + 1}`
+        )
+
+        if (e.errorInConsole.length && e.errorList.length) {
+          errors.errorInConsole.push(e.errorInConsole[0])
+          errors.errorList.push(e.errorList[0])
+        }
+      }
+
+      return errors
+    },
+    /**
+     * @description Method to retrive the options of each selectable input in the mappedOption Object
+     * @param {Number } index - number representing the index of the item in the array of inputElements
+     * @Return a collection of item representing the options for a the selectables
+     */
+    getItemOptions(index) {
+      return Object.values(this.mappedOptions[index])[0]
+    },
+    /**
+     * @description Method to force update of this.inputsValue.
+     * this force the old value and new value of the input to be tracked by VUE.
+     * @param newValue, the new value of the input
+     * @param index index of the selected element
+     */
+
+    onSelectUpdate(newValue, index) {
+      if (this.$el && this.$el.id !== this.id) return //prevent event from firing on other input
+      this.resetRetroStyle([this.retro, this.messageAccessibility])
+      const updated = [...this.inputsValue] //create new array from inputsValue
+      updated[index] = newValue
+      this.inputsValue = updated //trigger vue reactivity for inputsValue
+    },
+    /**
+     * @description Component validation method to validate the user input against the solution
+     * can handle logic of Css style to apply (correct/wrong Answer) and return the result
+     * @return {Object} result
+     */
+    validateAnswer() {
+      let mappedResults
+      if (this.solution != null) {
+        mappedResults = this.inputsValue.map((a, i) => {
+          const s = this.solution[i]
+          return { selected: a, correct: s == a }
+        })
+      } else {
+        mappedResults = this.inputsValue.map((a, i) => {
+          return { selected: a, correct: false }
+        })
+      }
+
+      let { classRetro, mesA11y } = this.addRetroStyle(
+        this.solution,
+        mappedResults,
+        this.inputData.length
+      )
+
+      this.retro = [...classRetro]
+      this.messageAccessibility = [...mesA11y]
+
+      this.retro = classRetro
+      this.messageAccessibility = mesA11y
+
+      this.result = mappedResults.filter((a) => a.selected)
+      let tr = this.retroType(this.solution, this.result)
+
+      let cAns
+      if (this.solution != null) cAns = this.computeResult(this.result)
+      else cAns = false
+
+      return {
+        userAnswer: this.result,
+        correctAnswer: cAns,
+        retroType: tr
+      }
+    },
+    computeResult(result) {
+      const res = result.filter((el) => el.correct)
+      return res.length == this.solution.length
+    }
+  }
+}
+</script>
+<style lang="scss">
+.dropdown-container {
+  position: relative;
+}
+
+div.texteatrou {
+  display: inline !important;
+  .cnt-input {
+    display: inline;
+
+    .v-input {
+      display: inline-block !important;
+
+      .v-input__control,
+      .v-field {
+        width: 240px !important;
+        grid-area: inherit !important;
+
+        .v-field__field {
+          height: 25px !important;
+          padding: 0 !important;
+          min-height: inherit !important;
+
+          .v-field__input {
+            padding-top: 0 !important;
+            padding-bottom: 0 !important;
+            min-height: inherit !important;
+
+            .v-select__selection {
+              min-height: inherit !important;
+            }
+          }
+        }
+
+        .v-field__append-inner {
+          margin-right: 6px;
+        }
+      }
+
+      .v-input__details {
+        display: none;
+      }
+    }
+  }
+}
+</style>