{"id":19251345,"url":"https://github.com/springtype-org/st-state","last_synced_at":"2026-02-28T02:15:57.963Z","repository":{"id":57369107,"uuid":"336107598","full_name":"springtype-org/st-state","owner":"springtype-org","description":"~250 byte nano library for client-side state management and persistence","archived":false,"fork":false,"pushed_at":"2021-02-05T23:21:41.000Z","size":138,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-05T08:46:37.938Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/springtype-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-04T23:13:31.000Z","updated_at":"2021-02-09T16:21:13.000Z","dependencies_parsed_at":"2022-09-15T21:31:12.487Z","dependency_job_id":null,"html_url":"https://github.com/springtype-org/st-state","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springtype-org%2Fst-state","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springtype-org%2Fst-state/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springtype-org%2Fst-state/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springtype-org%2Fst-state/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/springtype-org","download_url":"https://codeload.github.com/springtype-org/st-state/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240347763,"owners_count":19787230,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T18:22:01.667Z","updated_at":"2026-02-28T02:15:52.929Z","avatar_url":"https://github.com/springtype-org.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eSpringType: st-state\u003c/h1\u003e\n\n\u003e Nano library for client-side state management and persistency\n\n[![Gitter](https://badges.gitter.im/springtype-official/springtype.svg)](https://gitter.im/springtype-official/springtype?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n\n\u003ch2 align=\"center\"\u003ePurpose\u003c/h2\u003e\n\nThis is an exremely tiny, yet powerful library for global state management. `st-state` can also save and load state from/to `sessionStorage` and `localStorage`.\n\n\u003ch2 align=\"center\"\u003eFeatures\u003c/h2\u003e\n\n- ✅ Abstracts the HTML5 `local/sessionStorage` API\n- ✅ Tiny: `202 bytes` (best, brotli) - `324 bytes` (worst, umd, gz)\n- ✅ Zero dependencies\n- ✅ First class TypeScript support\n- ✅ 100% Unit Test coverage\n\n\u003ch2 align=\"center\"\u003eHow to\u003c/h2\u003e\n\nThis is how using `st-state` looks like:\n\n```tsx\nimport { tsx, render, Ref } from 'springtype';\nimport { $ } from 'st-query';\nimport { store } from 'st-state';\n\nconst RANDOM_NUMBERS = 'randomNumbers';\n\nconst RandomNumbersList = () =\u003e {\n  return \u003cfragment\u003e\n    {state.get(RANDOM_NUMBERS).map((randomNumber) =\u003e \u003cp\u003e{randomNumber}\u003c/p\u003e)}\n  \u003c/fragment\u003e\n}\n\nconst App = () =\u003e {\n\n  const randomNumberListRef: Ref = {};\n\n  // remember randomNumbers generated before\n  const defaultRandomNumbers = store.load(RANDOM_NUMBERS, []);\n\n  // current randomNumbers state, possibly initialized by remembered ones\n  const randomNumbers: Array\u003cnumber\u003e = store.get(RANDOM_NUMBERS);\n\n  const onGenerateRandomNumber = () =\u003e {\n\n    // updating the state locally\n    randomNumbers.push(Math.random());\n\n    // setting the state gobally\n    store.set(RANDOM_NUMBERS, randomNumbers);\n\n    // also persisting the state for re-visits\n    store.save(RANDOM_NUMBERS);\n\n    // re-render the UI\n    $(randomNumberListRef.current).html(\u003cRandomNumbersList /\u003e);\n  }\n\n  return (\n    \u003cfragment\u003e\n      \u003ch3\u003eRandom numbers:\u003c/h3\u003e\n\n      \u003cdiv ref={randomNumberListRef}\u003e\n        \u003cRandomNumbersList /\u003e\n      \u003c/div\u003e\n\n      \u003cbutton onClick={onGenerateRandomNumber}\u003e\n        Generate random number\n      \u003c/button\u003e\n    \u003c/fragment\u003e\n  );\n};\nrender(\u003cApp /\u003e);\n```\n\n\u003ch2 align=\"center\"\u003eAPI\u003c/h2\u003e\n\nThe following contract is made between the webapp and `st-state`:\n\n```typescript\nexport interface State {\n  [key: string]: any;\n}\n\nexport interface API {\n  state: State;\n  get(key: string, defaultValue?: any): any;\n  set(key: string, value: any): API;\n  load(key: string, defaultValue?: any): API;\n  save(key: string): API;\n  loadForSession(key: string, defaultValue?: any): API;\n  saveForSession(key: string): API;\n}\n```\n\n\u003ch2 align=\"center\"\u003eBackers\u003c/h2\u003e\n\nThank you so much for supporting us financially! 🙏🏻😎🥳👍\n\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\"\u003e\n        \u003cimg width=\"150\" height=\"150\"\n        src=\"https://avatars2.githubusercontent.com/u/17221813?v=4\u0026s=150\"\u003e\n        \u003c/br\u003e\n        \u003ca href=\"https://github.com/jsdevtom\"\u003eTom\u003c/a\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003ctbody\u003e\n\u003c/table\u003e\n\n\u003ch2 align=\"center\"\u003eMaintainers\u003c/h2\u003e\n\n`st-state` is brought to you by:\n\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\"\u003e\n        \u003cimg width=\"150\" height=\"150\"\n        src=\"https://avatars3.githubusercontent.com/u/454817?v=4\u0026s=150\"\u003e\n        \u003c/br\u003e\n        \u003ca href=\"https://github.com/kyr0\"\u003eAron Homberg\u003c/a\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003ctbody\u003e\n\u003c/table\u003e\n\n\u003ch2 align=\"center\"\u003eContributing\u003c/h2\u003e\n\nPlease help out to make this project even better and see your name added to the list of our\n[CONTRIBUTORS.md](./CONTRIBUTORS.md) :tada:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringtype-org%2Fst-state","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspringtype-org%2Fst-state","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringtype-org%2Fst-state/lists"}