Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 12 additions & 0 deletions api-link-report-angular.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# API Link Check Report

_Generated: 2026-05-19 18:51:16 UTC_

## Summary

| | |
|---|---|
| ✅ OK | 1483 |
| ❌ Not found (type/member missing) | 0 |
| ❌ HTTP error | 0 |
| ❌ **Total broken** | **0** |
12 changes: 12 additions & 0 deletions api-link-report-blazor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# API Link Check Report

_Generated: 2026-05-19 17:55:20 UTC_

## Summary

| | |
|---|---|
| ✅ OK | 1054 |
| ❌ Not found (type/member missing) | 0 |
| ❌ HTTP error | 0 |
|**Total broken** | **0** |
12 changes: 12 additions & 0 deletions api-link-report-react.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# API Link Check Report

_Generated: 2026-05-19 17:53:29 UTC_

## Summary

| | |
|---|---|
| ✅ OK | 1106 |
| ❌ Not found (type/member missing) | 0 |
| ❌ HTTP error | 0 |
| ❌ **Total broken** | **0** |
12 changes: 12 additions & 0 deletions api-link-report-wc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# API Link Check Report

_Generated: 2026-05-19 17:54:07 UTC_

## Summary

| | |
|---|---|
| ✅ OK | 1128 |
| ❌ Not found (type/member missing) | 0 |
| ❌ HTTP error | 0 |
| ❌ **Total broken** | **0** |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/angular/src/content/en/components/accordion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ If <ApiLink type="Accordion" member="singleBranchExpand" label="singleBranchExpa
### Angular Accordion Templating Example

With the Angular <ApiLink type="Accordion" label="Accordion component" />, you can customize the header and content panel`s appearance.
The sample below demonstrates how elaborate filtering options can be implemented using the built-in templating functionality of the <ApiLink type="ExpansionPanel" suffix={false} />.
The sample below demonstrates how elaborate filtering options can be implemented using the built-in templating functionality of the <ApiLink type="ExpansionPanelComponent" suffix={false} />.

<Sample src="/layouts/accordion-sample-3" height={550} alt="Angular Accordion Example" />

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/src/content/en/components/badge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ export class AppModule {}
```

<DocsAside type="note">
The <ApiLink type="Badge" label="igx-badge" /> has <ApiLink type="Badge" member="icon" label="icon" /> and <ApiLink type="Badge" member="type" label="type" /> inputs to configure the badge look. You can set the icon by providing its name from the official [material icons set](https://material.io/icons/). The badge type can be set to either <ApiLink kind="enum" type="Type" prefixed={false} member="Default" />, <ApiLink kind="enum" type="Type" prefixed={false} member="Info" />, <ApiLink kind="enum" type="Type" prefixed={false} member="Success" />, <ApiLink kind="enum" type="Type" prefixed={false} member="Warning" />, or <ApiLink kind="enum" type="Type" prefixed={false} member="Error" />. Depending on the type, a specific background color is applied.
The <ApiLink type="Badge" label="igx-badge" /> has <ApiLink type="Badge" member="icon" label="icon" /> and <ApiLink type="Badge" member="type" label="type" /> inputs to configure the badge look. You can set the icon by providing its name from the official [material icons set](https://material.io/icons/). The badge type can be set to either `Default`, `Info`, `Success`, `Warning`, or `Error`. Depending on the type, a specific background color is applied.
</DocsAside>

In our sample, <ApiLink type="Badge" member="icon" label="icon" /> and <ApiLink type="Badge" member="type" label="type" /> are bound to model properties named _icon_ and _type_.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ The chart also has the ability to consider auto-rotation of the labels if they w

After setting the <ApiLink pkg="charts" type="CategoryChart" member="autoMarginAndAngleUpdateMode" label="AutoMarginAndAngleUpdateMode" />, you can set the <ApiLink pkg="charts" type="CategoryChart" member="shouldAutoExpandMarginForInitialLabels" label="ShouldAutoExpandMarginForInitialLabels" /> property to true to opt into the automatic margin or set the <ApiLink pkg="charts" type="CategoryChart" member="shouldConsiderAutoRotationForInitialLabels" label="ShouldConsiderAutoRotationForInitialLabels" /> property to true for the auto-rotation. You can also further customize the automatic margin that is applied by setting the <ApiLink pkg="charts" type="CategoryChart" member="autoExpandMarginExtraPadding" label="AutoExpandMarginExtraPadding" /> and <ApiLink pkg="charts" type="CategoryChart" member="autoExpandMarginMaximumValue" label="AutoExpandMarginMaximumValue" /> to provide extra space or a maximum possible margin, respectively.

Custom label formats such as <ApiLink pkg="charts" type="NumberFormatSpecifier" suffix={false} /> and <ApiLink pkg="charts" type="DateTimeFormatSpecifier" suffix={false} /> can be added to each axis via the <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelFormatSpecifier" label="XAxisLabelFormatSpecifier" /> and <ApiLink pkg="charts" type="CategoryChart" member="yAxisLabelFormatSpecifier" label="YAxisLabelFormatSpecifier" /> collections. Commonly used for applying Intl.NumberFormat and Intl.DateTimeFormat language sensitive number, date and time formatting. In order for a custom format to be applied to the labels, the <ApiLink pkg="charts" type="CategoryChart" member="yAxisLabelFormat" label="YAxisLabelFormat" /> or <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelFormat" label="XAxisLabelFormat" /> need to be set to data item's property name on the <ApiLink pkg="charts" type="CategoryChart" />, eg. `{Date}`. For the <ApiLink pkg="charts" type="FinancialChart" /> the number is the context because it uses a numeric axis, therefore this needs to be set to `{0}`.
Custom label formats such as `NumberFormatSpecifier` and `DateTimeFormatSpecifier` can be added to each axis via the <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelFormatSpecifier" label="XAxisLabelFormatSpecifier" /> and <ApiLink pkg="charts" type="CategoryChart" member="yAxisLabelFormatSpecifier" label="YAxisLabelFormatSpecifier" /> collections. Commonly used for applying Intl.NumberFormat and Intl.DateTimeFormat language sensitive number, date and time formatting. In order for a custom format to be applied to the labels, the <ApiLink pkg="charts" type="CategoryChart" member="yAxisLabelFormat" label="YAxisLabelFormat" /> or <ApiLink pkg="charts" type="CategoryChart" member="xAxisLabelFormat" label="XAxisLabelFormat" /> need to be set to data item's property name on the <ApiLink pkg="charts" type="CategoryChart" />, eg. `{Date}`. For the <ApiLink pkg="charts" type="FinancialChart" /> the number is the context because it uses a numeric axis, therefore this needs to be set to `{0}`.

The following example formats the yAxis with a <ApiLink pkg="charts" type="NumberFormatSpecifier" suffix={false} /> to represent $USD prices for top box office movies in the United States.
The following example formats the yAxis with a `NumberFormatSpecifier` to represent $USD prices for top box office movies in the United States.

<Sample src="/charts/category-chart/format-specifiers" height={450} alt="Angular Format Specifiers for Axis Labels" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ It is also possible to show an axis annotation on a <ApiLink pkg="charts" type="

The Angular charting components also expose the ability to use value lines to call out different focal points of your data, such as minimum, maximum, and average values.

Applying the <ApiLink pkg="charts" type="ValueLayer" /> in the <ApiLink pkg="charts" type="CategoryChart" /> and <ApiLink pkg="charts" type="FinancialChart" /> components is done by setting the <ApiLink pkg="charts" type="CategoryChart" member="valueLines" label="ValueLines" /> property on the chart. This property takes a collection of the <ApiLink pkg="charts" type="ValueLayerValueMode" suffix={false} /> enumeration. You can mix and match multiple value layers in the same chart by adding multiple <ApiLink pkg="charts" type="ValueLayerValueMode" suffix={false} /> enumerations to the <ApiLink pkg="charts" type="CategoryChart" member="valueLines" label="ValueLines" /> collection of the chart.
Applying the <ApiLink pkg="charts" type="ValueLayer" /> in the <ApiLink pkg="charts" type="CategoryChart" /> and <ApiLink pkg="charts" type="FinancialChart" /> components is done by setting the <ApiLink pkg="charts" type="CategoryChart" member="valueLines" label="ValueLines" /> property on the chart. This property takes a collection of the <ApiLink pkg="charts" type="ValueLayerValueMode" kind="enum" suffix={false} prefixed={false} /> enumeration. You can mix and match multiple value layers in the same chart by adding multiple <ApiLink pkg="charts" type="ValueLayerValueMode" kind="enum" suffix={false} prefixed={false} /> enumerations to the <ApiLink pkg="charts" type="CategoryChart" member="valueLines" label="ValueLines" /> collection of the chart.

In the <ApiLink pkg="charts" type="DataChart" />, this is done by adding a <ApiLink pkg="charts" type="ValueLayer" /> to the `Series` collection of the chart and then setting the <ApiLink pkg="charts" type="ValueLayer" member="valueMode" label="ValueMode" /> property to one of the <ApiLink pkg="charts" type="ValueLayerValueMode" suffix={false} /> enumerations. Each of these enumerations and what they mean is listed below:
In the <ApiLink pkg="charts" type="DataChart" />, this is done by adding a <ApiLink pkg="charts" type="ValueLayer" /> to the `Series` collection of the chart and then setting the <ApiLink pkg="charts" type="ValueLayer" label="ValueMode" /> property to one of the <ApiLink pkg="charts" type="ValueLayerValueMode" kind="enum" suffix={false} prefixed={false} /> enumerations. Each of these enumerations and what they mean is listed below:

- `Auto`: The default value mode of the <ApiLink pkg="charts" type="ValueLayerValueMode" suffix={false} /> enumeration.
- `Auto`: The default value mode of the <ApiLink pkg="charts" type="ValueLayerValueMode" kind="enum" suffix={false} prefixed={false} /> enumeration.
- `Average`: Applies potentially multiple value lines to call out the average value of each series plotted in the chart.
- `GlobalAverage`: Applies a single value line to call out the average of all of the series values in the chart.
- `GlobalMaximum`: Applies a single value line to call out the absolute maximum value of all of the series values in the chart.
Expand Down Expand Up @@ -100,6 +100,6 @@ You can find more information about related chart types in these topics:
<ApiLink type="DataChart" pkg="charts" /><br />
<ApiLink type="ValueOverlay" pkg="charts" /><br />
<ApiLink type="ValueLayer" pkg="charts" /><br />
<ApiLink type="ValueLayerValueMode" pkg="charts" suffix={false} /><br />
<ApiLink type="ValueLayerValueMode" kind="enum" pkg="charts" suffix={false} prefixed={false} /><br />
<ApiLink type="CategoryChart" pkg="charts" /><br />
<ApiLink type="FinancialChart" pkg="charts" /><br />
20 changes: 10 additions & 10 deletions docs/angular/src/content/en/components/chat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To get started, install Ignite UI for Angular package as well as the Ignite UI f
npm install igniteui-angular igniteui-webcomponents
```

<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.
`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.

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

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

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

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

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

#### Custom Input Area
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:
Expand Down Expand Up @@ -404,12 +404,12 @@ We highly recommend using the standard Web Component styling approaches before r

## API Reference

- <ApiLink type="Chat" />
- <ApiLink kind="type" type="ChatOptions" />
- <ApiLink kind="type" type="ChatTemplates" />
- <ApiLink type="ChatMessageContextDirective" suffix={false} />
- <ApiLink type="ChatInputContextDirective" suffix={false} />
- <ApiLink type="ChatAttachmentContextDirective" suffix={false} />
- `IgxChatComponent`
- `IgxChatOptions`
- `IgxChatTemplates`
- `IgxChatMessageContextDirective`
- `IgxChatInputContextDirective`
- `IgxChatAttachmentContextDirective`
- [`Styling & Themes`](/themes)

## Additional Resources
Expand Down
2 changes: 1 addition & 1 deletion docs/angular/src/content/en/components/checkbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ At the end your checkbox should look like this:

- <ApiLink type="Checkbox" />
- [IgxCheckboxComponent Styles]({environment:sassApiUrl}/themes#function-checkbox-theme)
- <ApiLink type="LabelPosition" kind="enum" prefixed={false} />
- <ApiLink type="LabelPosition" kind="variable" prefixed={false} />

## Theming Dependencies

Expand Down
4 changes: 2 additions & 2 deletions docs/angular/src/content/en/components/combo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ $custom-combo-theme: combo-theme(
);
```

The <ApiLink type="Combo" /> uses the <ApiLink type="DropDown" /> internally as an item container. It also includes the <ApiLink type="InputGroup" suffix={false} /> and the <ApiLink type="Checkbox" suffix={false} /> components. Creating new themes, that extend these components' themes, and scoping them under the respective classes will let you change the combobox styles:
The <ApiLink type="Combo" /> uses the <ApiLink type="DropDown" /> internally as an item container. It also includes the <ApiLink type="InputGroupComponent" suffix={false} /> and the <ApiLink type="CheckboxComponent" suffix={false} /> components. Creating new themes, that extend these components' themes, and scoping them under the respective classes will let you change the combobox styles:

```scss
$custom-drop-down-theme: drop-down-theme(
Expand All @@ -416,7 +416,7 @@ The last step is to include the component's theme.
```

<DocsAside type="note">
The <ApiLink type="Combo" suffix={false} /> component uses the [`IgxOverlay`](/overlay) service to hold and display the combobox items list container. To properly scope your styles you might have to use an <ApiLink kind="interface" prefixed={false} suffix={false} type="OverlaySettings" member="outlet" />. For more details check the [`IgxOverlay Styling Guide`](/overlay-styling). Also is necessary to use `::ng-deep` when we are styling the components.
The <ApiLink type="ComboComponent" suffix={false} /> component uses the [`IgxOverlay`](/overlay) service to hold and display the combobox items list container. To properly scope your styles you might have to use an <ApiLink kind="interface" prefixed={false} suffix={false} type="OverlaySettings" member="outlet" />. For more details check the [`IgxOverlay Styling Guide`](/overlay-styling). Also is necessary to use `::ng-deep` when we are styling the components.
[!Note]
The default `type` of the `IgxCombo` is `box` unlike the [`IgxSelect`](/select) where it is `line`.
</DocsAside>
Expand Down
2 changes: 1 addition & 1 deletion docs/angular/src/content/en/components/date-picker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ The picker always returns a `Date` value, this means that If it is model bound o

### Projecting components

The <ApiLink type="DatePicker" /> allows the projection of child components that the <ApiLink type="InputGroup" /> supports (with the exception of <ApiLink type="Input" suffix={false} />) - [`igxLabel`](/label-input), [`igx-hint / IgxHint`](/input-group#hints), [`igx-prefix / igxPrefix`](/input-group#prefix--suffix), [`igx-suffix / igxSuffix`](/input-group#prefix--suffix). More detailed information about this can be found in the [Label & Input](/label-input) topic.
The <ApiLink type="DatePicker" /> allows the projection of child components that the <ApiLink type="InputGroup" /> supports (with the exception of <ApiLink type="InputDirective" suffix={false} />) - [`igxLabel`](/label-input), [`igx-hint / IgxHint`](/input-group#hints), [`igx-prefix / igxPrefix`](/input-group#prefix--suffix), [`igx-suffix / igxSuffix`](/input-group#prefix--suffix). More detailed information about this can be found in the [Label & Input](/label-input) topic.

```html
<igx-date-picker #datePicker>
Expand Down
Loading
Loading