Added custom property pane controls tutorial #285
Conversation
|
Hi @waldekmastykarz, I'm your friendly neighborhood Microsoft Pull Request Bot (You can call me MSBOT). Thanks for your contribution! The agreement was validated by Microsoft and real humans are currently evaluating your PR. TTYL, MSBOT; |
|
@manishgarg1 can you please review the doc and let us know if any changes to be made? Thanks! |
|
|
||
| ```ts | ||
| export interface IListItemsWebPartProps { | ||
| list: string; |
There was a problem hiding this comment.
Should this be listName for clarity?
There was a problem hiding this comment.
Sure thing, it would make its purpose clearer indeed.
| Welcome to SharePoint! | ||
| </span> | ||
| <p className='ms-font-l ms-fontColor-white'> | ||
| Customize SharePoint experiences using Web Parts. |
There was a problem hiding this comment.
I am assuming that these strings are not localized on purpose. Though I would recommend that we make it a habit to localize these in every sample. That will set consistent patterns.
There was a problem hiding this comment.
These are standard strings the way they are being provided by the template. From the tutorial point of view I think it would be good to avoid any changes unrelated to the tutorial to make it clear what's necessary to accomplish the given task versus what's a general good practice.
|
Hi @waldekmastykarz I'll be doing a voice edit pass on the article. Thanks! |
|
@waldekmastykarz thanks for merging the edits! There's only a couple more comments at the top of the file to look at. Thanks! |
|
@davidchesnut you mean the comment from @manishgarg1 about changing |
There was a problem hiding this comment.
@waldekmastykarz can you please review these two comments. Thanks!
| @@ -0,0 +1,827 @@ | |||
| # Build custom property pane controls | |||
There was a problem hiding this comment.
Could we call this "Build custom controls for the property pane"? I was thinking that for SEO purposes that developers might search for "custom control" attempting to find the info in this article. Would need to change this throughout the article.
There was a problem hiding this comment.
Sure thing. Good idea!
|
|
||
| > **Note:** The SharePoint Framework is currently in preview and is subject to change. SharePoint Framework client-side web parts are not currently supported for use in production environments. | ||
|
|
||
| The SharePoint Framework offers you a number of standard controls to be used for configuring web part properties in the property pane. If your web part requires a specific user interface for its configuration, beyond what is available in the SharePoint Framework, you can build a custom property pane control and use it in your web part. Custom property pane controls allow you to provide your users with an intuitive and rich interface for configuring how the web part should work. In this article you will learn how to build a custom property pane control that is a custom dropdown control that loads its data asynchronously from an external service without blocking the user interface in the web part. |
There was a problem hiding this comment.
@waldekmastykarz A suggested change to tighten up the wording and intent of this introduction. I pasted the text below, and if you like this rewrite, or want to suggest changes I can add it. Basically I'm trying to use as few words as possible to show the scenarios about why a developer would want to read this article (the intent.)
The SharePoint Framework contains a set of standard controls for the property pane. But sometimes you need additional functionality beyond the basic controls. You might need asynchronous updates to the data on a control, or a specific user interface. Build a custom control for the property pane to get the functionality you need.
In this article you will learn how to build a custom control for the property pane. You will build a custom dropdown control that loads its data asynchronously from an external service without blocking the user interface of the web part.
There was a problem hiding this comment.
Sounds good! Let's take it :D
|
Hi @davidchesnut, are there any other changes to the content from your side? If not, then I could gather the changes that we have so far and apply them so that we can merge the PR :) |
|
@waldekmastykarz no more changes from my side. Please go ahead and apply the changes so far. Thanks! |
|
Excellent! Thank you @davidchesnut! |
|
thx @waldekmastykarz and @davidchesnut, getting this forward now. |
What's in this Pull Request?
Tutorial about building custom web part property pane controls