17 Commits

Author SHA1 Message Date
Mohammed 'Mo' Mulazada
f73736d59a
improve docs readability (#1931)
* make codeblock easier to understand

* add explanation to what mock does

* add info block

* rewrite typescript section

* Update typescript.md

* Update docs/guides/testing.md

Co-authored-by: Blazej Sewera <code@sewera.dev>

* prefix with >

---------

Co-authored-by: Blazej Sewera <code@sewera.dev>
2023-07-13 18:01:47 +09:00
Daniels L
e71e313bd7
docs(typescript): fix bounded use store example (#1779)
* test: changer

* docs: fix abstract bounded store hook TS example

Fixes type issues due to optional arg:
https://github.com/pmndrs/zustand/discussions/1564#discussioncomment-5735802

* fix: pr feedback
2023-04-28 17:40:42 +09:00
Jacob Weisenburger
f94ad23b43
fixes #1735 (#1737) 2023-04-07 11:54:45 +09:00
Devansh Jethmalani
f508b2c315
docs(typescript): clean up bounded useStore recipe (#1581)
* Make bounded useStore recipe section minimal

* Add a receipe for `createBoundedUseStore`

* run prettier

* use vanilla store
(as the react store is already a bounded useStore hook)
2023-01-30 08:23:26 +09:00
Holger Grosse-Plankermann
04080fdedc
fix(docs/typescript): provide example how to use middlewares with #1565 (#1578) 2023-01-27 09:00:31 +09:00
Holger Grosse-Plankermann
1023eb4af4
fix(docs/typescript): use correct initial state in test example (#1577) 2023-01-26 19:55:37 +09:00
Holger Grosse-Plankermann
44b23382f0
fix(docs/typescript): add typing usage with custom store hooks (#1565)
* Docs for discussion 1564

* Apply prettier

* fix(docs/typescript): use overloading example discussed in #1564
2023-01-25 11:52:53 +09:00
Daishi Kato
0b55a3d74b
feat: deprecate default export (#1514) 2023-01-10 18:13:25 +09:00
Devansh Jethmalani
ea8415b98d
docs(typescript): highlight the extra parenthesis for create (#1410)
* docs(typescript): highlight the extra parenthesis for `create`

* fix typo
2022-11-05 12:58:21 +09:00
Devansh Jethmalani
ca059788d3
fix(types): fix StateCreator subtyping (#1373)
* fix(types): fix `StateCreator` subtyping

* prefer import type

Co-authored-by: daishi <daishi@axlight.com>
2022-10-23 08:55:31 +09:00
Joel Mathew Koshy
e8b05d8179
docs: added separate docs file for slices pattern (#1344) 2022-10-07 01:05:07 +09:00
Jacob Bergholtz
4ed81bc11b
Add usage with context to docs (#1291)
* docs: context guide proposal

* fix(docs): typo & omit comment

* fix(docs): remove horizontal rules

* fix(docs): add wiki link to DI

* fix(docs): format with prettier

* fix(docs): cases that model => where... is needed

* fix(docs): use sentence case

* fix(docs): omit quote block

* fix(docs): into "a" custom hook

* fix(docs): format with prettier

* fix(docs): sort broken nav indexes

* Update docs/guides/initialize-state-with-props.md

Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>

* fix(docs): reintroduce React.createContext example

* scripts: escape quotes

* styles: run prettier

* fix(docs): omit 'React' from imports

* styles: run prettier

* styles: run prettier

Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>
2022-09-18 09:01:06 +09:00
Chris K
1c56b91b5a
fix: remove unneeded <br> causing website build to fail (#1272) 2022-09-08 18:32:33 +09:00
Devansh Jethmalani
b8ec61dc53
docs(typescript): Rewrite the inference explanation (#1252)
* docs(typescript): Rewrite the inference explanation

* run prettier

* fix grammar

* run prettier

* typo

* grammar, punctuation

* more edits

* replacing ellipses with colon for consistency

* even more edits

* edit summary

Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>

* fix hypothetical type

Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>
2022-09-03 08:48:06 +09:00
Fawaz Haroun
445e147478
fix(docs): Issue 1120 docs guides (#1247)
* docs: testing documentation review

* docs: auto-generated-selectors documentation review

* docs: auto-generated-selectors documentation review

* docs: flux-inspired-practices documentation review

* docs: flux-inspired-practices documentation review

* docs: flux-inspired-practices documentation review

* docs: immutable-state-and-merging documentation review

* docs: immutable-state-and-merging documentation review

* docs: event-handler-in-pre-react-18 documentation review

* docs: ran the yarn run prettier command

* review: reviewed documentation guides

* review: typo fixes and ran yarn run prettier

* review: change based on review comment

* review: change based on review comment

* review: change based on review comment

* review: made changes based on review

* ran yarn run prettier

* Update docs/guides/typescript.md

Co-authored-by: Devansh Jethmalani <jethmalani.devansh@gmail.com>

Co-authored-by: Devansh Jethmalani <jethmalani.devansh@gmail.com>
2022-09-02 07:54:27 +09:00
Fawaz Haroun
476a381df8
fix(docs): Issue 1120 docs guides (#1244)
* docs: testing documentation review

* docs: auto-generated-selectors documentation review

* docs: auto-generated-selectors documentation review

* docs: flux-inspired-practices documentation review

* docs: flux-inspired-practices documentation review

* docs: flux-inspired-practices documentation review

* docs: immutable-state-and-merging documentation review

* docs: immutable-state-and-merging documentation review

* docs: event-handler-in-pre-react-18 documentation review

* docs: ran the yarn run prettier command

* review: reviewed documentation guides

* review: typo fixes and ran yarn run prettier

* review: change based on review comment

* review: change based on review comment

* review: change based on review comment
2022-08-31 08:09:15 +09:00
Chris K
b85f6413f1
docs(issue-1215): restructure top level docs (#1222) 2022-08-25 19:34:32 +09:00