Última modificação: 28 de agosto de 2025
Adicione campos aos módulos e temas para permitir que os criadores de conteúdo controlem os diferentes aspectos de uma página dentro do editor de páginas. Saiba mais sobre todos os campos disponíveis para módulos e temas, além de suas propriedades disponíveis.
Para obter mais informações sobre a implementação de campos de tema e módulo, incluindo grupos de campos e campos de repetição, consulte a visão geral dos campos de tema e módulo.
Propriedades utilizadas por todos os campos
Todos os campos compartilham um conjunto de propriedades comuns. Estes são campos gerais, como o nome do campo ou o texto de ajuda exibido para os criadores de conteúdo usando o campo no módulo ou tema.name
| String | O nome do campo, que você usará ao incorporar o campo e seus valores no módulo ou tema. Não pode conter espaços ou caracteres especiais. | richtext_field, date_field, etc.
|
| label
| String | O texto que o criador do conteúdo vê com a descrição do campo. Pode conter espaços. | Rich text field, Date field, etc.
|
| required
| Booleano | Determina se o campo pode ser deixado em branco no editor. Se true
, o conteúdo não poderá ser publicado sem um valor no campo. | false
|
| locked
| Booleano | Determina se o campo pode ser editado no editor de conteúdo. Se true
, o campo não aparecerá no editor de conteúdo. | false
|
| type
| String | O tipo de campo. Os tipos de campo são exclusivos por campo e podem ser encontrados na documentação de cada campo abaixo. | |
| inline_help_text
| String | O texto que exibe o rótulo do campo abaixo do campo (limite 400 caracteres). Melhor usado para informações necessárias para usar o campo. Você pode incluir as seguintes tags de HTML (outras tags serão ignoradas na renderização): a
, b
, br
, em
, i
, p
, small
, strong
, span
. | |
| help_text
| String | O texto que é exibido no editor dentro de uma dica de ferramenta ao passar o cursor do mouse para ajudar o criador de conteúdo (limite de 300 caracteres). Melhor usado para informações complementares, mas não necessárias para usar o campo. Você pode incluir as seguintes tags de HTML (outras tags serão ignoradas na renderização): a
, b
, br
, em
, i
, p
, small
, strong
, span
. | |
| id
| String | O ID exclusivo do campo, que é definido pelo HubSpot. Ao criar localmente, não é necessário especificar este ID. | |
| visibility
| Matriz | Define as condições de exibição do campo. Por exemplo, você pode definir um campo para exibir apenas quando outro campo de caixa de seleção tiver sido selecionado. Saiba mais sobre a visibilidade. | |
| display_width
| String | Por padrão, os campos são de largura completa no editor. Quando dois campos consecutivos no arquivo fields.json
estiverem definidos como half_width
, eles aparecerão um ao lado do outro no editor. | | |
| alias_mapping
| String | Um alias para o campo, que mapeia valores de campo existentes para um novo local sem quebrar o conteúdo existente. Isso pode ser útil quando for necessário atualizar um campo que está sendo usado no conteúdo ativo, como mover um campo da aba Conteúdo para a aba Estilos. Saiba mais sobre mapeamento de alias. | False
|
Alinhamento
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Objeto | Objeto contendo horizontal_align e vertical_align . | |
alignment_direction | String | Determina se apenas os controles de alinhamento horizontal ou vertical, ou ambos, devem ser mostrados. Pode ser:
| BOTH |
Imagem de fundo
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Objeto | O objeto que contendo o src da imagem, a posição do plano de fundo e o tamanho do fundo. | null |
Blog
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | ”default” / id do blog | Especifica qual blog é selecionado por padrão. Este parâmetro aceita argumentos padrão ou um ID de blog (disponível na URL do painel do blog). | null |
Booleano
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Booleano | Define se o estado padrão deste campo é true ou false . | false |
display | String | Escolha o estilo de exibição visual para o campo. Pode aparecer como um toggle ou checkbox . | checkbox |
Um botão pode fazer sentido quando o valor do campo ativa/desativa outros campos que são mostrados de forma condicional. Outra situação em que um botão pode ser útil é quando o campo representa uma grande mudança de design para o módulo.As caixas de seleção fazem sentido para alterações menores que podem não ter um efeito tão significativo na exibição do módulo, como ocultar ou mostrar pequenos elementos individuais.
Borda
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Booleano | Objeto com chaves para o raio da borda, as partes superior e inferior e os lados direito e esquerdo. | {} |
Escolha
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
choices | Matriz | Matriz contendo as opções selecionáveis, formatadas como um valor interno exclusivo seguido do rótulo. | [ [ "value 1", "Label 1" ], [ "value 2", "Label 2" ] ] |
default | Valor | Define o valor padrão selecionado da matriz de opções. | |
multiple | Booleano | Campo opcional que permite que várias opções sejam selecionadas quando definido como true .Defina display como checkbox ou select para configurar se o campo será exibido como uma lista de caixas de seleção ou um menu suspenso. | false |
display | String | Defina a aparência do campo usando um dos seguintes valores:
| "select" |
reordering_enabled | Booleano | Quando definido como true , permite que os criadores de conteúdo reordenem as opções do campo no editor. Para habilitar isso, multiple também deve ser definido como true . | false |
preset | String | Configura o botão predefinido para usar quando display estiver definido como buttons . Para cada predefinição, você precisará configurar os rótulos choices para corresponder a um conjunto específico de valores. Saiba mais sobre estas opções predefinidas abaixo. |
Predefinições do botão de escolha
Para configurar um campo de escolha para exibir botões em vez de um menu suspenso, caixas de seleção ou botões de opção, você pode usar uma das predefinições abaixo. Cada predefinição permite um conjunto específico de rótulos de opções, que você precisará incluir na matrizchoices
. Esses rótulos não podem ser personalizados.
Predefinição | Rótulos de escolha | Exemplo |
---|---|---|
case | none | upper | lower |

expand_icon
| caret
| plus
| chevron
|

icon_background_shape
| none
| square
| rounded
| circle
|

icon_size
| small
| medium
| large
|

layout
| cards
| tiles
| minimal
|

social_icon_background_shape
| none
| square
| rounded
| circle
|

social_icon_size
| small
| medium
| large
|

Cor
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Objeto | Define a cor e a opacidade padrão selecionadas. | { "color" : "#ffffff", "opacity" : 100 } |
show_opacity | Booleano | Define se a entrada de opacidade é mostrada.
| undefined |
limited_options | Matriz | Uma matriz de strings que oculta a grade de cores padrão e substitui a lista de cores favoritas (o rótulo “Favoritos” se torna “Cores disponíveis”). Os valores na matriz devem ser um código hexadecimal ou um color valor hexadecimal em qualquer caminho de herança. | undefined |
CTA
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | String | A CTA selecionada por padrão. Espera um ID de CTA que pode ser encontrado na URL ao editar uma CTA no gerenciador de CTA. | null |
Objeto do CRM
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
object_type | String | Tipo de objeto do CRM que o usuário pode escolher. Tipos de objetos do CRM suportados | |
properties_to_fetch | Matriz | Matriz de nomes de propriedades associadas ao tipo de objeto em forma de string. Exemplo: "date_of_birth" é uma propriedade associada a um contato. Use isso para limitar as informações que são disponibilizadas na página apenas àquelas de que você precisa. | |
default | Objeto | Objeto com ID da instância do objeto selecionado por padrão. ID de contato, ID de empresa etc. | null |
Propriedade do objeto do CRM
Parâmetro | Tipo | Descrição |
---|---|---|
object_type | String | Tipo de objeto do CRM que o usuário pode escolher. Saiba mais sobre os tipos de objeto do CRM compatíveis. |
default | Objeto | Contém a propriedade padrão para exibir. |
{{ module.fieldname.property }}
: retorna o nome interno da propriedade.{{ module.fieldname.property_definition.label }}
: retorna o rótulo da propriedade.{{ module.fieldname.property_definition.type }}
: retorna o tipo de propriedade (por exemplo, string).
Data
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Data/hora | O carimbo de data/hora Unix Epoch para a data e a hora que você quer usar por padrão. Deixe como nulo para permitir que o seletor de data e hora indique a data e a hora atuais para o criador do conteúdo. | null |
Data e hora
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Data/hora | O carimbo de data/hora Unix Epoch para a data e a hora que você quer usar por padrão. Deixe como nulo para permitir que o seletor de data e hora indique a data e a hora atuais para o criador do conteúdo. | null |
Endereço de e-mail
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Matriz | Matriz de strings de endereços de e-mail ["bob@example.com", "dennis@example.com"] | null |
Incorporação
supported_source_types
| Matriz | Tipos de fontes suportados para URLs oEmbed (oembed
), código de incorporação HTML (html
) ou Media Bridge (media_bridge
). | ["oembed", "html"]
|
| supported_oembed_types
| Matriz | O tipo de oEmbed suportado, inclui "photo"
, "video"
, "link"
e "rich"
. Não se aplica a supported_source_types de html | [ "photo", "video", "link", "rich" ]
|
| supported_media_bridge_providers
| Matriz | Matriz de IDs de provedor que determina quais provedores de Media Bridge estão disponíveis para selecionar conteúdo.Observação: esse parâmetro também será preenchido durante a instalação de um Aplicativo de provedor de Media Bridge. | | |
| type
| String | Este parâmetro está sempre definido como "embed"
| "embed"
|
| default
| Dict | Uma matriz contendo o parâmetro "source_type"
. Este parâmetro tem um valor baseado em string das opções fornecidas no parâmetro "supported_source_types"
. | oembed
|Arquivo
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | String | URL do arquivo. | null |
picker | String | Valores aceitáveis: “file”, “document”, “image”. O seletor mostra os ativos que foram carregados no gerenciador de arquivos ou no gerenciador de documentos, dependendo deste parâmetro. | file |
E-mail de acompanhamento
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | String | ID de e-mail | null |
Fonte
Observação:
- A família de fontes é determinada pela combinação das propriedades
font
efont_set
. Você deve incluir ambas para carregar a fonte. Ao herdar campos, você precisa herdar ambos os valores. - Ocultar subcampos relacionados ao CSS com
visibility
não impedirá que o CSS seja exibido no estilo retornado pelo objeto de campo. Você ainda precisará incluir manualmente o CSS no objetostyles
.
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Objeto | Objeto de fonte com definições de tamanho, unidade de tamanho, cor e estilos para negrito, itálico e sublinhado. | { "size" : 12, "size_unit" : "px", "color" : "#000", "styles" : { } } |
load_external_fonts | Booleano | O HubSpot carregará automaticamente a fonte web selecionada na página se ela estiver selecionada e referenciada pelo HubL em uma folha de estilo ou em um módulo. Defina como falso se você já estiver carregando a fonte na página, assim a fonte não será carregada duas vezes. | true |
visibility | Objeto | Usando o objeto aninhado hidden_subfields , você pode definir um booleano para os controles do campo de fonte que devem ser ocultados. Os subcampos incluem: font , size , bold , italic , underline e color . | |
variant | String | Ao usar uma fonte da Web; a variante da fonte que você deseja usar. Por exemplo, para usar um peso de fonte de 700, defina como "700" . Para usar itálico e um peso de fonte de 400, defina como "400i" . | |
limited_options | Matriz | Matriz de strings que substitui a lista de todas as opções de fonte. Os valores na matriz devem ser um nome de fonte codificado ou uma fonte name propriedade em qualquer caminho de herança. Por exemplo theme.typography.body_text.name . | undefined |
Formulário
Parâmetro | Tipo | Descrição |
---|---|---|
default | Objeto | Um objeto que contém os detalhes da resposta de envio do formulário. Inclui os seguintes parâmetros:
|
disable_inline_form_editing | String | Defina a propriedade disable_inline_form_editing como true para ocultar todos os controles de edição de formulário integrados no módulo de formulário. Isso inclui os campos do formulário, o texto do botão de envio, as opções de privacidade e consentimento de dados e o CAPTCHA. |
required_property_types | Matriz | Uma matriz que especifica quais formulários podem ser selecionados com base nos tipos de propriedade dos campos do formulário. Os valores incluem: "CONTACT" , "COMPANY" e "TICKET" . |
support_all_webinar_types | Booleano | Quando definido para true , o formulário mostrará um seletor de webinar mais genérico que permite selecionar webinars do Microsoft Teams, além do GoToWebinar. Os valores do campo do formulário também mudarão ligeiramente para economizar webinar_id e webinar_source em vez de gotowebinar_webinar_key . Você precisará passar esses valores de propriedade mais genéricos de volta para a Tag de formulário ao lado gotowebinar_webinar_key . |
embed_versions | Matriz | Uma matriz que especifica quais formulários podem ser selecionados com base na versão do formulário. Os valores incluem "v2" para formulários herdados e "v4" para novos formulários do editor. |
Gradiente
Parâmetro | Tipo | Descrição |
---|---|---|
default | Objeto | O objeto que contêm a orientação de um gradiente (“side_or_corner”) e paradas de cor para o gradiente como uma matriz de objetos. |
Linha do HubDB
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
table_name_or_id | String | O nome ou o ID da tabela do HubDB. Este campo é obrigatório. | |
columns_to_fetch | Matriz | Uma matriz de nomes de colunas para buscar na tabela. Se for deixado em branco, retornará todas as colunas da tabela. | [] |
display_columns | Matriz | Uma matriz de nomes de colunas para usar no rótulo de opção. Se for deixado em branco, retornará apenas a primeira coluna da tabela. | [] |
display_format | String | O formato em que você deseja que os dados da coluna fossem exibidos no seletor de linha do HubDB usando o símbolo de porcentagem e o número para designar uma coluna. Ex: %0 (%1) apareceria como Column0Value (Column1Value) | "" |
default | Objeto | Objeto que contém “id” para definir a linha de hubdb padrão. | { "id" : null } |
Tabela HubDb
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | String | ID da tabela do HubDB | null |
Ícone
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Objeto | Objeto de ícone | |
icon_set | String | O ícone do FontAwesome que deve ser usado. Estes são os possíveis valores:
| fontawesome-5.0.10 |
Imagem
Os campos de imagem são suportados nos módulos. As imagens podem ser usadas como campos de estilo. Você somente deve usar campos de imagem como campos de estilo se a imagem for puramente representativa, ou seja, não transmita significado e não seja uma imagem de fundo. Isso serve para seguir as práticas recomendadas de acessibilidade.Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Objeto | Define as propriedades para dimensionamento de imagens, texto alternativo e muito mais. Pode conter as seguintes propriedades:
| { "size_type" : "auto", "src" : "", "alt" : null, "loading": "disabled" } |
responsive | Booleano | Determina se a imagem deve agir de forma responsível ou se deve ter altura e largura fixas. | true |
show_loading | Booleano | Determina se os controles para escolher carregar a imagem de forma lenta são mostrados no editor de páginas. | false |
Link
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Objeto | O URL padrão e o comportamento de abertura do link. Este objeto inclui:
| { "url" : { "content_id" : null, "type" : "EXTERNAL", "href" : "" }, "open_in_new_tab" : false, "no_follow" : false, "sponsored" : false, "user_generated_content" : false } |
supported_types | Matriz | Os tipos de links que os criadores de conteúdo podem selecionar. Remova os tipos da lista que você não quer que os criadores de conteúdo tenham acesso para definir. Os tipos de valores incluem:
| [ "EXTERNAL", "CONTENT", "FILE", "EMAIL_ADDRESS", "BLOG", "CALL_TO_ACTION", "PHONE_NUMBER", "WHATSAPP_NUMBER", "PAYMENT" ] |
show_advanced_rel_options | Booleano | Por padrão, os criadores de conteúdo só poderão selecionar a opção no_follow .Quando definido como true , os criadores de conteúdo também podem selecionar:
| false |
Logotipo
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
show_loading | String | Determina se os controles para escolher carregar a imagem de forma lenta são mostrados no editor de páginas. | false |
default | Objeto | Objeto de logotipo. Se show_loading estiver definido como true , você poderá incluir uma propriedade loading para definir as opções de carregamento lento da imagem. As opções incluem:
| { override_inherited_src: false, src: "", alt: null, width: null, height: null, loading: "disabled" suppress_company_name: false } |
Menu
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Inteiro | O ID de menu para o menu. Valor padrão é null ; assume o menu padrão na navegação. | null |
Número
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Número | Um número padrão a ser usado. | null |
prefix | String | Adicionado como um prefixo ao campo de número. | |
suffix | String | Adicionado como um sufixo ao campo de número. | |
placeholder | String | Adiciona um valor de espaço reservado ao campo. |
Os parâmetros de sufixo e prefixo são para fins de exibição no editor de conteúdo e não afetam o valor numérico do campo.
Página
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Inteiro | Um ID de página predefinido a ser selecionado. | null |
Rich text
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | String | A string de conteúdo a ser exibida suporta HTML. Observação: você não pode usar a função get_asset_url dentro dessa propriedade padrão. | "" |
enabled_features | Matriz | Uma matriz de itens que permite configurar a barra de ferramentas do editor de rich text e determinar quais opções estão disponíveis para os editores de conteúdo. |
Menu simples
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Matriz de objetos | Estrutura JSON para menus e menus secundários. | [] |
Espaçamento
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Objeto | Define os valores de espaçamento padrão.Contém os objetos padding e margin :
units para definir as unidades que um criador de conteúdo pode usar no HubSpot. Saiba mais sobre as unidades abaixo. | {} |
limits | Objeto | Define as diretrizes para a quantidade min e max de espaçamento. Contém os objetos padding e margin :
units para definir as unidades que um criador de conteúdo pode usar no HubSpot. Saiba mais sobre as unidades abaixo. |
- Você deve incluir uma lista
units
ao definirmin
oumax
. - A propriedade
units
suporta os seguintes tipos de unidade:%
,ch
,em
,ex
,in
,lh
,pc
,pt
,px
,Q
,rem
,vh
,vmax
,vmin
evw
. - Quando um criador de conteúdo edita todos os deslocamentos de uma vez, o HubSpot usa o maior valor
min
e o menor valormax
. Além disso, somente as unidades compartilhadas por todos os lados estarão disponíveis para o criador do conteúdo.
Tag
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | String | A ID da tag. | null |
tag_value | Sting | O valor de saída. Pode ser um de:
| SLUG |
Texto
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | String | String de texto. | "" |
Alinhamento de texto
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Objeto | Objeto contendo horizontal_align e vertical_align . | |
alignment_direction | String | Determina se apenas os controles de alinhamento horizontal ou vertical, ou ambos, devem ser mostrados. Pode ser:
| BOTH |
URL
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Objeto | Objeto de URL, com tipo, href e id do conteúdo (se o conteúdo for uma página ou post no HubSpot) | { "content_id" : null, "href" : "", "type" : "EXTERNAL" } |
supported_types | Matriz | Lista dos tipos de links que podem ser selecionados pelos criadores de conteúdo. Remova os tipos da lista que você não quer que os criadores de conteúdo tenham acesso para definir. Os tipos incluem:
| [ "EXTERNAL", "CONTENT", "FILE", "EMAIL_ADDRESS", "BLOG" ] |
Vídeo
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
default | Objeto | Objeto de vídeo com configurações para player_id , height , width , size_type , conversion_asset , loop_video , mute_by_default , autoplay e hide_control . | [] |
show_advanced_options | Booleano | Se os criadores de conteúdo podem ver as opções padrão avançadas. | false |
Parâmetros de objeto conversion_asset
Parâmetro | Tipo | Descrição | Padrão |
---|---|---|---|
type | String | Aceita "FORM" , "CTA" ou "" | "" |
id | String | O ID do formulário ou tipo de CTA | "" |
position | String | Se o ativo de conversão deve ser mostrado antes do início do vídeo ou depois de este terminar. Aceita “PRE” ou “POST”. | "" |