Skip to main content

xplat-docs-platform-block

Guidance for using PlatformBlock in xplat MDX after ApiLink moved to registry-based resolution. Use when platform-specific prose or API symbols differ.

跳到安装

来源信息

仓库
IgniteUI/igniteui-documentation
最近来源活动
2026年6月9日 13:03
检测到的 SKILL.md 语言
英语
星标
6
分支
1

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
xplat-docs-platform-block
description
Guidance for using PlatformBlock in xplat MDX after ApiLink moved to registry-based resolution. Use when platform-specific prose or API symbols differ.
user-invocable
true
# PlatformBlock In Xplat Docs ## Purpose `PlatformBlock` is for platform-specific content, not for API URL mechanics. Use it when: - prose differs by platform; - sample code differs by platform; - the actual symbol or member name differs by platform; - a platform needs a manual external link or plain text because the API does not exist. Do not use it just to handle package, prefix, suffix, or URL differences. ApiLink and the generated registry should handle those. ## Correct Use ```mdx <PlatformBlock for="Angular"> <ApiLink type="IGridState" /> </PlatformBlock> <PlatformBlock for="React,WebComponents,Blazor"> <ApiLink type="GridState" /> </PlatformBlock> ``` ## ApiLink Rules - Prefer clean links: `<ApiLink type="Grid" />`. - Add `member` when linking to a member. - Add `pkg` only when `check-mdx-links` reports an ambiguity. - Do not add `exclude`, `excludePrefixFor`, or `excludeSuffixFor`. - Avoid new `prefixed={false}` or `suffix={false}` usage. ## Formatting Keep PlatformBlocks readable: ```mdx Some prose before. <PlatformBlock for="Angular"> Angular-only content. </PlatformBlock> <PlatformBlock for="React,WebComponents,Blazor"> Shared xplat content. </PlatformBlock> Some prose after. ``` Avoid single-line PlatformBlocks unless they are already inside a compact inline context that cannot be safely restructured.
在 GitHub 查看