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

Improved summary and PDF experience #1502

Open
49 of 58 tasks
Tracked by #339 ...
olemartinorg opened this issue Sep 25, 2023 · 3 comments
Open
49 of 58 tasks
Tracked by #339 ...

Improved summary and PDF experience #1502

olemartinorg opened this issue Sep 25, 2023 · 3 comments
Assignees
Labels
area/summary related to summaries/read-only data representation Epic kind/feature-request New feature or request ux Needs some love from a UX resource

Comments

@olemartinorg
Copy link
Contributor

olemartinorg commented Sep 25, 2023

There is a need to improve the existing summary functionality including the PDF in order to meet new requirements, to catch up on existing bugs and feature requests as well as to improve the code base.

While the a summary page, and especially the Summary component, is the main foundation for the PDF, there are also separate improvements needed for PDF that is independent of the Summary component. This epic address the total of changes needed in order to meet customer expectations.

Design for the improvements will be handled in #1744

Summary component

Right now our Summary component is somewhat limited. It is possible to point it at a single component, a non-repeating Group, or a repeating Group component, and if my recollection is correct it will:

  • Display a simple value, as typed/selected in the target form component
  • Display a static map for the Map component
  • Render non-form components as normal (or not show them at all?)
  • Render a non-repeating Group as a condensed/compact summary
  • Render a repeating group as a condensed/compact summary, but will not render nested repeating groups by default
  • Render a repeating group looking like individual fields, and render nested repeating groups as condensed/compact fields if given largeGroup: true.

It will however not:

  • Render a summary for an entire process step, or a different process step (although the automatic PDF generator will attempt to do that for the current process step)
  • Render a summary for an entire page, unless that entire page has been wrapped in a non-repeating Group.
  • Render deeper components. If given a Group with a Grid/Group/container component inside of it, the innermost container component will not be rendered, as summaries are not recursive.

At the same time, configuration is somewhat limited, as we allow for the excludedChildren and display options, but it is not at all easy to wrangle Summary into showing something that makes sense (and looks nice) for a user when you are working on a form with more complex Group and nested structures.

In this issue we should look into the usage of Summary today, talk to service owners, and design and implement a better Summary that could replace the one we have now. That should, at a minimum, include:

  • Smarter and better defaults. We should test against real apps and verify that summaries we generate makes sense and looks nice.
  • Recursivity by default. It should be possible to point to either a single component/group or an entire page in the app.
  • It should be possible to use a single Summary component to make a summary of the entire current process step, without specifying every component ID you want to summarize.
  • It should be possible to point a Summary component to a previous process step. App-frontend could fetch the layouts and data model for that step, and render a summary of the data in it, if you have permissions to read that data.
  • Overrides should be configured per-child, not for the entire Summary at once. Take inspiration from tableColumns in repeating Group. It should be possible to render the entire process step summary while at the same time making sure one component deep inside the structure is hidden or hides the 'change' button/bottom border/etc.

This should be a breaking change in the future, but could also be developed alongside non-breaking functionality (either by using feature flags or by implementing a new Summary2 component meant to replace the older one in a future major version).

PDF related issues

  1. kind/user-story
    Magnusrm danielskovli
  2. area/summary area/test
    adamhaeger
  3. area/summary kind/user-story
    adamhaeger
  4. area/summary kind/user-story status/draft
  5. area/summary ux
    adamhaeger
  6. area/summary ux
    adamhaeger
  7. kind/feature-request org/krt
    adamhaeger
  8. kind/bug
    bjosttveit
  9. kind/bug
    Magnusrm adamhaeger
  10. area/summary
    adamhaeger
  11. area/summary
    Magnusrm adamhaeger
  12. kind/user-story
    bjorntore

Summary related issues

  1. status/triage
    Edavda Magnusrm
    adamhaeger
  2. kind/bug
    Magnusrm
  3. kind/feature-request org/brg status/triage
    Magnusrm
  4. kind/feature-request ux
    adamhaeger benjamindehli
  5. area/accessibility area/summary kind/bug status/triage
    adamhaeger
  6. status/triage
    adamhaeger
  7. area/summary kind/feature-request status/triage
    Edavda
  8. area/summary kind/user-story status/draft status/triage ux
    Edavda
  9. area/summary kind/feature-request
    adamhaeger
  10. kind/bug
    RonnyB71 adamhaeger
  11. area/table fe-v4 kind/user-story org/pat ux
    Magnusrm
  12. area/summary kind/feature-request org/ssb
    Magnusrm mikaelrss
  13. area/summary kind/feature-request org/ssb
    Magnusrm mikaelrss
  14. kind/feature-request ux
    Edavda
  15. status/triage
  16. kind/feature-request org/dsb status/triage
    benjamindehli
  17. area/accessibility area/summary kind/bug org/brg org/krt org/ssb ux
  18. kind/bug org/ssb
    RonnyB71

Component list

  1. area/summary
    adamhaeger
  2. status/triage
    adamhaeger
  3. 8 of 8
    area/summary
    adamhaeger danielskovli
  4. Magnusrm
  5. Magnusrm
  6. HauklandJ Magnusrm
  7. area/summary kind/feature-request org/dibk org/krt org/ssb status/triage ux
    Edavda
  8. area/summary
    adamhaeger
  9. area/summary org/krt
    Magnusrm
  10. area/summary
    adamhaeger
  11. area/summary
    adamhaeger
  12. area/summary
    adamhaeger
  13. area/summary
    Magnusrm
  14. area/summary
    Magnusrm
  15. area/summary
    benjamindehli
  16. area/summary
    benjamindehli
  17. area/summary
    benjamindehli
  18. area/summary
    adamhaeger
  19. area/summary
    Magnusrm
  20. area/summary
    benjamindehli
  21. area/summary status/triage
    Magnusrm
  22. area/summary status/triage
    Magnusrm
  23. Magnusrm
  24. area/summary
    Magnusrm

Summary2 component tasks

  1. area/summary
    Magnusrm adamhaeger
    olemartinorg
@olemartinorg olemartinorg added kind/feature-request New feature or request ux Needs some love from a UX resource labels Sep 25, 2023
@xmrsa
Copy link

xmrsa commented Nov 10, 2023

I have added a relevant issue to this, regarding the placement of the "Endre"/"Change"-button in the layout of summaries of Group-components. #1641

@madsenandreas
Copy link

Situation:
A component of type "Summary" linked by "componentRef" to a "Group" component displays "Du har ikkje lagt inn informasjon her" to a subcomponent in the group even if the user have not used the component which can confuse the person filling the form out.

Wished Situation
Components not used in a group will not be displayed in the summary component.

My Case
In my case the group has dynamics which shows different components depending on prior choices in the group. The picture below has one component "Fag" with choices "Ingen", Grunnleggende..." this is optional to fill out. It also has a component "Matematikk deltakelse" this is also optional. The applicant can attend both or just one of these. The issue arises when just one of these is selected then the second one in summary gets the text "Du har ikkje lagt inn informasjon her".

image

How the summary component will look like:
image

@olavflar olavflar self-assigned this Jan 24, 2024
@olavflar olavflar moved this to Under arbeid 🚧 in Design Altinn 3 Jan 24, 2024
@olavflar olavflar added Epic and removed Epic labels Jan 24, 2024
@olavflar olavflar moved this to 📈 Todo in Team Apps Jan 30, 2024
@RonnyB71 RonnyB71 added area/summary related to summaries/read-only data representation Epic labels Feb 1, 2024
@RonnyB71 RonnyB71 changed the title Improving the Summary component Improved summary and PDF experience Feb 1, 2024
@Edavda Edavda self-assigned this Feb 5, 2024
@olavflar olavflar moved this from Under arbeid 🚧 to Oppsummering in Design Altinn 3 Feb 7, 2024
@olemartinorg
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/summary related to summaries/read-only data representation Epic kind/feature-request New feature or request ux Needs some love from a UX resource
Projects
Status: Under arbeid 🚧
Status: 👷 In Progress
Development

No branches or pull requests

6 participants