{"id":16202375,"url":"https://github.com/leifermendez/ngx-copilot","last_synced_at":"2025-09-02T22:40:46.339Z","repository":{"id":65458883,"uuid":"274939960","full_name":"leifermendez/ngx-copilot","owner":"leifermendez","description":"🏆 The most expected has arrived, a package for Angular that facilitates us to improve the experience of our users when guiding them in our interface","archived":false,"fork":false,"pushed_at":"2021-02-23T14:36:21.000Z","size":84,"stargazers_count":83,"open_issues_count":7,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-27T08:00:19.823Z","etag":null,"topics":["angular","angular-stepper","angular-wizard","copilot","copiloto","ngx-copilot","ngx-tour","nodejs","pwa","pwa-apps","stepper","ui-design","ux-design","wizard","wizard-steps"],"latest_commit_sha":null,"homepage":"https://ngx-copilot.stackblitz.io/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leifermendez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-25T14:38:46.000Z","updated_at":"2024-11-29T06:21:57.000Z","dependencies_parsed_at":"2023-01-24T14:45:32.741Z","dependency_job_id":null,"html_url":"https://github.com/leifermendez/ngx-copilot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leifermendez%2Fngx-copilot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leifermendez%2Fngx-copilot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leifermendez%2Fngx-copilot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leifermendez%2Fngx-copilot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leifermendez","download_url":"https://codeload.github.com/leifermendez/ngx-copilot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243814907,"owners_count":20352037,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angular-stepper","angular-wizard","copilot","copiloto","ngx-copilot","ngx-tour","nodejs","pwa","pwa-apps","stepper","ui-design","ux-design","wizard","wizard-steps"],"created_at":"2024-10-10T09:47:11.422Z","updated_at":"2025-03-16T10:32:55.179Z","avatar_url":"https://github.com/leifermendez.png","language":"TypeScript","funding_links":["https://www.buymeacoffee.com/leifermendez"],"categories":[],"sub_categories":[],"readme":"\n# Angular Copilot (ngx-copilot)\n\nThe most expected has arrived, a package for Angular that facilitates us to improve the experience of our users when guiding them in our interface\n\n\u003cimg src=\"https://badgen.net/npm/dy/ngx-copilot\" /\u003e \u003cimg src=\"https://badgen.net/npm/v/ngx-copilot\" /\u003e  \u003cimg src=\"https://img.shields.io/github/stars/leifermendez/ngx-copilot\" /\u003e \u003cimg src=\"https://img.shields.io/github/license/leifermendez/ngx-copilot\" /\u003e\n\n\n\u003ca href=\"https://www.buymeacoffee.com/leifermendez\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;\" \u003e\u003c/a\u003e\n---\n\n[Live demo](https://ngx-copilot.stackblitz.io/)\n\n[Stackblitz](https://stackblitz.com/edit/ngx-copilot)\n\n\u003cp  align=\"center\" style=\"display:flex;justify-content: space-between;width:100%;align-content: center;\"\u003e\n\u003cb\u003eExamples\u003c/b\u003e\u003cbr\u003e\n\u003cimg height=\"400\" src=\"https://i.imgur.com/mMdMVjq.gif\"  alt=\"Preview 1\" /\u003e\n\u003cbr\u003e\n\u003cimg height=\"400\" src=\"https://i.imgur.com/HSWTgFq.gif\"  alt=\"Preview 2\" /\u003e\t\n\u003c/p\u003e\n\n### Install\n`npm i ngx-copilot@latest --save`\n\n`npm install animate.css --save`\n\n### Import\n\n__angular.json__\n\n```json\n\"styles\": [\n  \"./node_modules/animate.css/animate.min.css\", \n  \"./node_modules/ngx-copilot/src/lib/ngx-copilot.css\",\n\n],\n```\n\n__app.module.ts__\n\n```typescript\nimport {BrowserModule} from '@angular/platform-browser';  \nimport {NgModule} from '@angular/core';  \nimport {AppComponent} from './app.component';  \n/** IMPORT **/\nimport { NgxCopilotModule } from  'ngx-copilot'; 👈\n  \n@NgModule({  \n  declarations: [  \n    AppComponent  \n  ],  \n  imports: [  \n    BrowserModule,  \n\tNgxCopilotModule 👈\n  ],  \n  providers: [],  \n  bootstrap: [AppComponent]  \n})  \nexport class AppModule {  \n}\n```\n__app.component.html__\n```html\n\u003cngx-wrapper-copilot\u003e\u003c/ngx-wrapper-copilot\u003e\n```\n\n### Use\n\nUse in your component\n```typescript\nimport  {Component,  OnInit}  from  '@angular/core'; \nimport  {NgxCopilotService}  from  'ngx-copilot';\n\n@Component({  \n  selector: 'app-root',  \n  templateUrl: './app.component.html',  \n  styleUrls: ['./app.component.css']  \n})  \nexport class AppComponent implements  OnInit {  \n\tconstructor(private  copilot:  NgxCopilotService){}\n\t\n\tngOnInit() {\n\t\tthis.copilot.checkInit();\n\t}\n\t\n\t/*Re initialize in specify step*/\n\tinitPosition  = (stepNumber:any) =\u003e  this.copilot.checkInit(stepNumber);\n\t\n\t/*Next Step*/\n\tnextStep = (stepNumber:any) =\u003e  this.copilot.next(stepNumber);\n\t\n\t/*Finish*/\n\tdone= () =\u003e  this.copilot.removeWrapper();\n}\n```\n\n### Template\n```html\n\u003cdiv\u003e  \n\n\t\u003c!--********** TEMPLATE FOR STEP 1  **********--\u003e\n\t\u003cng-template  #step1\u003e\n\t\t\u003cdiv  class=\"copilot-custom\"\u003e\n\t\t\u003ch3\u003eStep 1\u003c/h3\u003e\n\t\t\u003cp\u003eHello !\u003c/p\u003e\n\t\t\t\u003cdiv  class=\"footer-btn\"\u003e\n\t\t\t\t\u003cbutton  (click)=\"nextStep(2)\"  type=\"button\"\u003eNext Step 2!\u003c/button\u003e\n\t\t\t\t\u003cbutton  (click)=\"done()\"  type=\"button\"\u003eDone!\u003c/button\u003e\n\t\t\t\u003c/div\u003e\n\t\t\u003c/div\u003e\n\t\u003c/ng-template\u003e\n\n\t\u003c!--********** TEMPLATE FOR STEP 2  **********--\u003e\n\t\u003cng-template  #step2\u003e\n\t\t\u003cdiv  class=\"copilot-custom\"\u003e\n\t\t\u003ch3\u003eStep 2\u003c/h3\u003e\n\t\t\u003cp\u003eBye\u003c/p\u003e\n\t\t\t\u003cdiv  class=\"footer-btn\"\u003e\n\t\t\t\t\u003cbutton  (click)=\"nextStep(1)\"  type=\"button\"\u003eBack Step 1!\u003c/button\u003e\n\t\t\t\t\u003cbutton  (click)=\"done()\"  type=\"button\"\u003eDone!\u003c/button\u003e\n\t\t\t\u003c/div\u003e\n\t\t\u003c/div\u003e\n\t\u003c/ng-template\u003e\n\n\t\u003c!--********** BODY  **********--\u003e\t\n\t\u003cdiv copilot\n\t[copilot-template]=\"step1\" [copilot-step]=\"1\"\u003e\n\t \u003cbutton \u003eFocus 1\u003c/button\u003e\n\t\u003c/div\u003e\n\n\t\u003cdiv copilot\n\t[copilot-template]=\"step2\" [copilot-step]=\"2\"\u003e\n\t \u003cbutton \u003eFocus 2\u003c/button\u003e\n\t\u003c/div\u003e\n\n\u003c/div\u003e\n```\n### Customize\n\nWhen the `copilot` is active add a class in your body:\n\n__ngx-copilot-active__: Is actived\n\n__ngx-copilot-active-step-(NUMBER STEP)__: Is actived with number step\n\n![](https://i.imgur.com/zqMXbE8.png)\n\nIf you want change of overlay color insert in your styles.css: \n```css\n:root{\n\t--zoneColor:rgba(114, 113, 160, 0.5) !important\n}\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleifermendez%2Fngx-copilot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleifermendez%2Fngx-copilot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleifermendez%2Fngx-copilot/lists"}