Iridium CMSIridium CMS

text

The text property is used to define a plain text value.


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

export const sample = atom('sample', {
  myText: text(),
});

Configuration

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

  • minLengthnumber
    The minimum length of the field. Defaults to 0.
  • maxLengthnumber
    The maximum length of the field. Defaults to Infinity.
  • 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.
  • placeholderstring
    The input placeholder text in the admin. Defaults to undefined.
  • patternRegExp
    A regular expression pattern that the field value must match. Defaults to undefined.