Merge pull request #1327 from pnp/dev

Dev

CHANGELOG.json

@@ -1,5 +1,44 @@
 {
   "versions": [
+    {
+      "version": "3.11.0",
+      "changes": {
+        "new": [
+          "`ProgressStepsIndicator`: New control that shows a progress of steps. [#1322](https://github.com/pnp/sp-dev-fx-controls-react/pull/1322)"
+        ],
+        "enhancements": [
+          "`DynamicForm`: Add taxonomy tree to test harness [#1269](https://github.com/pnp/sp-dev-fx-controls-react/pull/1269)",
+          "`ModernTaxonomyPicker`: ability to disallow selecting children [#1279](https://github.com/pnp/sp-dev-fx-controls-react/pull/1279)",
+          "`PeoplePicker`: Use webAbsoluteUrl if provided through props to ensure user [#1273](https://github.com/pnp/sp-dev-fx-controls-react/issues/1273)",
+          "`DynamicForm`: Support for hidden fields [#1307](https://github.com/pnp/sp-dev-fx-controls-react/pull/1307/)",
+          "`Placeholder`: Documentation example to only display in edit mode [#1280](https://github.com/pnp/sp-dev-fx-controls-react/issues/1280)",
+          "`DynamicForm`: Update documentation regarding onBeforeSubmit [#1319](https://github.com/pnp/sp-dev-fx-controls-react/issues/1319)",
+          "`DynamicForm`: FirstDayOfWeek in DatePickers from webs regional settings [#1317](https://github.com/pnp/sp-dev-fx-controls-react/issues/1317)"
+
+        ],
+        "fixes": [
+          "`PeoplePicker`: fixes where people picker returns no results [#1292](https://github.com/pnp/sp-dev-fx-controls-react/issues/1292)",
+          "`FilePicker`: Tile view fix [#1272](https://github.com/pnp/sp-dev-fx-controls-react/issues/1272)",
+          "Issues with v1.15.2 [#1288](https://github.com/pnp/sp-dev-fx-controls-react/issues/1288)",
+          "`RichText`: Fix broken arrow icons [#1302](https://github.com/pnp/sp-dev-fx-controls-react/pull/1302)",
+          "`TaxonomyPicker`: Does not show term set labels in Version 3.10.0 [#1299](https://github.com/pnp/sp-dev-fx-controls-react/issues/1299)",
+          "`TaxonomyPicker`: Dynamic form select term not working [#1303](https://github.com/pnp/sp-dev-fx-controls-react/issues/1303)",
+          "`DynamicForm`: Check if hiddenfields property is undefined [#1314](https://github.com/pnp/sp-dev-fx-controls-react/pull/1314)",
+          "`DynamicForm`: PeoplePicker preselects wrong user if PrincipalType allows groups [#1315](https://github.com/pnp/sp-dev-fx-controls-react/issues/1315)"
+        ]
+      },
+      "contributions": [
+        "[Chad Eiserloh](https://github.com/c-eiser13)",
+        "[Hilton Giesenow](https://github.com/HiltonGiesenow)",
+        "[Jake Stanger](https://github.com/JakeStanger)",
+        "[Jasey Waegebaert](https://github.com/Jwaegebaert)",
+        "[João Mendes](https://github.com/joaojmendes)",
+        "[Josef Benda](https://github.com/SmarterJB)",
+        "[Mark Bice](https://github.com/mbice)",
+        "[Paolo Pialorsi](https://github.com/PaoloPia)",
+        "[Victor Romanov](https://github.com/VRomanovTau)"
+      ]
+    },
     {
       "version": "3.10.0",
       "changes": {

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Releases
 
+## 3.11.0
+
+### Enhancements
+
+- `DynamicForm`: Add taxonomy tree to test harness [#1269](https://github.com/pnp/sp-dev-fx-controls-react/pull/1269)
+- `ModernTaxonomyPicker`: ability to disallow selecting children [#1279](https://github.com/pnp/sp-dev-fx-controls-react/pull/1279)
+- `PeoplePicker`: Use webAbsoluteUrl if provided through props to ensure user [#1273](https://github.com/pnp/sp-dev-fx-controls-react/issues/1273)
+- `DynamicForm`: Support for hidden fields [#1307](https://github.com/pnp/sp-dev-fx-controls-react/pull/1307/)
+- `Placeholder`: Documentation example to only display in edit mode [#1280](https://github.com/pnp/sp-dev-fx-controls-react/issues/1280)
+- `DynamicForm`: Update documentation regarding onBeforeSubmit [#1319](https://github.com/pnp/sp-dev-fx-controls-react/issues/1319)
+
+### Fixes
+
+- `PeoplePicker`: fixes where people picker returns no results [#1292](https://github.com/pnp/sp-dev-fx-controls-react/issues/1292)
+- `FilePicker`: Tile view fix [#1272](https://github.com/pnp/sp-dev-fx-controls-react/issues/1272)
+- Issues with v1.15.2 [#1288](https://github.com/pnp/sp-dev-fx-controls-react/issues/1288)
+- `RichText`: Fix broken arrow icons [#1302](https://github.com/pnp/sp-dev-fx-controls-react/pull/1302)
+- `TaxonomyPicker`: Does not show term set labels in Version 3.10.0 [#1299](https://github.com/pnp/sp-dev-fx-controls-react/issues/1299)
+- `TaxonomyPicker`: Dynamic form select term not working [#1303](https://github.com/pnp/sp-dev-fx-controls-react/issues/1303)
+- `DynamicForm`: Check if hiddenfields property is undefined [#1314](https://github.com/pnp/sp-dev-fx-controls-react/pull/1314)
+
+### Contributors
+
+Special thanks to our contributors (in alphabetical order): [Chad Eiserloh](https://github.com/c-eiser13), [Hilton Giesenow](https://github.com/HiltonGiesenow), [Jake Stanger](https://github.com/JakeStanger), [Jasey Waegebaert](https://github.com/Jwaegebaert), [Josef Benda](https://github.com/SmarterJB), [Mark Bice](https://github.com/mbice), [Paolo Pialorsi](https://github.com/PaoloPia), [Victor Romanov](https://github.com/VRomanovTau).
+
 ## 3.10.0
 
 ### Enhancements

docs/documentation/docs/about/release-notes.md

@@ -1,5 +1,30 @@
 # Releases
 
+## 3.11.0
+
+### Enhancements
+
+- `DynamicForm`: Add taxonomy tree to test harness [#1269](https://github.com/pnp/sp-dev-fx-controls-react/pull/1269)
+- `ModernTaxonomyPicker`: ability to disallow selecting children [#1279](https://github.com/pnp/sp-dev-fx-controls-react/pull/1279)
+- `PeoplePicker`: Use webAbsoluteUrl if provided through props to ensure user [#1273](https://github.com/pnp/sp-dev-fx-controls-react/issues/1273)
+- `DynamicForm`: Support for hidden fields [#1307](https://github.com/pnp/sp-dev-fx-controls-react/pull/1307/)
+- `Placeholder`: Documentation example to only display in edit mode [#1280](https://github.com/pnp/sp-dev-fx-controls-react/issues/1280)
+- `DynamicForm`: Update documentation regarding onBeforeSubmit [#1319](https://github.com/pnp/sp-dev-fx-controls-react/issues/1319)
+
+### Fixes
+
+- `PeoplePicker`: fixes where people picker returns no results [#1292](https://github.com/pnp/sp-dev-fx-controls-react/issues/1292)
+- `FilePicker`: Tile view fix [#1272](https://github.com/pnp/sp-dev-fx-controls-react/issues/1272)
+- Issues with v1.15.2 [#1288](https://github.com/pnp/sp-dev-fx-controls-react/issues/1288)
+- `RichText`: Fix broken arrow icons [#1302](https://github.com/pnp/sp-dev-fx-controls-react/pull/1302)
+- `TaxonomyPicker`: Does not show term set labels in Version 3.10.0 [#1299](https://github.com/pnp/sp-dev-fx-controls-react/issues/1299)
+- `TaxonomyPicker`: Dynamic form select term not working [#1303](https://github.com/pnp/sp-dev-fx-controls-react/issues/1303)
+- `DynamicForm`: Check if hiddenfields property is undefined [#1314](https://github.com/pnp/sp-dev-fx-controls-react/pull/1314)
+
+### Contributors
+
+Special thanks to our contributors (in alphabetical order): [Chad Eiserloh](https://github.com/c-eiser13), [Hilton Giesenow](https://github.com/HiltonGiesenow), [Jake Stanger](https://github.com/JakeStanger), [Jasey Waegebaert](https://github.com/Jwaegebaert), [Josef Benda](https://github.com/SmarterJB), [Mark Bice](https://github.com/mbice), [Paolo Pialorsi](https://github.com/PaoloPia), [Victor Romanov](https://github.com/VRomanovTau).
+
 ## 3.10.0
 
 ### Enhancements

docs/documentation/docs/controls/DynamicForm.md

@@ -19,7 +19,7 @@ import { DynamicForm } from "@pnp/spfx-controls-react/lib/DynamicForm";
           listId={"3071c058-549f-461d-9d73-8b9a52049a80"}  
           listItemId={1}
           onCancelled={() => { console.log('Cancelled') }}
-          onBeforeSubmit={async (listItem) => { return true; }}
+          onBeforeSubmit={async (listItem) => { return false; }}
           onSubmitError={(listItem, error) => { alert(error.message); }}
           onSubmitted={async (listItemData) => { console.log(listItemData); }}>
 </DynamicForm>
@@ -38,7 +38,7 @@ The `DynamicForm` can be configured with the following properties:
 | contentTypeId | string | no | content type ID |
 | disabled | boolean | no | Allows form to be disabled. Default value is `false`|
 | disabledFields | string[] | no | InternalName of fields that should be disabled. Default value is `false`|
-| onBeforeSubmit | (listItemData: any) => Promise&lt;boolean&gt; | no | Before submit handler. Allows to modify the object to be submitted or cancel the submission. |
+| onBeforeSubmit | (listItemData: any) => Promise&lt;boolean&gt; | no | Before submit handler. Allows to modify the object to be submitted or cancel the submission. To cancel, return `true`.|
 | onSubmitted | (listItemData: any, listItem?: IItem) => void | no | Method that returns listItem data JSON object and PnPJS list item instance (`IItem`). |
 | onSubmitError | (listItemData: any, error: Error) => void | no | Handler of submission error. |
 | onCancelled | () => void | no | Handler when form has been cancelled. |

docs/documentation/docs/controls/ModernTaxonomyPicker.md

@@ -177,6 +177,7 @@ The ModernTaxonomyPicker control can be configured with the following properties
 | isBlocking | boolean | no | Whether the panel uses a modal overlay or not. |
 | onRenderActionButton | function | no | Optional custom renderer for adding e.g. a button with additional actions to the terms in the tree view. |
 | isPathRendered | boolean | no | Whether the terms will be rendered with the term label or the full path up to the root. |
+| allowSelectingChildren | boolean | no | Whether child terms can be selected. Default value is true. |
 
 ## Standalone TaxonomyTree control
 

docs/documentation/docs/controls/Placeholder.md

@@ -56,6 +56,21 @@ Sample of using the `hideButton` functionality for hiding the button when page i
              theme={this.props.themeVariant} />
 ```
 
+Sample to only display `Placeholder` when the web part is in edit mode:
+
+```TypeScript
+{
+  this.displayMode === DisplayMode.Edit ?
+  <Placeholder iconName='Edit'
+               iconText='Configure your web part'
+               description='Please configure the web part.'
+               buttonLabel='Configure'
+               onConfigure={this._onConfigure}
+               theme={this.props.themeVariant} /> :
+  <div />
+}
+```
+
 ## Implementation
 
 The placeholder control can be configured with the following properties:

docs/documentation/docs/controls/ProgressStepsIndicator.md

@@ -0,0 +1,61 @@
+# Progress Steps Indicator
+
+This control shows a progress of steps.
+
+Here is an example of the control in action:
+
+![ProgressStepsIndicator](../assets/ProgressStepsIndicator.png)
+
+
+
+## How to use this control in your solutions
+
+- Check that you installed the `@pnp/spfx-controls-react` dependency. Check out the [getting started](../../#getting-started) page for more information about installing the dependency.
+- In your component file, import the `ProgressStepsIndicator` control as follows:
+
+```TypeScript
+import { ProgressStepsIndicator } from '"@pnp/spfx-controls-react/lib/ProgressStepsIndicator';
+
+const progressSteps: IStep[] = [
+  { id: 0, title: "Step 1", description: "Step 1 Description" },
+  { id: 1, title: "Step 2", description: "Step 2 Description" },
+  { id: 3, title: "Step 3", description: "Step 3 Description" },
+  { id: 4, title: "Step 4", description: "Step 4 Description" },
+  { id: 5, title: "Step 5", description: "Step 5 Description" },
+  { id: 6, title: "Step 6", description: "Step 6 Description" },
+];
+```
+
+- Use the `ProgressStepsIndicator` control in your code as follows:
+
+```TypeScript
+{
+     <ProgressStepsIndicator steps={progressSteps} currentStep={0} themeVariant={props.themeVariant} />
+}
+```
+
+
+## Implementation
+
+The `ProgressStepsIndicator` control can be configured with the following properties:
+
+| Property | Type | Required | Description | Default |
+| ---- | ---- | ---- | ---- | ---- |
+| steps | ISteps[] | yes | Perogress Steps | |
+| currentStep | number | yes | index of current step | default is 0|
+| themeVariant | IReadonlyTheme | undefined | no | Theme | |
+
+ The `IStep Interface` definition:
+
+```TypeScript
+Interface IStep {
+  id?:number;
+  title:string;
+  description:string;
+}
+```
+
+
+
+
+![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/wiki/controls/ProgressStepsIndicator)

docs/documentation/docs/index.md

@@ -99,6 +99,7 @@ The following controls are currently available:
 - [PeoplePicker](./controls/PeoplePicker) (People Picker)
 - [Placeholder](./controls/Placeholder) (shows an initial placeholder if the web part has to be configured)
 - [Progress](./controls/Progress) (shows progress of multiple SEQUENTIALLY executed actions)
+- [ProgressStepsIndicator.md](./controls/ProgressStepsIndicator) (shows a progress of steps)
 - [SecurityTrimmedControl](./controls/SecurityTrimmedControl) (intended to be used when you want to show or hide components based on the user permissions)
 - [SiteBreadcrumb](./controls/SiteBreadcrumb) (Breadcrumb control)
 - [SitePicker](./controls/SitePicker) (Site Picker control)

docs/documentation/mkdocs.yml

@@ -59,6 +59,7 @@ nav:
     - PeoplePicker: 'controls/PeoplePicker.md'
     - Placeholder: 'controls/Placeholder.md'
     - Progress: 'controls/Progress.md'
+    - ProgressStepsIndicator: 'controls/ProgressStepsIndicator.md'
     - RichText: 'controls/RichText.md'
     - SecurityTrimmedControl: 'controls/SecurityTrimmedControl.md'
     - SiteBreadcrumb: 'controls/SiteBreadcrumb.md'