Skip to content

Commit a2f6d47

Browse files
committed
docs(chat/grid-lite): expose API References and sync jp locale
Uncomment the ## API References blocks added in the Angular Grid Lite en docs so the ApiLink entries actually render, and mirror the en chat/grid-lite ApiLink pass into the jp counterparts (angular chat, angular grid-lite x8, xplat interactivity/chat).
1 parent dcfb34c commit a2f6d47

17 files changed

Lines changed: 71 additions & 53 deletions

File tree

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,11 @@ the column collection is reset, and a new data source is bound to the grid.
6464

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

67-
{/* TODO ## API References
67+
## API References
6868

6969
- <ApiLink type="GridLite" />
7070
- <ApiLink type="GridLiteColumn" />
7171

72-
*/}
73-
7472
## Additional Resources
7573

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

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,14 +149,12 @@ export interface IgxGridLiteCellTemplateContext<T extends object> {
149149

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

152-
{/* TODO ## API References
152+
## API References
153153

154154
- <ApiLink type="GridLite" />
155155
- <ApiLink type="GridLiteColumn" />
156156
- <ApiLink type="GridLiteCellTemplateDirective" suffix={false} />
157157

158-
*/}
159-
160158
## Additional Resources
161159

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

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,13 +102,11 @@ In the sample below you can try out the different column properties and how they
102102

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

105-
{/* TODO ## API References
105+
## API References
106106

107107
- <ApiLink type="GridLite" />
108108
- <ApiLink type="GridLiteColumn" />
109109

110-
*/}
111-
112110
## Additional Resources
113111

114112
- [Data Binding](/grid-lite/binding)

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,13 +185,11 @@ The following example mocks remote filter operation, reflecting the REST endpoin
185185

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

188-
{/* TODO ## API References
189188
## API References
190189

191190
- <ApiLink type="GridLite" />
192191
- <ApiLink type="GridLiteColumn" />
193192

194-
*/}
195193
## Additional Resources
196194

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

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,12 @@ import { IgxGridLiteComponent, IgxGridLiteColumnComponent, IgxGridLiteCellTempla
6363

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

66-
{/* TODO ## API References
66+
## API References
6767

6868
- <ApiLink type="GridLite" />
6969
- <ApiLink type="GridLiteColumn" />
7070
- <ApiLink type="GridLiteHeaderTemplateDirective" suffix={false} />
7171

72-
*/}
73-
7472
## Additional Resources
7573

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

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -214,13 +214,11 @@ The following example mocks remote sorting operation, reflecting the REST endpoi
214214

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

217-
{/* TODO ## API References
217+
## API References
218218

219219
- <ApiLink type="GridLite" />
220220
- <ApiLink type="GridLiteColumn" />
221221

222-
*/}
223-
224222
## Additional Resources
225223

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

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,11 @@ Here is an example showcasing the custom theming from above.
8888

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

91-
{/* TODO ## API References
91+
## API References
9292

9393
- <ApiLink type="GridLite" />
9494
- <ApiLink type="GridLiteColumn" />
9595

96-
*/}
97-
9896
## Additional Resources
9997

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

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
## その他のリソース

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ _language: ja
1010

1111
import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro';
1212
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
13+
import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1314

1415
# Angular Grid Lite データ バインディング
1516

@@ -54,14 +55,17 @@ grid.data = [];
5455

5556

5657
<DocsAside type="info" title="情報">
57-
Grid Lite のソート/フィルター状態は、この方法でデータ ソースを変更しても保持されます。通常は `clearSort()` または `clearFilter()` を呼び出してリセットすることをお勧めします。
58+
Grid Lite のソート/フィルター状態は、この方法でデータ ソースを変更しても保持されます。通常は <ApiLink type="GridLite" member="clearSort" label="clearSort()" /> または <ApiLink type="GridLite" member="clearFilter" label="clearFilter()" /> を呼び出してリセットすることをお勧めします。
5859
</DocsAside>
5960

6061
以下のサンプルでは、グリッドに列の自動生成が有効になっています。データ切り替えボタンをクリックすると、列コレクションがリセットされ、新しいデータ ソースがグリッドにバインドされます。
6162

6263
<Sample src="/grid-lite/data-binding-dynamic" height={510} alt="Angular Grid Lite データ バインディングの例" />
6364

65+
## API リファレンス
6466

67+
- <ApiLink type="GridLite" />
68+
- <ApiLink type="GridLiteColumn" />
6569

6670
## その他のリソース
6771

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ _language: ja
1010

1111
import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro';
1212
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
13+
import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
1314

1415
# 列セル テンプレート
1516

@@ -26,7 +27,7 @@ import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
2627
</igx-grid-lite-column>
2728
```
2829

29-
**`IgxGridLiteCellTemplateDirective`** をインポートする必要もあります。
30+
<ApiLink type="GridLiteCellTemplateDirective" suffix={false} /> をインポートする必要もあります。
3031

3132
```typescript
3233
import { IgxGridLiteComponent, IgxGridLiteColumnComponent, IgxGridLiteCellTemplateDirective } from 'igniteui-angular/grids/lite';
@@ -116,7 +117,7 @@ defineComponents(
116117

117118
## セル コンテキスト オブジェクト
118119

119-
カスタム セル レンダラーには **`GridLiteCellContext`** オブジェクトがパラメータvとして渡され、以下のプロパティを持ちます。
120+
カスタム セル レンダラーには <ApiLink type="GridLiteCellTemplateContext" kind="type" suffix={false} /> オブジェクトがパラメータvとして渡され、以下のプロパティを持ちます。
120121

121122

122123
```typescript
@@ -147,7 +148,11 @@ export interface IgxGridLiteCellTemplateContext<T extends object> {
147148

148149
<Sample src="/grid-lite/column-config-simple" height={510} alt="Angular Grid Lite 列の基本構成" />
149150

151+
## API リファレンス
150152

153+
- <ApiLink type="GridLite" />
154+
- <ApiLink type="GridLiteColumn" />
155+
- <ApiLink type="GridLiteCellTemplateDirective" suffix={false} />
151156

152157
## その他のリソース
153158

0 commit comments

Comments
 (0)