15. Projeto [vuejs-13]: Atualização de um componente, utilizando uma sessão

O projeto [vuejs-13] baseia-se no projeto [vuejs-12], introduzindo a seguinte alteração: a matriz apresentada pela tabela HTML é definida num objeto [session] conhecido por todos os componentes. Trata-se, portanto, de uma forma de partilhar informações entre componentes. Este conceito é diretamente inspirado na sessão web. Utilizamos o método plugin para disponibilizar este objeto partilhado num atributo [Vue.$session].

A estrutura de diretórios do projeto é a seguinte:

15.1. O objeto [session]

O objeto [session] partilhado por todos os componentes é definido no script [./session.js]:


const session = {
  // liste des simulations
  get lignes() {
    return this._lignes;
  },
  // génération de la liste des simulations
  generateLignes() {
    this._lignes =
      [
        { id: 3, marié: "oui", enfants: 2, salaire: 35000, impôt: 1200 },
        { id: 5, marié: "non", enfants: 2, salaire: 35000, impôt: 1900 },
        { id: 7, marié: "non", enfants: 0, salaire: 30000, impôt: 2000 }
      ]
  },
  // suppression ligne n° index
  deleteLigne(index) {
    this._lignes.splice(index, 1);
  }
}
// export de l'objet [session]
export default session;

15.2. O plugin [./plugins/pluginSession]

O script [pluginSession] é o seguinte:


export default {
  install(Vue, session) {
    // ajoute une propriété [$session] à la classe vue
    Object.defineProperty(Vue.prototype, '$session', {
      // lorsque Vue.$session est référencé, on rend le 2ième paramètre [session] de la méthode [install]
      get: () => session,
    })
  }
}

linha 4: o objeto partilhado [session] estará disponível na propriedade [$session] de todos os componentes;

15.3. O script principal [main.js]

O script principal [main.js] é o seguinte:


// imports
import Vue from 'vue'
import App from './App.vue'

// plugins
import BootstrapVue from 'bootstrap-vue'
Vue.use(BootstrapVue);
 
// bootstrap
import 'bootstrap/dist/css/bootstrap.css'
import 'bootstrap-vue/dist/bootstrap-vue.css'
 
// session
import session from './session';
import pluginSession from './plugins/pluginSession'
Vue.use(pluginSession, session)
 
// configuration
Vue.config.productionTip = false
 
// instanciation projet [App]
new Vue({
  name: "app",
  render: h => h(App),
}).$mount('#app')

linhas 14–16: o plugin [pluginSession] é integrado na estrutura [Vue.js];
após a linha 16, o atributo [$session] fica disponível para todos os componentes;

15.4. A vista principal [App]

A vista [App] fica agora da seguinte forma:


<template>
  <div class="container">
    <b-card>
      <!-- message -->
      <b-alert show variant="success" align="center">
        <h4>[vuejs-13] : mise à jour d'un composant, partage des données avec une session</h4>
      </b-alert>
      <!-- table HTML -->
      <Table @updateTable="updateTable" :key="versionTable"/>
    </b-card>
  </div>
</template>
 
<script>
import Table from "./components/Table";
export default {
  // nom
  name: "app",
  // composants
  components: {
    Table
  },
  // état interne
  data() {
    return {
      // version table
      versionTable: 1
    };
  },
 
  // méthodes
  methods: {
    updateTable() {
      // eslint-disable-next-line
      console.log("App updateTable");
      // incrément version table
      this.versionTable++;
    }
  }
};
</script>

Comentários

A vista [App] já não gere a tabela apresentada pelo componente [Table] na linha 9;
linha 9: o componente [Table] emite o evento [updateTable], que solicita que o componente [Table] seja renderizado novamente. Uma forma de fazer isto é utilizar o atributo [:key]. Atribuímos a este atributo um valor mutável. Sempre que é modificado, o componente [Table] é renderizado novamente;
Linha 9: O valor do atributo [:key] é o atributo [versionTable] na linha 27. O método [updateTable] (linhas 33–38) é responsável por regenerar o componente [Table] da linha 9. Para tal, o método incrementa o valor do atributo [:key] do componente [Table] na linha 37. O componente [Table] é então regenerado automaticamente;

15.5. O componente [Table]

O componente [Table] evolui da seguinte forma:


<template>
  <div>
    <!-- empty list -->
    <template v-if="lignes.length==0">
      <b-alert show variant="warning">
        <h4>Votre liste de simulations est vide</h4>
      </b-alert>
      <!-- reload button-->
      <b-button variant="primary" @click="rechargerListe">Recharger la liste</b-button>
    </template>
    <!-- non-empty list-->
    <template v-if="lignes.length!=0">
      <b-alert show variant="primary" v-if="lignes.length==0">
        <h4>Liste de vos simulations</h4>
      </b-alert>
      <!-- simulation table -->
      <b-table striped hover responsive :items="lignes" :fields="fields">
        <template v-slot:cell(action)="row">
          <b-button variant="link" @click="supprimerLigne(row.index)">Supprimer</b-button>
        </template>
      </b-table>
    </template>
  </div>
</template>
 
<script>
export default {
  // état calculé
  computed: {
    lignes() {
      return this.$session.lignes;
    }
  },
  // état interne
  data() {
    return {
      fields: [
        { label: "#", key: "id" },
        { label: "Marié", key: "marié" },
        { label: "Nombre d'enfants", key: "enfants" },
        { label: "Salaire", key: "salaire" },
        { label: "Impôt", key: "impôt" },
        { label: "", key: "action" }
      ]
    };
  },
  // méthodes
  methods: {
    supprimerLigne(index) {
      // eslint-disable-next-line
      console.log("Table supprimerLigne", index);
      // on supprime la ligne
      this.$session.deleteLigne(index);
      // on demande au composant parent de mettre à jour la vue
      this.$emit("updateTable");
    },
    // rechargement de la liste affichée
    rechargerListe() {
      // eslint-disable-next-line
      console.log("Table rechargerListe");
      // on régènère la liste des simulations
      this.$session.generateLignes();
      // on demande au composant parent de mettre à jour la vue
      this.$emit("updateTable");
    }
  }
};
</script>

Comentários:

o atributo [rows] (linhas 4, 12, 17) já não é um parâmetro definido pelo componente pai, mas sim um atributo calculado do componente [Table] (linhas 30–32). [rows] é, portanto, a matriz [$session.rows] (linha 31);
Linhas 49–56: O método [deleteRow] remove uma linha da matriz [$session.rows]. Por predefinição, esta eliminação não altera a apresentação da tabela HTML. Isto deve-se ao facto de os elementos de [$session] não serem reativos: as alterações que lhes são feitas não se refletem nos componentes que os utilizam. Por esta razão, o componente [Table] solicita ao seu pai que o regenere utilizando o evento [updateTable] (linha 55). Vimos que o componente pai incrementaria então o atributo [:key] do componente [Table] para forçar a sua regeneração;
linhas 58–65: o método [reloadList] solicita ao objeto [$session] que regenere a matriz [$session.rows]. Pela mesma razão que antes, esta modificação de [$session.list] não altera, por predefinição, a apresentação da tabela HTML. Por este motivo, o componente [Table] solicita ao seu pai que o regenere utilizando o evento [updateTable] (linha 64).

15.6. Executar o projeto

Obtemos os mesmos resultados que no projeto [vuejs-12].