Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show item base classes #1591

Merged
merged 5 commits into from
Nov 13, 2024
Merged

Conversation

AndrewKeepCoding
Copy link
Contributor

@AndrewKeepCoding AndrewKeepCoding commented Jul 22, 2024

Description

Shows the base classes of each control/element.

Motivation and Context

This will help devs understand the inheritance structure of WinUI controls/elements.

How Has This Been Tested?

Tested on VS.

Screenshots (if appropriate):

image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

@karkarl
Copy link
Collaborator

karkarl commented Jul 22, 2024

Thanks for the PR, this is an awesome addition!

I think the breadcrumb bar should be below the header, since it's not for navigating and purely for informative purposes. @niels9001

@niels9001
Copy link
Contributor

Oooh I like this.. agree with @karkarl that having it below the title makes more sense.

That being said, I think the page header is starting to become pretty info heavy.

image

I wonder if the inheritance and namespace should live under a button+flyout? It's relevant information, but also not critical information. Thoughts @AndrewKeepCoding @karkarl ?

@AndrewKeepCoding
Copy link
Contributor Author

AndrewKeepCoding commented Jul 23, 2024

@karkarl Thanks for the feedback.
Changed the order and here is how it looks:
image

@AndrewKeepCoding
Copy link
Contributor Author

I wonder if the inheritance and namespace should live under a button+flyout? It's relevant information, but also not critical information.

@niels9001 I agree. There's a lot of text around there. But IMHO, I thought it'd be better for devs, especially the new ones in WinUI, that this inheritance info just gets into their eyes.

@marcelwgn
Copy link
Contributor

I wonder if the inheritance and namespace should live under a button+flyout? It's relevant information, but also not critical information.

@niels9001 I agree. There's a lot of text around there. But IMHO, I thought it'd be better for devs, especially the new ones in WinUI, that this inheritance info just gets into their eyes.

I might be an outlier with this position, but I don't think new devs really need to have that information often. There are very few situations where one wouldn't derive from UserControl/Control (which the new control templates already do). Out of curiosity, in which situation would this information would have been helpful to you @AndrewKeepCoding? 😃

@AndrewKeepCoding
Copy link
Contributor Author

AndrewKeepCoding commented Jul 23, 2024

Out of curiosity, in which situation would this information would have been helpful to you @AndrewKeepCoding? 😃

@marcelwgn
Now that I've been working with WinUI for a couple of years, I might not consider this feature that helpful. But when I started working with WinUI 3, with no experience on WPF or UWP, I remember that learning the inheritance of the elements helped me understand the framework better.

Might sound stupid and maybe it's just me, but for example, I remember I was assuming that RichTextBox, AutoSuggestBox and NumberBox derive from TextBox. 😅 After I learned that they are totally different controls, I tend to check out the inheritance of controls/elements when I use them by going all the way to the docs.

That's why I thought this feature would be good for devs new to WinUI.

I totally understand your opinions guys. Let me know if you want to close this or modify it to a less texty way. 🙂

@karkarl
Copy link
Collaborator

karkarl commented Aug 27, 2024

Perhaps it can mirror the msdn format, and be placed under the control description?

image

@AndrewKeepCoding
Copy link
Contributor Author

AndrewKeepCoding commented Aug 30, 2024

I didn't push the commit yet but looks like this:

image

@karkarl
Copy link
Collaborator

karkarl commented Sep 27, 2024

I think that looks great! Can you push the commit?

@AndrewKeepCoding
Copy link
Contributor Author

@karkarl Done.

@karkarl
Copy link
Collaborator

karkarl commented Nov 13, 2024

/azp run

@karkarl karkarl merged commit 60816c3 into microsoft:main Nov 13, 2024
2 checks passed
@AndrewKeepCoding AndrewKeepCoding deleted the show-item-base-classes branch November 14, 2024 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants