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

No samples are using a custom options pane #447

Open
Arlodotexe opened this issue Jun 19, 2023 · 0 comments
Open

No samples are using a custom options pane #447

Arlodotexe opened this issue Jun 19, 2023 · 0 comments
Assignees
Labels
documentation 📃 Improvements or additions to documentation sample app 🖼 ux 🖌️ Everything design related

Comments

@Arlodotexe
Copy link
Member

Arlodotexe commented Jun 19, 2023

Background

Sample Options are the pane next to sample controls that allow users to manipulate the sample. This separate pane is either generated using attributes, or manually assigned with a UserControl of your choice, and an instance of the sample is provided for manipulation. This approach keeps the sample XAML and C# source code presented to the user clean and succinct.

Problems

In order to create sample options, samples in CommunityToolkit vNext and CommunityToolkit Labs currently use either:

  • Generated option attributes, or
  • Directly insert the UI for manipulating the sample into the sample itself.

The second method is problematic, as it makes the source code for the sample hard to read and can lead to an inconsistent user experience. This issue arises due to a lack of documentation and samples for using a fully custom options pane.

Solution

For components with option-related UI inside their samples, migrate to using a custom options pane instead. This will improve the readability of the source code and provide a more consistent user experience.

@Arlodotexe Arlodotexe added documentation 📃 Improvements or additions to documentation sample app 🖼 ux 🖌️ Everything design related labels Jun 19, 2023
@Arlodotexe Arlodotexe self-assigned this Jun 19, 2023
@Arlodotexe Arlodotexe moved this to 📋 Backlog in Toolkit 8.x Jun 19, 2023
@Arlodotexe Arlodotexe moved this from 📋 Backlog to 🔖 Ready in Toolkit 8.x Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📃 Improvements or additions to documentation sample app 🖼 ux 🖌️ Everything design related
Projects
Status: 🔖 Ready
Development

No branches or pull requests

1 participant