Batch Importer (Bib/Acq) (UXPROD-47)

[UIDATIMP-884] Resizable Panes - Persistence | Use PersistedPaneset smart component for Data Import landing page Created: 31/Mar/21  Updated: 18/Nov/21  Resolved: 09/Aug/21

Status: Closed
Project: ui-data-import
Components: None
Affects versions: None
Fix versions: 5.0.0
Parent: Batch Importer (Bib/Acq)

Type: Story Priority: P3
Reporter: Ann-Marie Breaux (Inactive) Assignee: Tetiana Paranich
Resolution: Done Votes: 0
Labels: data-import, epam-folijet, has-draft-testrail, ui-only
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: File Proof.mp4    
Issue links:
Defines
defines UXPROD-3041 NFR: Data Import (Batch Importer for ... Closed
Relates
relates to FOLIO-3088 CLONE - Resizable Panes - Persistence... Open
relates to UIMARCAUTH-25 Authorities app | Resizable Panes - P... Closed
Sprint: Folijet Sprint 118, Folijet Sprint 119, Folijet Sprint 120
Story Points: 2
Development Team: Folijet
Tester Assignee: Ann-Marie Breaux (Inactive)
Epic Link: Batch Importer (Bib/Acq)

 Description   

Requirement: Update Resizable panes to support session/local storage persistence. See below documentation

Acceptance criteria
Given I am on a <<TBD>> app
AND I resize the second or third pane
AND I go to another app
When I return to the <<TBD>> app
Then resize should persists based on session and/or local storage

Technical documentation
we’ve added a new component, <PersistedPaneset> to stripes-smart-components: https://github.com/folio-org/stripes-smart-components/tree/master/lib/PersistedPaneset
you’re already using <Paneset> in your apps, to which @j.coburn recently added the ability to resize Panes (scroll up :wink. PersistedPaneset saves the current pane widths to the user’s localStorage so if you resize a pane, close the window, and then bring up folio again, the panes will be the same width.
to use PersistedPaneset

what about the search-and-filters pane?
while working on this, i realised i could use the same technique to persist the visibility of the filters pane. that is, if a user has hidden them and they refresh, the filters pane will remain hidden. so i’ve now done that in the Agreements and Licenses apps as well.
i don’t have as concise a commit diff to show as an example, but the key parts are here: https://github.com/folio-org/ui-agreements/blob/v6.0.0/src/components/views/Agreements.js#L75-L81
there, we’re using the @rehooks/local-storage package to give us a local storage hook that we use to read/set the visibility. note the filterPaneVisibilityKey that namespaces the local storage to this app. NB: you should never use an un-namespaced key into local storage since you share it with all folio apps in existence now and in the future, including ones you may not know of that were developed independently at some random library/university.



 Comments   
Comment by Ann-Marie Breaux (Inactive) [ 31/Mar/21 ]

Khalilah Gambrell A lot of Data Import's resizable panes come up in the Settings area. If we try to apply this persistence for Settings, would it apply to all Settings screens, or is there a way to make it only apply to the Settings/Data import screens?

Comment by Ann-Marie Breaux (Inactive) [ 14/Apr/21 ]

Hi Khalilah Gambrell Just wanted to circle back on the question above. We don't want to implement if our changes will affect other settings pages besides Data Import

Comment by Ann-Marie Breaux (Inactive) [ 14/Apr/21 ]

Ivan Kryzhanovskyi and Mariia Aloshyna I'm moving out of the current sprint until we're clear on the implications and get this out of draft

Comment by Khalilah Gambrell [ 14/Apr/21 ]

I do not think it impacts any other settings pages but the settings pages that data import supports but Ivan Kryzhanovskyi and Mariia Aloshyna should ask md331 or post the question on the #stripes or #stripes-updates.

Comment by Tetiana Paranich [ 04/Aug/21 ]

Work as expected on https://folio-snapshot-load.dev.folio.org

Google Chrome Version 91.0.4472.164 (Official Build) (64-bit)

Ann-Marie Breaux could you please recheck this ticket?

See the attached Proof.mp4

Comment by Ann-Marie Breaux (Inactive) [ 09/Aug/21 ]

Hi Tetiana Paranich and Oleksandr Hladchenko Looks good - thank you!

Comment by lew235 [ 07/Oct/21 ]

Laura has updated draft Testrail

Generated at Thu Feb 08 23:25:36 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.