nginstack

Module: @nginstack/engine/context/vendor

Members

<static> appBarLogoUrl :string

URL da imagem que deve ser exibida na barra de tarefas. Recomendações:

  • A altura da imagem deve ser de 24px (ou proporcional)
  • A largura da imagem deve ter no máximo 120px
  • A imagem não deve ter bordas vazias

Importante: com a evolução do sistema, a imagem informada pode se tornar inadequada ao padrão adotado no tema, sendo necessária a sua revisão. Por potencialmente ser impactada a cada atualização do sistema, evite alterar esta propriedade.

Type:
  • string

<static> colors :ThemeColors

Cores a serem utilizadas nas interfaces do sistema.

Esta propriedade não pode ser modificada parcialmente. Sempre que for modificar as cores, atribua um novo objeto na propriedade colors ou utilize o Object.assign para complementar os valores atuais conforme o exemplo.

Type:
  • ThemeColors
Example
vendor.colors = Object.assign(vendor.colors, {
  primary: '#1565c0',
  onPrimary: '#ffffff',
  secondary: '#cfd8dc',
  onSecondary: '#000000'
});

<static> faviconUrl :string

URL da imagem favicon que será exibida caso não haja uma explicitamente configurada no tema ou na tela de login.

Type:
  • string

<static> footerLogoTitle :string

O texto que descreve a imagem do logotipo no rodapé dos relatórios.

Type:
  • string

<static, nullable> footerLogoUrl :number|string

A chave ou URL do arquivo com a logomarca do fornecedor do sistema, para o rodapé dos relatórios.

Type:
  • number | string

<static> legalName :string

Razão social do fornecedor do sistema.

Type:
  • string

<static> logoTitle :string

O texto que descreve a imagem do logotipo do fornecedor do sistema.

Type:
  • string

<static> logoUrl :number|string

A chave ou URL do arquivo com a logomarca do fornecedor do sistema.

Type:
  • number | string

<static> mainMenuLogoUrl :string

Type:
  • string
Deprecated:
  • Utilize `appBarLogoUrl`

<static> name :string

O nome de fantasia do fornecedor do sistema.

Type:
  • string

<static> siteUrl :string

URI para o site do fornecedor do sistema.

Type:
  • string

<static> systemName :string

Nome de exibição do sistema.

Type:
  • string

Type Definitions

ThemeColors

Cores a serem utilizadas nas interfaces do sistema.

Type:
  • Object
Properties:
Name Type Argument Description
primary string

A cor primária é aquela que será mais utilizada nas telas e componentes do sistema.
onPrimary string

Cor dos elementos textuais, iconográficos e traços quando exibidos sobre a cor primária.
surface string

Cor da superfície dos componentes.
onSurface string

Cor dos elementos textuais, iconográficos e traços quando exibidos sobre a cor de superfície.
error string

Cor que deve ser utilizada para destacar os erros do sistema.
onError string

Cor dos elementos textuais, iconográficos e traços quando exibidos sobre a cor de erro.
background string

Cor do plano de fundo do sistema.
link string

Cor dos links do sistema.
secondary string <nullable>

A cor secundária permite acentuar e distinguir elementos do tema. Ter uma cor secundária é opcional e deve ser aplicada com moderação, apenas com objetivo de realçar alguns componentes do sistema em relação à cor primária.
onSecondary string <nullable>

Cor dos elementos textuais, iconográficos e traços quando exibidos sobre a cor secundária.