Iridium CMSIridium CMS

url

The url property is used to define a valid URL value.

NOTE: for URLs to be valid, they are required to have a protocol (e.g. https://) and a domain (e.g. example.com).


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

export const sample = atom('sample', {
  myUrl: url(),
});

Configuration

The url 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.
  • 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.