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

[CONSOLE] UI errors in Map view #218

Open
2 of 26 tasks
MidnightLightning opened this issue Feb 25, 2024 · 2 comments
Open
2 of 26 tasks

[CONSOLE] UI errors in Map view #218

MidnightLightning opened this issue Feb 25, 2024 · 2 comments

Comments

@MidnightLightning
Copy link

Overview

User story: As a visual learner who wants to understand the streams coming in and out of an address, I want the "map" view to be as understandable as possible, with no visual distractions that would hamper my understanding of the visualization. I want as clean a visual as possible to be able to screenshot it and share with others as an explanation for what's happening with my or their wallet.

User Persona/Target Audience:
Visual learners who wish to use and share the Map view to explain the current state of streams to/from an address.

Deadline: ??

UI/UX Design:

image
The central node of the graph has extra links both top and bottom that appear to be connecting the central node to themselves. Those are not needed and visually distracting from the other connections.

image

  • The attribution to React Flow in the bottom right (green circle) is not legible (color is same as background); should either be legible or removed entirely.
  • Outflows don't space themselves out as the in-flows do (blue separations between nodes are different). The outflows being so close together makes the labels for those flows overlap (orange circle). To fix this, the outflows should be spaced out as the in-flows are.
  • The central node is not centrally-aligned to either the in-flows nor out-flows horizontally. This makes a pretty unbalanced diagram overall.
  • Nodes that are on the out-flow side have a connection point on the top that leads back to the central node, and no connection point on the bottom. But the nodes on the in-flow side have a connection point on the top that is unused. This seems to imply a possibility of showing multi-hop flows, but that doesn't seem to be possible with this widget. Until such capability is added, the connection points on top of the in-flows should be removed.

Acceptance criteria

  • Satisfies entire acceptance criteria
  • Analytics capturing is added (Optional)
  • Consider demo & communication (Optional)
  • Follow-up ideas & considerations get noted (Optional)
  • Stakeholders approve (Optional)
  • Code review is approved by at least 2 reviewers
  • Tested by Elvijs/QA & discovered bugs resolved
  • Documentation updated
  • Assignee/opened by merges PR
  • Automated E2E tests for happy path
  • Code is merged
  • Observability of critical user path
  • Checked with target user persona

Links/Resources

Readiness criteria

  • Descriptive title
  • Written as a user story: “As a [persona] who [context], I want to [do X] because [reason] , so that [outcome].”
  • Acceptance criteria complying with Definition of Done
  • User Persona/Target Audience: If User Persona is known otherwise assume Target audience
  • Estimate/Story points
  • Deadline: If not a part of an epic
  • Priority: Reflected as order on the board, walking the board from the top and right
  • Assignee
  • Labels
  • Link to epic: If belonging to an epic
  • UI/UX Design (optional)
  • Blockers/Prerequisites (optional): Use Zenhub blocked by/blocking feature
  • Mood (optional): What mood is the user in when interfacing with this? Exploring? Stressed? Playful?
@kasparkallas
Copy link
Collaborator

kasparkallas commented Feb 27, 2024

Thank you for the issue!

I can't promise when I'd get around to this. Maybe you're interested in submitting a PR yourself?

This is the component that renders the diagram: https://github.com/superfluid-finance/superfluid-console/blob/313c023235f9cad965fefa53398f049d133ddedb/src/components/Map/Map.tsx#L40

The part that configures how ReactFlow looks is straightforward. The positions of the nodes are set by simple multiplications (e.g. position: { x: i * 300, y: 100 }). The connection points of the edges are not configured at all, i.e. they're the default.

I haven't investigated this much but I have a hunch ideally we'd use an auto-layout algorithm: https://reactflow.dev/learn/layouting/layouting & https://reactflow.dev/examples/layout/auto-layout

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

No branches or pull requests

2 participants