Skip to content

Release Notes Drop 3

Pat Miller edited this page Sep 14, 2016 · 6 revisions

Expect September to be relatively quiet, but we'll still release minor updates throughout the month. Drop 3 of the framework has a few changes to the property pane APIs in the sp-client-preview package, and some small fixes to the build toolchain.

#Getting the new bits Make sure that your @microsoft/generator-sharepoint npm package is version 0.1.2. To get the latest version, run npm i -g @microsoft/generator-sharepoint@latest

#Updating your existing projects

Getting your node modules set up correctly

1 - Open package.json and set the versions of the following packages:

  • "@microsoft/sp-client-base": "~0.2.1"

  • "@microsoft/sp-client-preview": "~0.3.0"

  • "@microsoft/sp-webpart-workbench": "~0.3.0"

2 - Run npm update then npm prune then npm dedupe
This will update all the packages then optimize the node_modules folder size.

3 - Run gulp nuke to clean up any old build artifacts

4 - Run gulp to build your updated project

API Changes

sp-client-preview changes

BaseClientSideWebPart

  • BaseClientSideWebPart::onAfterPropertyPaneChangesApplied has been removed
  • BaseClientSiteWebPart::onPropertyPaneConfigurationStart as been removed
  • BaseClientSideWebPart::propertyPaneRenderedByWebPart has been removed
  • BaseClientSideWebPart::onPropertyPaneConfigurationComplete has been renamed to onPropertyConfigurationComplete
  • BaseClientSideWebPart::onPropertyPaneSave has been added

IPropertyPaneData

  • IPropertyPaneData::onConfigurationEvent has been removed, replaced by
  • IPropertyPaneData::onClose
  • IPropertyPaneData::onConfigurationComplete
  • IPropertyPaneData::onLostFocus
  • IPropertyPaneData::onSave

WebPartConfigurationEvent

The entries for this enum have been tweaked

Tooling Changes

  • combokeys added to typings in generated project (makes it easier to use the @microsoft/sp-module-loader)
  • gulp --tasksno longer returns an error. Should make integration with IDEs like WebStorm easier
  • The title and description of component feature XML is now correct.
Clone this wiki locally