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

[Docs][MVUX][EPIC] Improve documentation + create sample #2434

Open
dr1rrb opened this issue Jul 15, 2024 · 2 comments · Fixed by #2538 or unoplatform/Uno.Samples#822
Open

[Docs][MVUX][EPIC] Improve documentation + create sample #2434

dr1rrb opened this issue Jul 15, 2024 · 2 comments · Fixed by #2538 or unoplatform/Uno.Samples#822
Assignees
Labels
kind/consumer-experience Categorizes issue or PR as related to improving the experience of consumers kind/documentation Categorizes an issue or PR as relevant to 3rd party dependencies that are consumed by this project triage/untriaged Indicates an issue requires triaging or verification.

Comments

@dr1rrb
Copy link
Member

dr1rrb commented Jul 15, 2024

Use Cases: Samples + Docs

Use Case Documentation Sample(s)
Create a Feed How to create a feed ✔️ Available - unoplatform/Uno.Samples#822
Using FeedView How to create a feed#Using a FeedView ✔️ Available - unoplatform/Uno.Samples#822
Create a List-Feed How to create a list feed ✔️ Available - unoplatform/Uno.Samples#822
Create a list feed where values are pushed in How to create a list feed where values are pushed in ✔️ Available - unoplatform/Uno.Samples#822
Create a State How to create a state with a command ✔️ Available - unoplatform/Uno.Samples#822
How to Paginate Data Pagination ✔️ Available - unoplatform/Uno.Samples#822
Selection Item Selection ✔️ Available - unoplatform/Uno.Samples#822
Execute a Command on an item in a list ❌ Not Documented ✔️ Available - unoplatform/Uno.Samples#822
State: Receive an implicit value in a Command and update State with UpdateAsync What are list-states#Update ✔️ Available - unoplatform/Uno.Samples#822
Updating state from a command w/ accessing previous value ❌ Not Documented ✔️ Available - unoplatform/Uno.Samples#822
Projecting state to a calculated field (?) ❌ Not Documented ❌ Not Available in Sample
Refresh a ListFeed using a Signal ❌ Not Documented ✔️ Available - unoplatform/Uno.Samples#822
Refresh a ListFeed using the Refresh command ❌ Not Documented ❌ Not Available in Sample
Refresh a ListFeed using a ListState in the model ❌ Not Documented ❌ Not Available in Sample

API/Documentation

Subject Documentation
Topics in Reference section should really be in the Overview (Reference is NOT meant to introduce use cases, it is meant to document APIs) 👀 In progress #2538
New "Overview" page for MVUX like for C# Markup ❌ Not Documented
API Definition for IAsyncCommand ❌ Not Documented
Explain UI Thread "limitations" with examples. Related discussion ❌ Not Documented
Refreshing FeedView. Related discussion ❌ Not Documented
Use the enhance visual states on a Button
Contracts needs to be discussed / updated prior to be documented (cf. #2440)
* xmlns:mvux="using:Uno.Extensions.Reactive.UI"
* On the style of a Button add <Setter Property="(mvux:ButtonExtensions.IsExecutionTrackingEnabled)" Value="True" />
* In the Template of the Button add a VisualStateGroup with visual states Idle, Executing, Failed and Succeed
❌ Not Documented

Possible states:

  • ✔️ Documented - Documentation Link(s)
  • ❌ Not Documented
  • ✔️ Available - Sample Link(s)
  • ❌ Not Available in Sample
  • 👀 To Be Reviewed
@dr1rrb dr1rrb added kind/consumer-experience Categorizes issue or PR as related to improving the experience of consumers kind/documentation Categorizes an issue or PR as relevant to 3rd party dependencies that are consumed by this project triage/untriaged Indicates an issue requires triaging or verification. labels Jul 15, 2024
@agneszitte agneszitte reopened this Sep 19, 2024
@agneszitte agneszitte reopened this Sep 23, 2024
@agneszitte
Copy link
Contributor

agneszitte commented Sep 23, 2024

@kazo0, @dr1rrb, @eriklimakc, @ajpinedam
I imagine we'll keep this Epic open to cover what’s still undocumented or missing from the samples, addressing it as time allows. Plus, we can add more items to the tables as needed if anything is missing. Does that sound right?

@DevTKSS
Copy link

DevTKSS commented Dec 15, 2024

To the ListFeed (=> FeedView?) point on your tasklist maybe this task state is outdated. For sample needcase, i am planning to provide some image+maybe video content to this but this repo is set to private till this point.
Have some curious misbehaving (Drag/Drop and additional a known skia problem)experienced there filed issue to that and trying to do small repro for this before coming to this adding point for that task here.

But for the refresh command, triggering the async command in the class( i registered it for DI for easyer implementation) on my model (mvux) is working fine on this app.

As nice gimmick it should also be able to use string localization😁 i say should because I did not add the switch for doing that till that point, but from the theme switching that should not be more difficult 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/consumer-experience Categorizes issue or PR as related to improving the experience of consumers kind/documentation Categorizes an issue or PR as relevant to 3rd party dependencies that are consumed by this project triage/untriaged Indicates an issue requires triaging or verification.
Projects
None yet
5 participants