Skip to content

Commit fe29219

Browse files
authored
Merge pull request pnp#1327 from pnp/dev
Dev
2 parents 256d4a7 + cb31776 commit fe29219

40 files changed

+1264
-772
lines changed

CHANGELOG.json

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,44 @@
11
{
22
"versions": [
3+
{
4+
"version": "3.11.0",
5+
"changes": {
6+
"new": [
7+
"`ProgressStepsIndicator`: New control that shows a progress of steps. [#1322](https://github.com/pnp/sp-dev-fx-controls-react/pull/1322)"
8+
],
9+
"enhancements": [
10+
"`DynamicForm`: Add taxonomy tree to test harness [#1269](https://github.com/pnp/sp-dev-fx-controls-react/pull/1269)",
11+
"`ModernTaxonomyPicker`: ability to disallow selecting children [#1279](https://github.com/pnp/sp-dev-fx-controls-react/pull/1279)",
12+
"`PeoplePicker`: Use webAbsoluteUrl if provided through props to ensure user [#1273](https://github.com/pnp/sp-dev-fx-controls-react/issues/1273)",
13+
"`DynamicForm`: Support for hidden fields [#1307](https://github.com/pnp/sp-dev-fx-controls-react/pull/1307/)",
14+
"`Placeholder`: Documentation example to only display in edit mode [#1280](https://github.com/pnp/sp-dev-fx-controls-react/issues/1280)",
15+
"`DynamicForm`: Update documentation regarding onBeforeSubmit [#1319](https://github.com/pnp/sp-dev-fx-controls-react/issues/1319)",
16+
"`DynamicForm`: FirstDayOfWeek in DatePickers from webs regional settings [#1317](https://github.com/pnp/sp-dev-fx-controls-react/issues/1317)"
17+
18+
],
19+
"fixes": [
20+
"`PeoplePicker`: fixes where people picker returns no results [#1292](https://github.com/pnp/sp-dev-fx-controls-react/issues/1292)",
21+
"`FilePicker`: Tile view fix [#1272](https://github.com/pnp/sp-dev-fx-controls-react/issues/1272)",
22+
"Issues with v1.15.2 [#1288](https://github.com/pnp/sp-dev-fx-controls-react/issues/1288)",
23+
"`RichText`: Fix broken arrow icons [#1302](https://github.com/pnp/sp-dev-fx-controls-react/pull/1302)",
24+
"`TaxonomyPicker`: Does not show term set labels in Version 3.10.0 [#1299](https://github.com/pnp/sp-dev-fx-controls-react/issues/1299)",
25+
"`TaxonomyPicker`: Dynamic form select term not working [#1303](https://github.com/pnp/sp-dev-fx-controls-react/issues/1303)",
26+
"`DynamicForm`: Check if hiddenfields property is undefined [#1314](https://github.com/pnp/sp-dev-fx-controls-react/pull/1314)",
27+
"`DynamicForm`: PeoplePicker preselects wrong user if PrincipalType allows groups [#1315](https://github.com/pnp/sp-dev-fx-controls-react/issues/1315)"
28+
]
29+
},
30+
"contributions": [
31+
"[Chad Eiserloh](https://github.com/c-eiser13)",
32+
"[Hilton Giesenow](https://github.com/HiltonGiesenow)",
33+
"[Jake Stanger](https://github.com/JakeStanger)",
34+
"[Jasey Waegebaert](https://github.com/Jwaegebaert)",
35+
"[João Mendes](https://github.com/joaojmendes)",
36+
"[Josef Benda](https://github.com/SmarterJB)",
37+
"[Mark Bice](https://github.com/mbice)",
38+
"[Paolo Pialorsi](https://github.com/PaoloPia)",
39+
"[Victor Romanov](https://github.com/VRomanovTau)"
40+
]
41+
},
342
{
443
"version": "3.10.0",
544
"changes": {

CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# Releases
22

3+
## 3.11.0
4+
5+
### Enhancements
6+
7+
- `DynamicForm`: Add taxonomy tree to test harness [#1269](https://github.com/pnp/sp-dev-fx-controls-react/pull/1269)
8+
- `ModernTaxonomyPicker`: ability to disallow selecting children [#1279](https://github.com/pnp/sp-dev-fx-controls-react/pull/1279)
9+
- `PeoplePicker`: Use webAbsoluteUrl if provided through props to ensure user [#1273](https://github.com/pnp/sp-dev-fx-controls-react/issues/1273)
10+
- `DynamicForm`: Support for hidden fields [#1307](https://github.com/pnp/sp-dev-fx-controls-react/pull/1307/)
11+
- `Placeholder`: Documentation example to only display in edit mode [#1280](https://github.com/pnp/sp-dev-fx-controls-react/issues/1280)
12+
- `DynamicForm`: Update documentation regarding onBeforeSubmit [#1319](https://github.com/pnp/sp-dev-fx-controls-react/issues/1319)
13+
14+
### Fixes
15+
16+
- `PeoplePicker`: fixes where people picker returns no results [#1292](https://github.com/pnp/sp-dev-fx-controls-react/issues/1292)
17+
- `FilePicker`: Tile view fix [#1272](https://github.com/pnp/sp-dev-fx-controls-react/issues/1272)
18+
- Issues with v1.15.2 [#1288](https://github.com/pnp/sp-dev-fx-controls-react/issues/1288)
19+
- `RichText`: Fix broken arrow icons [#1302](https://github.com/pnp/sp-dev-fx-controls-react/pull/1302)
20+
- `TaxonomyPicker`: Does not show term set labels in Version 3.10.0 [#1299](https://github.com/pnp/sp-dev-fx-controls-react/issues/1299)
21+
- `TaxonomyPicker`: Dynamic form select term not working [#1303](https://github.com/pnp/sp-dev-fx-controls-react/issues/1303)
22+
- `DynamicForm`: Check if hiddenfields property is undefined [#1314](https://github.com/pnp/sp-dev-fx-controls-react/pull/1314)
23+
24+
### Contributors
25+
26+
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).
27+
328
## 3.10.0
429

530
### Enhancements

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# Releases
22

3+
## 3.11.0
4+
5+
### Enhancements
6+
7+
- `DynamicForm`: Add taxonomy tree to test harness [#1269](https://github.com/pnp/sp-dev-fx-controls-react/pull/1269)
8+
- `ModernTaxonomyPicker`: ability to disallow selecting children [#1279](https://github.com/pnp/sp-dev-fx-controls-react/pull/1279)
9+
- `PeoplePicker`: Use webAbsoluteUrl if provided through props to ensure user [#1273](https://github.com/pnp/sp-dev-fx-controls-react/issues/1273)
10+
- `DynamicForm`: Support for hidden fields [#1307](https://github.com/pnp/sp-dev-fx-controls-react/pull/1307/)
11+
- `Placeholder`: Documentation example to only display in edit mode [#1280](https://github.com/pnp/sp-dev-fx-controls-react/issues/1280)
12+
- `DynamicForm`: Update documentation regarding onBeforeSubmit [#1319](https://github.com/pnp/sp-dev-fx-controls-react/issues/1319)
13+
14+
### Fixes
15+
16+
- `PeoplePicker`: fixes where people picker returns no results [#1292](https://github.com/pnp/sp-dev-fx-controls-react/issues/1292)
17+
- `FilePicker`: Tile view fix [#1272](https://github.com/pnp/sp-dev-fx-controls-react/issues/1272)
18+
- Issues with v1.15.2 [#1288](https://github.com/pnp/sp-dev-fx-controls-react/issues/1288)
19+
- `RichText`: Fix broken arrow icons [#1302](https://github.com/pnp/sp-dev-fx-controls-react/pull/1302)
20+
- `TaxonomyPicker`: Does not show term set labels in Version 3.10.0 [#1299](https://github.com/pnp/sp-dev-fx-controls-react/issues/1299)
21+
- `TaxonomyPicker`: Dynamic form select term not working [#1303](https://github.com/pnp/sp-dev-fx-controls-react/issues/1303)
22+
- `DynamicForm`: Check if hiddenfields property is undefined [#1314](https://github.com/pnp/sp-dev-fx-controls-react/pull/1314)
23+
24+
### Contributors
25+
26+
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).
27+
328
## 3.10.0
429

530
### Enhancements

docs/documentation/docs/controls/DynamicForm.md

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

docs/documentation/docs/controls/ModernTaxonomyPicker.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,7 @@ The ModernTaxonomyPicker control can be configured with the following properties
177177
| isBlocking | boolean | no | Whether the panel uses a modal overlay or not. |
178178
| onRenderActionButton | function | no | Optional custom renderer for adding e.g. a button with additional actions to the terms in the tree view. |
179179
| isPathRendered | boolean | no | Whether the terms will be rendered with the term label or the full path up to the root. |
180+
| allowSelectingChildren | boolean | no | Whether child terms can be selected. Default value is true. |
180181

181182
## Standalone TaxonomyTree control
182183

docs/documentation/docs/controls/Placeholder.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,21 @@ Sample of using the `hideButton` functionality for hiding the button when page i
5656
theme={this.props.themeVariant} />
5757
```
5858

59+
Sample to only display `Placeholder` when the web part is in edit mode:
60+
61+
```TypeScript
62+
{
63+
this.displayMode === DisplayMode.Edit ?
64+
<Placeholder iconName='Edit'
65+
iconText='Configure your web part'
66+
description='Please configure the web part.'
67+
buttonLabel='Configure'
68+
onConfigure={this._onConfigure}
69+
theme={this.props.themeVariant} /> :
70+
<div />
71+
}
72+
```
73+
5974
## Implementation
6075

6176
The placeholder control can be configured with the following properties:
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Progress Steps Indicator
2+
3+
This control shows a progress of steps.
4+
5+
Here is an example of the control in action:
6+
7+
![ProgressStepsIndicator](../assets/ProgressStepsIndicator.png)
8+
9+
10+
11+
## How to use this control in your solutions
12+
13+
- 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.
14+
- In your component file, import the `ProgressStepsIndicator` control as follows:
15+
16+
```TypeScript
17+
import { ProgressStepsIndicator } from '"@pnp/spfx-controls-react/lib/ProgressStepsIndicator';
18+
19+
const progressSteps: IStep[] = [
20+
{ id: 0, title: "Step 1", description: "Step 1 Description" },
21+
{ id: 1, title: "Step 2", description: "Step 2 Description" },
22+
{ id: 3, title: "Step 3", description: "Step 3 Description" },
23+
{ id: 4, title: "Step 4", description: "Step 4 Description" },
24+
{ id: 5, title: "Step 5", description: "Step 5 Description" },
25+
{ id: 6, title: "Step 6", description: "Step 6 Description" },
26+
];
27+
```
28+
29+
- Use the `ProgressStepsIndicator` control in your code as follows:
30+
31+
```TypeScript
32+
{
33+
<ProgressStepsIndicator steps={progressSteps} currentStep={0} themeVariant={props.themeVariant} />
34+
}
35+
```
36+
37+
38+
## Implementation
39+
40+
The `ProgressStepsIndicator` control can be configured with the following properties:
41+
42+
| Property | Type | Required | Description | Default |
43+
| ---- | ---- | ---- | ---- | ---- |
44+
| steps | ISteps[] | yes | Perogress Steps | |
45+
| currentStep | number | yes | index of current step | default is 0|
46+
| themeVariant | IReadonlyTheme | undefined | no | Theme | |
47+
48+
The `IStep Interface` definition:
49+
50+
```TypeScript
51+
Interface IStep {
52+
id?:number;
53+
title:string;
54+
description:string;
55+
}
56+
```
57+
58+
59+
60+
61+
![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/wiki/controls/ProgressStepsIndicator)

docs/documentation/docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ The following controls are currently available:
9999
- [PeoplePicker](./controls/PeoplePicker) (People Picker)
100100
- [Placeholder](./controls/Placeholder) (shows an initial placeholder if the web part has to be configured)
101101
- [Progress](./controls/Progress) (shows progress of multiple SEQUENTIALLY executed actions)
102+
- [ProgressStepsIndicator.md](./controls/ProgressStepsIndicator) (shows a progress of steps)
102103
- [SecurityTrimmedControl](./controls/SecurityTrimmedControl) (intended to be used when you want to show or hide components based on the user permissions)
103104
- [SiteBreadcrumb](./controls/SiteBreadcrumb) (Breadcrumb control)
104105
- [SitePicker](./controls/SitePicker) (Site Picker control)

docs/documentation/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ nav:
5959
- PeoplePicker: 'controls/PeoplePicker.md'
6060
- Placeholder: 'controls/Placeholder.md'
6161
- Progress: 'controls/Progress.md'
62+
- ProgressStepsIndicator: 'controls/ProgressStepsIndicator.md'
6263
- RichText: 'controls/RichText.md'
6364
- SecurityTrimmedControl: 'controls/SecurityTrimmedControl.md'
6465
- SiteBreadcrumb: 'controls/SiteBreadcrumb.md'

0 commit comments

Comments
 (0)