import { Meta, Canvas, Source } from '@storybook/blocks';
import * as IsValidEmailStories from './IsValidEmail.stories';

<Meta of={IsValidEmailStories} />
<style>
{
`
      .header {
      padding: 2rem;
      margin-bottom: 2rem;
    }
    
    .header h1 {
      margin-top: 0;
      color:  #0c419a;;
      font-size: 2.5rem;
      font-weight: 700;
    }
    
    .header p {
      font-size: 1.1rem;
      margin-bottom: 0;
    }
    `
}
</style>

<div className="header">
  <h1>Règle de validation `isValidEmail`</h1>
  <p>La règle de validation `isValidEmail` permet de vérifier si une chaîne de caractère est une adresse email valide.</p>
</div>

## Usage

Pour utiliser cette règle de validation, vous devez importer la fonction d'ordre supérieur `isValidEmailFn` depuis le package `@cnamts/synapse`.

<Source dark code={`
import { isValidEmailFn } from '@cnamts/synapse';
`} />

Vous devez ensuite faire appel à cette fonction pour obtenir la règle de validation.

<Source dark code={`
const isValidEmail = isValidEmailFn(/* optionals options */);
`} />

Vous pouvez ensuite utiliser la fonction retournée comme règle d'un champs de formulaire.

<Source dark code={`
<script setup lang="ts">
import { isValidEmailFn } from '@cnamts/synapse';
import { VTextField } from 'vuetify/components';

const isValidEmail = isValidEmailFn();
</script>

<template>
	<VTextField
		:rules="[isValidEmail]"
		label="Email"
	/>
</template>

`} />

Si vous n'utilisez cette règle sans options, vous pouvez faire appel à la fonction `isValidEmail`.

<Source dark code={`
<script setup lang="ts">
import { isValidEmail } from '@cnamts/synapse';
import { VTextField } from 'vuetify/components';
</script>

<template>
	<VTextField
		:rules="[isValidEmail]"
		label="Email"
	/>
</template>

`} />

## API

<Source dark code={`
isValidEmailFn(
	errorMessages?: {
		default: string;
	}
): (value: string) => true | string;
`} />

### Arguments

- `errorMessages` : objet optionnel permettant de personnaliser les messages d'erreur. Les clés disponibles sont :
	- `default` : message d'erreur par défaut.

### Valeurs de retour

Retourne une fonction pouvant être utilisée comme règle de validation pour un champs de formulaire Vuetify.

## Exemples

<Canvas of={IsValidEmailStories.Default} />
