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

相关文章

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

Python使用vllm处理多模态数据的预处理技巧

《Python使用vllm处理多模态数据的预处理技巧》本文深入探讨了在Python环境下使用vLLM处理多模态数据的预处理技巧,我们将从基础概念出发,详细讲解文本、图像、音频等多模态数据的预处理方法,... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Conda与Python venv虚拟环境的区别与使用方法详解

《Conda与Pythonvenv虚拟环境的区别与使用方法详解》随着Python社区的成长,虚拟环境的概念和技术也在不断发展,:本文主要介绍Conda与Pythonvenv虚拟环境的区别与使用... 目录前言一、Conda 与 python venv 的核心区别1. Conda 的特点2. Python v

Spring Boot中WebSocket常用使用方法详解

《SpringBoot中WebSocket常用使用方法详解》本文从WebSocket的基础概念出发,详细介绍了SpringBoot集成WebSocket的步骤,并重点讲解了常用的使用方法,包括简单消... 目录一、WebSocket基础概念1.1 什么是WebSocket1.2 WebSocket与HTTP

C#中Guid类使用小结

《C#中Guid类使用小结》本文主要介绍了C#中Guid类用于生成和操作128位的唯一标识符,用于数据库主键及分布式系统,支持通过NewGuid、Parse等方法生成,感兴趣的可以了解一下... 目录前言一、什么是 Guid二、生成 Guid1. 使用 Guid.NewGuid() 方法2. 从字符串创建

Python使用python-can实现合并BLF文件

《Python使用python-can实现合并BLF文件》python-can库是Python生态中专注于CAN总线通信与数据处理的强大工具,本文将使用python-can为BLF文件合并提供高效灵活... 目录一、python-can 库:CAN 数据处理的利器二、BLF 文件合并核心代码解析1. 基础合

Python使用OpenCV实现获取视频时长的小工具

《Python使用OpenCV实现获取视频时长的小工具》在处理视频数据时,获取视频的时长是一项常见且基础的需求,本文将详细介绍如何使用Python和OpenCV获取视频时长,并对每一行代码进行深入解析... 目录一、代码实现二、代码解析1. 导入 OpenCV 库2. 定义获取视频时长的函数3. 打开视频文

Spring IoC 容器的使用详解(最新整理)

《SpringIoC容器的使用详解(最新整理)》文章介绍了Spring框架中的应用分层思想与IoC容器原理,通过分层解耦业务逻辑、数据访问等模块,IoC容器利用@Component注解管理Bean... 目录1. 应用分层2. IoC 的介绍3. IoC 容器的使用3.1. bean 的存储3.2. 方法注

Python内置函数之classmethod函数使用详解

《Python内置函数之classmethod函数使用详解》:本文主要介绍Python内置函数之classmethod函数使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录1. 类方法定义与基本语法2. 类方法 vs 实例方法 vs 静态方法3. 核心特性与用法(1编程客