Link

The link field can be used to create a reference to other entries, or a an external resource (like a webpage or an email address).

link('My link field', {
  type: 'entry'
})

/**

Optional settings to configure a link field */

export type LinkOptions<T, Q>

{

/**

Add extra fields to each link */

fields: TypeConfig<T>

/**

Add instructional text to a field */

help: Label

/**

Display a minimal version */

inline: boolean

/**

Maximum amount of links that can be selected */

max: number

/**

Allow multiple links */

multiple: boolean

/**

Field is optional */

optional: boolean

/**

The type of links, this will configure the options of the link picker */

type:

| LinkType

| Array<LinkType>

/**

Width of the field in the dashboard UI (0-1) */

width: number

/**

Modify value returned when queried through `Pages` */

query<P>(

field: Expr<Array<(Entry & T) & (Url & T)>>,

pages: Pages<P>

): undefined | Expr<Q>

}