`email`

The email property is used to define a valid email value.


import { atom, email } from '@iridiumcms/core';

export const sample = atom('sample', {
  myEmail: email(),
});

Configuration

The email field takes an optional configuration object with the following properties:

defaultValuestring
The default value of the field. Defaults to undefined.
displayNamestring
The display name of the field. Defaults to the name of the property.
domainsstring[]
A list of valid email domains. Defaults to undefined.
requiredboolean
Whether the field is required. Defaults to false.
searchableboolean
Whether the field is searchable. Defaults to false.
filterableboolean
Allows filtering the field. Defaults to false.
layoutLAYOUT
The layout of the field in the admin. Defaults to LAYOUT.full.