Skip to content

docs: O-3144 #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
g-francesca wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: O-3144 #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/docs/cloud/ui-library/components.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Orama UI provides a set of React components designed to build AI-driven interfac
- **[`SearchResults`](https://github.com/oramasearch/orama-ui/blob/main/packages/ui/docs/components/SearchResults.md)** - Displays search results with customizable rendering
- **[`ChatInteractions`](https://github.com/oramasearch/orama-ui/blob/main/packages/ui/docs/components/ChatInteractions.md)** - Renders chat messages and user actions
- **[`Suggestions`](https://github.com/oramasearch/orama-ui/blob/main/packages/ui/docs/components/Suggestions.md)** - Displays prompt suggestions
- **[`RecentSearches`](https://github.com/oramasearch/orama-ui/blob/main/packages/ui/docs/components/RecentSearches.md)** - Component for managing and displaying recent search history

### Form Components

Expand Down
1 change: 1 addition & 0 deletions content/docs/cloud/ui-library/hooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Below is an overview of all available hooks. Each hook links to its detailed doc

- **[`useSearch`](https://github.com/oramasearch/orama-ui/blob/main/packages/ui/docs/hooks/useSearch.md)** - Access search state, query, results, and search functions
- **[`useChat`](https://github.com/oramasearch/orama-ui/blob/main/packages/ui/docs/hooks/useChat.md)** - Manage chat conversations, messages, and AI interactions
- **[`useRecentSearches`](https://github.com/oramasearch/orama-ui/blob/main/packages/ui/docs/hooks/useRecentSearches.md)** - Manage recent search history and state

The primary hooks must be used within the context of `SearchRoot` or `ChatRoot`, depending on whether you are building a search or chat experience. These root providers handle state management and context required by the hooks.

Expand Down