feat: deprecate some APIs toward v5 #1403

dai-shi · 2022-10-31T13:42:47Z

This is to deprecate some features which will be removed in v5.

zustand/context
store.destory
create(store)

They are not often used, have better alternatives, and/or can mislead usages.

There's no plan about v5 (btw, minimal requirement will be react 18) yet, but this PR would be good to get some feedback in advance.

codesandbox-ci · 2022-10-31T13:43:21Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit fc3752b:

Sandbox	Source
React	Configuration
React Typescript	Configuration
React Browserify	Configuration
React Snowpack	Configuration
React Parcel	Configuration
Next.js	Configuration
@pavlobu/zustand demo	Configuration

github-actions · 2022-10-31T13:44:47Z

Size Change: +1.71 kB (+5%) 🔍

Total Size: 38.7 kB

Filename	Size	Change
`dist/context.js`	775 B	+170 B (+28%)	🚨
`dist/esm/context.js`	581 B	+159 B (+38%)	🚨
`dist/esm/index.js`	559 B	+145 B (+35%)	🚨
`dist/esm/vanilla.js`	557 B	+156 B (+39%)	🚨
`dist/index.js`	704 B	+139 B (+25%)	🚨
`dist/system/context.development.js`	688 B	+139 B (+25%)	🚨
`dist/system/index.development.js`	712 B	+122 B (+21%)	🚨
`dist/system/vanilla.development.js`	598 B	+130 B (+28%)	🚨
`dist/system/vanilla.production.js`	292 B	+1 B (0%)
`dist/umd/context.development.js`	876 B	+142 B (+19%)	⚠️
`dist/umd/index.development.js`	836 B	+118 B (+16%)	⚠️
`dist/umd/vanilla.development.js`	678 B	+125 B (+23%)	🚨
`dist/umd/vanilla.production.js`	351 B	+2 B (+1%)
`dist/vanilla.js`	591 B	+157 B (+36%)	🚨

ℹ️ View Unchanged

Filename	Size
`dist/esm/middleware.js`	3.78 kB
`dist/esm/middleware/immer.js`	210 B
`dist/esm/shallow.js`	373 B
`dist/middleware.js`	4.36 kB
`dist/middleware/immer.js`	328 B
`dist/shallow.js`	971 B
`dist/system/context.production.js`	365 B
`dist/system/index.production.js`	391 B
`dist/system/middleware.development.js`	3.91 kB
`dist/system/middleware.production.js`	2.71 kB
`dist/system/middleware/immer.development.js`	292 B
`dist/system/middleware/immer.production.js`	187 B
`dist/system/shallow.development.js`	444 B
`dist/system/shallow.production.js`	322 B
`dist/umd/context.production.js`	533 B
`dist/umd/index.production.js`	526 B
`dist/umd/middleware.development.js`	4.49 kB
`dist/umd/middleware.production.js`	3.02 kB
`dist/umd/middleware/immer.development.js`	472 B
`dist/umd/middleware/immer.production.js`	337 B
`dist/umd/shallow.development.js`	1.09 kB
`dist/umd/shallow.production.js`	830 B

_{compressed-size-action}

luciancaetano · 2022-11-04T01:46:43Z

What would be the next steps to continue this pr ?

dai-shi · 2022-11-04T01:56:38Z

Hm, maybe I leave it open for a month or so, and then eventually merge it and release a minor version (v4.2.0).

So, questions are welcome in the mean time. (I think zustand/context is major one. The other two are minor.)

dai-shi · 2023-01-07T14:35:01Z

Let's do this along with #1514.

charkour · 2023-01-09T16:30:05Z

docs/previous-versions/zustand-v3-create-context.md

@@ -6,7 +6,7 @@ nav: 18
 A special `createContext` is provided since v3.5,
 which avoids misusing the store hook.

-> **Note**: This function will likely be deprecated in v4 and removed in v5.
+> **Note**: This function will be deprecated in v4 and removed in v5.


Hey @dai-shi, why is this helper function being deprecated? My team currently relies on this to initialize stores based on data from props.

In preparation for this being deprecated and removed, I've published a package re-creating this helpful function.

Thanks for your help!

Does this createContext function miss-use React APIs? Or is it a performance aspect? Or do you simply not want to manage this code anymore?

Thank you.

In v3, we only have one create function that creates a React hook.
Passing it via context (or props) can violate the rules of hooks. To avoid misusing it, createContext in v3.5 is carefully implemented so that it can't break the rules of hooks.

In v4, we provide a new general hook useStore along with createStore to create a vanilla store without React hooks.
These APIs are more React-ish, and recommended to use over zustand/context workaround. There's no risks to violate the rules of hooks. As we don't want to teach two usages, zustand/context is being deprecated and will be removed in v5.

So, the short answer is it's no longer necessary.

You are absolutely fine to keep it as a third-party package. The helper function could be useful for a pattern.

so are you saying the migration path would be to call createStore and put the result into your own context? Can you maybe show how a replacement of zustand/context would look like?

Good point. I answered it in one of discussions, but that should be in docs too.

Would be interested too on how to replace/migrate.
My main usecase is that I need zustand state per instance rather than global.

himself65 · 2023-01-12T05:01:18Z

thanks for maintaining this project, I'm wondering the roadmap of the v5

dai-shi · 2023-01-12T05:07:59Z

thanks for maintaining this project, I'm wondering the roadmap of the v5

There's still no plan about v5, but I feel like waiting until use hook lands.

val-o · 2023-07-18T07:27:50Z

readme.md

 import vanillaStore from './vanillaStore'

-const useBoundStore = create(vanillaStore)
+const useBoundStore = (selector) => useStore(vanillaStore, selector)


it seems that this will require more TS boilerplate

I think it's just a little. Such usage is already documented somewhere. If people use this pattern a lot, we could provide a util for it. Thanks for your feedback!

feat: deprecate some APIs toward v5

a9e175a

kiputgalak approved these changes Nov 3, 2022

View reviewed changes

dai-shi added 3 commits December 5, 2022 22:35

Merge branch 'main' into feat/deprecate-apis-toward-v5

987d159

update docs

dbb514c

Merge branch 'main' into feat/deprecate-apis-toward-v5

fc3752b

dai-shi marked this pull request as ready for review January 7, 2023 14:34

dai-shi added this to the v4.3.0 milestone Jan 7, 2023

charkour reviewed Jan 9, 2023

View reviewed changes

dai-shi merged commit 7d32f9c into main Jan 10, 2023

dai-shi deleted the feat/deprecate-apis-toward-v5 branch January 10, 2023 08:36

dai-shi mentioned this pull request Jan 10, 2023

docs: add migration example in v3 create context #1524

Merged

val-o reviewed Jul 18, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: deprecate some APIs toward v5 #1403

feat: deprecate some APIs toward v5 #1403

dai-shi commented Oct 31, 2022

codesandbox-ci bot commented Oct 31, 2022 •

edited

Loading

github-actions bot commented Oct 31, 2022 •

edited

Loading

luciancaetano commented Nov 4, 2022

dai-shi commented Nov 4, 2022

dai-shi commented Jan 7, 2023

charkour Jan 9, 2023

charkour Jan 9, 2023

dai-shi Jan 9, 2023

TkDodo Jan 10, 2023

dai-shi Jan 10, 2023 •

edited

Loading

GuskiS Jan 10, 2023

dai-shi Jan 10, 2023

himself65 commented Jan 12, 2023

dai-shi commented Jan 12, 2023

val-o Jul 18, 2023

dai-shi Jul 18, 2023

feat: deprecate some APIs toward v5 #1403

feat: deprecate some APIs toward v5 #1403

Conversation

dai-shi commented Oct 31, 2022

codesandbox-ci bot commented Oct 31, 2022 • edited Loading

github-actions bot commented Oct 31, 2022 • edited Loading

luciancaetano commented Nov 4, 2022

dai-shi commented Nov 4, 2022

dai-shi commented Jan 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dai-shi Jan 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

himself65 commented Jan 12, 2023

dai-shi commented Jan 12, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codesandbox-ci bot commented Oct 31, 2022 •

edited

Loading

github-actions bot commented Oct 31, 2022 •

edited

Loading

dai-shi Jan 10, 2023 •

edited

Loading