Controle de mensagem de boas vindas

Layout

O controle <vtex.cmc:welcomeMessage/> renderiza uma mensagem de boas vindas, que deve ser usada na topbar da loja.

Veja um exemplo na imagem abaixo.

${"base64":" ","img":{"width":331,"height":41,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":2199,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/pt/tutorials/Storefront/Layout/controle-de-mensagem-de-boas-vindas_1.png"}}$

Código HTML renderizado

Veja abaixo um exemplo do código renderizado por esse controle:


<div class="welcome col-xs-5">
	<script>
	    $(document).ready(function () {
	        vtexid.setScope('1acde8b8-c134-45ca-bda6-8496f39d6734');
	        vtexid.setScopeName('lojadobreno');
	        $('body').on('click', '#login', function () {
	            vtexid.start(
	                    {
	                        returnUrl: '/produto-teste/p',
	                        userEmail: '',
	                        locale: 'en-US',
	                        forceReload: false
	                    });
	        });
	    });
	</script>
	<div class="ajax-content-loader" rel="/no-cache/user/welcome">
	    <p class="welcome">
	    Bem-vindo!
	    <em><a id="login">Já é cadastrado?
	    </a></em>
	    </p>
	</div>
</div>

Note que o controle renderiza um código HTML com a mensagem de boas vindas e também um script.

Esse script é acionado quando o usuário clica no elemento de id "login", que por padrão vem com a mensagem "Já é cadastrado?", e é responsável por levar o usuário para a tela de login.

O script renderizado pelo controle também cria um cookie responsável por informar à loja que o usuário está logado.

Outros serviços da VTEX usam o mesmo cookie (por exemplo, o de avaliações de produtos), e assim não preciam pedir novamente que o usuário faça login.

Veja no script do exemplo acima que o método que cria esse cookie é o vtexid.setScope().

Ainda seguindo o exemplo acima, o cookie criado seria o seguinte: UsuarioGUID=1acde8b8-c134-45ca-bda6-8496f39d6734

Código HTML renderizado

Script de acionamento do login

Cookie