How do I install the Xplat Docs API Links skill?

Run npx skillmds@latest add igniteui/xplat-docs-api-links in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Xplat Docs API Links safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Xplat Docs API Links?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Xplat Docs API Links free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Xplat Docs API Links?

igniteui (@igniteui) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Xplat Docs API Links by igniteui — Agent Skill

Name: Xplat Docs API Links
Author: igniteui

Xplat Docs API Links

Reference guide for adding, fixing, and auditing ApiLink components in xplat MDX using the generated api-docs registry. Covers clean ApiLink props, pkg/kind disambiguation, member checks, PlatformBlock use, and registry reports.

igniteui 9e721c7 2.4 KB Updated Sep 17, 2026

File contents

Xplat ApiLink Guide

Preferred Markup

Use unprefixed TypeDoc names and let the registry resolve package, kind, prefix, suffix, URL, and member anchors:

<ApiLink type="Grid" />
<ApiLink type="Grid" member="rowSelection" />
<ApiLink type="CategoryChart" />

Props

type: required unprefixed symbol name.
member: optional member/property/method/enum value.
label: optional display text.
pkg: disambiguation only. Add it when check-mdx-links reports that the same symbol exists in multiple packages.
kind: use for Sass (kind="sass") or when the registry report proves a TypeDoc symbol needs narrowing.

Do not add exclude, excludePrefixFor, or excludeSuffixFor.

Avoid adding prefixed={false} or suffix={false} in new MDX. Those are legacy fallback overrides, not the normal registry-based workflow.

PlatformBlock

Use PlatformBlock only when the visible content or actual API symbol differs by platform:

<PlatformBlock for="Angular">
  <ApiLink type="IGridState" />
</PlatformBlock>

<PlatformBlock for="React,WebComponents,Blazor">
  <ApiLink type="GridState" />
</PlatformBlock>

Do not use PlatformBlock just to work around prefix/suffix/package URL rules. Those should be handled by the registry or by pkg disambiguation.

Validation

Run registry checks before making manual API-link assumptions:

npm run check-mdx-links:broken:angular
npm run check-mdx-links:broken:react
npm run check-mdx-links:broken:wc
npm run check-mdx-links:broken:blazor

Interpret common statuses:

missing: the symbol was not found in the latest platform registry.
member-missing: the symbol exists, but the requested member was not found.
ambiguous: the symbol exists in multiple packages; add pkg.
dynamic: the link uses a template value such as {ComponentName} and cannot be resolved statically.
sass: Sass links are intentionally outside the TypeDoc registry.

For member-missing, inspect the registry before editing. Some APIs expose platform-specific member names, for example React dataSource versus older source prose that says itemsSource.

---name: xplat-docs-api-linksdescription: Reference guide for adding, fixing, and auditing ApiLink components in xplat MDX using the generated api-docs registry. Covers clean ApiLink props, pkg/kind disambiguation, member checks, PlatformBlock use, and registry reports.---# Xplat ApiLink Guide## Preferred MarkupUse unprefixed TypeDoc names and let the registry resolve package, kind, prefix,suffix, URL, and member anchors:```mdx<ApiLink type="Grid" /><ApiLink type="Grid" member="rowSelection" /><ApiLink type="CategoryChart" />```## Props- `type`: required unprefixed symbol name.- `member`: optional member/property/method/enum value.- `label`: optional display text.- `pkg`: disambiguation only. Add it when `check-mdx-links` reports that the same symbol exists in multiple packages.- `kind`: use for Sass (`kind="sass"`) or when the registry report proves a TypeDoc symbol needs narrowing.Do not add `exclude`, `excludePrefixFor`, or `excludeSuffixFor`.Avoid adding `prefixed={false}` or `suffix={false}` in new MDX. Those are legacyfallback overrides, not the normal registry-based workflow.## PlatformBlockUse `PlatformBlock` only when the visible content or actual API symbol differs byplatform:```mdx<PlatformBlock for="Angular"> <ApiLink type="IGridState" /></PlatformBlock><PlatformBlock for="React,WebComponents,Blazor"> <ApiLink type="GridState" /></PlatformBlock>```Do not use PlatformBlock just to work around prefix/suffix/package URL rules.Those should be handled by the registry or by `pkg` disambiguation.## ValidationRun registry checks before making manual API-link assumptions:```bashnpm run check-mdx-links:broken:angularnpm run check-mdx-links:broken:reactnpm run check-mdx-links:broken:wcnpm run check-mdx-links:broken:blazor```Interpret common statuses:- `missing`: the symbol was not found in the latest platform registry.- `member-missing`: the symbol exists, but the requested member was not found.- `ambiguous`: the symbol exists in multiple packages; add `pkg`.- `dynamic`: the link uses a template value such as `{ComponentName}` and cannot be resolved statically.- `sass`: Sass links are intentionally outside the TypeDoc registry.For `member-missing`, inspect the registry before editing. Some APIs exposeplatform-specific member names, for example React `dataSource` versus oldersource prose that says `itemsSource`.

Frequently asked questions