Skip to content

Commit 7ef56bb

Browse files
rjborbarjborba
committed
Add examples for React and Nextjs apps
1 parent e09f061 commit 7ef56bb

7 files changed

Lines changed: 35 additions & 36 deletions

File tree

‎packages/ui-stencil/src/components/internal/orama-chat-messages-container/orama-chat-assistent-message/orama-sources/readme.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@
77

88
## Properties
99

10-
| Property | Attribute | Description | Type | Default |
11-
| --------------- | ------------------- | ----------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------- |
12-
| `linksRel` | `links-rel` | | `string` | `'noopener noreferrer'` |
13-
| `linksTarget` | `links-target` | | `string` | `'_blank'` |
14-
| `sourceBaseURL` | `source-base-u-r-l` | | `string` | `''` |
15-
| `sources` | `sources` | | `any` | `undefined` |
16-
| `sourcesMap` | -- | | `{ path?: string; description?: string; title?: string; }` | `{ title: 'title', description: 'description', path: 'path', }` |
10+
| Property | Attribute | Description | Type | Default |
11+
| --------------- | ------------------- | ----------- | -------- | ----------------------- |
12+
| `linksRel` | `links-rel` | | `string` | `'noopener noreferrer'` |
13+
| `linksTarget` | `links-target` | | `string` | `'_blank'` |
14+
| `sourceBaseURL` | `source-base-u-r-l` | | `string` | `''` |
15+
| `sources` | `sources` | | `any` | `undefined` |
1716

1817

1918
## Events

‎packages/ui-stencil/src/components/internal/orama-chat-messages-container/orama-chat-assistent-message/readme.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77

88
## Properties
99

10-
| Property | Attribute | Description | Type | Default |
11-
| ------------------------ | --------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
12-
| `chatMarkdownLinkHref` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
13-
| `chatMarkdownLinkTarget` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
14-
| `chatMarkdownLinkTitle` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
15-
| `interaction` | -- | | `{ query: string; response?: string; sources?: any; latest?: boolean; status: TAnswerStatus; interactionId?: string; relatedQueries?: string[]; }` | `undefined` |
10+
| Property | Attribute | Description | Type | Default |
11+
| ------------------------ | --------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
12+
| `chatMarkdownLinkHref` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
13+
| `chatMarkdownLinkTarget` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
14+
| `chatMarkdownLinkTitle` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
15+
| `interaction` | -- | | `{ query: string; response?: string; sources?: SourceItem[]; latest?: boolean; status: TAnswerStatus; interactionId?: string; relatedQueries?: string[]; }` | `undefined` |
1616

1717

1818
## Dependencies

‎packages/ui-stencil/src/components/internal/orama-chat-messages-container/orama-chat-user-message/readme.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77

88
## Properties
99

10-
| Property | Attribute | Description | Type | Default |
11-
| ------------- | --------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
12-
| `interaction` | -- | | `{ query: string; response?: string; sources?: any; latest?: boolean; status: TAnswerStatus; interactionId?: string; relatedQueries?: string[]; }` | `undefined` |
10+
| Property | Attribute | Description | Type | Default |
11+
| ------------- | --------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
12+
| `interaction` | -- | | `{ query: string; response?: string; sources?: SourceItem[]; latest?: boolean; status: TAnswerStatus; interactionId?: string; relatedQueries?: string[]; }` | `undefined` |
1313

1414

1515
## Dependencies

‎packages/ui-stencil/src/components/internal/orama-chat/readme.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@
77

88
## Properties
99

10-
| Property | Attribute | Description | Type | Default |
11-
| ------------------------ | -------------------------- | ----------- | ------------------------------------------------------------- | ------------------- |
12-
| `chatMarkdownLinkHref` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
13-
| `chatMarkdownLinkTarget` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
14-
| `chatMarkdownLinkTitle` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
15-
| `clearChatOnDisconnect` | `clear-chat-on-disconnect` | | `boolean` | `undefined` |
16-
| `defaultTerm` | `default-term` | | `string` | `undefined` |
17-
| `focusInput` | `focus-input` | | `boolean` | `false` |
18-
| `linksRel` | `links-rel` | | `string` | `undefined` |
19-
| `linksTarget` | `links-target` | | `string` | `undefined` |
20-
| `placeholder` | `placeholder` | | `string` | `'Ask me anything'` |
21-
| `prompt` | `prompt` | | `string` | `undefined` |
22-
| `showClearChat` | `show-clear-chat` | | `boolean` | `true` |
23-
| `sourceBaseUrl` | `source-base-url` | | `string` | `''` |
24-
| `sourcesMap` | -- | | `{ path?: string; description?: string; title?: string; }` | `undefined` |
25-
| `suggestions` | -- | | `string[]` | `undefined` |
26-
| `systemPrompts` | -- | | `string[]` | `undefined` |
10+
| Property | Attribute | Description | Type | Default |
11+
| ------------------------ | -------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
12+
| `chatMarkdownLinkHref` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
13+
| `chatMarkdownLinkTarget` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
14+
| `chatMarkdownLinkTitle` | -- | | `({ text, href }: { text: string; href: string; }) => string` | `undefined` |
15+
| `clearChatOnDisconnect` | `clear-chat-on-disconnect` | | `boolean` | `undefined` |
16+
| `defaultTerm` | `default-term` | | `string` | `undefined` |
17+
| `focusInput` | `focus-input` | | `boolean` | `false` |
18+
| `linksRel` | `links-rel` | | `string` | `undefined` |
19+
| `linksTarget` | `links-target` | | `string` | `undefined` |
20+
| `placeholder` | `placeholder` | | `string` | `'Ask me anything'` |
21+
| `prompt` | `prompt` | | `string` | `undefined` |
22+
| `showClearChat` | `show-clear-chat` | | `boolean` | `true` |
23+
| `sourceBaseUrl` | `source-base-url` | | `string` | `''` |
24+
| `sourcesMap` | -- | | `SourcesMapItem[] \| { path?: string \| SourcesMapRenderFunction; description?: string \| SourcesMapRenderFunction; title?: string \| SourcesMapRenderFunction; } & { datasourceId?: string; }` | `undefined` |
25+
| `suggestions` | -- | | `string[]` | `undefined` |
26+
| `systemPrompts` | -- | | `string[]` | `undefined` |
2727

2828

2929
## Events

0 commit comments

Comments
 (0)