{"id":23334849,"url":"https://github.com/yext/search-ui-react","last_synced_at":"2026-01-16T18:31:19.306Z","repository":{"id":37080576,"uuid":"451595901","full_name":"yext/search-ui-react","owner":"yext","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-22T20:05:08.000Z","size":59779,"stargazers_count":11,"open_issues_count":13,"forks_count":13,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-09-22T21:26:36.259Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yext.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-01-24T19:02:35.000Z","updated_at":"2025-08-07T14:59:25.000Z","dependencies_parsed_at":"2024-02-01T00:32:15.837Z","dependency_job_id":"cf4c0489-0ca6-41f5-bd01-c219dc813e9b","html_url":"https://github.com/yext/search-ui-react","commit_stats":{"total_commits":357,"total_committers":22,"mean_commits":"16.227272727272727","dds":0.7787114845938375,"last_synced_commit":"109b4436154e41d671171e3fa242ab93067e1273"},"previous_names":["yext/answers-react-components"],"tags_count":52,"template":false,"template_full_name":null,"purl":"pkg:github/yext/search-ui-react","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yext%2Fsearch-ui-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yext%2Fsearch-ui-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yext%2Fsearch-ui-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yext%2Fsearch-ui-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yext","download_url":"https://codeload.github.com/yext/search-ui-react/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yext%2Fsearch-ui-react/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278386122,"owners_count":25978109,"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-10-04T02:00:05.491Z","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":[],"created_at":"2024-12-21T01:14:19.936Z","updated_at":"2026-01-16T18:31:19.291Z","avatar_url":"https://github.com/yext.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# search-ui-react\n\n\u003cdiv\u003e\n  \u003ca href=\"https://npmjs.org/package/@yext/search-ui-react\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/@yext/search-ui-react\" alt=\"NPM version\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"./LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-BSD%203--Clause-blue.svg\" alt=\"License\"/\u003e\n  \u003c/a\u003e\n  \u003ca href='https://coveralls.io/github/yext/search-ui-react?branch=main'\u003e\n    \u003cimg src='https://coveralls.io/repos/github/yext/search-ui-react/badge.svg?branch=main' alt='Coverage Status' /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\nA library of React Components for powering Yext Search integrations.\n\nSee the [full documentation](./docs/search-ui-react.md) here.\n\n## Getting Started\n\nIf you are using NPM 7+, you can install the components with the following command:\n\n```bash\nnpm install @yext/search-ui-react\n```\nThe @yext/search-headless-react peer dependency will be automatically installed.\n\nIf you are using NPM 6 or Yarn, you can install the library and its peer dependencies with this command:\n```bash\nnpx install-peerdeps @yext/search-ui-react\n```\nThe command will work with Yarn so long as NPM 6+ is installed on the machine.\n\nOnce the library and its peer dependencies are installed, our React Components should be nested inside the `SearchHeadlessProvider`. `SearchHeadlessProvider` requires a `SearchHeadless` instance, which is created using `provideHeadless(...)` with the appropriate credentials:\n\n```tsx\nimport { provideHeadless, SearchHeadlessProvider } from '@yext/search-headless-react';\nimport { SearchBar, UniversalResults, VerticalConfigMap } from '@yext/search-ui-react';\nimport { v4 as uuidv4 } from 'uuid';\n\nconst config = {\n  apiKey: '\u003capiKey\u003e',\n  experienceKey: '\u003cexperienceKey\u003e',\n  locale: 'en',\n  experienceVersion: 'PRODUCTION',\n}\n\nconst searcher = provideHeadless(config);\n\nsearcher.setSessionTrackingEnabled(true);\nlet sessionId = window.sessionStorage.getItem('sessionId');\nif (!sessionId) {\n  sessionId = uuidv4();\n  window.sessionStorage.setItem('sessionId', sessionId);\n}\nsearcher.setSessionId(sessionId);\n\nconst verticalConfigMap: VerticalConfigMap = {\n  help_articles: {\n    label: \"Help Articles\"\n  }\n}\n\nfunction App() {\n  return (\n    \u003cSearchHeadlessProvider searcher={searcher}\u003e\n      \u003cSearchBar /\u003e\n      \u003cUniversalResults verticalConfigMap={verticalConfigMap}/\u003e\n    \u003c/SearchHeadlessProvider\u003e\n  );\n}\n\nexport default App;\n```\n\nTo use the Component Library's Styling without adding Tailwind to your project, add the following import: \n\n```tsx\nimport '@yext/search-ui-react/bundle.css'\n```\n\n## Compatibility Notes\n\nThis library and its dependencies use optional chaining and other modern TS syntax that is not inherently supported by Webpack \u003c5 (e.g. via `create-react-app@4`). Additional Babel plugins are needed for transpiling if using legacy versions.\n\nIf you need to verify this package against multiple major React releases while developing locally, follow the workflow in [guides/react-compatibility.md](./guides/react-compatibility.md) to install the library into the `test-site` the same way end users consume it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyext%2Fsearch-ui-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyext%2Fsearch-ui-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyext%2Fsearch-ui-react/lists"}