{"id":31103698,"url":"https://github.com/learncodeweb/lcwtourguide","last_synced_at":"2025-09-17T02:50:19.015Z","repository":{"id":310803279,"uuid":"1041284376","full_name":"LearnCodeWeb/lcwTourGuide","owner":"LearnCodeWeb","description":"Tour Guide Free JS plugin","archived":false,"fork":false,"pushed_at":"2025-08-20T09:54:58.000Z","size":28,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-20T11:19:34.926Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://learncodeweb.github.io/lcwTourGuide/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LearnCodeWeb.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-20T09:01:05.000Z","updated_at":"2025-08-20T10:02:10.000Z","dependencies_parsed_at":"2025-08-20T11:30:00.563Z","dependency_job_id":null,"html_url":"https://github.com/LearnCodeWeb/lcwTourGuide","commit_stats":null,"previous_names":["learncodeweb/lcwtourguide"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/LearnCodeWeb/lcwTourGuide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LearnCodeWeb%2FlcwTourGuide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LearnCodeWeb%2FlcwTourGuide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LearnCodeWeb%2FlcwTourGuide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LearnCodeWeb%2FlcwTourGuide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LearnCodeWeb","download_url":"https://codeload.github.com/LearnCodeWeb/lcwTourGuide/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LearnCodeWeb%2FlcwTourGuide/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275526367,"owners_count":25480460,"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","status":"online","status_checked_at":"2025-09-17T02:00:09.119Z","response_time":84,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-09-17T02:50:14.420Z","updated_at":"2025-09-17T02:50:19.008Z","avatar_url":"https://github.com/LearnCodeWeb.png","language":"HTML","readme":"# lcwTourGuide\n\n**lcwTourGuide** is a lightweight JavaScript library for creating guided tours on web pages. Easily highlight elements, add tooltips, and guide users through your UI with callbacks for start, step change, and end events.\n\n## Features\n\n- Highlight elements on your page.\n- Display tooltips with custom text.\n- Navigate steps with \"Next\" and \"Previous\".\n- Callbacks for `onStart`, `onStep`, and `onEnd`.\n- Easy to integrate via CDN or npm.\n\n## Installation\n\n### Via CDN\n\n```\nhttps://cdn.jsdelivr.net/gh/LearnCodeWeb/lcwTourGuide@v-1.0/src/lcwTourGuide.css\n```\n```\nhttps://cdn.jsdelivr.net/gh/LearnCodeWeb/lcwTourGuide@v-1.0/src/lcwTourGuide.js\n```\n\n# HTML\n```\n\u003clink rel=\"stylesheet\" href=\"https://cdn.jsdelivr.net/gh/LearnCodeWeb/lcwTourGuide@v-1.0/src/lcwTourGuide.css\"\u003e\n\u003cscript src=\"https://cdn.jsdelivr.net/gh/LearnCodeWeb/lcwTourGuide@v-1.0/src/lcwTourGuide.js\"\u003e\u003c/script\u003e\n```\n\n\n## 🚀 Usage\n\n### 1. Mark elements for the tour\n\nAdd `data-lcw-tour-step` and `data-lcw-tour-text` attributes to elements:\n\n```\n\u003cbutton data-lcw-tour-step=\"1\" data-lcw-tour-text=\"Click here to create a new item\"\u003e\n  New Item\n\u003c/button\u003e\n\n\u003cinput type=\"text\" data-lcw-tour-step=\"2\" data-lcw-tour-text=\"Enter the name here\"\u003e\n\n\u003cdiv data-lcw-tour-step=\"3\" data-lcw-tour-text=\"Finally, click Save\"\u003e\n  Save\n\u003c/div\u003e\n```\n\n* `data-lcw-tour-step=\"1\"` → defines the order\n* `data-lcw-tour-text=\"...\"` → tooltip text\n\n\n### 2. Initialize the tour\n\n```\ndocument.addEventListener('DOMContentLoaded', () =\u003e {\n  const tour = new lcwTourGuide({\n    onStart: () =\u003e console.log(\"✅ Tour started\"),\n    onStep: (index, el) =\u003e console.log(`➡️ Step ${index + 1}:`, el),\n    onEnd: () =\u003e console.log(\"🏁 Tour finished\")\n  });\n\n  tour.start();\n});\n```\n\n---\n\n## ⚙️ Options\n\n| Option    | Type     | Default             | Description                     |\n| --------- | -------- | ------------------- | ------------------------------- |\n| `onStart` | Function | `() =\u003e {}`          | Called when the tour starts     |\n| `onStep`  | Function | `(index, el) =\u003e {}` | Called when a step is displayed |\n| `onEnd`   | Function | `() =\u003e {}`          | Called when the tour ends       |\n\n---\n\n## 🎨 Styling\n\nDefault styles can be customized:\n\n```\n.lcw-tour-tooltip {\n    position: absolute;\n    background: #ffffff;\n    color: #444;\n    padding: 16px;\n    border-radius: 6px;\n    max-width: 280px;\n    z-index: 10001;\n    font-size: 14px;\n    box-shadow: 0 4px 12px rgba(0, 0, 0, 0.4);\n}\n\n.lcw-tour-tooltip button {\n    margin-top: 10px;\n    margin-right: 5px;\n    padding: 5px 10px;\n    border: none;\n    background: #007bff;\n    color: white;\n    border-radius: 4px;\n    cursor: pointer;\n}\n\n.lcw-tour-tooltip button:hover {\n    background: #0056b3;\n}\n\n.lcw-tour-overlay {\n    position: fixed;\n    top: 0;\n    left: 0;\n    width: 100vw;\n    height: 100vh;\n    background: rgba(0, 0, 0, 0.6);\n    z-index: 10000;\n}\n\n.lcw-tour-highlight {\n    position: relative;\n    z-index: 10002;\n    box-shadow: 0 0 0 4px rgba(0, 123, 255, 0.7);\n    border-radius: 4px;\n    background-color: white;\n}\n\n.lcw-tour-close {\n    position: absolute;\n    top: 8px;\n    right: 10px;\n    color: white;\n    font-size: 18px;\n    cursor: pointer;\n    font-weight: bold;\n}\n\n.lcw-tour-close:hover {\n    color: #ff6b6b;\n}\n```\n\n## 📜 License\n\nMIT License. Free to use in personal and commercial projects.\n\n---\n\n## 🤝 Contributing\n\nContributions, issues, and feature requests are welcome!\nFeel free to fork, improve, and submit pull requests.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flearncodeweb%2Flcwtourguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flearncodeweb%2Flcwtourguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flearncodeweb%2Flcwtourguide/lists"}