K.I.S.S---Keep IT Simple,Stupid!    人生苦短,我用Python

SharePoint Framework (SPFx) JSON UI 结构的简单入门教程

 
分类: 问答 2025年5月30日
简介:一个针对 SharePoint Framework (SPFx) JSON UI 结构的简单入门教程,专注于使用 JSON 进行 SharePoint 列表和库的列格式化(Column Formatting)以及表单自定义(List Form Customization)。教程将简洁明了,涵盖基础知识、JSON 结构、简单示例和实践步骤,适合初学者快速上手。内容基于你的提供的 JSON 示例,并结合 SharePoint 现代体验的 JSON 格式化功能。

1. 什么是 SharePoint Framework 的 JSON UI 结构?

在 SharePoint Framework (SPFx) 中,JSON 主要用于:

  • 列格式化(Column Formatting):自定义 SharePoint 列表或库中列的显示样式和行为,而不更改底层数据。
  • 列表表单自定义(List Form Customization):通过 JSON 配置列表表单的布局(如 header、body、footer),以创建更友好的用户体验。
  • JSON 是一种轻量级、基于文本的数据格式,使用键值对、对象和数组来定义 UI 元素、样式和行为,易于阅读和编辑。

核心特点

  • 简单易用:无需编写复杂代码,适合非开发人员。
  • 灵活性:支持样式、条件格式、动态内容(如字段值引用)。
  • 平台支持:适用于 SharePoint Online 和 SharePoint Server(2019 及以上,部分功能依赖版本)。

2. JSON UI 结构基础

SharePoint 的 JSON 格式化遵循特定的 schema,通常包含以下关键属性:

  • $schema:指定 JSON 格式化的 schema(如列格式化的 schema URL)。
  • "elmType":定义 HTML 元素类型(如 div、span、a)。
  • "style":定义 CSS 样式(如 width、color、padding)。
  • "attributes":设置 HTML 属性(如 class、href)。
  • "txtContent":设置元素的文本内容,支持字段引用(如 @currentField)或静态文本。
  • "children":定义嵌套子元素,支持多层 UI 结构。
  • 条件格式:使用表达式(如 if、toString())实现动态显示或样式。

示例 schema(列格式化):

{
  "elmType": "div",       // 元素类型(div、button、span等)
  "attributes": {         // HTML 属性(如 class、href)
    "class": "ms-fontColor-themePrimary"
  },
  "style": {              // CSS 样式
    "font-size": "14px",
    "padding": "10px"
  },
  "children": [           // 子元素数组
    { 
      "elmType": "span",
      "txtContent": "Hello SPFx!" 
    }
  ]
}

 




注:当前文章会不定期进行更新。如果您对本文有更好的建议,有新资料推荐, 可以点击: 欢迎分享优秀网站
这个位置将来会放广告

我想等网站访问量多了,在这个位置放个广告。网站纯公益,但是用爱发电服务器也要钱啊 ----------狂奔的小蜗牛