The hook `persistentStateSave` is called even when the option `persistentState` is set to false

lijigang.us · August 11, 2021, 2:43pm

Hello, Handsontable team,

According to the doc, the hook persistentStateSave is only exposed when the option persistentState is set true. However, it is still called when the column is manually moved even when the persistentState is set false.

github.com

handsontable/handsontable/blob/4d56e68f9cb6412b841663278b2e0eb3ad181233/src/plugins/manualColumnMove/manualColumnMove.js#L679


    return;
  }


  const firstMovedVisualColumn = priv.columnsToMove[0];
  const firstMovedPhysicalColumn = this.hot.toPhysicalColumn(firstMovedVisualColumn);
  const movePerformed = this.dragColumns(priv.columnsToMove, target);


  priv.columnsToMove.length = 0;


  if (movePerformed === true) {
    this.persistentStateSave();
    this.hot.render();
    this.hot.view.adjustElementsSize(true);


    const selectionStart = this.hot.toVisualColumn(firstMovedPhysicalColumn);
    const selectionEnd = selectionStart + columnsLen - 1;


    this.hot.selectColumns(selectionStart, selectionEnd);
  }
}

It doesn’t check whether the persistentState is set to false.

Please check this fiddle: https://jsfiddle.net/guobacai/46gcnaLz/22/

Also, when calling the moveColumns/moveColumn, the hook persistentStateSave is not called even when the persistentState is set true. I am not sure if this is by design.

aleksandra_budnik · August 13, 2021, 10:27am

Hi @lijigang.us

Thank you for sharing your insights. /the hook itself is called but nothing gets stored in the localStorage. We should update the description in the documentation. The same happens for the persistentStateLoad.

I have reported the alteration need in our main repository https://github.com/handsontable/handsontable/issues/8638

lijigang.us · August 13, 2021, 2:31pm

Hi @aleksandra_budnik

Thanks for the quick response.

I guess this problem could be here: https://github.com/handsontable/handsontable/blob/b0a09bde9a9d4164bee4f28cd047fa843f42a7a9/src/plugins/manualColumnMove/manualColumnMove.js#L337

Even when the persistentState is set to false, it will still calls the hook ‘persistentStateLoad’ .
As you said, since there is nothing in the localStorage, so no column is moved.

However, according to the doc, the hook persistentStateLoad is not even supposed to be called.

So, the doc is a little confusing.

aleksandra_budnik · August 16, 2021, 11:40am

That is true. That is why I have asked the team not to improve the description.

aleksandra_budnik · November 24, 2022, 12:43pm

I’m closing this issue as done. Thank you for the feedback @lijigang.us one again.