{"id":43949064,"url":"https://github.com/sandeshshrestha/react-user-guide","last_synced_at":"2026-02-07T03:30:33.132Z","repository":{"id":35102598,"uuid":"183101733","full_name":"sandeshshrestha/react-user-guide","owner":"sandeshshrestha","description":"React User Guide","archived":false,"fork":false,"pushed_at":"2024-05-02T01:46:57.000Z","size":7599,"stargazers_count":19,"open_issues_count":13,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-12T22:30:34.107Z","etag":null,"topics":["react","tooltip","user-guide","user-tour"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/sandeshshrestha.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2019-04-23T21:56:06.000Z","updated_at":"2024-04-13T04:54:37.000Z","dependencies_parsed_at":"2024-05-02T03:02:58.821Z","dependency_job_id":"6a5be592-2389-4e54-a815-0696a3e68359","html_url":"https://github.com/sandeshshrestha/react-user-guide","commit_stats":{"total_commits":97,"total_committers":4,"mean_commits":24.25,"dds":"0.45360824742268047","last_synced_commit":"e5c808b6df01dc60243992d16a5684dd0b3ece41"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/sandeshshrestha/react-user-guide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandeshshrestha%2Freact-user-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandeshshrestha%2Freact-user-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandeshshrestha%2Freact-user-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandeshshrestha%2Freact-user-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sandeshshrestha","download_url":"https://codeload.github.com/sandeshshrestha/react-user-guide/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandeshshrestha%2Freact-user-guide/sbom","scorecard":{"id":799043,"data":{"date":"2025-08-11","repo":{"name":"github.com/sandeshshrestha/react-user-guide","commit":"888ea35a40e9d09cfd9b578e9f441b534545c384"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.8,"checks":[{"name":"Code-Review","score":-1,"reason":"Found no human activity in the last 17 changesets","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/publish-gh-pages.yml:1","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-gh-pages.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/sandeshshrestha/react-user-guide/publish-gh-pages.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-gh-pages.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/sandeshshrestha/react-user-guide/publish-gh-pages.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/sandeshshrestha/react-user-guide/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/sandeshshrestha/react-user-guide/publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/sandeshshrestha/react-user-guide/publish.yml/master?enable=pin","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"50 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27","Warn: Project is vulnerable to: GHSA-4www-5p9h-95mh","Warn: Project is vulnerable to: GHSA-9gqv-wp59-fq42","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5","Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp","Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq","Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr","Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765","Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986","Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6","Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v","Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-7mwh-4pqv-wmr8","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T09:53:43.387Z","repository_id":35102598,"created_at":"2025-08-23T09:53:43.387Z","updated_at":"2025-08-23T09:53:43.387Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29185344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-07T00:44:15.062Z","status":"online","status_checked_at":"2026-02-07T02:00:07.217Z","response_time":63,"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":["react","tooltip","user-guide","user-tour"],"created_at":"2026-02-07T03:30:31.428Z","updated_at":"2026-02-07T03:30:33.124Z","avatar_url":"https://github.com/sandeshshrestha.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# React User Guide\n\n[![NPM](https://img.shields.io/npm/v/react-user-guide.svg)](https://www.npmjs.com/package/react-user-guide) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\n## Install\n\n```bash\nnpm install --save react-user-guide\n```\n\n## Usage\n\n```jsx\nimport React, { Component } from 'react';\nimport UserGuide from 'react-user-guide';\n\nconst style = {\n  width: '20vw',\n  backgroundColor: 'grey',\n  marginTop: '20vh',\n  marginLeft: '40vw',\n  padding: 5\n};\n\nconst buttonConfig = {\n  yesText: 'Yes',\n  noText: 'No',\n  nextText: 'Next',\n  skipText: 'Skip',\n  finishText: 'Finish'\n};\n\nconst guides = [\n  {\n    querySelector: '.unique-classname',\n    position: 'east',\n    title: 'First',\n    message: 'User guide position \\'east\\''\n  },\n  {\n    querySelector: '.unique-classname',\n    position: 'west',\n    title: 'Second',\n    message: 'User guide position \\'west\\''\n  },\n  {\n    querySelector: '.unique-classname',\n    position: 'north',\n    title: 'Third',\n    message: 'User guide position \\'north\\''\n  },\n  {\n    querySelector: '.unique-classname',\n    tooltipWidth: 500,\n    position: 'south',\n    title: 'Forth',\n    message: 'User guide position \\'south\\', with custom width'\n  }\n];\n\nexport default class App extends Component {\n  render () {\n    return (\n      \u003cUserGuide buttonConfig={buttonConfig} guides={guides}\u003e\n        \u003cdiv style={style} className=\"unique-classname\"\u003eTarget element\u003c/div\u003e\n      \u003c/UserGuide\u003e\n    )\n  }\n}\n\n```\n\n## Styling Guide\n\n### Import pre-styled css\n```css\n@import '~react-user-guide/dist/custom-style.css';\n```\n### Use the following scss to style yourself\n```scss\n// Style modal\n.userGuide--modal {\n  h1 {\n\n  }\n\n  p {\n\n  }\n\n  button {\n\n  }\n}\n\n// Style mask\n.userGuide--mask {\n\n}\n\n// Style tooltip\n.userGuide--message {\n  h3 {\n\n  }\n\n  p {\n\n  }\n\n  button {\n\n  }\n}\n\n```\n\n## Configs\n\n### \u0026lt;HelpText\u0026gt;\n\n* guides *[Guide]* - array of all guides/tooltip\n* guideKey *[string]* - unique key that will be used to store in localStorage (default = 'guideKey')\n* title *[string]* - Title used in Modal (default = 'Quick Guide')\n* content *[string]* - Content used in Modal (default = 'Would you like us to walk you through different features in this app?')\n* buttonConfig *[ButtonConfig]* - Text used by different buttons\n\n### Guide\n\n* querySelector *[string]* - css selector of the target element\n* title *[string]* - title of tooltop\n* message *[string]* - message of tooltip\n* position *[string]* - *(east|west|north|south)* - position of tooltip from target element (default = 'north')\n* tooltipWidth *[int]* - width of tooltip (default = 240)\n\n### ButtonConfig\n\n* yesText *[string]* - Text for 'Yes' button\n* noText *[string]* - Text for 'No' button\n* nextText *[string]* - Text for 'Next' button\n* skipText *[string]* - Text for 'Skip' button\n* finishText *[string]* - Text for 'Finish' button\n\n## DEMO\nhttps://sandeshshrestha.github.io/react-user-guide/\n\n## Screenshots\n\n[Click here if images didn't load](https://github.com/sandeshshrestha/React-User-Guide#screenshots)\n![Initial modal](https://github.com/sandeshshrestha/React-User-Guide/blob/master/screenshots/initial-modal.png)\n![Guide East](https://github.com/sandeshshrestha/React-User-Guide/blob/master/screenshots/guide-east.png)\n![Guide West](https://github.com/sandeshshrestha/React-User-Guide/blob/master/screenshots/guide-west.png)\n![Guide North](https://github.com/sandeshshrestha/React-User-Guide/blob/master/screenshots/guide-north.png)\n![Guide South](https://github.com/sandeshshrestha/React-User-Guide/blob/master/screenshots/guide-south.png)\n## License\n\nMIT © [sandeshshrestha](https://github.com/sandeshshrestha)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandeshshrestha%2Freact-user-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsandeshshrestha%2Freact-user-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandeshshrestha%2Freact-user-guide/lists"}