angular-ui/ui-grid

Restore state only works if the grid has the ui-grid-cellNav attribute

Open

#5,640 opened on Aug 24, 2016

View on GitHub
 (0 comments) (3 reactions) (0 assignees)JavaScript (5,395 stars) (2,496 forks)batch import
good first issue

Description

The restore state feature does not work, if you remove the ui-grid-cellNav attribute from the grid. It seems like there is a dependency between ui-grid-save-state and ui-grid-cellNav.

You can recreate this issue with the following Plunker, which is based on the tutorial (http://ui-grid.info/docs/#/tutorial/208_save_state): http://plnkr.co/edit/SopQvxj9uKKZezxvr3pQ?p=preview

  1. Press "Save" button.
  2. Scroll down a bit.
  3. Press "Restore" button.
  4. The scroll position is restored. --> correct!
  5. Remove the ui-grid-cellNav attribute from the grid (or use this Punker: http://plnkr.co/edit/Bo0DKZOpQxMBS2FlPwyq?p=preview).
  6. Repeat steps 1-3.
  7. The scroll position is not restored. --> bug!

As far as I can say, the save state feature still works, but I'm not 100% sure. I need to use the save/restore state feature, but I do not want to have each cell selectable. That's why I can not add the ui-grid-cellNav attribute to my grid.

Contributor guide

Tech stack
javascript
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
AngularJS basicsui grid usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the dependency between ui grid save state and ui grid cellNav modules. The issue occurs when ui grid cellNav is not present; the restore state fails to restore scroll position. Examine the source code in the save state and cellNav modules to understand how scroll position is saved and restored, and whether there is an implicit dependency that requires cellNav to be active. The Plunker examples demonstrate the behavior. Look for any conditions in the restore logic that rely on cellNav's scroll handler or state. Consider adding a standalone scroll restore mechanism that does not depend on cellNav.