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

Clarify the relationship between IsVisible and the visual tree in .NET MAUI documentation #2666

Closed
bhavanesh2001 opened this issue Dec 6, 2024 · 0 comments · Fixed by #2713
Assignees
Labels
doc-enhancement Improve the current content [org] dotnet-maui/subsvc dotnet-mobile/svc Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.

Comments

@bhavanesh2001
Copy link
Contributor

bhavanesh2001 commented Dec 6, 2024

Type of issue

Missing information

Description

The current documentation in the Performance Best Practices for .NET MAUI article states:

"The IsVisible property of each element determines whether the element should be part of the visual tree or not."

This statement can be misleading because, in reality:

Setting IsVisible to false does not remove the element from the visual tree.
The element remains in the visual tree but is excluded from rendering and layout calculations.
This is inconsistent with the more accurate explanation in the VisualElement.IsVisible API documentation, which states:

"Gets or sets a value that determines whether this element will be visible on screen and take up space in layouts."

Suggested Action:

Clarify the performance article to specify that setting IsVisible to false excludes the element from rendering and layout calculations but keeps it in the visual tree for faster toggling.
This clarification would prevent misunderstandings about the behavior of the IsVisible property.

Page URL

https://learn.microsoft.com/en-us/dotnet/maui/deployment/performance?view=net-maui-9.0#reduce-the-visual-tree-size

Content source URL

https://github.com/dotnet/docs-maui/blob/main/docs/deployment/performance.md

Document Version Independent Id

5845bd05-2151-862c-9b29-1d76664a9f0d

Article author

@davidbritch

Metadata

  • ID: 5845bd05-2151-862c-9b29-1d76664a9f0d
  • Service: dotnet-mobile
  • Sub-service: dotnet-maui

Related Issues


Associated WorkItem - 359140

@dotnetrepoman dotnetrepoman bot added the ⌚ Not Triaged Not triaged label Dec 6, 2024
@issues-automation issues-automation bot added dotnet-maui/subsvc dotnet-mobile/svc Pri1 High priority, do before Pri2 and Pri3 labels Dec 6, 2024
@davidbritch davidbritch added the doc-enhancement Improve the current content [org] label Dec 20, 2024
@dotnetrepoman dotnetrepoman bot removed the ⌚ Not Triaged Not triaged label Dec 20, 2024
@davidbritch davidbritch self-assigned this Dec 20, 2024
@davidbritch davidbritch added the 🗺️ reQUEST Triggers an issue to be imported into Quest. label Jan 2, 2025
@sequestor sequestor bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Jan 2, 2025
@davidbritch davidbritch moved this from Todo to In Progress in dotnet/docs-maui 2025 Sprints Jan 7, 2025
@github-project-automation github-project-automation bot moved this from In Progress to Done in dotnet/docs-maui 2025 Sprints Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement Improve the current content [org] dotnet-maui/subsvc dotnet-mobile/svc Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants