Uploaded image for project: 'ui-data-import'
  1. ui-data-import
  2. UIDATIMP-979

Resizable Panes - Persistence | Use PersistedPaneset smart component for Data import/View all page



    • Folijet Sprint 142
    • 2
    • Folijet
    • Morning Glory (R2 2022)


      Requirement: Update Data import/View all to persist session/local storage of the search/filter pane collapsed/uncollapsed. See below documentation

      Acceptance criteria
      Given I am on the Data import/View all log page
      AND I collapse the Search/Filter pane by clicking the arrow at the top of the pane
      AND I go to another app or Settings area
      When I return to Data import/View all
      The Search/Filter pane being in a collapsed state should persist
      NOTE: See technical documentation below, headed what about the search-and-filters pane?

      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.

      TestRail: Results


          Issue Links



                Oleksandr Hladchenko1 Oleksandr Hladchenko1
                abreaux Ann-Marie Breaux
                0 Vote for this issue
                3 Start watching this issue



                  TestRail: Runs

                    TestRail: Cases