使用SPFx和pnpjs添加并且定制化页面

2023-12-09 09:33
文章标签 定制 使用 页面 spfx pnpjs

本文主要是介绍使用SPFx和pnpjs添加并且定制化页面,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

首先创建spfx webpart项目:

使用VS Code打开,然后在terminal中安裝pnpjs包:

安装完成之后,在webpart代码文件(这里是CreatePageWebPart.ts)中,从pnpjs包中导入需要用到的对象如下:

然后修改render方法,添加一个按钮,点击按钮的时候执行addPage方法,定义如下:

具体代码以及注释如下,不要忘记导入react和react-dom。

import * as React from 'react';
import * as ReactDom from 'react-dom';... ... public render(): void {//render一个按钮,绑定onClick事件ReactDom.render(React.createElement('button', {onClick:this.addPage.bind(this)}, 'Add Page'), this.domElement)}private addPage(){//使用addClientSidePage方法添加一个页面,指定页面name和title//默认会将页面添加到Site Pages文档库中sp.web.addClientSidePage('newpage.aspx', 'New Page').then((page) =>{//为页面添加一个sectionconst section = page.addSection();//向section中添加html代码section.addControl(new ClientSideText('<h1>this is a new page</h1>'));//保存页面page.save();}).catch(err=>{console.log(err);});}

运行gulp serve, 因为要访问SharePoint,所以打开online的工作台,添加webpart,显示“Add Page”按钮,点击之后,会自动在Site Pages文档库里添加一个页面:

 

除了创建页面和在页面上添加html代码之外,还可以使用addControl方法添加webpart。可以使用下面的方法,列出所有OOTB以及安裝的自定义的client webpart:

sp.web.getClientSideWebParts().then(wp=>console.log(wp));

作为演示,我们添加一个News Link webpart。修改代码,添加一个editPage函数,然后将“Add Page”按钮改为“Edit Page”,并将editPage方法绑定到onClick事件上,代码和注释如下:

public render(): void {//修改按钮属性ReactDom.render(React.createElement('button', {onClick:this.editPage.bind(this)}, 'edit Page'), this.domElement)}private editPage(){//这里列出所有webpart的信息,可以找到需要添加的webpart的idsp.web.getClientSideWebParts().then(wp=>console.log(wp));//获取刚刚新建的页面const pageFile = sp.web.getFileByServerRelativeUrl(`${this.context.pageContext.web.serverRelativeUrl}/SitePages/newpage.aspx`);ClientSidePage.fromFile(pageFile).then((page) =>{//添加一个新sectionconst section = page.addSection();//创建一个New Link webpartconst webpart = new ClientSideWebpart('New Link', null, {}, 'c1b5736d-84dd-4fdb-a7be-e7e9037bd3c3');//将webpart添加到section中section.addControl(webpart);//保存页面page.save();}).catch(err=>{console.log(err);});}

重新运行gulp serve,点击“Edit Page”按钮,打开创建的页面可以看到News Link webpart。

 

除此之外,pnpjs还提供了其他针对页面的操作,例如查找页面上的control,添加comments等,具体使用方法请参考:https://pnp.github.io/pnpjs/sp/docs/client-side-pages/

这篇关于使用SPFx和pnpjs添加并且定制化页面的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/473310

相关文章

postgresql使用UUID函数的方法

《postgresql使用UUID函数的方法》本文给大家介绍postgresql使用UUID函数的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录PostgreSQL有两种生成uuid的方法。可以先通过sql查看是否已安装扩展函数,和可以安装的扩展函数

如何使用Lombok进行spring 注入

《如何使用Lombok进行spring注入》本文介绍如何用Lombok简化Spring注入,推荐优先使用setter注入,通过注解自动生成getter/setter及构造器,减少冗余代码,提升开发效... Lombok为了开发环境简化代码,好处不用多说。spring 注入方式为2种,构造器注入和setter

MySQL中比较运算符的具体使用

《MySQL中比较运算符的具体使用》本文介绍了SQL中常用的符号类型和非符号类型运算符,符号类型运算符包括等于(=)、安全等于(=)、不等于(/!=)、大小比较(,=,,=)等,感兴趣的可以了解一下... 目录符号类型运算符1. 等于运算符=2. 安全等于运算符<=>3. 不等于运算符<>或!=4. 小于运

使用zip4j实现Java中的ZIP文件加密压缩的操作方法

《使用zip4j实现Java中的ZIP文件加密压缩的操作方法》本文介绍如何通过Maven集成zip4j1.3.2库创建带密码保护的ZIP文件,涵盖依赖配置、代码示例及加密原理,确保数据安全性,感兴趣的... 目录1. zip4j库介绍和版本1.1 zip4j库概述1.2 zip4j的版本演变1.3 zip4

Python 字典 (Dictionary)使用详解

《Python字典(Dictionary)使用详解》字典是python中最重要,最常用的数据结构之一,它提供了高效的键值对存储和查找能力,:本文主要介绍Python字典(Dictionary)... 目录字典1.基本特性2.创建字典3.访问元素4.修改字典5.删除元素6.字典遍历7.字典的高级特性默认字典

使用Python构建一个高效的日志处理系统

《使用Python构建一个高效的日志处理系统》这篇文章主要为大家详细讲解了如何使用Python开发一个专业的日志分析工具,能够自动化处理、分析和可视化各类日志文件,大幅提升运维效率,需要的可以了解下... 目录环境准备工具功能概述完整代码实现代码深度解析1. 类设计与初始化2. 日志解析核心逻辑3. 文件处

一文详解如何使用Java获取PDF页面信息

《一文详解如何使用Java获取PDF页面信息》了解PDF页面属性是我们在处理文档、内容提取、打印设置或页面重组等任务时不可或缺的一环,下面我们就来看看如何使用Java语言获取这些信息吧... 目录引言一、安装和引入PDF处理库引入依赖二、获取 PDF 页数三、获取页面尺寸(宽高)四、获取页面旋转角度五、判断

C++中assign函数的使用

《C++中assign函数的使用》在C++标准模板库中,std::list等容器都提供了assign成员函数,它比操作符更灵活,支持多种初始化方式,下面就来介绍一下assign的用法,具有一定的参考价... 目录​1.assign的基本功能​​语法​2. 具体用法示例​​​(1) 填充n个相同值​​(2)

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​,用于描述对象在其生命

使用Python删除Excel中的行列和单元格示例详解

《使用Python删除Excel中的行列和单元格示例详解》在处理Excel数据时,删除不需要的行、列或单元格是一项常见且必要的操作,本文将使用Python脚本实现对Excel表格的高效自动化处理,感兴... 目录开发环境准备使用 python 删除 Excphpel 表格中的行删除特定行删除空白行删除含指定