SharePoint Framework 构建你的第一个web部件(一)

简介: 博客地址:http://blog.csdn.net/FoxDaveSharePoint客户端web部件是出现在SharePoint页面的控件,但却是在浏览器本地运行的。
 博客地址: http://blog.csdn.net/FoxDave

SharePoint客户端web部件是出现在SharePoint页面的控件,但却是在浏览器本地运行的。他们是SharePoint网站的页面上的一个个小块。你可以使用现代的脚本开发工具和SharePoint工作台(一个开发测试平台)来构建客户端web部件,可以部署客户端web部件到O365开发者租户中的的传统的web部件页。并且对于纯JavaScript脚本的项目来说,你可以利用通用的脚本框架构建web部件,如AngularJS和React。举个例子,你可以使用React和Office UI Fabric React的组件一起来快速创建跟Office 365中用户体验相同的组件。

下面开始介绍实战。

客户端web部件是运行在SharePoint页面上下文中的客户端组件。客户端web部件可以部署到SharePoint Online,你也可以使用现代JavaScript脚本工具和库来构建他们。

客户端web部件支持:

>用HTML和JavaScript构建

>SharePoint online和本地SharePoint环境

注意:在开始跟随本篇下面的操作步骤之前,请确保你已经参照上一篇文章进行了开发环境的配置。

创建一个新的web部件项目

在你喜欢的路径上创建一个新的项目路径,按下面步骤操作:

>Win+R打开运行窗体,输入cmd回车,在打开的命令行中,先定位到希望项目所在的目录,然后运行md命令,如:

md myfirstwebpart,运行之后的效果如下图,这里我在C盘根目录创建了一个项目文件夹。

然后进入到刚才创建的目录,输入命令cd myfirstwebpart。

接下来通过Yeoman SharePoint Generator来生成一个新的web部件,执行如下的命令:

yo @microsoft/sharepoint

执行命令后会出现提示,询问解决方案的名称和路径,第一个提问可以直接回车保持跟文件夹的名称相同,第二个通过上下箭头进行选择后回车即可,这里我选择使用当前目录,如下图:

接下来会继续询问一些设置:

>web部件的名称。(直接输入回车保持默认)

>web部件的描述。(直接输入回车保持默认)

>要使用的框架,可以用上下箭头进行选择,直接输入回车的话即为默认项,不使用脚本web框架。

完成后Yeoman会开始安装必要的依赖项并生成web部件的解决方案文件,这会需要几分钟,如下图正在等待安装完成:

操作完成之后,你会看到如下图的信息表示成功:

关于故障排除的信息,查看Known issues

使用你最喜欢的代码编辑器/IDE

由于SharePoint客户端解决方案是基于HTML/TypeScript的,你可以使用任意的代码编辑器或IDE来构建你的web部件,这个在上一篇文章中已经提到,不再赘述。本文将使用Visual Studio code来演示,你也可以使用其他喜欢的IDE。

使用Visual Studio 2015

目前,Visual Studio通过NodeJS工具来支持SharePoint客户端项目,更多信息戳这里,在之后的文章中也会对它进行详细介绍。

预览web部件

如果想预览你的web部件,编译并在本地的web服务器运行的话,做如下操作。

回到你的命令行,确保你仍然在项目目录下然后输入命令gulp serve来编译和预览你的web部件。

这个很重要,你可以将它理解为在Visual Studio里面运行F5启动调试。

该命令会执行一系列的gulp任务来在“localhost:4321”创建一个本地的基于节点的HTTPS服务器,并在你的本地开发环境中启动你的默认浏览器去预览你的web部件,运行命令的效果如下所示:

客户端工具组使用默认的HTTPS端点。但是由于没有在本地的开发环境配置默认的证书,你的浏览器会显示证书错误,如下图:

这取决于你使用的浏览器来进行下一步的操作,比如对于上图的IE和Microsoft Edge或Google Chrome来说,选择Continue to this website即可,如果是Firefox之类的,需要添加一个例外。

SharePoint客户端开发工具使用gulp作为任务运行器来处理编译进程如:

>打包并压缩JavaScript和CSS文件。

>在每个编译之前运行工具来调用打包和压缩任务。

>将SASS文件编译为CSS。

>将TypeScript文件编译为JavaScript。

如果对于gulp来说你是新手,你可以阅读Using Gulp,他描述了结合VIsual Studio的ASP.NET 5项目如何使用gulp。

Visual Studio Code内置了对gulp和其他任务运行器的支持。使用Ctrl+Shift+B来调试和预览你的web部件。

SharePoint工作台

SharePoint工作台(workbench)是一个开发者设计平台,它使你可以快速地预览和测试web部件而不需要在SharePoint中部署他们。SharePoint工作台包括客户端页面和画板,你可以在开发时添加或删除画板,测试你的web部件。

点击+号按钮来添加我们创建的web部件。点击+号时你可以看到可用的web部件列表,该列表会将我们的web部件和你的开发环境可用的web部件一同列出。

如上图所示,选择HelloWorldweb部件,将他添加到页面,如下图:

简单吗?这就是咱们的第一个客户端web部件,已经添加到了页面上。(实际上除了配置和运行几个命令,咱们什么都没有写)

选择web部件左侧的铅笔图标打开web部件属性面板,如下图:

跟传统web部件一样,这个属性是你可以自定义的,以后会讲到。这个属性面板是客户端驱动的,提供了与SharePoint的一致性设计。我们来修改一下Description属性试试,比如改为This is a test, awesome!

上图只是一个示例,在实际操作的过程中你会发现,在你在右面的面板修改属性的同时,左边的web部件的内容也会随着改变。

这是该属性面板的一个新的功能,能够配置更新行为(有反应的和无反应的)。默认情况下更新行为是有反应的,你可以在修改属性时看到更改。就像上面说的,这个更改是马上生效的。

Web部件项目结构

你可以使用Visual Studio Code来查看web部件项目的结构。

>在命令行中,定位到目录src\webparts\helloWorld。

>输入命令

code .

用Visual Studio Code(或是你喜欢的编辑器)来打开web部件项目。(不要忘了code后面的空格加点)

Visual Studio Code会打开项目,如下图:

如果你得到了错误,你可能需要install the code command in PATH

构建SharePoint客户端web部件的主要语言是TypeScript。TypeScript是JavaScript的超类型,能够被编译成纯JavaScript。SharePoint客户端开发工具就是用TypeScript的类、模型和接口编译的,帮助开发者构建强壮的客户端web部件。

下一讲将对项目具体的结构和代码进行讲解。



相关文章
|
10天前
|
编解码 前端开发 JavaScript
构建高效响应式Web界面:现代前端框架的比较
【4月更文挑战第9天】在移动设备和多样屏幕尺寸盛行的时代,构建能够适应不同视口的响应式Web界面变得至关重要。本文深入探讨了几种流行的前端框架——Bootstrap、Foundation和Tailwind CSS,分析它们在创建响应式设计中的优势与局限。通过对比这些框架的栅格系统、组件库和定制化能力,开发者可以更好地理解如何选择合适的工具来优化前端开发流程,并最终实现高性能、跨平台兼容的用户界面。
|
11天前
|
前端开发 JavaScript 关系型数据库
从前端到后端:构建现代化Web应用的技术探索
在当今互联网时代,Web应用的开发已成为了各行各业不可或缺的一部分。从前端到后端,这篇文章将带你深入探索如何构建现代化的Web应用。我们将介绍多种技术,包括前端开发、后端开发以及各种编程语言(如Java、Python、C、PHP、Go)和数据库,帮助你了解如何利用这些技术构建出高效、安全和可扩展的Web应用。
|
5天前
|
数据库 开发者 Python
Python中使用Flask构建简单Web应用的例子
【4月更文挑战第15天】Flask是一个轻量级的Python Web框架,它允许开发者快速搭建Web应用,同时保持代码的简洁和清晰。下面,我们将通过一个简单的例子来展示如何在Python中使用Flask创建一个基本的Web应用。
|
8天前
|
JavaScript 前端开发 API
Vue.js:构建高效且灵活的Web应用的利器
Vue.js:构建高效且灵活的Web应用的利器
|
16天前
|
编解码 前端开发 开发者
构建响应式Web界面:Flexbox与Grid布局的深度对比
【4月更文挑战第4天】 在现代前端开发中,构建灵活且响应式的用户界面是至关重要的。随着移动设备浏览量的增加,能够适应不同屏幕尺寸和分辨率的布局技术变得必不可少。Flexbox和Grid是CSS提供的两种强大的布局机制,它们各自以独特的方式解决了响应式设计的挑战。本文将深入探讨Flexbox和Grid的核心概念、使用场景和性能考量,为开发者提供在面对不同布局需求时做出明智选择的依据。
|
1月前
|
编解码 前端开发 开发者
构建响应式Web界面:Flexbox的力量
【2月更文挑战第28天】 在现代网页设计中,创建能在不同设备上保持一致性和功能性的响应式界面是至关重要的。Flexbox,一个CSS布局模块,为前端开发者提供了强大工具来轻松实现灵活的布局设计。本文将深入探讨Flexbox的核心概念、使用场景以及如何通过它来优化响应式设计流程。
|
1月前
|
前端开发 开发者 UED
构建响应式Web界面:Flexbox与Grid布局的深度解析
【2月更文挑战第28天】 在现代前端开发中,打造灵活且适应不同屏幕尺寸的用户界面是至关重要的。随着移动设备的普及,响应式设计已经成为网页制作不可或缺的一部分。本文将深入探讨两种强大的CSS布局模块——Flexbox和Grid,它们如何简化布局创建过程,并赋予设计师更大的灵活性去构建动态和流畅的响应式界面。通过对这两种技术的比较、使用场景分析以及代码示例,读者将能够更好地理解何时以及如何使用这些工具来提升前端项目的质量和效率。
16 0
|
1月前
|
编解码 前端开发 开发者
构建响应式Web界面:Flexbox布局的全面指南
【2月更文挑战第28天】 在当今多变的设备屏幕尺寸和分辨率中,创建一个能够适应不同视口的响应式Web界面至关重要。本文深入探讨了CSS Flexbox布局模块,它是一种设计灵活且强大的方式来创建复杂的响应式布局。我们将透过概念解析、关键属性讲解以及实际案例分析,帮助前端开发者掌握Flexbox的核心原理和应用技巧,以实现流畅的页面布局调整和优化用户体验。
|
1月前
|
物联网 调度 开发者
构建高效Python Web应用:异步编程与Tornado框架解析
【2月更文挑战第27天】 在处理高并发的Web应用场景时,传统的同步阻塞模型往往难以满足性能需求。本文将深入探讨Python世界中的异步编程概念,并结合Tornado这一轻量级、非阻塞式Web服务器及框架,展示如何构建高性能的Web应用。通过实例驱动的方法论,我们将剖析Tornado的核心组件,包括其IOLoop、异步HTTP客户端和服务器端处理机制,以及与协程集成的细节。文章旨在为开发者提供一套实践指南,帮助他们利用Python实现快速响应和资源高效的Web服务。
28 2
|
1月前
|
监控 前端开发 JavaScript
构建高性能Web应用:前端性能优化的关键策略与实践
本文将深入探讨前端性能优化的关键策略与实践,从资源加载、渲染优化、代码压缩等多个方面提供实用的优化建议。通过对前端性能优化的深入剖析,帮助开发者全面提升Web应用的用户体验和性能表现。

热门文章

最新文章