Skip to content

Commit

Permalink
Merge 0fb6d7a into 9409383
Browse files Browse the repository at this point in the history
  • Loading branch information
ElemelonWind committed Jul 15, 2022
2 parents 9409383 + 0fb6d7a commit 84d21e6
Show file tree
Hide file tree
Showing 582 changed files with 3,763 additions and 3,763 deletions.
2 changes: 1 addition & 1 deletion .storybook/yextTheme.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ module.exports = create({

// Brand logo
brandTitle: 'Yext Component Library',
brandUrl: 'https://github.com/yext/answers-react-components',
brandUrl: 'https://github.com/yext/search-ui-react',
brandImage: './logo.png'
});
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
# answers-react-components
# search-react-ui

<div>
<a href="https://npmjs.org/package/@yext/answers-react-components">
<img src="https://img.shields.io/npm/v/@yext/answers-react-components" alt="NPM version"/>
<a href="https://npmjs.org/package/@yext/search-react-ui">
<img src="https://img.shields.io/npm/v/@yext/search-react-ui" alt="NPM version"/>
</a>
<a href="./LICENSE">
<img src="https://img.shields.io/badge/License-BSD%203--Clause-blue.svg" alt="License"/>
</a>
<a href='https://coveralls.io/github/yext/answers-react-components?branch=main'>
<img src='https://coveralls.io/repos/github/yext/answers-react-components/badge.svg?branch=main' alt='Coverage Status' />
<a href='https://coveralls.io/github/yext/search-react-ui?branch=main'>
<img src='https://coveralls.io/repos/github/yext/search-react-ui/badge.svg?branch=main' alt='Coverage Status' />
</a>
</div>
<br>

A library of React Components for powering Yext Search integrations.

See the [full documentation](./docs/answers-react-components.md) here.
See the [full documentation](./docs/search-react-ui.md) here.

## Getting Started

If you are using NPM 7+, you can install the components with the following command:

```bash
npm install @yext/answers-react-components
npm install @yext/search-react-ui
```
The @yext/answers-headless-react peer dependency will be automatically installed.

If you are using NPM 6 or Yarn, you can install the library and its peer dependencies with this command:
```bash
npx install-peerdeps @yext/answers-react-components
npx install-peerdeps @yext/search-react-ui
```
The command will work with Yarn so long as NPM 6+ is installed on the machine.

Once the library and its peer dependencies are installed, the components can be rendered using React by placing them inside the `AnswersHeadlessProvider` with the appropriate credentials:

```tsx
import { AnswersHeadlessProvider } from '@yext/answers-headless-react';
import { SearchBar, UniversalResults } from '@yext/answers-react-components';
import { SearchBar, UniversalResults } from '@yext/search-react-ui';

const config = {
apiKey: '<apiKey>',
Expand All @@ -60,5 +60,5 @@ export default App;
To use the Component Library's Styling without adding Tailwind to your project, add the following import:

```tsx
import '@yext/answers-react-components/bundle.css'
import '@yext/search-react-ui/bundle.css'
```

This file was deleted.

This file was deleted.

This file was deleted.

25 changes: 0 additions & 25 deletions docs/answers-react-components.alternativeverticalscssclasses.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

24 changes: 0 additions & 24 deletions docs/answers-react-components.alternativeverticalsprops.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

25 changes: 0 additions & 25 deletions docs/answers-react-components.appliedfilterscssclasses.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

23 changes: 0 additions & 23 deletions docs/answers-react-components.appliedfiltersprops.md

This file was deleted.

This file was deleted.

0 comments on commit 84d21e6

Please sign in to comment.