Skip to content

Commit f3c6f41

Browse files
committed
fix(docs): adding chat readme and info in changelog (#16583)
1 parent d59d045 commit f3c6f41

File tree

2 files changed

+105
-14
lines changed

2 files changed

+105
-14
lines changed

CHANGELOG.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,14 @@ All notable changes for each version of this project will be documented in this
44

55
## 21.0.0
66

7-
### Themes
8-
9-
- `IgxButton`
10-
- **Breaking Change**
11-
- The following shadow-related parameters were removed from the `outlined-button-theme` and `flat-button-theme`:
12-
- `resting-shadow`
13-
- `hover-shadow`
14-
- `focus-shadow`
15-
- `active-shadow`
16-
17-
## 21.0.0
18-
197
### New Features
208

9+
- **New component** `IgxChat`:
10+
- A component that provides complete solution for building conversational interfaces in your applications. Read up more information in the [ReadMe](https://github.com/IgniteUI/igniteui-angular/tree/master/projects/igniteui-angular/chat/README.md)
11+
2112
- `IgxGrid`, `IgxTreeGrid`, `IgxHierarchicalGrid`
2213
- Added PDF export functionality to grid components. Grids can now be exported to PDF format alongside the existing Excel and CSV export options.
23-
14+
2415
The new `IgxPdfExporterService` follows the same pattern as Excel and CSV exporters:
2516

2617
```ts
@@ -60,9 +51,16 @@ All notable changes for each version of this project will be documented in this
6051
- **Landscape orientation** by default (suitable for wide grids)
6152
- **Internationalization** support for all 19 supported languages
6253
- Respects all grid export options (ignoreFiltering, ignoreSorting, ignoreColumnsVisibility, etc.)
63-
54+
6455
### Breaking Changes
6556

57+
- `IgxButton`
58+
- The following shadow-related parameters were removed from the `outlined-button-theme` and `flat-button-theme`:
59+
- `resting-shadow`
60+
- `hover-shadow`
61+
- `focus-shadow`
62+
- `active-shadow`
63+
6664
#### Dependency Injection Refactor
6765
- All internal DI now uses the `inject()` API across `igniteui-angular` (no more constructor DI in library code).
6866
- If you extend our components/services or call their constructors directly, remove DI params and switch to `inject()` (e.g., `protected foo = inject(FooService);`).
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
2+
# IgxChat
3+
4+
**IgxChat** is a component that provides a chat interface, wrapping the **IgcChat** web component.
5+
6+
A walkthrough of how to get started can be found [here](https://www.infragistics.com/products/ignite-ui-angular/angular/components/chat)
7+
8+
# Usage
9+
10+
```html
11+
<igx-chat
12+
[messages]="messages"
13+
[draftMessage]="draft"
14+
[options]="chatOptions"
15+
[templates]="chatTemplates"
16+
(messageCreated)="onMessageCreated($event)">
17+
</igx-chat>
18+
```
19+
20+
# API Summary
21+
The following tables summarize the **igx-chat** inputs, outputs and directives.
22+
23+
### Inputs
24+
The following inputs are available in the **igx-chat** component:
25+
26+
| Name | Type | Description |
27+
| :--- | :--- | :--- |
28+
| `messages` | `IgcChatMessage[]` | Array of chat messages to display |
29+
| `draftMessage` | `{ text: string; attachments?: IgcChatMessageAttachment[] } \| undefined` | Draft message with text and optional attachments |
30+
| `options` | `IgxChatOptions` | Configuration options for the chat component |
31+
| `templates` | `IgxChatTemplates` | Custom templates for rendering chat elements |
32+
33+
### Outputs
34+
The following outputs are available in the **igx-chat** component:
35+
36+
| Name | Description | Parameters |
37+
| :--- | :--- | :--- |
38+
| `messageCreated` | Emitted when a new message is created | `IgcChatMessage` |
39+
| `messageReact` | Emitted when a user reacts to a message | `IgcChatMessageReaction` |
40+
| `attachmentClick` | Emitted when an attachment is clicked | `IgcChatMessageAttachment` |
41+
| `attachmentDrag` | Emitted when attachment drag starts | `void` |
42+
| `attachmentDrop` | Emitted when attachment is dropped | `void` |
43+
| `typingChange` | Emitted when typing indicator state changes | `boolean` |
44+
| `inputFocus` | Emitted when the input receives focus | `void` |
45+
| `inputBlur` | Emitted when the input loses focus | `void` |
46+
| `inputChange` | Emitted when the input value changes | `string` |
47+
48+
### Directives
49+
The following directives are available for type checking in templates:
50+
51+
| Name | Selector | Description |
52+
| :--- | :--- | :--- |
53+
| `IgxChatMessageContextDirective` | `[igxChatMessageContext]` | Provides type information for chat message template contexts |
54+
| `IgxChatAttachmentContextDirective` | `[igxChatAttachmentContext]` | Provides type information for chat attachment template contexts |
55+
| `IgxChatInputContextDirective` | `[igxChatInputContext]` | Provides type information for chat input template contexts |
56+
57+
# Chat Extras
58+
59+
The **chat-extras** module provides additional utilities for enhancing chat functionality.
60+
61+
## MarkdownPipe
62+
63+
The `MarkdownPipe` transforms markdown text into HTML, allowing you to render formatted messages in the chat.
64+
65+
### Usage
66+
67+
```typescript
68+
import { MarkdownPipe } from 'igniteui-angular/chat-extras';
69+
70+
@Component({
71+
standalone: true,
72+
imports: [IgxChatComponent, MarkdownPipe, AsyncPipe],
73+
template: `
74+
<igx-chat [messages]="messages" [templates]="templates">
75+
<ng-template #renderer igxChatMessageContext let-message>
76+
<div [innerHTML]="message.text | fromMarkdown | async"></div>
77+
</ng-template>
78+
</igx-chat>
79+
`
80+
})
81+
```
82+
83+
### Supported Markdown Features
84+
85+
The pipe supports common markdown syntax including:
86+
- **Bold** text (`**text**`)
87+
- *Italic* text (`*text*`)
88+
- Headings (`# H1`, `## H2`, etc.)
89+
- Lists (ordered and unordered)
90+
- Links (`[text](url)`)
91+
- Code blocks and inline code
92+
- Blockquotes
93+
- And more...

0 commit comments

Comments
 (0)