{"id":22538114,"url":"https://github.com/cfpb/ctrl-f","last_synced_at":"2025-04-09T20:15:11.333Z","repository":{"id":64739681,"uuid":"542735953","full_name":"cfpb/ctrl-f","owner":"cfpb","description":"A simple search UI for client-side fuzzy searching.","archived":false,"fork":false,"pushed_at":"2024-05-02T22:22:03.000Z","size":6501,"stargazers_count":4,"open_issues_count":3,"forks_count":2,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-04-09T20:15:02.939Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/ctrl-f","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cfpb.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}},"created_at":"2022-09-28T18:26:56.000Z","updated_at":"2025-01-05T16:04:04.000Z","dependencies_parsed_at":"2023-02-12T19:16:29.546Z","dependency_job_id":null,"html_url":"https://github.com/cfpb/ctrl-f","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/cfpb%2Fctrl-f","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fctrl-f/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fctrl-f/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fctrl-f/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cfpb","download_url":"https://codeload.github.com/cfpb/ctrl-f/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103872,"owners_count":21048245,"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":[],"created_at":"2024-12-07T11:10:13.863Z","updated_at":"2025-04-09T20:15:11.299Z","avatar_url":"https://github.com/cfpb.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ctrl-f\n\nA simple search interface for client-side fuzzy searching.\n\n![ctrl-f screenshot](screenshot.gif)\n\n## Usage\n\n```\nimport search from 'ctrl-f';\n\nconst buttonText = 'Search this page';\n\nconst searchData = [\n  {\n    id: 123,\n    title: 'The Grand Design',\n    contents: 'The Grand Design examines the history of scientific knowledge about the universe and explains eleven-dimensional M-theory.'\n    link: '#the-grand-design'\n  },\n  {\n    id: 456,\n    title: 'Metamorphosis',\n    contents: 'Metamorphosis tells the story of salesman who wakes to find himself transformed into a huge insect and struggles to adjust to this new condition.'\n    link: '#metamorphosis'\n  }\n];\n\n\nconst onClose = () =\u003e {\n  console.log( 'search modal closed!' );\n};\n\nconst onFollow = () =\u003e {\n  console.log( 'a search result was followed (clicked/tapped)!' );\n};\n\n// Adds a \"Search this page\" button to the specified container element\n// Clicking the button opens the search modal interface\nsearch( document.querySelector('#container'), { buttonText, searchData, onClose, onFollow } );\n```\n\n## Options\n\nStay tuned.\n\n## Development\n\n#### `yarn`\n\nInstall dependencies.\n\n#### `yarn start`\n\nRuns the app in the development mode.\\\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will reload if you make edits.\\\nYou will also see any lint errors in the console.\n\n#### `yarn test`\n\nLaunches the test runner in the interactive watch mode.\\\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n#### `yarn format`\n\nLints and formats all source files using [Prettier](https://prettier.io/).\n\n#### `yarn build`\n\nBuilds the app for production to the `dist` folder.\\\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\n---\n\n## Open source licensing info\n\n1. [TERMS](TERMS.md)\n2. [LICENSE](LICENSE)\n3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2Fctrl-f","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcfpb%2Fctrl-f","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2Fctrl-f/lists"}