JSDoc: Namespace: Fields

All Module and theme HubSpot Fields

This is a collection of `hubspot-fields-js` functions (Methods) that are used to generete fields (json) for HubSpot modules and themes.

Source:

types/namespaces.js, line 1

Methods

(static) alignment(label, name, fieldsopt) → {COMMON_FIELDS}

Alignment field

only_style_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| ALIGNMENT_FIELD	<optional>

Source:

style-tab-fields.js, line 17

Returns:

Type: COMMON_FIELDS

Example

fi.alignment('label', 'name', {...options if needed})

(static) audioplayer(label, name, fieldsopt) → {COMMON_FIELDS}

Audioplayer field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| AUDIO_FIELD	<optional>

Source:

content-tab-fields.js, line 37

Returns:

Type: COMMON_FIELDS

Example

fi.audioplayer('label', 'name', {...options if needed})

(static) backgroundimage(label, name, fieldsopt) → {COMMON_FIELDS}

backgroundimage field

only_style_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| BACKGROUND_IMAGE_FIELD	<optional>

Source:

style-tab-fields.js, line 37

Returns:

Type: COMMON_FIELDS

Example

fi.backgroundimage('label', 'name', {...options if needed})

(static) blog(label, name, fieldsopt) → {COMMON_FIELDS}

Blog field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| BLOG_FIELD	<optional>

Source:

content-tab-fields.js, line 57

Returns:

Type: COMMON_FIELDS

Example

fi.blog('label', 'name', {...options if needed})

(static) boolean(label, name, fieldsopt) → {COMMON_FIELDS}

Boolean field

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| BOOLEAN_FIELD	<optional>

Source:

fields.js, line 17

Returns:

Type: COMMON_FIELDS

Example

fi.boolean('label', 'name', {...options if needed})

(static) border(label, name, fieldsopt) → {COMMON_FIELDS}

border field

only_style_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| BORDER_FIELD	<optional>

Source:

style-tab-fields.js, line 57

Returns:

Type: COMMON_FIELDS

Example

fi.border('label', 'name', {...options if needed})

(static) choice(label, name, fieldsopt) → {COMMON_FIELDS}

Choice field

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| CHOICE_FIELD	<optional>

Source:

fields.js, line 36

Returns:

Type: COMMON_FIELDS

Example

fi.choice('label', 'name', {...options if needed})

(static) color(label, name, fieldsopt) → {COMMON_FIELDS}

Color field

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| COLOR_FIELD	<optional>

Source:

fields.js, line 74

Returns:

Type: COMMON_FIELDS

Example

fi.color('label', 'name', {...options if needed})

(static) crmobject(label, name, fieldsopt) → {COMMON_FIELDS}

crmobject field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| CRM_OBJECT_FIELD	<optional>

Source:

content-tab-fields.js, line 77

Returns:

Type: COMMON_FIELDS

Example

fi.crmobject('label', 'name', {...options if needed})

(static) crmobjectproperty(label, name, fieldsopt) → {COMMON_FIELDS}

crmobjectproperty field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| CRM_OBJECT_PROPERTY_FIELD	<optional>

Source:

content-tab-fields.js, line 97

Returns:

Type: COMMON_FIELDS

Example

fi.crmobjectproperty('label', 'name', {...options if needed})

(static) cta(label, name, fieldsopt) → {COMMON_FIELDS}

cta field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| CTA_FIELD	<optional>

Source:

content-tab-fields.js, line 117

Returns:

Type: COMMON_FIELDS

Example

fi.cta('label', 'name', {...options if needed})

(static) date(label, name, fieldsopt) → {COMMON_FIELDS}

date field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| DATE_FIELD	<optional>

Source:

content-tab-fields.js, line 137

Returns:

Type: COMMON_FIELDS

Example

fi.date('label', 'name', {...options if needed})

(static) datetime(label, name, fieldsopt) → {COMMON_FIELDS}

datetime field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| DATA_AND_TIME_FIELD	<optional>

Source:

content-tab-fields.js, line 157

Returns:

Type: COMMON_FIELDS

Example

fi.datetime('label', 'name', {...options if needed})

(static) email(label, name, fieldsopt) → {COMMON_FIELDS}

email field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| EMAIL_ADDRESS_FIELD	<optional>

Source:

content-tab-fields.js, line 177

Returns:

Type: COMMON_FIELDS

Example

fi.email('label', 'name', {...options if needed})

(static) embed(label, name, fieldsopt) → {COMMON_FIELDS}

embed field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| EMBEDED_FIELD	<optional>

Source:

content-tab-fields.js, line 197

Returns:

Type: COMMON_FIELDS

Example

fi.embed('label', 'name', {...options if needed})

(static) file(label, name, fieldsopt) → {COMMON_FIELDS}

file field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| FILE_FIELD	<optional>

Source:

content-tab-fields.js, line 217

Returns:

Type: COMMON_FIELDS

Example

fi.file('label', 'name', {...options if needed})

(static) font(label, name, fieldsopt) → {COMMON_FIELDS}

font field

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| FONT_FIELD	<optional>

Source:

fields.js, line 55

Returns:

Type: COMMON_FIELDS

Example

fi.font('label', 'name', {...options if needed})

(static) form(label, name, fieldsopt) → {COMMON_FIELDS}

form field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| FORM_FIELD	<optional>

Source:

content-tab-fields.js, line 237

Returns:

Type: COMMON_FIELDS

Example

fi.form('label', 'name', {...options if needed})

(static) gradient(label, name, fieldsopt) → {COMMON_FIELDS}

gradient field

only_style_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| GRADIENT_FIELD	<optional>

Source:

style-tab-fields.js, line 77

Returns:

Type: COMMON_FIELDS

Example

fi.gradient('label', 'name', {...options if needed})

(static) html(label, name, fieldsopt) → {COMMON_FIELDS}

html field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| HTML_FIELD	<optional>

Source:

content-tab-fields.js, line 257

Returns:

Type: COMMON_FIELDS

Example

fi.html('label', 'name', {...options if needed})

(static) hubdbrow(label, name, fieldsopt) → {COMMON_FIELDS}

hubdbrow field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| HUBDB_ROW_FIELD	<optional>

Source:

content-tab-fields.js, line 277

Returns:

Type: COMMON_FIELDS

Example

fi.hubdbrow('label', 'name', {...options if needed})

(static) hubdbtable(label, name, fieldsopt) → {COMMON_FIELDS}

hubdbtable field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| HUBDB_TABLE_FIELD	<optional>

Source:

content-tab-fields.js, line 297

Returns:

Type: COMMON_FIELDS

Example

fi.hubdbtable('label', 'name', {...options if needed})

(static) hubl(label, name, fieldsopt) → {COMMON_FIELDS}

hubl field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| HUBL_FIELD	<optional>

Source:

content-tab-fields.js, line 317

Returns:

Type: COMMON_FIELDS

Example

fi.hubl('label', 'name', {...options if needed})

(static) icon(label, name, fieldsopt) → {COMMON_FIELDS}

icon field

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| ICON_FIELD	<optional>

Source:

fields.js, line 112

Returns:

Type: COMMON_FIELDS

Example

fi.icon('label', 'name', {...options if needed})

(static) image(label, name, fieldsopt) → {COMMON_FIELDS}

image field

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| IMAGE_FIELD	<optional>

Source:

fields.js, line 93

Returns:

Type: COMMON_FIELDS

Example

fi.image('label', 'name', {...options if needed})

(static) link(label, name, fieldsopt) → {COMMON_FIELDS}

link field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| LINK_FIELD	<optional>

Source:

content-tab-fields.js, line 397

Returns:

Type: COMMON_FIELDS

Example

fi.link('label', 'name', {...options if needed})

(static) logo(label, name, fieldsopt) → {COMMON_FIELDS}

logo field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| LOGO_FIELD	<optional>

Source:

content-tab-fields.js, line 377

Returns:

Type: COMMON_FIELDS

Example

fi.logo('label', 'name', {...options if needed})

(static) meeting(label, name, fieldsopt) → {COMMON_FIELDS}

meeting field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| MEETING_FIELD	<optional>

Source:

content-tab-fields.js, line 357

Returns:

Type: COMMON_FIELDS

Example

fi.meeting('label', 'name', {...options if needed})

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| MENU_FIELD	<optional>

Source:

content-tab-fields.js, line 337

Returns:

Type: COMMON_FIELDS

Example

fi.menu('label', 'name', {...options if needed})

(static) number(label, name, fieldsopt) → {COMMON_FIELDS}

number field

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| NUMBER_FIELD	<optional>

Source:

fields.js, line 131

Returns:

Type: COMMON_FIELDS

Example

fi.number('label', 'name', {...options if needed})

(static) page(label, name, fieldsopt) → {COMMON_FIELDS}

page field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| PAGE_FIELD	<optional>

Source:

content-tab-fields.js, line 497

Returns:

Type: COMMON_FIELDS

Example

fi.page('label', 'name', {...options if needed})

(static) payment(label, name, fieldsopt) → {COMMON_FIELDS}

payment field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| PAYMENT_FIELD	<optional>

Source:

content-tab-fields.js, line 477

Returns:

Type: COMMON_FIELDS

Example

fi.payment('label', 'name', {...options if needed})

(static) podcast(label, name, fieldsopt) → {COMMON_FIELDS}

podcast field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| PODCAST_FIELD	<optional>

Source:

content-tab-fields.js, line 457

Returns:

Type: COMMON_FIELDS

Example

fi.podcast('label', 'name', {...options if needed})

(static) richtext(label, name, fieldsopt) → {COMMON_FIELDS}

richtext field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| RICHTEXT_FIELD	<optional>

Source:

content-tab-fields.js, line 417

Returns:

Type: COMMON_FIELDS

Example

fi.richtext('label', 'name', {...options if needed})

(static) simplemenu(label, name, fieldsopt) → {COMMON_FIELDS}

simplemenu field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| SIMPLE_MENU_FIELD	<optional>

Source:

content-tab-fields.js, line 437

Returns:

Type: COMMON_FIELDS

Example

fi.simplemenu('label', 'name', {...options if needed})

(static) spacing(label, name, fieldsopt) → {COMMON_FIELDS}

spacing field

only_style_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| SPACING_FIELD	<optional>

Source:

style-tab-fields.js, line 97

Returns:

Type: COMMON_FIELDS

Example

fi.spacing('label', 'name', {...options if needed})

(static) tag(label, name, fieldsopt) → {COMMON_FIELDS}

tag field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| TAG_FIELD	<optional>

Source:

content-tab-fields.js, line 517

Returns:

Type: COMMON_FIELDS

Example

fi.tag('label', 'name', {...options if needed})

(static) text(label, name, fieldsopt) → {COMMON_FIELDS}

Text fields provide content creators a simple text editing experience with no rich text functionality. Text fields initially show as a single line, but can actually expand to be textareas, supporting multiple lines.

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| TEXT_FIELD	<optional>

Source:

content-tab-fields.js, line 17

Returns:

Type: COMMON_FIELDS

Example

fi.text('label', 'name', {...options if needed})

(static) textalignment(label, name, fieldsopt) → {COMMON_FIELDS}

textalignment field

only_style_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| TEXT_ALIGNMENT_FIELD	<optional>

Source:

style-tab-fields.js, line 117

Returns:

Type: COMMON_FIELDS

Example

fi.textalignment('label', 'name', {...options if needed})

(static) url(label, name, fieldsopt) → {COMMON_FIELDS}

url field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| URL_FIELD	<optional>

Source:

content-tab-fields.js, line 557

Returns:

Type: COMMON_FIELDS

Example

fi.url('label', 'name', {...options if needed})

(static) video(label, name, fieldsopt) → {COMMON_FIELDS}

videoplayer field

only_content_tab

Parameters:

Name	Type	Attributes	Description
`label`	string		Field label
`name`	string		Field name (HubL variable name)
`fields`	BASE_FIELDS \| VIDEO_FIELD	<optional>

Source:

content-tab-fields.js, line 537

Returns:

Type: COMMON_FIELDS

Example

fi.videoplayer('label', 'name', {...options if needed})

Namespace: Fields

All Module and theme HubSpot Fields

This is a collection of hubspot-fields-js functions (Methods) that are used to generete fields (json) for HubSpot modules and themes.

Methods

(static) alignment(label, name, fieldsopt) → {COMMON_FIELDS}

Alignment field

Parameters:

Returns:

Example

(static) audioplayer(label, name, fieldsopt) → {COMMON_FIELDS}

Audioplayer field

Parameters:

Returns:

Example

(static) backgroundimage(label, name, fieldsopt) → {COMMON_FIELDS}

backgroundimage field

Parameters:

Returns:

Example

(static) blog(label, name, fieldsopt) → {COMMON_FIELDS}

Blog field

Parameters:

Returns:

Example

(static) boolean(label, name, fieldsopt) → {COMMON_FIELDS}

Boolean field

Parameters:

Returns:

Example

(static) border(label, name, fieldsopt) → {COMMON_FIELDS}

border field

Parameters:

Returns:

Example

(static) choice(label, name, fieldsopt) → {COMMON_FIELDS}

Choice field

Parameters:

Returns:

Example

(static) color(label, name, fieldsopt) → {COMMON_FIELDS}

Color field

Parameters:

Returns:

Example

(static) crmobject(label, name, fieldsopt) → {COMMON_FIELDS}

crmobject field

Parameters:

Returns:

Example

(static) crmobjectproperty(label, name, fieldsopt) → {COMMON_FIELDS}

crmobjectproperty field

Parameters:

Returns:

Example

(static) cta(label, name, fieldsopt) → {COMMON_FIELDS}

cta field

Parameters:

Returns:

Example

(static) date(label, name, fieldsopt) → {COMMON_FIELDS}

date field

Parameters:

Returns:

Example

(static) datetime(label, name, fieldsopt) → {COMMON_FIELDS}

datetime field

Parameters:

Returns:

Example

(static) email(label, name, fieldsopt) → {COMMON_FIELDS}

email field

Parameters:

Returns:

Example

(static) embed(label, name, fieldsopt) → {COMMON_FIELDS}

embed field

Parameters:

Returns:

Example

(static) file(label, name, fieldsopt) → {COMMON_FIELDS}

This is a collection of `hubspot-fields-js` functions (Methods) that are used to generete fields (json) for HubSpot modules and themes.