Navigation & Routes

Navigation & Routes

Introdução

Um dos pontos altos de uma boa aplicação de admin é garantir que está bem posicionada e que sua navegação é simples. Para controlar a navegação no menu lateral do admin VTEX existem dois arquivos que serão úteis: o navigation.json e o routes.json.

navigation.json

O navigation é o arquivo que define as regras de navegação na barra lateral do admin VTEX. Com ele você pode construir desde um link mais simples, em que um clique leva para sua app, como construir menus mais complexos com submenus associados.

imageimage

routes.json

O routes é quem define as rotas e componentes react associados, da sua aplicação, qualquer componente que esteja mapeado para uma rota, deve ser declarado no routes, ainda que não esteja diretamente associado a um item de navegação no navigation.json.

Atividade

  1. Dentro da pasta admin/ criada no passo anterior, crie mais dois arquivos, o navigation.json e o routes.json
|_ admin/
+ |_ navigation.json
+ |_ routes.json
  1. No navigation.json crie um objeto JSON com as propriedades section, titleId e path:
{
  "section": "orders",
  "titleId": "admin-example.navigation.label",
  "path": "/admin/iotraining"
}
  1. No routes.json atribua um component e um path para a navegação criada:
{
  "admin.app.example": {
    "component": "adminExample",
    "path": "/admin/app/iotraining"
  }
}

NOTA: O mapeamento de um navigation para uma route é feito através do path. O path deve divergir apenas por um /app/ no routes.json

//navigation.json

/admin/{{seupath}}

//routes.json

/admin/app/{{seupath}}
  1. Para finalizar, crie um componente simples de hello world com o mesmo nome que você deu para o component no routes.json
//react/adminExample.tsx
import React, { FC } from 'react'

const AdminExample: FC = () => {
  return <h1>Hello, World!</h1>
}

export default AdminExample

Link a aplicação (vtex link). O resultado deve ser o seguinte:

imageimage

Repare que o menu criado está sem nenhuma mensagem ainda, nós o evoluiremos posteriormente, clique no espaço em branco mostrado acima para ver a mensagem de Hello, World!.

Está com dúvidas?

Veja o gabarito para esta etapa ou participe do nosso office hours


Ajude-nos a fazer este conteúdo melhor!

Os cursos do VTEX IO são de código aberto. Se você perceber algum problema, pode abrir um pull request!

Faça uma contribuição

ou abra uma issue