Gathering detailed insights and metrics for jotai
Gathering detailed insights and metrics for jotai
👻 Primitive and flexible state management for React
Installations
npm install jotaiDeveloper
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
>=12.20.0
Typescript Support
Yes
Node Version
18.20.4
NPM Version
10.7.0
Statistics
18,838 Stars
1,531 Commits
622 Forks
66 Watching
8 Branches
246 Contributors
Updated on 28 Nov 2024
Bundle Size
9.11 kB
Minified
3.46 kB
Minified + Gzipped
Languages
TypeScript (82.24%)
JavaScript (16.53%)
CSS (1.23%)
Total Downloads
Cumulative downloads
Total Downloads
76,962,964
Last day
-4%
204,071
Compared to previous day
Last week
3.2%
1,141,794
Compared to previous week
Last month
4.1%
4,857,683
Compared to previous month
Last year
122.1%
48,282,725
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
2
Versions
visit jotai.org or npm i jotai
Jotai scales from a simple useState replacement to an enterprise TypeScript application.
- Minimal core API (2kb)
- Many utilities and extensions
- No string keys (compared to Recoil)
First, create a primitive atom
An atom represents a piece of state. All you need is to specify an initial value, which can be primitive values like strings and numbers, objects, and arrays. You can create as many primitive atoms as you want.
1import { atom } from 'jotai' 2 3const countAtom = atom(0) 4const countryAtom = atom('Japan') 5const citiesAtom = atom(['Tokyo', 'Kyoto', 'Osaka']) 6const mangaAtom = atom({ 'Dragon Ball': 1984, 'One Piece': 1997, Naruto: 1999 })
Use the atom in your components
It can be used like React.useState:
1import { useAtom } from 'jotai' 2 3function Counter() { 4 const [count, setCount] = useAtom(countAtom) 5 return ( 6 <h1> 7 {count} 8 <button onClick={() => setCount((c) => c + 1)}>one up</button> 9 ...
Create derived atoms with computed values
A new read-only atom can be created from existing atoms by passing a read
function as the first argument. get allows you to fetch the contextual value
of any atom.
1const doubledCountAtom = atom((get) => get(countAtom) * 2) 2 3function DoubleCounter() { 4 const [doubledCount] = useAtom(doubledCountAtom) 5 return <h2>{doubledCount}</h2> 6}
Creating an atom from multiple atoms
You can combine multiple atoms to create a derived atom.
1const count1 = atom(1) 2const count2 = atom(2) 3const count3 = atom(3) 4 5const sum = atom((get) => get(count1) + get(count2) + get(count3))
Or if you like fp patterns ...
1const atoms = [count1, count2, count3, ...otherAtoms] 2const sum = atom((get) => atoms.map(get).reduce((acc, count) => acc + count))
Derived async atoms 
You can make the read function an async function too.
1const urlAtom = atom('https://json.host.com') 2const fetchUrlAtom = atom(async (get) => { 3 const response = await fetch(get(urlAtom)) 4 return await response.json() 5}) 6 7function Status() { 8 // Re-renders the component after urlAtom is changed and the async function above concludes 9 const [json] = useAtom(fetchUrlAtom) 10 ...
You can create a writable derived atom
Specify a write function at the second argument. get will return the current
value of an atom. set will update the value of an atom.
1const decrementCountAtom = atom( 2 (get) => get(countAtom), 3 (get, set, _arg) => set(countAtom, get(countAtom) - 1) 4) 5 6function Counter() { 7 const [count, decrement] = useAtom(decrementCountAtom) 8 return ( 9 <h1> 10 {count} 11 <button onClick={decrement}>Decrease</button> 12 ...
Write only derived atoms
Just do not define a read function.
1const multiplyCountAtom = atom(null, (get, set, by) => 2 set(countAtom, get(countAtom) * by), 3) 4 5function Controls() { 6 const [, multiply] = useAtom(multiplyCountAtom) 7 return <button onClick={() => multiply(3)}>triple</button> 8}
Async actions
Just make the write function an async function and call set when you're ready.
1const fetchCountAtom = atom( 2 (get) => get(countAtom), 3 async (_get, set, url) => { 4 const response = await fetch(url) 5 set(countAtom, (await response.json()).count) 6 } 7) 8 9function Controls() { 10 const [count, compute] = useAtom(fetchCountAtom) 11 return ( 12 <button onClick={() => compute('http://count.host.com')}>compute</button> 13 ...
Note about functional programming
Jotai's fluid interface is no accident — atoms are monads, just like promises! Monads are an established pattern for modular, pure, robust and understandable code which is optimized for change. Read more about Jotai and monads.
Links
No vulnerabilities found.
Reason
30 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/publish.yml:8
Reason
Found 24/30 approved changesets -- score normalized to 8
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/compressed-size-action.yml:1
- Warn: no topLevel permission defined: .github/workflows/lint-and-type.yml:1
- Warn: no topLevel permission defined: .github/workflows/livecodes-post-comment.yml:1
- Warn: no topLevel permission defined: .github/workflows/livecodes-preview.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish.yml:1
- Warn: no topLevel permission defined: .github/workflows/test-multiple-builds.yml:1
- Warn: no topLevel permission defined: .github/workflows/test-multiple-versions.yml:1
- Warn: no topLevel permission defined: .github/workflows/test-old-typescript.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/compressed-size-action.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/compressed-size-action.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/compressed-size-action.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/compressed-size-action.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/compressed-size-action.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/compressed-size-action.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/compressed-size-action.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/compressed-size-action.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-and-type.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/lint-and-type.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint-and-type.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/lint-and-type.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-and-type.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/lint-and-type.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/livecodes-post-comment.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/livecodes-post-comment.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/livecodes-preview.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/livecodes-preview.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/livecodes-preview.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/livecodes-preview.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/livecodes-preview.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/livecodes-preview.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/livecodes-preview.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/livecodes-preview.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/publish.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/publish.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/publish.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-multiple-builds.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-multiple-builds.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-multiple-builds.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-multiple-builds.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-multiple-builds.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-multiple-builds.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-multiple-versions.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-multiple-versions.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-multiple-versions.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-multiple-versions.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-multiple-versions.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-multiple-versions.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-multiple-versions.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-multiple-versions.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-multiple-versions.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-multiple-versions.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-multiple-versions.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-multiple-versions.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-old-typescript.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-old-typescript.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-old-typescript.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-old-typescript.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-old-typescript.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/pmndrs/jotai/test-old-typescript.yml/main?enable=pin
- Info: 0 out of 16 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 11 third-party GitHubAction dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 28 are checked with a SAST tool
Reason
97 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
- Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
- Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
- Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
- Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
- Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
- Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-33f9-j839-rf8h
- Warn: Project is vulnerable to: GHSA-c36v-fmgq-m8hx
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
- Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
- Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
- Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
- Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
- Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
- Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
- Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
- Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
- Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
- Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
- Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
- Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg
- Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96
- Warn: Project is vulnerable to: GHSA-3949-f494-cm99
- Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
- Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
- Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
- Warn: Project is vulnerable to: GHSA-q9mw-68c2-j6m5
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-54xq-cgqr-rpm3
- Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
- Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
Score
5
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More