什么是generator-spfx-pnpjs-uifabric-starter
generator-spfx-pnpjs-uifabric-starter是一个npm包,用于使用TypeScript和React的SharePoint Framework(SPFx)项目的生成器。它包含PnPJS和Office UI Fabric React库的引用,使得用户可以快速开始开发具有PnPJS数据访问和UI Fabric组件的项目。
如何使用generator-spfx-pnpjs-uifabric-starter
前置条件
在开始使用generator-spfx-pnpjs-uifabric-starter之前,需要从以下位置获取和安装必要的软件和工具:
- Git:https://git-scm.com/downloads
- Node.js(v8.x和v10.x的任何版本):https://nodejs.org/en/download/
- SharePoint框架工具:https://www.npmjs.com/package/@microsoft/generator-sharepoint
- Yeoman:https://www.npmjs.com/package/yo
安装generator-spfx-pnpjs-uifabric-starter
要安装并开始使用generator-spfx-pnpjs-uifabric-starter,请按照以下步骤进行操作:
- 在命令提示符中输入以下命令安装yeoman:
npm install -g yo
- 在命令提示符中输入以下命令,以安装generator-spfx-pnpjs-uifabric-starter:
npm install -g generator-spfx-pnpjs-uifabric-starter
- 在命令提示符中输入以下命令,创建一个新的SPFx项目:
yo @microsoft/sharepoint
选择您喜欢的SPFx Web部件或扩展,然后在“生成器概览”屏幕上选择“Other”选项。
填写其他有关项目的详细信息,并在提示输入“generator-spfx-pnpjs-uifabric-starter”时输入它。
输入SPFx项目所需的其他信息,例如项目名称,组织名称等。
选择您要使用的SPFx版本。
选择您的PnPJS版本,或者接受默认版本。
输入您要使用的CSS框架,或者接受默认框架。
等待生成器创建项目并安装所需的依赖项。
使用generator-spfx-pnpjs-uifabric-starter
完成以上步骤后,您可以开始使用generator-spfx-pnpjs-uifabric-starter。
运行以下命令以构建项目:
npm run build
要在本地调试项目,请运行以下命令:
gulp serve
在此阶段,您可以参考Office UI Fabric和PnPJS文档,并从中了解有关它们使用和API的更多信息。
generator-spfx-pnpjs-uifabric-starter示例代码
在generator-spfx-pnpjs-uifabric-starter创建的SPFx项目中,您可以看到以下类型的示例代码:
PnPJS
import pnp from 'sp-pnp-js'; // 获取SharePoint站点标题 pnp.sp.web.select("Title").get().then(web => { console.log(web.Title); });
Office UI Fabric React
-- -------------------- ---- ------- ------ - -- ----- ---- -------- ------ - ------------- - ---- ------------------------------------ ------ --------- ---------------- - ------------ ------- - ------ ------- ----- ---------- ------- --------------------------------- --- - ------ --------- ------------------------------------ - ------ - ----- -------------- ----------- ------ -- ------------------------------------- ------ -- - -
总结
generator-spfx-pnpjs-uifabric-starter是一个强大的工具,可以帮助您快速启动和开发SPFx项目,包含PnPJS和Office UI Fabric React库的引用。在使用此工具之前,请确保您具备适当的SPFx和TypeScript知识,并遵循Microsoft提供的最佳实践。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066b6051ab1864dac6726c