Scroll

Tratamento genérico de scrolls no Gartic

Build

Para gerar as demos e o arquivo compilado e compatível com todos os browsers via babel, executar o comando:

npm run build

Sintaxe

Verificar a sintaxe padrão através do comando:

npm test

Demo

Lista de demonstrações de uso:

• Básico - Scroll com sombras, manter posição, limite de elementos e evento
• Múltiplo - Scroll horizontal e vertical, com alteração de tamanho

API

new Scroll(elem[, opcoes])

• elem HTMLElement - Elemento que irá englobar toda a lógica do scroll
• opcoes Object - Configurações do scroll
• opcoes.classes Array - Lista de classes para aplicar a sombra (topo, meio, rodape)
• opcoes.manterPosicao Boolean - Fixa a posição de visão do scroll
• opcoes.elementosMax Number - Quantidade máxima de elementos
• opcoes.elementoScroll String - Query de captura do elemento de scroll
• opcoes.scrollVertical Boolean - Indica se fará uso de scrollbar vertical
• opcoes.scrollHorizontal Boolean - Indica se fará uso de scrollbar horizontal
• opcoes.margemVertical Array - Margem no topo e rodapé do scroll vertical
• opcoes.margemHorizontal Array - Margem a esquerda e a direita do scroll horizontal
• opcoes.tolerancia Number - Tolerância para detecção do fim do scroll
• opcoes.autoRefresh Boolean - Atualização automática do scroll

Construtor da classe, iniciando variáveis globais da classe e rotina.

scroll.append(elem)

• elem HTMLElement - Elemento a ser adicionado

Adiciona um elemento ao scroll.

scroll.empty()

Zerando elementos dentro do scroll.

scroll.refresh([manual])

• manual Boolean - Indica se a atualização está sendo feita por scroll do usuario

Atualiza parâmetros do scroll.

scroll.remove(elem)

• elem HTMLElement - Elemento a ser removido

Remove um elemento do scroll.

scroll.scrollTo(x, y, tempo)

• x Number - Coordenada X para posicionamento do topo do scroll
• y Number - Coordenada Y para posicionamento do topo do scroll
• tempo Number - Tempo em milisegundos para realizar a animação do scroll

Move o scroll para um ponto específico.

scroll.scrollEnd(x, y, tempo)

• x Boolean - Mover para o fim do scroll vertical
• y Boolean - Mover para o fim do scroll horizontal
• tempo Number - Tempo em milisegundos para realizar a animação do scroll

Move o scroll para o fim.

scroll.scrollElem

Obtém o elemento de scroll.

Evento: 'inicio'

Detecta que está no inicio da rolagem

Evento: 'fim'

Detecta que está no final da rolagem.

Evento: 'scroll'

• x Number
• y Number
• start Number
• time Number

Detecta que está no final da rolagem.