@devix-tecnologia/timeline-vue 1.4.0 → 2.0.0

package/README.md

@@ -29,7 +29,10 @@ yarn add @devix-tecnologia/timeline-vue
 <template>
   <main>
     <div class="telaTimeline">
-      <Timeline :perfilTimeline="perfilTimeline" :eventosTimeline="listaEventos" />
+      <Timeline 
+      :perfilTimeline="perfilTimeline" :eventosTimeline="listaEventos"
+      @eventoClick="emitirEventoClick"
+    />
     </div>
   </main>
 </template>
@@ -42,6 +45,9 @@ import '@devix-tecnologia/timeline-vue/dist/style.css'
 export default defineComponent({
   components: { Timeline },
   setup() {
+    const emitirEventoClick = (evento: Evento) => {
+      alert(`foi clicado no evento ${evento.titulo}`);
+    };
     const perfilTimeline = {
       nome: 'Maria do Socorro',
       imagem: 'https://this-person-does-not-exist.com/img/avatar-gen11071f8e0802a35d66684ee9376722b2.jpg',
@@ -50,9 +56,8 @@ export default defineComponent({
     const listaEventos = [
       {
         data: new Date('2023-04-26T18:10Z'),
-        previsto: new Date('2023-04-26T18:10Z'),
+        previstoPara: new Date('2023-04-26T18:10Z'),
         realizado: new Date('2023-04-26T18:15Z'),
-        duracao: null,
         tolerancia: 20,
         titulo: 'Vacina da gripe',
         subtitulo: 'Posto de saúde do bairro',
@@ -66,9 +71,7 @@ export default defineComponent({
       },
       {
         data: new Date('2023-05-09T17:00Z'),
-        previsto: new Date('2023-05-09T17:00Z'),
-        realizado: null,
-        duracao: null,
+        previstoPara: new Date('2023-05-09T17:00Z'),
         tolerancia: 10,
         titulo: 'Vitamina D',
         subtitulo: '2 comprimidos',
@@ -79,10 +82,9 @@ export default defineComponent({
         },
         status: 'planejado',
         criticidade: 'baixa',
-        aoClicar: () => alert('Olá, mundo!')
       }
     ]
-    return { perfilTimeline, listaEventos }
+    return { emitirEventoClick, perfilTimeline, listaEventos }
   }
 })
 </script>
@@ -131,7 +133,7 @@ body {
 
 ### Propriedades:
   
-A Timeline da DEVIX ordena e lista Eventos de forma crescente de acordo com a data/hora cadastrada.
+A Timeline ordena e lista Eventos de forma crescente de acordo com a data/hora cadastrada.
 
 Cada Evento mostra a hora prevista, hora em que o evento foi realizado, título, subtítulo, ícone de categoria, ícone de status, indicação de criticidade e campo para informação em destaque.
 
@@ -142,10 +144,8 @@ Cada Evento mostra a hora prevista, hora em que o evento foi realizado, título,
 ## 🚀  Contribuindo
 ---
 
-Faça um fork do projeto, crie uma nova branch e faça seus commits.
-
 ### Importante:
-- Os componentes da Timeline Devix são divididos em átomos, moléculas e organismos, seguindo os padrões do Design Atômico;
+- Os componentes da Timeline são divididos em átomos, moléculas e organismos, seguindo os padrões do Design Atômico;
 - Cada componente vem acompanhado de documentação no storybook;
 - A timeline de demonstração utiliza dados mock;
 - Dê uma olhada no arquivo ``` type.ts ``` também, ele é o arquivo de tipos com influência sobre toda a aplicação.
@@ -155,4 +155,23 @@ Faça um fork do projeto, crie uma nova branch e faça seus commits.
 yarn storybook 
 ```
 
-## 😉
+Faça um fork do projeto, crie uma nova branch e faça seus commits. Seguem passos para bons commits:
+
+1) **Criar um Fork:** Acesse o repositório de origem no GitHub e clique em "Fork". Isso criará uma cópia do projeto na sua conta pessoal do GitHub.
+1) **Clonar ou Atualizar o Seu Fork:** Se ainda não clonou o seu fork para a máquina local, faça-o com `git clone [URL_DO_SEU_FORK]`. Se já possui o projeto clonado, certifique-se de que seu fork esteja atualizado em relação ao projeto de origem usando os comandos:
+   ```
+   git remote add upstream [URL_DO_REPOSITORIO_ORIGEM]
+   git fetch upstream
+   git merge upstream/branch_de_referencia
+   ```
+1) **Atualizar Referências Remotas:** O comando `git remote update` atualiza as referências locais em relação aos repositórios remotos.
+1) **Selecionar o Branch de Partida:** Em geral, utiliza-se o `develop` como branch base, mas verifique sempre no git graph ou em instruções específicas da tarefa qual branch deve ser utilizado.
+1) **Sincronizar Mudanças Remotas:** Antes de iniciar as modificações, é uma boa prática sincronizar o branch local com o remoto usando `git pull origin branch_de_referencia`.
+1) **Criar um Novo Branch:** Ao trabalhar em uma nova funcionalidade ou correção, crie um novo branch com um nome descritivo, como `feature-relatorio-cliente`, usando o comando `git checkout -b nome_do_branch`.
+1) **Fazer Alterações e Commit:** Realize as alterações necessárias no código. Ao terminar, faça um commit seguindo um padrão de mensagens semânticas e imperativas. Lembre-se de criar e/ou executar testes automatizados para garantir que nada foi quebrado.
+1) **Enviar Alterações para o GitHub:** Envie as alterações para o seu fork com o comando `git push origin nome_do_branch`.
+1) **Abrir um Pull Request:** Acesse seu fork no GitHub e clique em "New Pull Request". Escolha os branches de origem e destino corretos e envie sua solicitação. O desenvolvedor ou equipe responsável pelo projeto de origem revisará suas alterações e, se aprovadas, fará o merge no projeto principal.
+
+---
+
+Código-fonte bom é código compartilhado! Contribua melhorando esse importante projeto. 😉