Funções de ajuda Javascript

Descrição#

São definidas algumas funções em Javascript no arquivo assets/js/theme/modules/helpers.js para facilitar o uso do tema.

As funções são definidas globalmente usando o arquivo assets/js/theme/modules/helpersGlobal.js e, portanto, podem ser chamadas desde qualquer escopo.

Funções de ajuda JavaScript#

Code Descrição
closeModals(modal);

Função para manejo de fechamento modal

  • Se é preenchida unicamente é fechado o modal incluído como input
  • Se não houver input, todos os modais são fechados
disableSmoothScroll(); Função para desativar “smooth scrolling” no conteúdo principal.
enableSmoothScroll(); Função para ativar “smooth scrolling” no conteúdo principal.
getFirstVisibleElement(selector);

Função para obter o primeiro elemento visível do seletor CSS:
manageDefaultCollapsibleSidebar();

Função para manejar o comportamento padrão da barra lateral (sidebar):

  • Se a janela é maior ou igual a 1024 pixels de largura, o “sidebar” não é colapsado
  • Se a janela for menor que 1024 pixels de largura, “sidebar” é colapsado
manageDefaultToc();

Função para manejo de comportamento padrão da tabela de conteúdos:

  • Se a janela for maior ou igual que 1216 pixels de largura, a tabela de conteúdo aparecerá sem colapsar
  • Se a janela for menor a 1216 pixels de largura, a tabela de conteúdo será colapsada
toggleExtendMenu(force);

Função para manejo de menu estendido da barra de navegação (unicamente se a barra é mostrada):

  • force
    • true: o menu é mostrado
    • false: o menu estará oculto
toggleSidebar(force, noTransition);

Função para manejo de comportamento da barra lateral (“sidebar”):

  • force
    • true: barra lateral não colapsada
    • false: barra lateral colapsada
  • noTransition
    • true: desativar a animação de menu de transição
    • false: ativar a animação de menu de transição (comportamento padrão)
toggleSidebarEntry(entry, force);

Função para manejo de entrada da barra lateral:

  • entry
    • menu de entrada que pode expandir ou reduzir seus elementos (<a> elementos contendo a classe is-icon-expandable)
  • force
    • true: entrada expandida
    • false: entrada reduzida
toggleSidebarEntries(force);

Função para manejo de entradas da barra lateral:

  • force
    • true: todas as entradas expandidas
    • false: todas as entradas reduzidas
toggleToc(force);

Função para manejo de comportamento da tabela de conteúdos:

  • force
    • true: tabela de conteúdo não colapsada
    • false: tabela de conteúdo colapsada