Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
estruyf committed Jan 12, 2021
2 parents 5958429 + 36ad1fe commit bde7827
Show file tree
Hide file tree
Showing 70 changed files with 1,936 additions and 244 deletions.
34 changes: 32 additions & 2 deletions CHANGELOG.JSON
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
{
"versions": [
{
"version": "2.4.0",
"changes": {
"new": [
"`AccessibleAccordion` control [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)"
],
"enhancements": [
"`Placeholder`: support of custom rendering for `iconText` and `description`",
"`PeoplePicker`: ability just to display inactive users name (ideally the value fetched from 'Author/Title') [#768](https://github.com/pnp/sp-dev-fx-controls-react/issues/768)",
"`TaxonomyPicker`: New `onPanelSelectionChange` property added. Can be used to interact with the control while selecting items in the panel, before Click or Cancel is clicked. [#761](https://github.com/pnp/sp-dev-fx-controls-react/issues/761)",
"`TaxonomyPicker`: `selectChildrenIfParentSelected` property added. Specifies if the children should be selected when parent item is selected (defaults to false). [#765](https://github.com/pnp/sp-dev-fx-controls-react/issues/765)",
"`ListPicker`: ability to pick lists from specified site using `webAbsoluteUrl` property.",
"`FilePicker`: `buttonIconProps` to define properties of the button's icon [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)"
],
"fixes": [
"`DateTimePicker`: documentation fix [#767](https://github.com/pnp/sp-dev-fx-controls-react/pull/767)",
"`PeoplePicker`: documentation fix - Changed isRequired property to new required [#769](https://github.com/pnp/sp-dev-fx-controls-react/pull/769)",
"Documentation fix - missing `IFramePanel` link on home page [#775](https://github.com/pnp/sp-dev-fx-controls-react/pull/775)",
"Documentation fix for `FilePicker`: updated `onChaged` to `onChange` [#776](https://github.com/pnp/sp-dev-fx-controls-react/pull/776)"
]
},
"contributions": [
"[André Lage](https://github.com/aaclage)",
"[Christian Metz](https://github.com/ChrisOMetz)",
"[Gaurav Goyal](https://github.com/Gaurav8Bizportals)",
"[Leif Frederiksen](https://github.com/Leif-Frederiksen)",
"[Ravichandran Krishnasamy](https://github.com/ravichandran-blog)",
"[San](https://github.com/sankarkumar23)",
"[João Mendes](https://github.com/joaojmendes)"
]
},
{
"version": "2.3.0",
"changes": {
Expand Down Expand Up @@ -167,8 +198,7 @@
{
"version": "1.19.0",
"changes": {
"new": [
],
"new": [],
"enhancements": [
"`ListView`: Add clear button to filter text box [#549](https://github.com/pnp/sp-dev-fx-controls-react/issues/549)",
"`FolderExplorer`: Add clear button to filter text box [#553](https://github.com/pnp/sp-dev-fx-controls-react/pull/553)",
Expand Down
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Releases

## 2.4.0

### New control(s)

- `AccessibleAccordion` control [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)

### Enhancements

- `Placeholder`: support of custom rendering for `iconText` and `description`
- `PeoplePicker`: ability just to display inactive users name (ideally the value fetched from 'Author/Title') [#768](https://github.com/pnp/sp-dev-fx-controls-react/issues/768)
- `TaxonomyPicker`: New `onPanelSelectionChange` property added. Can be used to interact with the control while selecting items in the panel, before Click or Cancel is clicked. [#761](https://github.com/pnp/sp-dev-fx-controls-react/issues/761)
- `TaxonomyPicker`: `selectChildrenIfParentSelected` property added. Specifies if the children should be selected when parent item is selected (defaults to false). [#765](https://github.com/pnp/sp-dev-fx-controls-react/issues/765)
- `ListPicker`: ability to pick lists from specified site using `webAbsoluteUrl` property.
- `FilePicker`: `buttonIconProps` to define properties of the button's icon [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)

### Fixes

- `DateTimePicker`: documentation fix [#767](https://github.com/pnp/sp-dev-fx-controls-react/pull/767)
- `PeoplePicker`: documentation fix - Changed isRequired property to new required [#769](https://github.com/pnp/sp-dev-fx-controls-react/pull/769)
- Documentation fix - missing `IFramePanel` link on home page [#775](https://github.com/pnp/sp-dev-fx-controls-react/pull/775)
- Documentation fix for `FilePicker`: updated `onChaged` to `onChange` [#776](https://github.com/pnp/sp-dev-fx-controls-react/pull/776)

### Contributors

Special thanks to our contributors (in alphabetical order): [André Lage](https://github.com/aaclage), [Christian Metz](https://github.com/ChrisOMetz), [Gaurav Goyal](https://github.com/Gaurav8Bizportals), [Leif Frederiksen](https://github.com/Leif-Frederiksen), [Ravichandran Krishnasamy](https://github.com/ravichandran-blog), [San](https://github.com/sankarkumar23), [João Mendes](https://github.com/joaojmendes).

## 2.3.0

### New control(s)
Expand Down
26 changes: 26 additions & 0 deletions docs/documentation/docs/about/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Releases

## 2.4.0

### New control(s)

- `AccessibleAccordion` control [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)

### Enhancements

- `Placeholder`: support of custom rendering for `iconText` and `description`
- `PeoplePicker`: ability just to display inactive users name (ideally the value fetched from 'Author/Title') [#768](https://github.com/pnp/sp-dev-fx-controls-react/issues/768)
- `TaxonomyPicker`: New `onPanelSelectionChange` property added. Can be used to interact with the control while selecting items in the panel, before Click or Cancel is clicked. [#761](https://github.com/pnp/sp-dev-fx-controls-react/issues/761)
- `TaxonomyPicker`: `selectChildrenIfParentSelected` property added. Specifies if the children should be selected when parent item is selected (defaults to false). [#765](https://github.com/pnp/sp-dev-fx-controls-react/issues/765)
- `ListPicker`: ability to pick lists from specified site using `webAbsoluteUrl` property.
- `FilePicker`: `buttonIconProps` to define properties of the button's icon [#770](https://github.com/pnp/sp-dev-fx-controls-react/pull/770)

### Fixes

- `DateTimePicker`: documentation fix [#767](https://github.com/pnp/sp-dev-fx-controls-react/pull/767)
- `PeoplePicker`: documentation fix - Changed isRequired property to new required [#769](https://github.com/pnp/sp-dev-fx-controls-react/pull/769)
- Documentation fix - missing `IFramePanel` link on home page [#775](https://github.com/pnp/sp-dev-fx-controls-react/pull/775)
- Documentation fix for `FilePicker`: updated `onChaged` to `onChange` [#776](https://github.com/pnp/sp-dev-fx-controls-react/pull/776)

### Contributors

Special thanks to our contributors (in alphabetical order): [André Lage](https://github.com/aaclage), [Christian Metz](https://github.com/ChrisOMetz), [Gaurav Goyal](https://github.com/Gaurav8Bizportals), [Leif Frederiksen](https://github.com/Leif-Frederiksen), [Ravichandran Krishnasamy](https://github.com/ravichandran-blog), [San](https://github.com/sankarkumar23), [João Mendes](https://github.com/joaojmendes).

## 2.3.0

### New control(s)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/documentation/docs/controls/DateTimePicker.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Here are some examples of the control:
- Import the control into your component. The DateConvention and TimeConvention controls if the time of day controls are shown and the time format used (12 hours/24 hours).

```TypeScript
import { DateTimePicker, DateConvention, TimeConvention } from '@pnp/spfx-controls-react/lib/dateTimePicker';
import { DateTimePicker, DateConvention, TimeConvention } from '@pnp/spfx-controls-react/lib/DateTimePicker';
```
- Use the `DateTimePicker` control in your code as follows, either as an uncontrolled or a controlled component:

Expand Down
3 changes: 2 additions & 1 deletion docs/documentation/docs/controls/FilePicker.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ import { FilePicker, IFilePickerResult } from '@pnp/spfx-controls-react/lib/File
accepts= {[".gif", ".jpg", ".jpeg", ".bmp", ".dib", ".tif", ".tiff", ".ico", ".png", ".jxr", ".svg"]}
buttonIcon="FileImage"
onSave={(filePickerResult: IFilePickerResult) => { this.setState({filePickerResult }) }}
onChanged={(filePickerResult: IFilePickerResult) => { this.setState({filePickerResult }) }}
onChange={(filePickerResult: IFilePickerResult) => { this.setState({filePickerResult }) }}
context={this.props.context}
/>
```
Expand All @@ -59,6 +59,7 @@ The FilePicker component can be configured with the following properties:
| label | string | no | Specifies the text describing the file picker. |
| buttonLabel | string | no | Specifies the label of the file picker button. |
| buttonIcon | string | no | In case it is provided the file picker will be rendered as an action button. |
buttonIconProps | IIconProps | no | In case it is provided the file picker will be rendered as an Icon the and all can define Properties for Icon |
| onSave | (filePickerResult: IFilePickerResult) => void | yes | Handler when the file has been selected and picker has been closed. |
| onChange | (filePickerResult: IFilePickerResult) => void | no | Handler when the file selection has been changed. |
| context | ExtensionContext \| WebPartContext | yes | Current context. |
Expand Down
1 change: 1 addition & 0 deletions docs/documentation/docs/controls/ListPicker.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ The `ListPicker` control can be configured with the following properties:
| placeHolder | string | no | Placeholder label to show in the dropdown. **Deprecated. Use `placeholder` instead.** |
| placeholder | string | no | Placeholder label to show in the dropdown. |
| onSelectionChanged | (newValue: string OR string[]): void | no | Callback function when the selected option changes. |
| webAbsoulteUrl | string | no | Absolute Web Url of target site (user requires permissions) |

Enum `LibsOrderBy`

Expand Down
2 changes: 2 additions & 0 deletions docs/documentation/docs/controls/ListView.ContextualMenu.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,5 @@ The result will look like the following:
Once you click on an action, you will see the alert:

![ContextualMenu_clicked](../assets/ListView.ContextualMenu_clicked.png)

![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/wiki/controls/ListViewContextualMenu)
2 changes: 2 additions & 0 deletions docs/documentation/docs/controls/Pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,5 @@ The Pagination control can be configured with the following properties:
| hideFirstPageJump | boolean | no | Hide the quick jump to the first page | false |
| hideLastPageJump | boolean | no | Hide the quick jump to the last page | false |
| limiterIcon | string | no | Limitir icon form Fluent IU | More |

![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/wiki/controls/Pagination)
5 changes: 3 additions & 2 deletions docs/documentation/docs/controls/PeoplePicker.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import { PeoplePicker, PrincipalType } from "@pnp/spfx-controls-react/lib/People
personSelectionLimit={3}
groupName={"Team Site Owners"} // Leave this blank in case you want to filter from all users
showtooltip={true}
isRequired={true}
required={true}
disabled={true}
onChange={this._getPeoplePickerItems}
showHiddenInUI={false}
Expand Down Expand Up @@ -70,7 +70,8 @@ The People picker control can be configured with the following properties:
| onChange | (items: IPersonaProps[]) => void | no | Get the selected users in the control. | |
| peoplePickerWPclassName | string | no | applies custom styling to the people picker element | |
| peoplePickerCntrlclassName | string | no | applies custom styling to the people picker control only | |
| defaultSelectedUsers | string[] | no | Default selected user emails or login names | |
| defaultSelectedUsers | string[] | no | Default selected user emails or login names, optionally append `/title` with forward slash.
If user is not found then only optional title will be shown. If you do not have email or login name of inactive users just pass `/title` alone prefixed with slash.| |
| webAbsoluteUrl | string | no | Specify the site URL on which you want to perform the user query call. If not provided, the people picker will perform a tenant wide people/group search. When provided it will search users/groups on the provided site. | |
| principalTypes | PrincipalType[] | no | Define which type of data you want to retrieve: User, SharePoint groups, Security groups. Multiple are possible. | |
| ensureUser | boolean | no | When ensure user property is true, it will return the local user ID on the current site when doing a tenant wide search. | false |
Expand Down
14 changes: 12 additions & 2 deletions docs/documentation/docs/controls/Placeholder.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,16 @@ import { Placeholder } from "@pnp/spfx-controls-react/lib/Placeholder";
onConfigure={this._onConfigure} />
```

- With custom element for `description`:

```TypeScript
<Placeholder iconName='Edit'
iconText='Configure your web part'
description={defaultClassNames => <span className={`${defaultClassNames} ${additionalStyles}`}>Please configure the web part.</span>}
buttonLabel='Configure'
onConfigure={this._onConfigure} />
```

- With the `onConfigure` property you can define what it needs to do when you click on the button. Like for example opening the property pane:

```typescript
Expand Down Expand Up @@ -51,9 +61,9 @@ The placeholder control can be configured with the following properties:
| ---- | ---- | ---- | ---- |
| buttonLabel | string | no | Text label to be displayed on the button bellow the description. The button is optional. |
| contentClassName | string | no | This is the className that is applied to the root element of the content zone. You can use this to apply custom styles to the placeholder. |
| description | string | yes | Text description for the placeholder. This appears bellow the Icon and IconText. |
| description | string \| ((defaultClassNames: string) =&gt; React.ReactElement) | yes | Text description or render function for the placeholder. This appears bellow the Icon and IconText. |
| iconName | string | yes | The name of the icon that will be used in the placeholder. This is the same name as you can find on the Office UI Fabric icons page: [Office UI Fabric icons](https://dev.office.com/fabric#/styles/icons). For example: `Page` or `Add`. |
| iconText | string | yes | Heading text which is displayed next to the icon. |
| iconText | string \| ((defaultClassNames: string) =&gt; React.ReactElement) | yes | Heading text or render function which is displayed next to the icon. |
| hideButton | boolean | no | Specify if you want to hide the button. Default is `false`. |
| onConfigure | function | no | onConfigure handler for the button. The button is optional. |

Expand Down
4 changes: 3 additions & 1 deletion docs/documentation/docs/controls/TaxonomyPicker.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,8 @@ The TaxonomyPicker control can be configured with the following properties:
| onGetErrorMessage | (value: IPickerTerms) => string \| Promise&lt;string&gt; | no | The method is used to get the validation error message and determine whether the picker value is valid or not. Mutually exclusive with the static string `errorMessage` (it will take precedence over this).<br />When it returns string:<ul><li>If valid, it returns empty string.</li><li>If invalid, it returns the error message string to be shown below the picker.</li></ul><br />When it returns Promise&lt;string&gt;:<ul><li>The resolved value is display as error message.</li><li>The rejected, the value is thrown away.</li></ul> |
| required | boolean | no | Specifies if to display an asterisk near the label. Note that error message should be specified in `onGetErrorMessage` or `errorMessage` |
| useSessionStorage | boolean | no | Specify if the control uses session storage. Default is set to true for better performance. |
| onPanelSelectionChange | (prevValue: IPickerTerms, newValue: IPickerTerms) => void | no | Panel selection change handler. Can be used to interact with the control while selecting items in the panel, before Click or Cancel is clicked. |
| selectChildrenIfParentSelected | boolean | no | Specifies if the children should be selected when parent item is selected (defaults to false). |


Interface `IPickerTerm`
Expand Down Expand Up @@ -227,4 +229,4 @@ Enum `UpdateType`
| disableTerm |
| selectTerm |

![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/wiki/controls/Placeholder)
![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/wiki/controls/TaxonomyPicker)
2 changes: 1 addition & 1 deletion docs/documentation/docs/controls/TreeView.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,4 +250,4 @@ items: [
private skypeCheckIcon: IIconProps = { iconName: 'SkypeCheck' };
```
![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/wiki/controls/TreeView)
Loading

0 comments on commit bde7827

Please sign in to comment.