Skip to content
This repository was archived by the owner on Jun 21, 2023. It is now read-only.

Commit 2ad7b46

Browse files
authored
Merge pull request #1025 from github/feature/inline-reviews-tooltip
Preview inline-comments as tooltip
2 parents d9116de + d3559c6 commit 2ad7b46

13 files changed

+358
-9
lines changed

src/GitHub.InlineReviews/GitHub.InlineReviews.csproj

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,11 @@
9292
<Compile Include="Peek\InlineCommentPeekResultPresentation.cs" />
9393
<Compile Include="Peek\InlineCommentPeekResultPresenter.cs" />
9494
<Compile Include="Properties\AssemblyInfo.cs" />
95+
<Compile Include="Resources.Designer.cs">
96+
<AutoGen>True</AutoGen>
97+
<DesignTime>True</DesignTime>
98+
<DependentUpon>Resources.resx</DependentUpon>
99+
</Compile>
95100
<Compile Include="SampleData\CommentThreadViewModelDesigner.cs" />
96101
<Compile Include="SampleData\DiffCommentThreadViewModelDesigner.cs" />
97102
<Compile Include="SampleData\PullRequestCommentsViewModelDesigner.cs" />
@@ -114,6 +119,10 @@
114119
<Compile Include="ViewModels\IPullRequestCommentsViewModel.cs" />
115120
<Compile Include="ViewModels\IssueCommentThreadViewModel.cs" />
116121
<Compile Include="ViewModels\PullRequestCommentsViewModel.cs" />
122+
<Compile Include="ViewModels\TooltipCommentThreadViewModel.cs" />
123+
<Compile Include="Views\TooltipCommentThreadView.xaml.cs">
124+
<DependentUpon>TooltipCommentThreadView.xaml</DependentUpon>
125+
</Compile>
117126
<Compile Include="Views\DiffCommentThreadView.xaml.cs">
118127
<DependentUpon>DiffCommentThreadView.xaml</DependentUpon>
119128
</Compile>
@@ -379,13 +388,21 @@
379388
</VSCTCompile>
380389
</ItemGroup>
381390
<ItemGroup>
391+
<EmbeddedResource Include="Resources.resx">
392+
<Generator>PublicResXFileCodeGenerator</Generator>
393+
<LastGenOutput>Resources.Designer.cs</LastGenOutput>
394+
</EmbeddedResource>
382395
<EmbeddedResource Include="VSPackage.resx">
383396
<MergeWithCTO>true</MergeWithCTO>
384397
<ManifestResourceName>VSPackage</ManifestResourceName>
385398
<SubType>Designer</SubType>
386399
</EmbeddedResource>
387400
</ItemGroup>
388401
<ItemGroup>
402+
<Page Include="Views\TooltipCommentThreadView.xaml">
403+
<Generator>MSBuild:Compile</Generator>
404+
<SubType>Designer</SubType>
405+
</Page>
389406
<Page Include="Views\DiffCommentThreadView.xaml">
390407
<SubType>Designer</SubType>
391408
<Generator>MSBuild:Compile</Generator>

src/GitHub.InlineReviews/Resources.Designer.cs

Lines changed: 81 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="CommentTooltipStatusMessage" xml:space="preserve">
121+
<value>Click to reply</value>
122+
</data>
123+
<data name="CommentTooltipStatusOverflowMessage" xml:space="preserve">
124+
<value>Click to reply or view more (showing most recent of {0} comments)</value>
125+
</data>
126+
</root>

src/GitHub.InlineReviews/SampleData/CommentViewModelDesigner.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
using System;
22
using System.Reactive;
3+
using ReactiveUI;
34
using GitHub.InlineReviews.ViewModels;
45
using GitHub.Models;
56
using GitHub.SampleData;
67
using GitHub.UI;
7-
using ReactiveUI;
88

99
namespace GitHub.InlineReviews.SampleData
1010
{

src/GitHub.InlineReviews/Tags/InlineCommentGlyphFactory.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ static Brush GetBackground(ResourceDictionary dictionary)
6969
public UIElement GenerateGlyph(IWpfTextViewLine line, InlineCommentTag tag)
7070
{
7171
var glyph = CreateGlyph(tag);
72+
glyph.Tag = tag;
73+
7274
glyph.MouseLeftButtonUp += (s, e) =>
7375
{
7476
if (OpenThreadView(tag)) e.Handled = true;

src/GitHub.InlineReviews/Tags/ShowInlineCommentGlyph.xaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
44
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
55
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
6-
mc:Ignorable="d">
6+
mc:Ignorable="d"
7+
ToolTipService.ShowDuration="600000" ToolTipService.HasDropShadow="True">
8+
<UserControl.ToolTip>
9+
<ToolTip x:Name="CommentToolTip" />
10+
</UserControl.ToolTip>
711
<Viewbox>
812
<Path Stroke="Black"
913
Data="M13 2H1c-0.55 0-1 0.45-1 1v8c0 0.55 0.45 1 1 1h2v3.5l3.5-3.5h6.5c0.55 0 1-0.45 1-1V3c0-0.55-0.45-1-1-1z m0 9H6L4 13V11H1V3h12v8z"/>

src/GitHub.InlineReviews/Tags/ShowInlineCommentGlyph.xaml.cs

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
using System;
22
using System.Windows.Controls;
3+
using GitHub.InlineReviews.Views;
4+
using GitHub.InlineReviews.ViewModels;
5+
using System.Linq;
6+
using GitHub.Models;
37

48
namespace GitHub.InlineReviews.Tags
59
{
@@ -10,5 +14,26 @@ public ShowInlineCommentGlyph()
1014
InitializeComponent();
1115
}
1216

17+
protected override void OnToolTipOpening(ToolTipEventArgs e)
18+
{
19+
var tag = Tag as ShowInlineCommentTag;
20+
var comments = tag.Thread.Comments.Select(comment => new PullRequestReviewCommentModel
21+
{
22+
User = comment.User,
23+
Body = comment.Body,
24+
CreatedAt = comment.CreatedAt
25+
});
26+
27+
var viewModel = new TooltipCommentThreadViewModel(comments);
28+
var view = new TooltipCommentThreadView();
29+
view.DataContext = viewModel;
30+
31+
CommentToolTip.Content = view;
32+
}
33+
34+
protected override void OnToolTipClosing(ToolTipEventArgs e)
35+
{
36+
CommentToolTip.Content = null;
37+
}
1338
}
1439
}

src/GitHub.InlineReviews/ViewModels/CommentThreadViewModel.cs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,10 @@ public abstract class CommentThreadViewModel : ReactiveObject, ICommentThreadVie
1717
/// <summary>
1818
/// Intializes a new instance of the <see cref="CommentThreadViewModel"/> class.
1919
/// </summary>
20-
/// <param name="currentUser">The current user.</param>
20+
/// <param name="currentUser">The current user on null if not required.</param>
2121
/// <param name="commentModels">The thread comments.</param>
22-
public CommentThreadViewModel(IAccount currentUser)
22+
public CommentThreadViewModel(IAccount currentUser = null)
2323
{
24-
Guard.ArgumentNotNull(currentUser, nameof(currentUser));
25-
2624
Comments = new ObservableCollection<ICommentViewModel>();
2725
CurrentUser = currentUser;
2826
}

src/GitHub.InlineReviews/ViewModels/CommentViewModel.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public class CommentViewModel : ReactiveObject, ICommentViewModel
2626
/// Initializes a new instance of the <see cref="CommentViewModel"/> class.
2727
/// </summary>
2828
/// <param name="thread">The thread that the comment is a part of.</param>
29-
/// <param name="currentUser">The current user.</param>
29+
/// <param name="currentUser">The current user or null if not used.</param>
3030
/// <param name="commentId">The ID of the comment.</param>
3131
/// <param name="body">The comment body.</param>
3232
/// <param name="state">The comment edit state.</param>
@@ -42,7 +42,6 @@ public CommentViewModel(
4242
DateTimeOffset updatedAt)
4343
{
4444
Guard.ArgumentNotNull(thread, nameof(thread));
45-
Guard.ArgumentNotNull(currentUser, nameof(currentUser));
4645
Guard.ArgumentNotNull(body, nameof(body));
4746
Guard.ArgumentNotNull(user, nameof(user));
4847

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using GitHub.Models;
4+
5+
namespace GitHub.InlineReviews.ViewModels
6+
{
7+
public class TooltipCommentThreadViewModel : CommentThreadViewModel
8+
{
9+
public TooltipCommentThreadViewModel(IEnumerable<IPullRequestReviewCommentModel> comments)
10+
{
11+
foreach (var comment in comments)
12+
{
13+
Comments.Add(new CommentViewModel(this, CurrentUser, comment));
14+
}
15+
}
16+
17+
public override Uri GetCommentUrl(int id)
18+
{
19+
throw new NotImplementedException();
20+
}
21+
}
22+
}

0 commit comments

Comments
 (0)