Field | /mod.ts | netlify_cms_config@v0.3.2

class Field

Re-export

import { Field } from "https://deno.land/x/netlify_cms_config@v0.3.2/mod.ts";

Constructors

new

Field(label: string, config: Options)

optional

Options extends BaseOptions = BaseOptions

config: Options

label: string

widget: string

getName(): string

Get the current name

hint(hint: string): this

Optionally add helper text directly below a widget. Useful for including instructions. Accepts markdown for bold, italic, strikethrough, and links.

name(name: string): this

Change the field name

pattern(pattern: string, error: string): this

Add field validation by specifying a list with a regex pattern and an error message.

required(required?): this

Makes the field mandatory.

toJSON(): Record<string, any>

Return the field as JSON