element-plus/website/docs/fr-FR/dialog.md
2021-06-08 14:11:33 +08:00

10 KiB
Raw Blame History

Dialog

Informe les utilisateurs tout en préservant l'état de la page.

Usage

Le Dialog ouvre un modal personnalisable.

:::demo Configurez model-value / v-model avec un Boolean, un modal apparaîtra quand la valeur sera à true. Le Dialog possède deux parties: body et footer, ce-dernier nécessitant un slot appelé footer. L'attribut optionnel title (vide par défaut) définit le titre. Cet exemple montre également comment before-close peut être utilisé.

<el-button type="text" @click="dialogVisible = true">Cliquez pour ouvrir le modal</el-button>

<el-dialog
  title="Tips"
  v-model="dialogVisible"
  width="30%"
  :before-close="handleClose">
  <span>Ceci est un message</span>
  <template #footer>
    <span class="dialog-footer">
      <el-button @click="dialogVisible = false">Annuler</el-button>
      <el-button type="primary" @click="dialogVisible = false">Confirmer</el-button>
    </span>
  </template>
</el-dialog>

<script>
  export default {
    data() {
      return {
        dialogVisible: false
      };
    },
    methods: {
      handleClose(done) {
        this.$confirm('Voulez-vous vraiment quitter ?')
          .then(_ => {
            done();
          })
          .catch(_ => {});
      }
    }
  };
</script>

:::

:::tip before-close ne fonctionne que quand l'utilisateur clique sur l'icône de fermeture en dehors du modal. S'il y a des boutons dans le footer, vous pouvez configurer before-close grâce à leur évènement click. :::

Personalisation

Le contenu du modal peut être n'importe quoi, tableau ou formulaire compris.

:::demo

<!-- Table -->
<el-button type="text" @click="dialogTableVisible = true">Ouvrir un modal avec tableau</el-button>

<el-dialog title="Adresse d'expédition" v-model="dialogTableVisible">
  <el-table :data="gridData">
    <el-table-column property="date" label="Date" width="150"></el-table-column>
    <el-table-column property="name" label="Nom" width="200"></el-table-column>
    <el-table-column property="address" label="Adresse"></el-table-column>
  </el-table>
</el-dialog>

<!-- Form -->
<el-button type="text" @click="dialogFormVisible = true">Ouvrir un modal avec formulaire</el-button>

<el-dialog title="Adresse d'expédition" v-model="dialogFormVisible">
  <el-form :model="form">
    <el-form-item label="Nom de promotion" :label-width="formLabelWidth">
      <el-input v-model="form.name" autocomplete="off"></el-input>
    </el-form-item>
    <el-form-item label="Zones" :label-width="formLabelWidth">
      <el-select v-model="form.region" placeholder="Sélectionnez une zone">
        <el-option label="Zone No.1" value="shanghai"></el-option>
        <el-option label="Zone No.2" value="beijing"></el-option>
      </el-select>
    </el-form-item>
  </el-form>
  <template #footer>
    <span class="dialog-footer">
      <el-button @click="dialogFormVisible = false">Annuler</el-button>
      <el-button type="primary" @click="dialogFormVisible = false">Confirmer</el-button>
    </span>
  </template>
</el-dialog>

<script>
  export default {
    data() {
      return {
        gridData: [{
          date: '2016-05-02',
          name: 'John Smith',
          address: 'No.1518,  Jinshajiang Road, Putuo District'
        }, {
          date: '2016-05-04',
          name: 'John Smith',
          address: 'No.1518,  Jinshajiang Road, Putuo District'
        }, {
          date: '2016-05-01',
          name: 'John Smith',
          address: 'No.1518,  Jinshajiang Road, Putuo District'
        }, {
          date: '2016-05-03',
          name: 'John Smith',
          address: 'No.1518,  Jinshajiang Road, Putuo District'
        }],
        dialogTableVisible: false,
        dialogFormVisible: false,
        form: {
          name: '',
          region: '',
          date1: '',
          date2: '',
          delivery: false,
          type: [],
          resource: '',
          desc: ''
        },
        formLabelWidth: '120px'
      };
    }
  };
</script>

:::

Dialog imbriqué

Si un Dialog est imbriqué dans un autre Dialog, append-to-body est requis.

:::demo Normalement l'utilisation de Dialog imbriqué est déconseillée. Si vous avez besoin de plusieurs Dialogs sur la page, vous pouvez les aplatir afin qu'ils soit au même niveau. Si vous devez absolument utiliser un Dialog imbriqué, configurez l'attribut append-to-body du Dialog imbriqué à true et il sera ajouté au body au lieu de son noeud parent, afin d'avoir un affichage correct.

<template>
  <el-button type="text" @click="outerVisible = true">Ouvrir le modal extérieur</el-button>

  <el-dialog title="Modal extérieur" v-model="outerVisible">
    <el-dialog
        width="30%"
        title="Modal intérieur"
        v-model="innerVisible"
        append-to-body>
    </el-dialog>
    <template #footer>
      <div class="dialog-footer">
        <el-button @click="outerVisible = false">Annuler</el-button>
        <el-button type="primary" @click="innerVisible = true">Ouvrir le modal intérieur</el-button>
      </div>
    </template>
  </el-dialog>
</template>

<script>
  export default {
    data() {
      return {
        outerVisible: false,
        innerVisible: false
      };
    }
  }
</script>

:::

Centrer le contenu

Le contenu du modal peut être centré.

:::demo Régler center à true centrera horizontalement le header et le footer. center n'affecte que le header et le footer. Le contenu du body pouvant être n'importe quoi, si vous désirez le centrer vous devrez ajouter des règles CSS.

<el-button type="text" @click="centerDialogVisible = true">Cliquez pour ouvrir le modal</el-button>

<el-dialog
  title="Attention"
  v-model="centerDialogVisible"
  width="30%"
  center>
  <span>Le contenu du modal n'est pas centré par défaut.</span>
  <template #footer>
    <span class="dialog-footer">
      <el-button @click="centerDialogVisible = false">Annuler</el-button>
      <el-button type="primary" @click="centerDialogVisible = false">Confirmer</el-button>
    </span>
  </template>
</el-dialog>

<script>
  export default {
    data() {
      return {
        centerDialogVisible: false
      };
    }
  };
</script>

:::

:::tip Le contenu de Dialog bénéficie du lazy loading, ce qui signifie que le slot par défaut n'est pas généré par le DOM avant la première ouverture. Si vous avez besoin de manipuler le DOM ou d'accéder à un composant via ref, vous pouvez le faire avec la callback de l'évènement open. :::

Destroy on Close (Translation needed)

When this is feature is enabled, the content under default slot will be destroyed with a v-if directive. Enable this when you have perf concerns.

:::demo Note that by enabling this feature, the content will not be rendered before transition.beforeEnter dispatched, there will only be overlay header(if any) footer(if any).

<el-button type="text" @click="centerDialogVisible = true">Click to open Dialog</el-button>

<el-dialog
  title="Notice"
  v-model="centerDialogVisible"
  width="30%"
  destroy-on-close
  center>
  <span>Notice: before dialog gets opened for the first time this node and the one bellow will not be rendered</span>
  <div>
    <strong>Extra content (Not rendered)</strong>
  </div>
  <template #footer>
    <span class="dialog-footer">
      <el-button @click="centerDialogVisible = false">Cancel</el-button>
      <el-button type="primary" @click="centerDialogVisible = false">Confirm</el-button>
    </span>
  </template>

</el-dialog>

<script>
  export default {
    data() {
      return {
        centerDialogVisible: false
      };
    }
  };
</script>

:::tip When using modal = false, please make sure that append-to-body was set to true, because Dialog was positioned by position: relative, when modal gets removed, Dialog will position itself based on the current position in the DOM, instead of Document.Body, thus the style will be messed up. :::

Attributs

Attribut Description Type Valeurs acceptées Défaut
model-value / v-model Visibilité du Dialog boolean
title Titre du Dialog. Peut aussi être passé via un slot (voir la table suivante). string
width Largeur du Dialog. string / number 50%
fullscreen Si le Dialog doit être en plein écran. boolean false
top Valeur du margin-top du CSS du Dialog. string 15vh
modal Si un masque est affiché. boolean true
append-to-body S'il faut ajouter le Dialog au body. Un Dialog imbriqué doit avoir cet attribut à true. boolean false
lock-scroll Si le défilement du body est désactivé. boolean true
custom-class Nom de classe pour le Dialog string
open-delay Temps (millisecondes) avant la ouvert number 0
close-delay Temps (millisecondes) avant la proche number 0
close-on-click-modal Si le Dialog peut être fermé en cliquant sur le masque. boolean true
close-on-press-escape Si le Dialog peut être fermé en appuyant sur Echap. boolean true
show-close Si le bouton de fermeture doit apparaître. boolean true
before-close Callback avant la fermeture du Dialog. function(done)done est utilisé pour fermer le Dialog.
center Si le header et le footer doivent être centrés. boolean false
destroy-on-close Destroy elements in Dialog when closed boolean false

Slot

Nom Description
Contenu du Dialog.
title Contenu du titre.
footer Contenu du footer.

Évènements

Nom Description Paramètres
open Se déclenche quand le Dialog s'ouvre.
opened Se déclenche quand l'animation d'ouverture est terminée.
close Se déclenche quand le Dialog se ferme.
closed Se déclenche quand l'animation de fermeture du Dialog est terminée.