Skip to content

Commit 1ad5e25

Browse files
authored
Merge pull request #254 from IgniteUI/sstoychev/adding-api-links
feat(chat/grid-lite): adding api links
2 parents 15799f7 + a2f6d47 commit 1ad5e25

20 files changed

Lines changed: 131 additions & 99 deletions

File tree

docs/angular/src/content/en/components/chat.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To get started, install Ignite UI for Angular package as well as the Ignite UI f
2525
npm install igniteui-angular igniteui-webcomponents
2626
```
2727

28-
`IgxChatComponent` provides Angular bindings (events, templates, DI, change detection, pipes), while the visual chat UI is rendered by the Web Component. Installing both ensures the chat behaves natively in Angular while leveraging the full Web Component UI.
28+
<ApiLink type="Chat" /> provides Angular bindings (events, templates, DI, change detection, pipes), while the visual chat UI is rendered by the Web Component. Installing both ensures the chat behaves natively in Angular while leveraging the full Web Component UI.
2929

3030
For a complete introduction to the Ignite UI for Angular, read the [_getting started_](/general/getting-started) topic.
3131

@@ -85,8 +85,8 @@ The Chat component exposes several key properties that let you control its state
8585
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8686
| `messages` | Array of messages (`IgcChatMessage[]`) displayed in the chat. You can bind to this to control which messages are shown. |
8787
| `draftMessage` | The current unsent message, represented as an object containing `text` and optional `attachments`. This is useful for saving or restoring message drafts. |
88-
| `options` | Chat configuration (`IgxChatOptions`) such as current user ID, input placeholders, accepted file types, quick reply suggestions and typing behavior. |
89-
| `templates` | Custom Angular templates (`IgxChatTemplates`) for message content, input, attachments, and other parts of the chat UI. |
88+
| `options` | Chat configuration (<ApiLink type="ChatOptions" kind="type" suffix={false} />) such as current user ID, input placeholders, accepted file types, quick reply suggestions and typing behavior. |
89+
| `templates` | Custom Angular templates (<ApiLink type="ChatTemplates" kind="type" suffix={false} />) for message content, input, attachments, and other parts of the chat UI. |
9090

9191
These properties make it straightforward to synchronize the Chat’s UI with your application’s state and backend.
9292

@@ -168,7 +168,7 @@ This level of granularity means you can tweak just one part (for example, how at
168168

169169
Here:
170170
- `let-message` exposes the message object.
171-
- The `igxChatMessageContext` directive ensures proper typing for message templates.
171+
- The <ApiLink type="ChatMessageContextDirective" suffix={false} label="igxChatMessageContext" /> directive ensures proper typing for message templates.
172172

173173
#### Custom Input Area
174174
By default, the chat input is a text area. You can override it to provide a more tailored experience, such as adding a voice input button:
@@ -435,12 +435,12 @@ Finally, **include** the custom theme in your application:
435435

436436
## API Reference
437437

438-
- `IgxChatComponent`
439-
- `IgxChatOptions`
440-
- `IgxChatTemplates`
441-
- `IgxChatMessageContextDirective`
442-
- `IgxChatInputContextDirective`
443-
- `IgxChatAttachmentContextDirective`
438+
- <ApiLink type="Chat" />
439+
- <ApiLink type="ChatOptions" kind="type" suffix={false} />
440+
- <ApiLink type="ChatTemplates" kind="type" suffix={false} />
441+
- <ApiLink type="ChatMessageContextDirective" suffix={false} />
442+
- <ApiLink type="ChatInputContextDirective" suffix={false} />
443+
- <ApiLink type="ChatAttachmentContextDirective" suffix={false} />
444444
- [`Styling & Themes`](/themes)
445445

446446
## Additional Resources

docs/angular/src/content/en/components/grid-lite/binding.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ namespace: Infragistics.Controls
99

1010
import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro';
1111
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
12+
import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1213

1314

1415
# Angular Grid Lite Data Binding
@@ -56,19 +57,17 @@ Or just set the respective properties in the html instead of using a `@ViewChild
5657
<DocsAside type="info">
5758
The sort/filter states of the Grid Lite component are kept when changing the data source in this manner.
5859
</DocsAside>
59-
Usually you will want to reset them by calling either **`clearSort()`** and/or **`clearFilter()`**.
60+
Usually you will want to reset them by calling either <ApiLink type="GridLite" member="clearSort" label="clearSort()" /> and/or <ApiLink type="GridLite" member="clearFilter" label="clearFilter()" />.
6061

6162
In the sample below, the grid has column auto-generation enabled. When you click on the switch data button,
6263
the column collection is reset, and a new data source is bound to the grid.
6364

6465
<Sample src="/grid-lite/data-binding-dynamic" height={510} alt="Angular Grid Lite Data Binding Example" />
6566

66-
{/* TODO ## API References
67+
## API References
6768

68-
* `{ComponentName}`
69-
* `Column`
70-
71-
*/}
69+
- <ApiLink type="GridLite" />
70+
- <ApiLink type="GridLiteColumn" />
7271

7372
## Additional Resources
7473

docs/angular/src/content/en/components/grid-lite/cell-template.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ namespace: Infragistics.Controls
99

1010
import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro';
1111
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
12+
import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1213

1314

1415
# Column Cell Template
@@ -26,7 +27,7 @@ To achieve that, use **`<ng-template>`** inside `<igx-grid-lite-column>...</igx-
2627
</igx-grid-lite-column>
2728
```
2829

29-
You also need to import **`IgxGridLiteCellTemplateDirective`**
30+
You also need to import <ApiLink type="GridLiteCellTemplateDirective" suffix={false} />
3031

3132
```typescript
3233
import { IgxGridLiteComponent, IgxGridLiteColumnComponent, IgxGridLiteCellTemplateDirective } from 'igniteui-angular/grids/lite';
@@ -117,7 +118,7 @@ Keep in mind the more complex and involved the template is, the greater the perf
117118

118119
## Cell Context Object
119120

120-
The custom cell renderer is passed an **`GridLiteCellContext`** object as a parameter with the following props:
121+
The custom cell renderer is passed an <ApiLink type="GridLiteCellTemplateContext" kind="type" suffix={false} /> object as a parameter with the following props:
121122

122123

123124
```typescript
@@ -148,12 +149,11 @@ export interface IgxGridLiteCellTemplateContext<T extends object> {
148149

149150
<Sample src="/grid-lite/column-config-simple" height={510} alt="Angular Grid Lite Column Config Basic" />
150151

151-
{/* TODO ## API References
152+
## API References
152153

153-
* `{ComponentName}`
154-
* `Column`
155-
156-
*/}
154+
- <ApiLink type="GridLite" />
155+
- <ApiLink type="GridLiteColumn" />
156+
- <ApiLink type="GridLiteCellTemplateDirective" suffix={false} />
157157

158158
## Additional Resources
159159

docs/angular/src/content/en/components/grid-lite/column-configuration.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ namespace: Infragistics.Controls
99

1010
import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro';
1111
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
12+
import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1213

1314

1415
# Column Configuration
@@ -101,12 +102,10 @@ In the sample below you can try out the different column properties and how they
101102

102103
<Sample src="/grid-lite/column-config-dynamic" height={510} alt="Angular Grid Lite Column Config Dynamic" />
103104

104-
{/* TODO ## API References
105+
## API References
105106

106-
* `{ComponentName}`
107-
* `Column`
108-
109-
*/}
107+
- <ApiLink type="GridLite" />
108+
- <ApiLink type="GridLiteColumn" />
110109

111110
## Additional Resources
112111

docs/angular/src/content/en/components/grid-lite/filtering.mdx

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ namespace: Infragistics.Controls
88
---
99

1010
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
11+
import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1112

1213

1314
# Angular Grid Lite Filter Operations
@@ -42,7 +43,7 @@ column.filteringCaseSensitive = true;
4243

4344
## Filter Model
4445

45-
The building blocks for filter operations in the grid is the **`FilterExpression`** which has the following structure:
46+
The building blocks for filter operations in the grid is the <ApiLink type="GridLiteFilteringExpression" kind="type" suffix={false} /> which has the following structure:
4647

4748
```typescript
4849
export interface FilterExpression<T, K extends Keys<T> = Keys<T>> {
@@ -79,7 +80,7 @@ export interface FilterExpression<T, K extends Keys<T> = Keys<T>> {
7980

8081
## Filter API
8182

82-
The Grid Lite exposes two main approaches for applying filter operations from its API. Either through the **`GridLite.filter()`**/**`GridLite.clearFilter()`** methods or through the **`Grid.Lite.filterExpressions`** property.
83+
The Grid Lite exposes two main approaches for applying filter operations from its API. Either through the <ApiLink type="GridLite" member="filter" label="filter()" />/<ApiLink type="GridLite" member="clearFilter" label="clearFilter()" /> methods or through the <ApiLink type="GridLite" member="filterExpressions" /> property.
8384

8485
The **`filter()`** method accepts either a single expression or an array of filter expression and then filters the grid data
8586
based on those expressions.
@@ -107,7 +108,7 @@ grid.clearFilter();
107108

108109
## Initial Filter State
109110

110-
The **`filterExpressions`** property is very similar in behavior to the **`filter()`** method call. It exposes a declarative way to control filter state in the grid, but the most useful property is the ability to set initial filter state when the Grid Lite component is first rendered.
111+
The <ApiLink type="GridLite" member="filterExpressions" label="filterExpressions" /> property is very similar in behavior to the **`filter()`** method call. It exposes a declarative way to control filter state in the grid, but the most useful property is the ability to set initial filter state when the Grid Lite component is first rendered.
111112

112113
For example here is a Lit-based sample:
113114

@@ -155,7 +156,7 @@ onFiltered(event: IgxFilteredEvent) { ... }
155156
In cases where filtering must be done remotely or you want to save the current state/data to a server somewhere,
156157
the Grid Lite exposes a hook where you can implement and customize this behavior.
157158

158-
Using the **`dataPipelineConfiguration`** property, you can provide a custom hook which will be called each time a filter operation is about to run. The callback is passed a **`DataPipelineParams`** object.
159+
Using the <ApiLink type="GridLite" member="dataPipelineConfiguration" label="dataPipelineConfiguration" /> property, you can provide a custom hook which will be called each time a filter operation is about to run. The callback is passed a **`DataPipelineParams`** object.
159160

160161
```typescript
161162
export type DataPipelineParams<T extends object> = {
@@ -184,11 +185,11 @@ The following example mocks remote filter operation, reflecting the REST endpoin
184185

185186
<Sample src="/grid-lite/filtering-pipeline" height={510} alt="Angular Grid Lite Filtering Config Remote" />
186187

187-
{/* TODO ## API References
188188
## API References
189-
* `{ComponentName}`
190-
* `Column`
191-
*/}
189+
190+
- <ApiLink type="GridLite" />
191+
- <ApiLink type="GridLiteColumn" />
192+
192193
## Additional Resources
193194

194195
- [Column Configuration](/grid-lite/column-configuration)

docs/angular/src/content/en/components/grid-lite/header-template.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ namespace: Infragistics.Controls
99

1010
import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro';
1111
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
12+
import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1213

1314

1415
# Customizing the Column Header
@@ -62,12 +63,11 @@ import { IgxGridLiteComponent, IgxGridLiteColumnComponent, IgxGridLiteCellTempla
6263

6364
<Sample src="/grid-lite/column-config-headers" height={510} alt="Angular Grid Lite Column Config Headers" />
6465

65-
{/* TODO ## API References
66+
## API References
6667

67-
* `{ComponentName}`
68-
* `Column`
69-
70-
*/}
68+
- <ApiLink type="GridLite" />
69+
- <ApiLink type="GridLiteColumn" />
70+
- <ApiLink type="GridLiteHeaderTemplateDirective" suffix={false} />
7171

7272
## Additional Resources
7373

docs/angular/src/content/en/components/grid-lite/overview.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ namespace: Infragistics.Controls
88
---
99

1010
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
11+
import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1112

1213

1314
# Free & Open-Source Angular Data Grid (Grid Lite)
@@ -27,7 +28,7 @@ Angular <a href="https://custom-elements-everywhere.com/#angular" target="_blank
2728
<Sample src="/grid-lite/overview" height={510} alt="Angular Grid Lite App Sample Main" />
2829

2930
## Installation and Setup
30-
To use Grid Lite in your application you can import it directly from `igniteui-angular` through this entry point `igniteui-angular/grids/lite`. But you also need to install the `igniteui-grid-lite` package that powers the UI. IgxGridLiteComponent provides Angular bindings (events, templates, DI, change detection, pipes), while the visual grid lite UI is rendered by `igniteui-grid-lite`. Installing both ensures the grid lite behaves natively in Angular while leveraging the full `igniteui-grid-lite` UI.
31+
To use Grid Lite in your application you can import it directly from `igniteui-angular` through this entry point `igniteui-angular/grids/lite`. But you also need to install the `igniteui-grid-lite` package that powers the UI. <ApiLink type="GridLite" /> provides Angular bindings (events, templates, DI, change detection, pipes), while the visual grid lite UI is rendered by `igniteui-grid-lite`. Installing both ensures the grid lite behaves natively in Angular while leveraging the full `igniteui-grid-lite` UI.
3132

3233
```shell
3334
npm install igniteui-grid-lite

docs/angular/src/content/en/components/grid-lite/sorting.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ namespace: Infragistics.Controls
99

1010
import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro';
1111
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
12+
import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1213

1314

1415
# Sort Operations
@@ -184,7 +185,7 @@ In the following sample, when you try to sort the **Name** and **Rating** column
184185

185186
In cases where sorting must be done remotely or you want to save the current state/data to a server somewhere, the Grid Lite exposes a hook where you can implement and customize this behavior.
186187

187-
Using the **`dataPipelineConfiguration`** property, you can provide a custom hook which will be called each time a sort operation is about to run. The callback is passed a **`DataPipelineParams`** object.
188+
Using the <ApiLink type="GridLite" member="dataPipelineConfiguration" label="dataPipelineConfiguration" /> property, you can provide a custom hook which will be called each time a sort operation is about to run. The callback is passed a **`DataPipelineParams`** object.
188189

189190
```typescript
190191
export type DataPipelineParams<T extends object> = {
@@ -213,12 +214,10 @@ The following example mocks remote sorting operation, reflecting the REST endpoi
213214

214215
<Sample src="/grid-lite/sorting-pipeline" height={510} alt="Angular Grid Lite Sorting Config Pipeline" />
215216

216-
{/* TODO ## API References
217+
## API References
217218

218-
* `{ComponentName}`
219-
* `Column`
220-
221-
*/}
219+
- <ApiLink type="GridLite" />
220+
- <ApiLink type="GridLiteColumn" />
222221

223222
## Additional Resources
224223

docs/angular/src/content/en/components/grid-lite/theming.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ namespace: Infragistics.Controls
88
---
99

1010
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
11+
import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1112

1213

1314
# Styles and Themes
@@ -87,11 +88,10 @@ Here is an example showcasing the custom theming from above.
8788

8889
<Sample src="/grid-lite/styling-custom" height={510} alt="Angular Grid Lite Styling Custom Theme" />
8990

90-
{/* TODO ## API References
91+
## API References
9192

92-
* `{ComponentName}`
93-
* `Column`
94-
*/}
93+
- <ApiLink type="GridLite" />
94+
- <ApiLink type="GridLiteColumn" />
9595

9696
## Additional Resources
9797

docs/angular/src/content/jp/components/chat.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Chat コンポーネントは静的なメッセージ リストではなく、**
2626
npm install igniteui-angular igniteui-webcomponents
2727
```
2828

29-
`IgxChatComponent` は Angular のバインディング (イベント、テンプレート、DI、変更検出、パイプ) を提供し、視覚的なチャット UI は Web Components によってレンダリングされます。両方をインストールすることで、Angular でネイティブに動作するチャットを実現しつつ、Web Components の完全な UI を活用できます。
29+
<ApiLink type="Chat" /> は Angular のバインディング (イベント、テンプレート、DI、変更検出、パイプ) を提供し、視覚的なチャット UI は Web Components によってレンダリングされます。両方をインストールすることで、Angular でネイティブに動作するチャットを実現しつつ、Web Components の完全な UI を活用できます。
3030

3131
Ignite UI for Angular については、「[はじめに](general/getting-started.md)」トピックををご覧ください。
3232

@@ -86,8 +86,8 @@ Chat コンポーネントは、その状態と構成を制御できるいくつ
8686
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8787
| `messages` | チャットに表示されるメッセージ (`IgcChatMessage[]`) の配列。表示するメッセージを制御するためにバインド可能。 |
8888
| `draftMessage` | 未送信メッセージ。`text` とオプションの `attachments` を含むオブジェクト。メッセージ下書きの保存や復元に便利。 |
89-
| `options` | 現在のユーザー ID、入力プレースホルダー、許可されるファイル タイプ、クイック リプライサジェスト、入力遅延、カスタム レンダラーなどのチャット設定 (`IgxChatOptions`)。 |
90-
| `templates` | メッセージ コンテンツ、入力、添付ファイル、その他のチャット UI 部分に対して、カスタム Angular テンプレート(`IgxChatTemplates`)。 |
89+
| `options` | 現在のユーザー ID、入力プレースホルダー、許可されるファイル タイプ、クイック リプライサジェスト、入力遅延、カスタム レンダラーなどのチャット設定 (<ApiLink type="ChatOptions" kind="type" suffix={false} />)。 |
90+
| `templates` | メッセージ コンテンツ、入力、添付ファイル、その他のチャット UI 部分に対して、カスタム Angular テンプレート(<ApiLink type="ChatTemplates" kind="type" suffix={false} />)。 |
9191

9292
上記のプロパティを使用することで、Chat の UI をアプリケーションの状態やバックエンドと簡単に同期させることができます。
9393

@@ -167,7 +167,7 @@ Chat のカスタマイズ可能な部分は次の通りです:
167167

168168
上記の例では:
169169
- `let-message` はメッセージ オブジェクトを公開します。
170-
- `igxChatMessageContext` ディレクティブは、メッセージ テンプレートの適切な入力を保証します。
170+
- <ApiLink type="ChatMessageContextDirective" suffix={false} label="igxChatMessageContext" /> ディレクティブは、メッセージ テンプレートの適切な入力を保証します。
171171

172172
#### 入力領域のカスタマイズ
173173
デフォルトでは、チャット入力はテキスト領域です。音声入力ボタンなど、より適した体験を提供するためにオーバーライドできます。
@@ -401,12 +401,12 @@ Chat コンポーネントのオプションには、高度なスタイル設定
401401

402402
## API リファレンス
403403

404-
- `IgxChatComponent`
405-
- `IgxChatOptions`
406-
- `IgxChatTemplates`
407-
- `IgxChatMessageContextDirective`
408-
- `IgxChatInputContextDirective`
409-
- `IgxChatAttachmentContextDirective`
404+
- <ApiLink type="Chat" />
405+
- <ApiLink type="ChatOptions" kind="type" suffix={false} />
406+
- <ApiLink type="ChatTemplates" kind="type" suffix={false} />
407+
- <ApiLink type="ChatMessageContextDirective" suffix={false} />
408+
- <ApiLink type="ChatInputContextDirective" suffix={false} />
409+
- <ApiLink type="ChatAttachmentContextDirective" suffix={false} />
410410
- [スタイル設定およびテーマ](./themes/index.md)
411411

412412
## その他のリソース

0 commit comments

Comments
 (0)