Deprecating PullToRefreshListView for controls available in next Windows release #1981

kbrons · 2018-04-17T13:41:20Z

Issue: #1946

PR Type

What kind of change does this PR introduce?

Feature

Build or CI related changes
Documentation content changes
Sample app changes

What is the current behavior?

See #1946

What is the new behavior?

The developer can enable the native controls when available (see pull-to-refresh)

PR Checklist

Please check if your PR fulfills the following requirements:

Tested code with current supported SDKs
Docs have been added/updated which fit documentation template. (for bug fixes / features)
Sample in sample app has been added / updated (for bug fixes / features)
- Icon has been created (if new sample) following the Thumbnail Style Guide and templates
Tests for the changes have been added (for bug fixes / features) (if applicable)
Header has been added to all new source files (run build/UpdateHeaders.bat)
Contains NO breaking changes

Other information

For this implementation to work, the sample app had to be updated to the latest Insider's SDK (Build 17125).

…used properties and refreshcancelled event

Odonno · 2018-04-17T14:58:10Z

@kbrons Can you rename the title of this PR so everyone can understand what this is about in a glimpse?

kbrons · 2018-04-17T15:06:38Z

Sure thing, I forgot to change it when I created the PR. Thanks for letting me know!

michael-hawker · 2018-04-17T16:32:45Z

Directory.Build.props

@@ -23,7 +23,7 @@


    <UwpMetaPackageVersion>5.4.1</UwpMetaPackageVersion>
-    <DefaultTargetPlatformVersion>16299</DefaultTargetPlatformVersion>
+    <DefaultTargetPlatformVersion>17125</DefaultTargetPlatformVersion>


We should probably wait until the final SDK release and do this once, eh?

Yeah, I had to change it because the app would crash when trying to use the native control otherwise. Maybe we could remove the code to enable the feature and leave a PR with it to merge when the final SDK is released, along with this update. What do you think?

@nmetulev thoughts?

michael-hawker · 2018-04-17T16:33:19Z

Microsoft.Toolkit.Uwp.UI.Controls/PullToRefreshListView/PullToRefreshListView.cs

@@ -33,6 +34,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls
    [TemplatePart(Name = PartIndicatorTransform, Type = typeof(CompositeTransform))]
    [TemplatePart(Name = PartDefaultIndicatorContent, Type = typeof(TextBlock))]
    [TemplatePart(Name = PullAndReleaseIndicatorContent, Type = typeof(ContentPresenter))]
+    [Obsolete("The PullToRefreshListView will be removed in a future major release. Please use the RefreshContainer control available in the 1803 version of Windows")]


Is the sample already marked deprecated as well?

I just noticed I updated most of the documentation, but forgot to add the badge for the menu and the disclaimer on top of the page in the sample app. I'll add them as soon as I can.

Just added the badge and the deprecated message to the menu, also the deprecation warning on the page.

nmetulev

I haven't tested this yet, just few things I noticed.

I don't think appveyor is setup to build with an insider sdk, so we are going to have to wait until 1803 is released to merge this

nmetulev · 2018-04-17T20:23:15Z

Microsoft.Toolkit.Uwp.UI.Controls/PullToRefreshListView/PullToRefreshListView.cs

+        private ControlTemplate _previousTemplateUsed;
+        private RefreshContainer _refreshContainer;
+
+        private bool UsingRefreshContainer => IsRefreshContainerSupported && UseRefreshContainerWhenPossible;


Should start with _ and lowercase

nmetulev · 2018-04-17T20:27:05Z

docs/controls/PullToRefreshListview.md

@@ -45,7 +48,42 @@ be raised and the *RefreshIntentCanceledCommand*, if any, will be executed.

 [PullToRefreshListView Sample Page](https://github.com/Microsoft/UWPCommunityToolkit/tree/master/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/PullToRefreshListView)

-## Default Template 
+## <a name="refreshcontainer"></a> Moving to RefreshContainer
+The (soon to be released) 1803 version of Windows now includes its own implementation of [pull-to-refresh](https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/pull-to-refresh) controls, having [RefreshContainer](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.refreshcontainer) as the main control.


1803 will be released when 3.0 is released, remove "soon to be released"

nmetulev · 2018-04-17T20:27:54Z

docs/controls/PullToRefreshListview.md

+## <a name="refreshcontainer"></a> Moving to RefreshContainer
+The (soon to be released) 1803 version of Windows now includes its own implementation of [pull-to-refresh](https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/pull-to-refresh) controls, having [RefreshContainer](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.refreshcontainer) as the main control.
+
+The PullToRefreshListView and the RefreshContainer share the same concepts and provide mostly the same functionality, with the caveats that the RefreshContainer works only with a touch interface and it's not as customizable as the PullToRefreshListView.


remove "it's not as customizable as the PullToRefreshListView"

nmetulev · 2018-04-17T20:28:44Z

docs/controls/PullToRefreshListview.md

+Being a touch-only control, it's recommended that you also have a refresh button for users without a touch interface. You can trigger the RefreshRequested event by calling the RefreshContainer's RequestRefresh method.
+
+### Making the transition even easier
+Starting with v3 of the UWP Community Toolkit, the PullToRefreshListView provides a new property called **UseRefreshContainerWhenPossible**. Setting the value to true will force the PullToRefreshListView to use a template based on the RefreshContainer when running on the 1803 version of Windows and above, and the regular template otherwise.


should be v3.0

windowstoolkitbot · 2018-04-30T01:13:32Z

This PR is linked to unclosed issues. Please check if one of these issues should be closed: #1946

Kevin added 9 commits April 17, 2018 09:53

Updated target platform

b083b4b

Moved PullToRefreshListView default template to new file

d969d6e

Fixed template separation

07f8636

Added template with Refresh Container

a769c69

Implemented switching between templates

e974de0

Implemented RefreshRequested action for RefreshContainer control

3bdbc1a

Added the obsolete attribute to the PullToRefreshListView

9aecc18

Started adding RefreshContainer documentation, pending notes about un…

7566dbd

…used properties and refreshcancelled event

Added missing items to documentation

609c738

kbrons changed the title ~~Feature/1946~~ Deprecating PullToRefreshListView for controls available in next Windows release Apr 17, 2018

michael-hawker reviewed Apr 17, 2018

View reviewed changes

Added deprecated badge and message in sample app menu

66207b8

michael-hawker added controls 🎛️ reviewers wanted labels Apr 17, 2018

nmetulev requested changes Apr 17, 2018

View reviewed changes

Kevin added 5 commits April 18, 2018 10:09

Documentation changes

7c9ea84

Renamed UsingRefreshContainer to _usingRefreshContainer

456ba9d

Added DeprecatedWarning to sample app page

7be79d2

Fixed bug when switching templates too many times

a7b5694

Added deprecated warning ignore to sample app page

e538564

nmetulev changed the base branch from master to rel/3.0.0-preview April 24, 2018 19:36

michael-hawker approved these changes Apr 26, 2018

View reviewed changes

Merge branch 'rel/3.0.0-preview' into feature/1946

252eab9

nmetulev approved these changes Apr 30, 2018

View reviewed changes

nmetulev merged commit 4fd0046 into CommunityToolkit:rel/3.0.0-preview Apr 30, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecating PullToRefreshListView for controls available in next Windows release #1981

Deprecating PullToRefreshListView for controls available in next Windows release #1981

kbrons commented Apr 17, 2018 •

edited

Loading

Odonno commented Apr 17, 2018

kbrons commented Apr 17, 2018

michael-hawker Apr 17, 2018

kbrons Apr 17, 2018

michael-hawker Apr 17, 2018

michael-hawker Apr 17, 2018

kbrons Apr 17, 2018

kbrons Apr 18, 2018

nmetulev left a comment

nmetulev Apr 17, 2018

nmetulev Apr 17, 2018

nmetulev Apr 17, 2018

nmetulev Apr 17, 2018

windowstoolkitbot commented Apr 30, 2018

Deprecating PullToRefreshListView for controls available in next Windows release #1981

Deprecating PullToRefreshListView for controls available in next Windows release #1981

Conversation

kbrons commented Apr 17, 2018 • edited Loading

PR Type

What is the current behavior?

What is the new behavior?

PR Checklist

Other information

Odonno commented Apr 17, 2018

kbrons commented Apr 17, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nmetulev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

windowstoolkitbot commented Apr 30, 2018

kbrons commented Apr 17, 2018 •

edited

Loading