Allow for the creation and management of organization records (UXPROD-1139)

[UIORGS-239] Resizable Panes - Persistence | Use PersistedPaneset smart component. Created: 14/Apr/21  Updated: 05/May/21  Resolved: 19/Apr/21

Status: Closed
Project: ui-organizations
Components: None
Affects versions: None
Fix versions: 2.4.0
Parent: Allow for the creation and management of organization records

Type: Story Priority: P3
Reporter: Andrei Shumski Assignee: Dennis Bridges
Resolution: Done Votes: 0
Labels: ui-only
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: PNG File image-2021-04-19-16-00-20-848.png    
Issue links:
Relates
relates to UISACQCOMP-24 Resizable Panes Closed
relates to UXPROD-2630 Thunderjet - R2 Enhancements/Bugfixes Closed
Sprint: ACQ Sprint 112
Story Points: 1
Development Team: Thunderjet
Tester Assignee: Dennis Bridges
Epic Link: Allow for the creation and management of organization records

 Description   

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

Acceptance criteria  
Given I am on the Organizations app
AND I resize the second or third pane
AND I go to another app
When I return to the Organizations 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 Andrei Shumski [ 19/Apr/21 ]

Tested on folio-testing. Review, please.

Comment by Dennis Bridges [ 19/Apr/21 ]

test successful in FOLIO-snapshot. thx!

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