使用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

相关文章

Nginx使用Keepalived部署web集群(高可用高性能负载均衡)实战案例

《Nginx使用Keepalived部署web集群(高可用高性能负载均衡)实战案例》本文介绍Nginx+Keepalived实现Web集群高可用负载均衡的部署与测试,涵盖架构设计、环境配置、健康检查、... 目录前言一、架构设计二、环境准备三、案例部署配置 前端 Keepalived配置 前端 Nginx

Python logging模块使用示例详解

《Pythonlogging模块使用示例详解》Python的logging模块是一个灵活且强大的日志记录工具,广泛应用于应用程序的调试、运行监控和问题排查,下面给大家介绍Pythonlogging模... 目录一、为什么使用 logging 模块?二、核心组件三、日志级别四、基本使用步骤五、快速配置(bas

使用animation.css库快速实现CSS3旋转动画效果

《使用animation.css库快速实现CSS3旋转动画效果》随着Web技术的不断发展,动画效果已经成为了网页设计中不可或缺的一部分,本文将深入探讨animation.css的工作原理,如何使用以及... 目录1. css3动画技术简介2. animation.css库介绍2.1 animation.cs

使用雪花算法产生id导致前端精度缺失问题解决方案

《使用雪花算法产生id导致前端精度缺失问题解决方案》雪花算法由Twitter提出,设计目的是生成唯一的、递增的ID,下面:本文主要介绍使用雪花算法产生id导致前端精度缺失问题的解决方案,文中通过代... 目录一、问题根源二、解决方案1. 全局配置Jackson序列化规则2. 实体类必须使用Long封装类3.

Python文件操作与IO流的使用方式

《Python文件操作与IO流的使用方式》:本文主要介绍Python文件操作与IO流的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、python文件操作基础1. 打开文件2. 关闭文件二、文件读写操作1.www.chinasem.cn 读取文件2. 写

PyQt6中QMainWindow组件的使用详解

《PyQt6中QMainWindow组件的使用详解》QMainWindow是PyQt6中用于构建桌面应用程序的基础组件,本文主要介绍了PyQt6中QMainWindow组件的使用,具有一定的参考价值,... 目录1. QMainWindow 组php件概述2. 使用 QMainWindow3. QMainW

使用Python自动化生成PPT并结合LLM生成内容的代码解析

《使用Python自动化生成PPT并结合LLM生成内容的代码解析》PowerPoint是常用的文档工具,但手动设计和排版耗时耗力,本文将展示如何通过Python自动化提取PPT样式并生成新PPT,同时... 目录核心代码解析1. 提取 PPT 样式到 jsON关键步骤:代码片段:2. 应用 JSON 样式到

java变量内存中存储的使用方式

《java变量内存中存储的使用方式》:本文主要介绍java变量内存中存储的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、介绍2、变量的定义3、 变量的类型4、 变量的作用域5、 内存中的存储方式总结1、介绍在 Java 中,变量是用于存储程序中数据

关于Mybatis和JDBC的使用及区别

《关于Mybatis和JDBC的使用及区别》:本文主要介绍关于Mybatis和JDBC的使用及区别,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、JDBC1.1、流程1.2、优缺点2、MyBATis2.1、执行流程2.2、使用2.3、实现方式1、XML配置文件

macOS Sequoia 15.5 发布: 改进邮件和屏幕使用时间功能

《macOSSequoia15.5发布:改进邮件和屏幕使用时间功能》经过常规Beta测试后,新的macOSSequoia15.5现已公开发布,但重要的新功能将被保留到WWDC和... MACOS Sequoia 15.5 正式发布!本次更新为 Mac 用户带来了一系列功能强化、错误修复和安全性提升,进一步增