Skip to content
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

feat: allow user to prevent default on markdown link event #63

Merged
merged 2 commits into from
Nov 25, 2024
Merged

feat: allow user to prevent default on markdown link event #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
359a9ba
feat: allow user to prevent default on markdown link event
rjborba Nov 25, 2024
d78268a
feat: add target ccallback for markdown links
rjborba Nov 25, 2024
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
12 changes: 12 additions & 0 deletions apps/demo-react/src/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ function App() {
style={{ height: '600px' }}
onAnswerSourceClick={(e: Event) => console.log(e)}
onAnswerGenerated={(e: Event) => console.log(e)}
chatMarkdownLinkTitle={({ text }) => text?.toUpperCase()}
chatMarkdownLinkHref={({ href }) => href}
onChatMarkdownLinkClicked={(e: Event) => {
console.log(e)
e.preventDefault()
}}
/>
</div>
</section>
Expand Down Expand Up @@ -76,6 +82,12 @@ function App() {
console.log(e)
e.preventDefault()
}}
chatMarkdownLinkTitle={({ text }) => text?.toUpperCase()}
chatMarkdownLinkHref={({ href }) => href}
onChatMarkdownLinkClicked={(e: Event) => {
console.log(e)
e.preventDefault()
}}
/>
</div>
</section>
Expand Down
29 changes: 25 additions & 4 deletions packages/ui-stencil-vue/lib/components.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,18 @@ export const OramaChat = /*@__PURE__*/ defineContainer<JSX.OramaChat>('orama-cha
'focusInput',
'suggestions',
'systemPrompts',
'chatMarkdownLinkTitle',
'chatMarkdownLinkHref',
'chatMarkdownLinkTarget',
'answerGenerated'
]);


export const OramaChatAssistentMessage = /*@__PURE__*/ defineContainer<JSX.OramaChatAssistentMessage>('orama-chat-assistent-message', undefined, [
'interaction'
'interaction',
'chatMarkdownLinkTitle',
'chatMarkdownLinkHref',
'chatMarkdownLinkTarget'
]);


Expand All @@ -50,8 +56,12 @@ export const OramaChatBox = /*@__PURE__*/ defineContainer<JSX.OramaChatBox>('ora
'suggestions',
'autoFocus',
'systemPrompts',
'chatMarkdownLinkTitle',
'chatMarkdownLinkHref',
'chatMarkdownLinkTarget',
'answerGenerated',
'answerSourceClick'
'answerSourceClick',
'chatMarkdownLinkClicked'
]);


Expand All @@ -65,6 +75,9 @@ export const OramaChatButton = /*@__PURE__*/ defineContainer<JSX.OramaChatButton

export const OramaChatMessagesContainer = /*@__PURE__*/ defineContainer<JSX.OramaChatMessagesContainer>('orama-chat-messages-container', undefined, [
'interactions',
'chatMarkdownLinkTitle',
'chatMarkdownLinkHref',
'chatMarkdownLinkTarget',
'answerGenerated'
]);

Expand Down Expand Up @@ -112,7 +125,11 @@ export const OramaLogoIcon = /*@__PURE__*/ defineContainer<JSX.OramaLogoIcon>('o


export const OramaMarkdown = /*@__PURE__*/ defineContainer<JSX.OramaMarkdown>('orama-markdown', undefined, [
'content'
'content',
'chatMarkdownLinkTitle',
'chatMarkdownLinkHref',
'chatMarkdownLinkTarget',
'chatMarkdownLinkClicked'
]);


Expand Down Expand Up @@ -168,10 +185,14 @@ export const OramaSearchBox = /*@__PURE__*/ defineContainer<JSX.OramaSearchBox>(
'searchPlaceholder',
'suggestions',
'searchParams',
'chatMarkdownLinkTitle',
'chatMarkdownLinkHref',
'chatMarkdownLinkTarget',
'searchCompleted',
'searchResultClick',
'answerGenerated',
'answerSourceClick'
'answerSourceClick',
'chatMarkdownLinkClicked'
]);


Expand Down
66 changes: 64 additions & 2 deletions packages/ui-stencil/src/components.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/
import { HTMLStencilElement, JSXBase } from "@stencil/core/internal";
import { ButtonProps } from "./components/internal/orama-button/orama-button";
import { CloudIndexConfig, ColorScheme, Facet, OnAnswerGeneratedCallbackProps, OnAnswerSourceClickCallbackProps, OnSearchCompletedCallbackProps, OnSearchResultClickCallbackProps, ResultMap, SearchResult, SearchResultBySection, SourcesMap } from "./types/index";
import { ChatMarkdownLinkHref, ChatMarkdownLinkTarget, ChatMarkdownLinkTitle, CloudIndexConfig, ColorScheme, Facet, OnAnswerGeneratedCallbackProps, OnAnswerSourceClickCallbackProps, OnChatMarkdownLinkClickedCallbackProps, OnSearchCompletedCallbackProps, OnSearchResultClickCallbackProps, ResultMap, SearchResult, SearchResultBySection, SourcesMap } from "./types/index";
import { TChatInteraction } from "./context/chatContext";
import { OramaClient } from "@oramacloud/client";
import { InputProps } from "./components/internal/orama-input/orama-input";
Expand All @@ -18,7 +18,7 @@ import { TThemeOverrides as TThemeOverrides1 } from "./components.d";
import { SearchResultsProps } from "./components/internal/orama-search-results/orama-search-results";
import { TextProps } from "./components/internal/orama-text/orama-text";
export { ButtonProps } from "./components/internal/orama-button/orama-button";
export { CloudIndexConfig, ColorScheme, Facet, OnAnswerGeneratedCallbackProps, OnAnswerSourceClickCallbackProps, OnSearchCompletedCallbackProps, OnSearchResultClickCallbackProps, ResultMap, SearchResult, SearchResultBySection, SourcesMap } from "./types/index";
export { ChatMarkdownLinkHref, ChatMarkdownLinkTarget, ChatMarkdownLinkTitle, CloudIndexConfig, ColorScheme, Facet, OnAnswerGeneratedCallbackProps, OnAnswerSourceClickCallbackProps, OnChatMarkdownLinkClickedCallbackProps, OnSearchCompletedCallbackProps, OnSearchResultClickCallbackProps, ResultMap, SearchResult, SearchResultBySection, SourcesMap } from "./types/index";
export { TChatInteraction } from "./context/chatContext";
export { OramaClient } from "@oramacloud/client";
export { InputProps } from "./components/internal/orama-input/orama-input";
Expand All @@ -40,6 +40,9 @@ export namespace Components {
"withTooltip"?: string;
}
interface OramaChat {
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"defaultTerm"?: string;
"focusInput"?: boolean;
"linksRel"?: string;
Expand All @@ -52,10 +55,16 @@ export namespace Components {
"systemPrompts"?: string[];
}
interface OramaChatAssistentMessage {
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"interaction": TChatInteraction;
}
interface OramaChatBox {
"autoFocus": boolean;
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"clientInstance"?: OramaClient;
"index"?: CloudIndexConfig;
"linksRel"?: string;
Expand All @@ -73,6 +82,9 @@ export namespace Components {
"label": string;
}
interface OramaChatMessagesContainer {
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"interactions": TChatInteraction[];
}
interface OramaChatUserMessage {
Expand Down Expand Up @@ -105,6 +117,9 @@ export namespace Components {
"size": number;
}
interface OramaMarkdown {
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"content": string;
}
interface OramaModal {
Expand All @@ -130,6 +145,9 @@ export namespace Components {
"suggestions"?: string[];
}
interface OramaSearchBox {
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"chatPlaceholder"?: string;
"clientInstance"?: OramaClient;
"colorScheme"?: ColorScheme;
Expand Down Expand Up @@ -241,6 +259,10 @@ export interface OramaInputCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLOramaInputElement;
}
export interface OramaMarkdownCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLOramaMarkdownElement;
}
export interface OramaModalCustomEvent<T> extends CustomEvent<T> {
detail: T;
target: HTMLOramaModalElement;
Expand Down Expand Up @@ -294,6 +316,7 @@ declare global {
interface HTMLOramaChatBoxElementEventMap {
"answerGenerated": OnAnswerGeneratedCallbackProps;
"answerSourceClick": OnAnswerSourceClickCallbackProps;
"chatMarkdownLinkClicked": OnChatMarkdownLinkClickedCallbackProps;
}
interface HTMLOramaChatBoxElement extends Components.OramaChatBox, HTMLStencilElement {
addEventListener<K extends keyof HTMLOramaChatBoxElementEventMap>(type: K, listener: (this: HTMLOramaChatBoxElement, ev: OramaChatBoxCustomEvent<HTMLOramaChatBoxElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
Expand Down Expand Up @@ -385,7 +408,18 @@ declare global {
prototype: HTMLOramaLogoIconElement;
new (): HTMLOramaLogoIconElement;
};
interface HTMLOramaMarkdownElementEventMap {
"chatMarkdownLinkClicked": OnChatMarkdownLinkClickedCallbackProps;
}
interface HTMLOramaMarkdownElement extends Components.OramaMarkdown, HTMLStencilElement {
addEventListener<K extends keyof HTMLOramaMarkdownElementEventMap>(type: K, listener: (this: HTMLOramaMarkdownElement, ev: OramaMarkdownCustomEvent<HTMLOramaMarkdownElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
removeEventListener<K extends keyof HTMLOramaMarkdownElementEventMap>(type: K, listener: (this: HTMLOramaMarkdownElement, ev: OramaMarkdownCustomEvent<HTMLOramaMarkdownElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
}
var HTMLOramaMarkdownElement: {
prototype: HTMLOramaMarkdownElement;
Expand Down Expand Up @@ -437,6 +471,7 @@ declare global {
"searchResultClick": OnSearchResultClickCallbackProps;
"answerGenerated": OnAnswerGeneratedCallbackProps;
"answerSourceClick": OnAnswerSourceClickCallbackProps;
"chatMarkdownLinkClicked": OnChatMarkdownLinkClickedCallbackProps;
}
interface HTMLOramaSearchBoxElement extends Components.OramaSearchBox, HTMLStencilElement {
addEventListener<K extends keyof HTMLOramaSearchBoxElementEventMap>(type: K, listener: (this: HTMLOramaSearchBoxElement, ev: OramaSearchBoxCustomEvent<HTMLOramaSearchBoxElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
Expand Down Expand Up @@ -562,6 +597,9 @@ declare namespace LocalJSX {
"withTooltip"?: string;
}
interface OramaChat {
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"defaultTerm"?: string;
"focusInput"?: boolean;
"linksRel"?: string;
Expand All @@ -575,10 +613,16 @@ declare namespace LocalJSX {
"systemPrompts"?: string[];
}
interface OramaChatAssistentMessage {
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"interaction"?: TChatInteraction;
}
interface OramaChatBox {
"autoFocus"?: boolean;
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"clientInstance"?: OramaClient;
"index"?: CloudIndexConfig;
"linksRel"?: string;
Expand All @@ -591,6 +635,10 @@ declare namespace LocalJSX {
* Fired when user clicks on answer source
*/
"onAnswerSourceClick"?: (event: OramaChatBoxCustomEvent<OnAnswerSourceClickCallbackProps>) => void;
/**
* Fired when user clicks on chat markdown link
*/
"onChatMarkdownLinkClicked"?: (event: OramaChatBoxCustomEvent<OnChatMarkdownLinkClickedCallbackProps>) => void;
"placeholder"?: string;
"sourceBaseUrl"?: string;
"sourcesMap"?: SourcesMap;
Expand All @@ -604,6 +652,9 @@ declare namespace LocalJSX {
"label"?: string;
}
interface OramaChatMessagesContainer {
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"interactions"?: TChatInteraction[];
"onAnswerGenerated"?: (event: OramaChatMessagesContainerCustomEvent<OnSearchCompletedCallbackProps>) => void;
}
Expand Down Expand Up @@ -638,7 +689,11 @@ declare namespace LocalJSX {
"size"?: number;
}
interface OramaMarkdown {
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"content"?: string;
"onChatMarkdownLinkClicked"?: (event: OramaMarkdownCustomEvent<OnChatMarkdownLinkClickedCallbackProps>) => void;
}
interface OramaModal {
"closeOnEscape"?: boolean;
Expand Down Expand Up @@ -666,6 +721,9 @@ declare namespace LocalJSX {
"suggestions"?: string[];
}
interface OramaSearchBox {
"chatMarkdownLinkHref"?: ChatMarkdownLinkHref;
"chatMarkdownLinkTarget"?: ChatMarkdownLinkTarget;
"chatMarkdownLinkTitle"?: ChatMarkdownLinkTitle;
"chatPlaceholder"?: string;
"clientInstance"?: OramaClient;
"colorScheme"?: ColorScheme;
Expand All @@ -685,6 +743,10 @@ declare namespace LocalJSX {
* Fired when user clicks on answer source
*/
"onAnswerSourceClick"?: (event: OramaSearchBoxCustomEvent<OnAnswerSourceClickCallbackProps>) => void;
/**
* Fired when user clicks on chat markdown link
*/
"onChatMarkdownLinkClicked"?: (event: OramaSearchBoxCustomEvent<OnChatMarkdownLinkClickedCallbackProps>) => void;
/**
* Fired when search successfully resolves
*/
Expand Down
15 changes: 14 additions & 1 deletion ...ama-chat-messages-container/orama-chat-assistent-message/orama-chat-assistent-message.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import '@phosphor-icons/webcomponents/dist/icons/PhThumbsDown.mjs'
import '@phosphor-icons/webcomponents/dist/icons/PhWarning.mjs'
import { chatContext, TAnswerStatus } from '@/context/chatContext'
import { copyToClipboard } from '@/utils/utils'
import type { ChatMarkdownLinkHref, ChatMarkdownLinkTarget, ChatMarkdownLinkTitle } from '@/types'

@Component({
tag: 'orama-chat-assistent-message',
Expand All @@ -14,6 +15,10 @@ import { copyToClipboard } from '@/utils/utils'
})
export class OramaChatAssistentMessage {
@Prop() interaction: TChatInteraction
@Prop() chatMarkdownLinkTitle?: ChatMarkdownLinkTitle
@Prop() chatMarkdownLinkHref?: ChatMarkdownLinkHref
@Prop() chatMarkdownLinkTarget?: ChatMarkdownLinkTarget

@State() isCopied = false
handleCopyToClipboard = () => {
this.isCopied = true
Expand Down Expand Up @@ -60,7 +65,15 @@ export class OramaChatAssistentMessage {
linksTarget={chatContext.linksTarget}
/>
<div class="message-wrapper">
{!this.interaction.response ? <orama-dots-loader /> : <orama-markdown content={this.interaction.response} />}
{!this.interaction.response ? (
<orama-dots-loader />
) : (
<orama-markdown
content={this.interaction.response}
chatMarkdownLinkTitle={this.chatMarkdownLinkTitle}
chatMarkdownLinkHref={this.chatMarkdownLinkHref}
/>
)}

<div class={{ 'message-actions': true, hidden: this.interaction.status !== TAnswerStatus.done }}>
{this.interaction.latest && (
Expand Down
Loading
Loading