codeforpdx / codeforpdx/PASS

[Discovery] - Create Document View component

Open
#644 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discovery enhancement
Dominant language
JavaScript
Stars
38
Forks
23
Avg merge
11m
Merged PRs (30d)
4

Description

Note: This issue is marked for discovery. It is open for discussion and not necessarily decided upon.

Describe the Current Behavior/Feature:

In the Documents table, clicking on "Preview File" icon button from the grid opens the file directly. It may be better to have it instead direct to a separate page that displays the full information/metadata for that file.

Rationale:

The "Profile" icon button in the Contacts table already behaves in this way and it is good to have consistent design.

Besides, the term 'preview' makes it seem more like the user can glimpse a document rather than directly open it. Doing so may potentially exit out of the app unexpectedly, which could be frustrating for the user.

Proposed Changes:

Create a new component, perhaps called Document View, that opens when clicking on the "Preview File" icon button. There it will display a preview of the document plus the associated data.

Consult the Figma design:

2024-05-24 (2) - Copy

Also consider adding a button in the page that will open that file directly. In which case, the labeling should be clear and perhaps have a warning along the lines of "This will take you outside of the app. Proceed?".

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked Figma design and the existing Profile icon behavior in the Contacts table, then trace the Documents table's "Preview File" action. Done means agreeing on and implementing a separate Document View that shows the document preview and associated metadata, with an explicitly labeled option to open the file outside the app if retained.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.