Renderizar Definições do Componente

Para renderizar as definições do componente, você pode usar um URL de definições e as opções de renderização.

URL de Definições do Componente

Um URL de definições do componente é renderizado usando um iframe e chamado com parâmetros para permitir definições específicas de um componente real que foi solto em uma página. O URL de definições tem este formato:

{Component Settings URL}?instance=<app-instance>&width=<width>&currCompId=<id of the app associated with the settings panel>&locale=<locale>
Nome Tipo Descrição

URL de Definições do Componente

URL

URL de Definições de um componente

largura

Número

Largura em pixels do iframe de Definições

currCompId

String

ID atual do componente editado pelo painel Definições

configuração regional

String

Configuração regional atual do site host (Site Builder). O formato é <idioma>_<dialeto>. Exemplo: En_us.

Opções de Renderização das Definições do Componente Local

Você tem três opções para renderizar o iframe no painel Definições de um componente local, com base no tamanho e na complexidade do iframe. Cada opção é especificada na propriedade settingsRenderOption.

Nota:

Essas opções só estão disponíveis aos componentes locais. Os painéis de Definições dos componentes remotos são renderizados sempre em uma caixa de diálogo.
  • em linha
    • Só utilize essa opção se você tiver algumas propriedades que o usuário deve informar.

    • O iframe será inserido na guia Geral no local do botão comum para navegar até o painel Definições.

    • Fornece a solução mais integrada, exigindo o mínimo de cliques do usuário, mas tem espaço limitado.

  • painel
    • Use essa opção quando você tiver uma lista maior de propriedades, mas elas ainda puderem ser razoavelmente exibidas nos 300 pixels do painel Definições padrão.

    • O iframe deslizará para a view e um botão Voltar aparecerá para retornar o usuário para a guia Geral.

    • Fornece uma solução integrada na qual você pode interagir com o iframe na página.

  • caixa de diálogo
    • O modo padrão de tratar layouts de definições mais gerais que exigem uma interface de usuário complexa.

    • Exibe o iframe em uma caixa de diálogo modal na página.