SharePoint框架客户端网络部件样本和教程材料
该存储库包含社区样本,这些样本展示了SharePoint框架客户端Web零件的不同用法模式。
我们确实欢迎在此存储库中对样本文件夹的社区贡献,以证明与SharePoint框架的不同用例。请注意,如果您使用第三方库,请确保库许可证允许作为样本的一部分进行分发。
SharePoint客户端网络零件是出现在SharePoint页面内的控件,但在浏览器中本地运行。它们是出现在SharePoint网站上的页面的组成部分。您可以使用现代脚本开发工具和SharePoint Workbench(开发测试表面)构建客户端的Web零件,并且可以将客户端的Web零件部署到Office 365租户的经典Web零件页面。除了普通的JavaScript项目外,您还可以与常见的脚本框架一起构建Web零件,例如AngularJS和React。例如,您可以将React与Office UI Fabric的组件一起使用,以根据Office 365中使用的相同组件快速创建体验。
有问题或问题吗?
请使用以下逻辑将您的问题或问题提交正确的位置,以确保尽快注意和解决它们。
- 您对SPFX有一般性问题或挑战 – 使用SP-DEV-DOCS存储库问题列表。
- 您在特定的Web部件或示例上存在问题 – 使用此存储库中的问题列表。
其他资源
- SharePoint框架的概述
- SharePoint框架开发工具和库
- 入门
使用样品
要构建和开始使用这些项目,您需要克隆并构建项目。
通过在控制台中执行以下命令来克隆此存储库:
git clone https://git***hub.com/pnp/sp-dev-fx-webparts.git
导航到克隆的存储库文件夹,该文件夹应与存储库名称相同:
cd sp-dev-fx-webparts
要访问样品,请使用以下命令,在其中您替换了要访问的sample-folder-name 。
cd samples cd sample-folder-name
确保您使用正确版本的节点作为解决方案。您可以通过在您感兴趣的示例文件夹中咨询README.md文件来做到这一点。您会看到节点版本推荐;您也可以在https://aka.m**s/s*pfx-matrix上查阅SPFX兼容性矩阵,以查找样品使用的SPFX版本的节点的支持版本。
示例文件夹还可能包含一个.nvmrc文件,该文件是一个可以与Node Manager(例如NVM或NVS)一起使用的版本说明符,可确保您使用正确的Node为项目使用。
要使用NVM切换到NODE的正确版本,请在包含.nvmrc文件的文件夹中运行以下命令:
nvm use
如果使用NVS,请在包含.nvmrc文件的文件夹中运行以下命令:
nvs use
使用节点的正确版本后,运行以下命令以安装NPM软件包:
npm install
这将安装所需的NPM软件包和依赖项,以构建和运行客户端项目。
安装了NPM软件包后,运行以下命令以在SharePoint Workbench中预览您的Web零件:
gulp serve
作者
该存储库的贡献者都是自愿分享代码样本的社区成员。工作是作为一个开源社区项目完成的,每个样本都包含在自己的解决方案中。
贡献
这些样本直接来自功能团队,SharePoint PNP Core Team(http://aka*.m*s*/m365pnp)或社区共享。我们欢迎您对新样本的问题和建议的意见。我们也欢迎围绕客户端网络零件的社区贡献。如果您有任何疑问,请告诉我们。
在提交拉动请求之前,请查看我们的贡献指南,以便我们可以尽快处理您的贡献。
行为守则
该存储库采用了Microsoft开源行为代码。有关更多信息,请参见《行为守则常见问题守则》或与其他问题或评论联系opencode@microsoft.com。
分享很关心!
