{"id":15366737,"url":"https://github.com/south-paw/react-obfuscate-ts","last_synced_at":"2025-04-15T12:33:20.984Z","repository":{"id":40282825,"uuid":"280121442","full_name":"South-Paw/react-obfuscate-ts","owner":"South-Paw","description":"🕵️ A React component to obfuscate contact links and text","archived":false,"fork":false,"pushed_at":"2023-08-04T09:51:40.000Z","size":870,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T02:07:47.857Z","etag":null,"topics":["component","email","hacktoberfest","hide","link","obfuscate","react","sms","tel"],"latest_commit_sha":null,"homepage":"https://react-obfuscate-ts.netlify.app","language":"TypeScript","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/South-Paw.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}},"created_at":"2020-07-16T10:12:45.000Z","updated_at":"2023-12-31T18:11:42.000Z","dependencies_parsed_at":"2024-06-21T16:53:42.737Z","dependency_job_id":"245effb9-dae7-4014-83a1-67bc86f33721","html_url":"https://github.com/South-Paw/react-obfuscate-ts","commit_stats":{"total_commits":18,"total_committers":1,"mean_commits":18.0,"dds":0.0,"last_synced_commit":"07ccd1322e74b0ba0d2855bbb0165854e83d4dff"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/South-Paw%2Freact-obfuscate-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/South-Paw%2Freact-obfuscate-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/South-Paw%2Freact-obfuscate-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/South-Paw%2Freact-obfuscate-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/South-Paw","download_url":"https://codeload.github.com/South-Paw/react-obfuscate-ts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249072618,"owners_count":21208217,"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":["component","email","hacktoberfest","hide","link","obfuscate","react","sms","tel"],"created_at":"2024-10-01T13:19:36.443Z","updated_at":"2025-04-15T12:33:20.951Z","avatar_url":"https://github.com/South-Paw.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @south-paw/react-obfuscate-ts\n\n🕵️ A React component to obfuscate contact links and text\n\n[![npm](https://img.shields.io/npm/v/@south-paw/react-obfuscate-ts.svg)](https://www.npmjs.com/package/@south-paw/react-obfuscate-ts)\n\n## Features\n\n- Easy to implement component for hiding your contact links or text in the DOM.\n- Obfuscation of `email`, `tel`, `sms`, `href` and any other string of text as a child.\n- `aria-label` for screen readers to identify the obfuscated element.\n- Polymorphic `as` prop for use with other Link components (such as your own UI libraries link component).\n\n## How it works\n\nThe component reverses the content in the DOM for you and uses CSS to re-reverse the content so it appears normally to the user, it also replaces the content of the link's `href` attribute. When a user hovers, clicks or focuses the element, it is considered \"interacted\" and has its content un-reversed and the correct `href` attribute applied. This ideally makes the link useless for a bot/spammer but ensures it remains user friendly when viewed normally.\n\n## Basic usage\n\n```jsx\nimport { Obfuscate } from '@south-paw/react-obfuscate-ts';\n\n// use the component's children to create the link and display\n\u003cObfuscate email\u003ehello@example.com\u003c/Obfuscate\u003e;\n\n// or specify the email address for the link with custom children\n\u003cObfuscate email=\"hello@example.com\"\u003eEmail me!\u003c/Obfuscate\u003e;\n```\n\n## Inspiration\n\nI was inspired to create this package after using the [coston/react-obfuscate](https://github.com/coston/react-obfuscate) package for two years. After switching the majority of my own code bases to TypeScript, I was disappointed to see there was no `@types` package for this original version and that it wasn't reliably obfuscating it's content in some of the usages I had. I decided that I'd do a variant of that component with a new API, a few minor bug fixes and one that included types as well.\n\n## Issues and Bugs\n\nIf you find any, please report them [here](https://github.com/South-Paw/react-obfuscate-ts/issues) so they can be squashed.\n\n## License\n\nMIT, see the [LICENSE](./LICENSE) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsouth-paw%2Freact-obfuscate-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsouth-paw%2Freact-obfuscate-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsouth-paw%2Freact-obfuscate-ts/lists"}