Allow disabling store persistence of the list parameters #9019
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fzaninotto
requested changes
Jun 16, 2023
| @@ -88,15 +88,23 @@ export const useListParams = ({ | |||
| const location = useLocation(); | |||
| const navigate = useNavigate(); | |||
| const [localParams, setLocalParams] = useState(defaultParams); | |||
| const [params, setParams] = useStore(storeKey, defaultParams); | |||
| const [params, setParams] = useStore( | |||
| storeKey || `${resource}.listParams`, | |||
There was a problem hiding this comment.
if storeKey is false, this will still use the store. Can you add a comment to explain what's the rationale?
There was a problem hiding this comment.
We can't disable a hook, so although we still read the store, its values are not used later in the code
| @@ -111,7 +119,10 @@ export const useListParams = ({ | |||
| () => | |||
| getQuery({ | |||
| queryFromLocation, | |||
| params: disableSyncWithLocation ? localParams : params, | |||
| params: | |||
| disableSyncWithLocation || disableSyncWithStore | |||
There was a problem hiding this comment.
I think you must also dd the check for disableSyncWithStore in changeParams L146, and anywhere else the setParams may be called.
There was a problem hiding this comment.
changeParams does not call setParams
fzaninotto
approved these changes
Jun 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
For one-off lists (e.g. in dashboards),
<ListBase>does the fetching and puts the data in a<ListContext>, so it’s fine.But as it uses the store by default, a list for a given resource will be affected by the actions of the user in other lists of the same resource.
It’s possible to specify a different
storeKeyto avoid that, but it’s silly to have to define a store key when what I want is to disable the use of the store altogether.It’s also possible to use
disableSyncWithLocation, but the name of that prop isn’t clearly related to the store.Solution
Allow to set
storeKeytofalseto disable the store altogether