-
Notifications
You must be signed in to change notification settings - Fork 151
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #615 from pnp/dev
3.17.0 release
- Loading branch information
Showing
91 changed files
with
5,115 additions
and
3,707 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "extends": [ | ||
| "development" | ||
| ], | ||
| "hints": { | ||
| "no-inline-styles": "off" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # PropertyFieldButton control | ||
|
|
||
| This control generates a Button Control . | ||
|
|
||
| **PropertyFieldButton example usage** | ||
|
|
||
|  | ||
|
|
||
| ## How to use this control in your solutions | ||
|
|
||
| - Check that you installed the `@pnp/spfx-property-controls` dependency. Check out The [getting started](../../#getting-started) page for more information about installing the dependency. | ||
| - Import the following modules to your component: | ||
|
|
||
| ```TypeScript | ||
| import { PropertyFieldButton} from '@pnp/spfx-property-controls/lib/PropertyFieldButton'; | ||
| ``` | ||
|
|
||
| - Add the custom property control to the `groupFields` of the web part property pane configuration: | ||
|
|
||
| ```TypeScript | ||
| PropertyFieldButton("", { | ||
| text={"Button"} | ||
| key={"buttonID"} | ||
| disabled={false} | ||
| className={className} | ||
| styles={styles} | ||
| onClick={()=>{alert("Button Clicked")}} | ||
| iconProps={iconProps} | ||
| isPrimary={true} | ||
| isVIsible={true} | ||
|
|
||
| }) | ||
| ``` | ||
|
|
||
| ## Implementation | ||
|
|
||
| The `PropertyFieldButton` control can be configured with the following properties: | ||
|
|
||
| | Property | Type | Required | Description | | ||
| | --------- | -------------- | -------- | ---------------------------------------------------------- | | ||
| | key | string | yes | An unique key that indicates the identity of this control. | | ||
| | styles | IButtonStyles | no | styles object | | ||
| | classname | string | no | css ClassName | | ||
| | isVisible | boolean | yes | Indicate if button is visible | | ||
| | text | string | no | text of button | | ||
| | isPrimary | boolean | yes | indicate Button is a primary button | | ||
| | iconProps | IIconProps | no | text of button | | ||
| | disable | boolean | no | Disable control | | ||
| | onClick | (e:any) =>void | yes | Onclick function | | ||
|
|
||
|  |
146 changes: 146 additions & 0 deletions
146
docs/documentation/docs/controls/PropertyFieldContentTypePicker.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| # PropertyFieldContentTypePicker control | ||
|
|
||
| This control generates a ContentType picker field that can be used in the property pane of your SharePoint Framework web parts. | ||
|
|
||
| The control automatically retrieves the ContentType for a given SharePoint Site or selected SharePoint list: | ||
|
|
||
|  | ||
|
|
||
| ## How to use this control in your solutions | ||
|
|
||
| 1. Check that you installed the `@pnp/spfx-property-controls` dependency. Check out The [getting started](../../#getting-started) page for more information about installing the dependency. | ||
| 2. Import the following modules to your component: | ||
|
|
||
| ```TypeScript | ||
| import { PropertyFieldContentTypePicker, PropertyFieldContentTypePickerOrderBy } from '@pnp/spfx-property-controls/lib/PropertyFieldContentTypePicker'; | ||
| ``` | ||
|
|
||
| 3. You'll probably want to use this control in combination with the [PropertyFieldListPicker](./PropertyFieldListPicker.md). Make sure to select the `multiSelect` prop to `false`, as this control is designed to work with a single list. Store the list id in your web part properties, as follows: | ||
| ```TypeScript | ||
| export interface IPropertyControlsTestWebPartProps { | ||
| list: string; // Stores the list ID | ||
| } | ||
| ``` | ||
|
|
||
| 3. Create a new property for your web part, as indicated between the `BEGIN:` and `END:` comments below: | ||
|
|
||
|
|
||
| ```TypeScript | ||
| export interface IPropertyControlsTestWebPartProps { | ||
| list: string; // Stores the list ID | ||
|
|
||
| // BEGIN: Added | ||
| view: string; // Stores the view ID | ||
| contentType : string // stores the contenttype ID | ||
| // END: Added | ||
| } | ||
| ``` | ||
|
|
||
| 4. Add the custom property control to the `groupFields` of the web part property pane configuration: | ||
|
|
||
| ```TypeScript | ||
| PropertyFieldContentTypePicker('contentType', { | ||
| label: 'Select a Content Type', | ||
| context: this.context, | ||
| selectedContentType: this.properties.contentType, | ||
| disabled: false, | ||
| orderBy: PropertyFieldContentTypeOrderBy.Name, | ||
| onPropertyChange: this.onPropertyPaneFieldChanged.bind(this), | ||
| properties: this.properties, | ||
| onGetErrorMessage: null, | ||
| deferredValidationTime: 0, | ||
| key: 'contentTypePickerFieldId' | ||
| }) | ||
|
|
||
| ``` | ||
|
|
||
| 5. To fetch the contentTypes of a particular site, change the property pane configuration as follows: | ||
|
|
||
| ```TypeScript | ||
| PropertyFieldContentTypePicker('contentType', { | ||
| label: 'Select a Content Type', | ||
| context: this.context, | ||
| selectedContentType: this.properties.contentType, | ||
| disabled: false, | ||
| webAbsoluteUrl:"https://****.sharepoint.com/sites/*****", | ||
| orderBy: PropertyFieldContentTypeOrderBy.Name, | ||
| onPropertyChange: this.onPropertyPaneFieldChanged.bind(this), | ||
| properties: this.properties, | ||
| onGetErrorMessage: null, | ||
| deferredValidationTime: 0, | ||
| key: 'contentTypePickerFieldId' | ||
| }) | ||
| ``` | ||
|  | ||
|
|
||
| 6. To fetch the contentTypes of selected list, change the property pane configuration as follows: | ||
|
|
||
| ```TypeScript | ||
| PropertyFieldContentTypePicker('contentType', { | ||
| label: 'Select a Content Type', | ||
| context: this.context, | ||
| selectedContentType: this.properties.contentType, | ||
| listId: {list-guid} //"0da3b4b7-8ebd-4f15-87ee-afae5cacadad" | ||
| disabled: false, | ||
| orderBy: PropertyFieldContentTypeOrderBy.Name, | ||
| onPropertyChange: this.onPropertyPaneFieldChanged.bind(this), | ||
| properties: this.properties, | ||
| onGetErrorMessage: null, | ||
| deferredValidationTime: 0, | ||
| key: 'contentTypePickerFieldId' | ||
| }) | ||
|
|
||
| ``` | ||
|
|
||
|  | ||
|
|
||
| 7. If ListID specified in the propertiesc is not available in the selected site, the control will error out as follows | ||
| ```TypeScript | ||
| PropertyFieldContentTypePicker('contentType', { | ||
| label: 'Select a Content Type', | ||
| context: this.context, | ||
| selectedContentType: this.properties.contentType, | ||
| listId: {list-guid} //"0da3b4b7-8ebd-4f15-87ee-afae5cacadad" | ||
| disabled: false, | ||
| orderBy: PropertyFieldContentTypeOrderBy.Name, | ||
| onPropertyChange: this.onPropertyPaneFieldChanged.bind(this), | ||
| properties: this.properties, | ||
| onGetErrorMessage: null, | ||
| deferredValidationTime: 0, | ||
| key: 'contentTypePickerFieldId' | ||
| }) | ||
|
|
||
| ``` | ||
|  | ||
|
|
||
| ## Implementation | ||
|
|
||
| The `PropertyFieldContentTypePicker` control can be configured with the following properties: | ||
|
|
||
| | Property | Type | Required | Description | | ||
| | ---- | ---- | ---- | ---- | | ||
| | label | string | yes | Property field label displayed on top. | | ||
| | listId | string | no | The ID of the list or library you wish to select a contentType from. | | ||
| | disabled | boolean | no | Specify if the control needs to be disabled. | | ||
| | context | BaseComponentContext | yes | Context of the current web part. | | ||
| | selectedContentType | string | string[] | no | IDefines ContentType titles which should be excluded from the ContentType picker control. | | ||
| | orderBy | PropertyFieldContentTypeOrderBy | no | Specify the property on which you want to order the retrieve set of ContentTypes. | | ||
| | webAbsoluteUrl | string | no | Absolute Web Url of target site (user requires permissions) | | ||
| | 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. | | ||
| | 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. | | ||
| | contentTypesToExclude | string[] | no | Defines contentTypes by which should be excluded from the contentType picker control. You can specify contentType titles or IDs | | ||
| | filter | string | no | Filter contentTypes from OData query. | | ||
| | onContentTypesRetrieved | (contentType: ISPContentType[]) => PromiseLike<ISPContentType[]> \| ISPContentType[] | no | Callback that is called before the dropdown is populated. | | ||
|
|
||
|
|
||
| Enum `PropertyFieldContentTypePickerOrderBy` | ||
|
|
||
| | Name | Description | | ||
| | ---- | ---- | | ||
| | Id | Sort by contentType ID | | ||
| | Title | Sort by contentType title | | ||
|
|
||
|  |
Oops, something went wrong.