Skip to content

Commit

Permalink
Merge pull request #563 from pnp/dev
Browse files Browse the repository at this point in the history
3.13.0 Release
  • Loading branch information
AJIXuMuK authored Apr 19, 2023
2 parents 31db375 + 7432fed commit e2a83ec
Show file tree
Hide file tree
Showing 38 changed files with 54,988 additions and 9,380 deletions.
23 changes: 23 additions & 0 deletions CHANGELOG.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
{
"versions": [
{
"version": "3.13.0",
"changes": {
"new": [],
"enhancements": [
"`PropertyFieldCollectionData`: add `panelProps` property to collection data [#546](https://github.com/pnp/sp-dev-fx-property-controls/pull/546)",
"SharePoint Framework v1.17.1 support"
],
"fixes": [
"Italian localization updated [#549](https://github.com/pnp/sp-dev-fx-property-controls/pull/549)",
"Fixed multiple typos [#550](https://github.com/pnp/sp-dev-fx-property-controls/pull/550)",
"Swedish localization updated [#553](https://github.com/pnp/sp-dev-fx-property-controls/pull/553)",
"`PropertyPanePropertyEditor`: crash when property undefined/null [#552](https://github.com/pnp/sp-dev-fx-property-controls/pull/552)"
]
},
"contributions": [
"[Chad Eiserloh](https://github.com/c-eiser13)",
"[Gitwey](https://github.com/Gitwey)",
"[Jake Stanger](https://github.com/JakeStanger)",
"[Luca3082](https://github.com/Luca3082)",
"[Valeras Narbutas](https://github.com/ValerasNarbutas)"
]
},
{
"version": "3.12.0",
"changes": {
Expand Down
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Releases

## 3.13.0

### Enhancements

- `PropertyFieldCollectionData`: add `panelProps` property to collection data [#546](https://github.com/pnp/sp-dev-fx-property-controls/pull/546)
- SharePoint Framework v1.17.1 support

### Fixes

- Italian localization updated [#549](https://github.com/pnp/sp-dev-fx-property-controls/pull/549)
- Fixed multiple typos [#550](https://github.com/pnp/sp-dev-fx-property-controls/pull/550)
- Swedish localization updated [#553](https://github.com/pnp/sp-dev-fx-property-controls/pull/553)
- `PropertyPanePropertyEditor`: crash when property undefined/null [#552](https://github.com/pnp/sp-dev-fx-property-controls/pull/552)

### Contributors

Special thanks to our contributors (in alphabetical order): [Chad Eiserloh](https://github.com/c-eiser13), [Gitwey](https://github.com/Gitwey), [Jake Stanger](https://github.com/JakeStanger), [Luca3082](https://github.com/Luca3082), [Valeras Narbutas](https://github.com/ValerasNarbutas).

## 3.12.0

### Enhancements
Expand Down
18 changes: 18 additions & 0 deletions docs/documentation/docs/about/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Releases

## 3.13.0

### Enhancements

- `PropertyFieldCollectionData`: add `panelProps` property to collection data [#546](https://github.com/pnp/sp-dev-fx-property-controls/pull/546)
- SharePoint Framework v1.17.1 support

### Fixes

- Italian localization updated [#549](https://github.com/pnp/sp-dev-fx-property-controls/pull/549)
- Fixed multiple typos [#550](https://github.com/pnp/sp-dev-fx-property-controls/pull/550)
- Swedish localization updated [#553](https://github.com/pnp/sp-dev-fx-property-controls/pull/553)
- `PropertyPanePropertyEditor`: crash when property undefined/null [#552](https://github.com/pnp/sp-dev-fx-property-controls/pull/552)

### Contributors

Special thanks to our contributors (in alphabetical order): [Chad Eiserloh](https://github.com/c-eiser13), [Gitwey](https://github.com/Gitwey), [Jake Stanger](https://github.com/JakeStanger), [Luca3082](https://github.com/Luca3082), [Valeras Narbutas](https://github.com/ValerasNarbutas).

## 3.12.0

### Enhancements
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PropertyFieldFolderPicker control

This control allows you to explore and select a folder from the propery pane.
This control allows you to explore and select a folder from the property pane.
It also allows the user to create a new folder at the current level being explored.

Here is an example of the control:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface IPropertyControlsTestWebPartProps {

```TypeScript
PropertyFieldChoiceGroupWithCallout('choiceGroupWithCalloutValue', {
calloutContent: React.createElement('div', {}, 'Select preferrable mobile platform'),
calloutContent: React.createElement('div', {}, 'Select preferable mobile platform'),
calloutTrigger: CalloutTriggers.Hover,
key: 'choiceGroupWithCalloutFieldId',
label: 'Preferred mobile platform',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ The `PropertyFieldCollectionData` control can be configured with the following p
| disableItemDeletion | boolean | no | Allows you to specify if users can delete already inserted items. | false |
| panelClassName | string | no | Allows you to specify a custom CSS class name for the collection data panel. | |
| tableClassName | string | no | Allows you to specify a custom CSS class name for the collection data table inside the panel. | |
| panelProps | IPanelProps | no | Allows you to pass in props of the panel such as type and size to control the underlying panel. | |

Interface `ICustomCollectionField`

Expand All @@ -152,7 +153,7 @@ Interface `ICustomCollectionField`
| required | boolean | no | Specify if the field is required. |
| options | [IDropdownOption[]](https://developer.microsoft.com/en-us/fabric#/components/dropdown) \| (fieldId: string, item: any) => IDropdownOption[] | no | Dropdown options. Only necessary when dropdown type is used. Options can be either a static array or a function that will calculate the values dynamically and can react to the current item. |
| onRenderOption | IRenderFunction<ISelectableOption> | no | Dropdown custom options render method. Only for the **dropdown** field type. |
| placeholder | string | no | Placehoder text which will be used for the input field. If not provided the input title will be used. |
| placeholder | string | no | Placeholder text which will be used for the input field. If not provided the input title will be used. |
| defaultValue | any | no | Specify a default value for the input field. |
| deferredValidationTime | number | no | Field will start to validate after users stop typing for `deferredValidationTime` milliseconds. Default: 200ms. |
| onGetErrorMessage | (value: any, index: number, crntItem: any): string \| Promise<string> | no | The method is used to get the validation error message and determine whether the input value is valid or not. It provides you the current row index and the item you are currently editing. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The `PropertyFieldListPicker` control can be configured with the following prope
| disabled | boolean | no | Specify if the control needs to be disabled. |
| context | BaseComponentContext | yes | Context of the current web part. |
| selectedList | string \| string[] \| IPropertyFieldList \| IPropertyFieldList[] | no | Initial selected list set of the control. |
| baseTemplate | number | no | BaseTemplate ID of the lists or libaries you want to return. |
| baseTemplate | number | no | BaseTemplate ID of the lists or libraries you want to return. |
| includeHidden | boolean | no | Specify if you want to include hidden lists in the list picker. By default this is set to `true`. |
| orderBy | PropertyFieldListPickerOrderBy | no | Specify the property on which you want to order the retrieve set of lists. |
| multiSelect | boolean | no | Specify if you want to have a single or multi-list picker. By default this is set to `false` (single list picker). |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The `PropertyFieldMonacoEditor` control can be configured with the following pro
| theme | string | no | 'vs-dark' |
| readOnly | boolean | no | editor is read only |
| showLineNumbers | boolean | no | Show line number - default no |
| showMiniMap | boolean | no | Show Mini Map - deafault yes |
| showMiniMap | boolean | no | Show Mini Map - default yes |
| onChange | (newValue:string) => void; | no | If set, this method is used to get the the input value when it changed |
| language | string | yes | language, please see https://microsoft.github.io/monaco-editor/index.html for all supported languages |
| jsonDiagnosticsOptions | monaco.languages.json.DiagnosticsOptions | no | see https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.json.DiagnosticsOptions.html |
Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/docs/controls/PropertyFieldOrder.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ PropertyFieldOrder("orderedItems", {
onPropertyChange: this.onPropertyPaneFieldChanged
})
```
![Customized item display using the onRenerItem callback property](../assets/order-onRenderItem.png)
![Customized item display using the onRenderItem callback property](../assets/order-onRenderItem.png)

## Implementation

Expand All @@ -111,7 +111,7 @@ The `PropertyFieldOrder` control can be configured with the following properties
| label | string | yes | Property field label displayed on top. |
| items | Array<any> | yes | An array of values to reorder. |
| textProperty | string | no | The property to use for display, when undefined, the toString() method of the object is used (ignored when the onRenderItem function is specified) |
| maxHeight | number | no | The maximun height for the items in px (when not set, the control expands as necessary) |
| maxHeight | number | no | The maximum height for the items in px (when not set, the control expands as necessary) |
| disabled | boolean | no | Specify if the control needs to be disabled. |
| disableDragAndDrop | boolean | no | When true, drag and drop reordering is disabled (defaults to false) |
| removeArrows | boolean | no | When true, arrow buttons are not displayed (defaults to false) |
Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/docs/controls/PropertyFieldPeoplePicker.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,13 @@ The `PropertyFieldPeoplePicker` control can be configured with the following pro
| label | string | yes | Property field label displayed on top. |
| disabled | boolean | no | Specify if the control needs to be disabled. |
| context | BaseComponentContext | yes | Context of the current web part. |
| initialData | IPropertyFieldGroupOrPerson[] | no | Intial data to load in the people picker (optional). |
| initialData | IPropertyFieldGroupOrPerson[] | no | Initial data to load in the people picker (optional). |
| allowDuplicate | boolean | no | Defines if the People Picker allows to select duplicated users (optional). |
| multiSelect | boolean | no | Define if you want to allow multi user / group selection. (optional, true by default). |
| principalType | PrincipalType[] | no | Define which type of data you want to retrieve: User, SharePoint groups, Security groups. Multiple are possible. |
| onPropertyChange | function | yes | Defines a onPropertyChange function to raise when the date gets changed. |
| properties | any | yes | Parent web part properties, this object is use to update the property value. |
| targetSiteUrl | string | no | Specify the URL of the target site from which you want to retreive the users/groups. |
| targetSiteUrl | string | no | Specify the URL of the target site from which you want to retrieve the users/groups. |
| key | string | yes | An unique key that indicates the identity of this control. |
| onGetErrorMessage | function | no | The method is used to get the validation error message and determine whether the input value is valid or not. See [this documentation](https://dev.office.com/sharepoint/docs/spfx/web-parts/guidance/validate-web-part-property-values) to learn how to use it. |
| deferredValidationTime | number | no | Control will start to validate after users stop typing for `deferredValidationTime` milliseconds. Default value is 200. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The `PropertyFieldRoleDefinitionPicker` control can be configured with the follo
| webAbsoluteUrl | string | no | Absolute Web Url of target site (user requires permissions) |
| required | boolean | no | Sets the label to inform that the value is required. |
| disabled | boolean | no | Specifies if the picker button is disabled |
| roleDefinitions | IRoleDefinitionInformation[] | yes | The value of selected role defintions
| roleDefinitions | IRoleDefinitionInformation[] | yes | The value of selected role definitions
| multiSelect | boolean | no | Specify if you want to have a single or multi-select role definition picker. By default this is set to `true` (multi-select role picker). |
| selectedRoleDefinition | string[] | no | Pre-selected role definitions for the picker control
| roleDefinitionsToExclude | string[] | no | Role definitions to be excluded from the picker control
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The `PropertyFieldSitePicker` control can be configured with the following prope
| label | string | yes | Property field label displayed on top. |
| disabled | boolean | no | Specify if the control needs to be disabled. |
| context | BaseComponentContext | yes | Context of the current web part. |
| initialSites | IPropertyFieldSite[] | no | Intial sites to load in the site picker (optional). |
| initialSites | IPropertyFieldSite[] | no | Initial sites to load in the site picker (optional). |
| multiSelect | boolean | no | Define if you want to allow multiple sites selection. (optional, false by default). |
| onPropertyChange | function | yes | Defines a `onPropertyChange` function to raise when the sites get changed. |
| properties | any | yes | Parent web part properties, this object is use to update the property value. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The `PropertyFieldSliderWithCallout` control uses the same implementation as the
| calloutWidth | number | no | Custom width for callout including borders. If value is 0, no width is applied. |
| calloutTrigger | CalloutTriggers | no | Event to show the callout |
| gapSpace | number | no | The gap between the callout and the target |
| debounce | number | no | Time specified in miliseconds after which the onChanged handler is going to be called. |
| debounce | number | no | Time specified in milliseconds after which the onChanged handler is going to be called. |

Enum `CalloutTriggers`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Interface `IPickerTerms`

`PropertyFieldEnterpriseTermPicker` is implemented to be used for "enterprise" Term Stores with large amount of groups, terms sets, and terms. It loads term sets and terms on demand - only at the moment when specified group or term set has been expanded in the Term Store Tree.
To implement on-demand loading `PropertyFieldEnterpriseTermPicker` uses `@pnp/sp-taxonomy` module from `@pnp/pnpjs` library. It increases the size of a bundle when the control is used.
Additionaly, `PropertyFieldEnterpriseTermPicker` allows to request labels for the terms in the picker.
Additionally, `PropertyFieldEnterpriseTermPicker` allows to request labels for the terms in the picker.

`PropertyFieldTermPicker` loads all the groups and term sets from the term service during the initial request. This approach fits most of the scenarios with small and medium number of objects in a term store. Besides that, `PropertyFieldTermPicker` does not use any additional libraries or modules to retrieve data from the taxonomy service which makes it much more lightweight option in comparison with `PropertyFieldEnterpriseTermPicker`. See [PropertyFieldTermPicker](./PropertyFieldTermPicker) for implementation details.

Expand Down
Loading

0 comments on commit e2a83ec

Please sign in to comment.