npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tour-onboarding

v1.0.24

Published

Uma biblioteca Vue 2 com componentes para onboarding.

Downloads

88

Readme

Tour Onboarding

Biblioteca de components para criação de fluxos onboarding.

npm install tour-onboarding

Para começar vamos trazer o component do card de instrução e algumas importações:

<OnboardingTourCard />

import {
	OnboardingTourCard, // Componente de instrução
	initOnboardingTour, // Função de incialização do tour
	TourConfig, // Acesso as configurações do onboarding (opcional)
} from 'tour-onboarding';

Podemos configurar ações quando o usuário avançar ou retornar os passos do onboarding usando os eventos next e prev.

<OnboardingTourCard @next="nextStepTour" @prev="prevStepTour" />

Importar estilos no main.js

import 'tour-onboarding/src/style/main.scss';

Agora vamos passar a classe t-step-01 para os components que desejamos ser o foco de cada passo do onboarding e ajustar a numeração de cada passo: t-step-01, t-step-02...

<div class="t-step-01"> Component do passo 01 </div>

<div class="t-step-02"> Component do passo 02 </div>

Para inciar o tour devemos chamar a função initOnboarding no hook mounted do vue passando um array de passos no parametro da função como no exemplo abaixo:

A função deve ser chamada no hook mounted pois a montagem (renderização) do componente foi finalizada. Neste ponto, podemos acessar os elementos do DOM recém-criados.

async mounted() {
	await initOnboardingTour({
		steps: [
			{
				text: 'Texto do passo 1',
				step: 1,
				position: 'bottom',
			},
			{
				text: 'Texto do passo 2',
				step: 2,
				position: 'bottom',
			},
			{
				text: 'Texto do passo 2',
				step: 3,
				position: 'top',
			}
		]
	});
}

O campo position indica a posição do balão de instução.

Para destacar mais components no passo atual do onboarding podemos usar a classe t-step-component-01, a numeração do passo também deve ser ajustada (t-step-component-02, t-step-component-03...).

PS: A margem do component de instrução está padronizada sendo necessário um ajuste na biblioteca para torna-lá dinâmica. (Uma lógica parecida com a de posição).