diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 5a10dd49..7303f4fd 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WVW2/bIBSA/wt5dbZe0k6NpknZS/fQaZdM2kNVWdg+tVEotuDQpJr236eYOjYYsLe9wsfnczGc+18E4YBkTW41K0CRhDQUK7ImT3WhOai3Zv1NhU+cJGTHREHWFwnJK8YLCYKs70+KTfpNs3yXbpFK7E3PVDKaDVwWZ5svL34nJ9/H9A6eQdKSiTL9ynXJhIpoffjI/jDwM1HAYZxxuzwrYfORmGFxQoxodX6zujxbDYLYAm6RImxyZHXcNUIjTgS5keWPlwamlBYZMmoF32+3vepRizaITmb27aJdr6xqN24Du3AaX6tCFQepmMIvTfvxuGsxgkPZNQac0PXUv3rSV+C/UmUCQT7S3KO1jzhfubqORdo31JV6Y257O+yuRsY9/WiXZ6X7vs1LUP4hZEk7Ip0lvGMKQYDsdfjS+GQd6FjPbt6dXw2fo8/6ePkmdQabklm3KWAa3SiPBvJaFtOmFvPKEpJzqtTxrCqWTC3hYE6R4YOiM5VLls2oZo/6Yx/+NO77OVSavan8Q6/n0GQzM4y+t9MR9siUr+R1RrnV7n5yGd8JiczCXAJF+FTXO9+dNZ6eGV1WV2RSmFIZalqmM/fnCPg6MKJkguFPhtVo3rtKB4wozXCaJR2h0ZG2Z1gtg3PtuJv+zXCLxBl0LnyHQvPJdMGXveU1WKSg+3gpLdk+WsuHP0W7O9KBCgAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WWW2/TMBSA/4v72sIu3dAqhFRexsMQlyJ4mKbISc4Sq14S2cdrJ8R/R43JxY4vAV7jz1/OJfbJ/U+CcESyIbeK5SDJkjQUS7IhT3WuOMjX+vmrEp84WZI9q3KyuViSrGQ8F1CRzX2v2CZfFMv2yQ6pwMH0TAWj6chlcKb58uLXsve9T+7gGQQtWFUkn7kqWCUDWhc+sT+M/KzK4TjNuH08K2H9kpBh0SNatD6/WV+erUdB7AB3SBG2GbI67JqgASeC2Iri20sDMaVB+oxKwtfb3aB6VFUbRCfT62bRrtdGtRu7gV04jatVvoqDkEzip6Z9edi1mMC+7BoNRnQD9a+e5A/wX6myCkE80syhNbdYb7m6DkU6NNSWOmNuezvurkLGHf1oH89K922bV0X5O58l6YhklvCOSYQKxKDDl8Yl60DLenbz5vxqfB19VKfDF9VpLCYzTpPHNDlRDg1ktcjjphZzypYk41TK016Zr5hcwVHvIuMLRaUyEyydUc0Bdcc+/mjs+3Os1Gux/H2359hkMjOMrrvTEg5IzPedcgV+V78c8xS8Tik3PpthAmpXjwRmaiaAInyo673r7GvPwEwOvS3SpYipNBWXqdT+yDy+DgwoWcXwB8Ny8t9gKy0woNRDbpZ0ggZH44FhufLOx9Nq8jdDMhCn17lwbfLNOd0FV/aGV2OBgh7CpTRkh2AtH34DQMxza8kKAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 8d82a62c..cb28aad0 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA+09247cOHb/Ij/ED1pZvImSMTPAJA+bABtkEwfJg9doqKtVVYKrpBpdut1r+N8DXouHElUse2ee8lS0xHPhufOQan9Nhv5lTN5//Jp8brun5D1Ok64+N8n75M9z+9SMSZrMwyl5n5z7p/nUjO/U4+w4nU9JmuxO9Tg2Y/I+Sb6lBge5Ivn14T/ndvf54cNUD5PF9VwPbf3oYAPTVnCnyaUemm66srVK7Z8f/tI8N0N9aLvDw19P86HtxjDRtdl30r6Sbrun5stCWPLppqwKalHMY/Nff/5gceznbje1fWewqNfbDCou1vi7eNIwHF6C697A8u7SDGM7TiFsD/r9NlZWWLx/VfP/4yIXbNG23dQM+3q3ghlCbEvF5/rKA8rxVf7ja7f7TtJvNGwUfQ9BkJ2pH+pD890cWfAfZMqxUF/tVxP1OQobQJRerhY3T+1pabXy6bZ15RVH7IrnQzNNzfDrcPjv18tVptPrxWIDM7YZV0xtEvsw1VPzq5ROiJoz5T5yBWPk6jsPD9PGknwib+z0DVoe4HqwPZz6x/rkRqxrhFVY7Iw7l3c1uN3Q1FPzYX7cDe1jM6wYnqLkzftRetISbhGTk36Q0r/2/ecbdMSUH7NGldpWDUS9+p2sz0EeZ3Wa0UA8bLt2iqST6bm3iWWasX/I8iRZjfFP6B76iuHAwvvuX451d4jmwpn/RwvAkDZCIHcJwTK+6jFCRP/bTke/rvPdxpv33R6q6q0YiouZd/qrJfnSTsc/hSo18fIhplxbRJkVxgEyNWubacBapLHcJvdGj2+EB5e4AddLW132y6bSADMvsVr7BwrAp/nGfXCPKFw4d81X9iiqKMnpjTJouV1540+M22+skFsrhNbpwZnfR9DLdSuE7IzvJLC+U1nbTr1ZzN0sgzeI3thuKWrXSd9LJhzxgjHozRrMXQ50jX4/yR1OV59+CdT7D2bCw48VRG7N6iY0B39c0Zo5LG/sBubH0atfA1SvM7+beHT2DpONK9au1B3434URW1GZAf4e1jKAbENd/z5Pbs4MsKpm/aFqckjerSK9qPCq/9KOU9PdNlEz7w9dOSB699rt0r59SnV8f/81eRbhsu+S9wnOSFYlabJvm9OT6IUq5tJk15/PAucn/e5/mt3UD2KGmvIuT9KPeUpoVjH26VP60UDIF/KBnIaS9CNamyZe4JRkiJGUpEj+0jTPCkxTpn+LFGW0JClPUZZXZVrq51WaZ5SjFOVpnlUlSRHSMxDWUxAxA4MUGayoSPOMl2WKuAEvNQOo0gOc68kY6TnYYMYGMzaYscGMBcM5Jynm5olhGQvMRV6mxGAmSNMiOMUZYSkhmhQxiIlBTAozEIgZwSmRiFGZkkq/ogIxxUVKkZ5DDcuUmFc0RRlGLKVMy4AKzCVHKeVaqNSwTAVmjlHKcv2KSWHgMmXYPCEanAnMDJGUGcxMCAMznDJuBgIzqVJm9FcYxIVhucBmYKRcGGEU1ioEy4TQtDBSLkqDxwiDG8wcmSdGGNxg5gYzN5h5oZXEDWZeaoHxKsVZnpO0NPorkV5oiVOU8bxMSyOMkponTOu4LLRuS671Vhoxl8bmKoO5MpZRYU20Mh5SUU2iMjxXxjQqw3Nl3cRIA+W5FivKkX1mXSW3vpJbZ8mtt+SawNWnsfDpnK95NZZejTPOmPRejLj0Xl6U0muxEI1gRvAilokJEw6JMs6lQ6KMkFJ4HcoYxcKj8qwqKuEcKEOoUB6gHABlecmV3WPGld0XCClzl0+YHkjDpcY6aVkJ68yzEpXCOoVmkLJOSktljMYWxa/hoZBhoiyUdYml8FICV8I85FxlFDlSRiH4lbYg1iRNQEyR7lBVQpcoI0Wh1SO1Iz1EmGEurULECCUu8QwhO8J2JOSSi8AjAx0XspSRTr0tNMcIcS0chEr7rDKw2NLAloYMeBKfjHhqRO1bplnGhRlw+86uAlsKMuwJwYs1aU6IdHYqRsRAELsKwixEYd9aGkr9EnNlnlG7CmkKQvGIWklRS4PaVVBmsNBCaxLJQCg5oHYd1NJguQgRInkwKymmDQUxS4JZEioeMpYiZpfBLAlmSTBtQagQFIjQf2EpFHYVhSVRWBKFXYU0VSnbwkpKBkcp5cKugltJyfgoWeFW39zS4FYb3NoUL+wzbuhKP1DPLI3SGHVpl1HaZZTWbEtqWC6ZQVKqpMRSpMKlYL60kiqNpCpDobIUKkuhIibcVFZQlaVQWV1UXDsqqiyFyiwCS88U3OEc2Wda3Tgn9hG1I2ZHhR1xOyrtyJKw/o2R0QW2/o2RpYEsDevfGFkayNJApV44RlpQGOdmYBeBLQVsKVjvxthSwJaC8e9rHiAi2ONyLQ8QUATSJP0oSqgio3kF5lGZL1BWIJEvcCZWzkXSk+kBZ3mhsoNcTyFfEBX6BQTN9StKzIAKJLxMpWfLJ7KIxKK+Ub8ysHKWSk+mWOQGnNGKiKJGPSD6l+pfg0pWNBKUm0FpBpWaW2ikJdIwMtrnOZcxST1ChjKSmHPxSKYW8ag0qLGuGEmKiZ6PZckoB9i+I+YRNQMmB1fpM5muqxSjrGQIiJ8BNRVCGaRY02cBJnI5kae4ysqcgIkcTCzlxFULKXWlUCIVBGhGSyytl2QVd9ivBPtC90tilYsDszAOJDYlIt+smKB8J22rpKUwD5yVJRdZXxQlVCYisU2hMkngjOVKczgrCrEbqFIqCzpMczsSJlXKLQK2z4gaOUzJLZCw2OXK5DtnqqyrKFudiuFU6ZV0VV4IuiWS3iccg2UEe1KhcCqTU1c1iaAVIWlGtFqdKt4JIRakUn5eMSFpnFFRM3E9wCyXuiQpZiglWYlxKjYQ8plDSdqh2EGtUOKakohgXP9KV+e0VJQYQ9LfcFaJ2rMSNPMCOfiljTK6ir/U+EXiFhVrRoWtiAJVFi1CrySrxBvGpOarVNz6MCOuRg4xaeeEpZiI1AeJVUDCOA/rDcPtN5Y2xlb1hqGNYbyBFdoYljbGVlWMoY3hDRvD0MawtLFitakg30mlUbH9J5nI1tJwcMFl3UOyQtRMpR1VRE8TCVs9wwVKaSZiJi6wGjnkhW2K6nglRsh3/5+nft88hblOVIhlrCByz4B4lueeKcAUg0uptmJVbSbJFKhIZYFPCrkdlaFFhh2lJK7ELZsUSGqGeP0LsXeXUhRPCtPnKYTjk4qLHaEelLIPogXK1SZP/Fvt6GS3ScqJCFFKQYlGAZLql/OY6hkUWsaCHpY7NTFPlHI44znT0hYQStxqROyI2hEzIyFThUUkLtlYwAWzo0KNHNFWG74LQxKRCRatlgTynVheyamUvviV0hd7LRk7xUAKlTIu2ig4y4UYhMtmLFfbR5xxoStpnqVQBZN9MyEaKTJWVHIXpZ+VuR3ZZ5XFXHH9TFT4elQQOxJvuagWSjOo9EAqWg6QGch+h2PHBIXFRmDMJRt5ncCYSzbyOoExl9BwKiEw5hIWLuUIzOukCNdQBNaHhIdDKYHuS6SL8tUcLt85U5U5olVeoTlSmSHZ6lQKMyTd0BaF2qIbGZJCbVGpLb5aOlBvc7SRISnUFpXa4mwVK9QWLTawKm3JE4HnZpiap39TJwMfPyZJ+jV50AcF9oTk67frgcD7rwlST7D6oeqnVD+VflfoX/n42zdBPndxi57XbewKELmAxQ046jKg4X96d8SQONpCoqCwD1Wx20DmfMYRIuUWLEGGu1z/ahli81yLj5jFmF8jaz2PqtW5XCj6NSBd3KNAlK+pLk1Ifl1e/fCbvKs+qivtjkSdNYZY2+2acQSq3NQCMAEF3D6egGzZDQtdsYV6N/SQC3pDSmtInp5cDCTCmuqn53asPf6LCIuqTyewZHI/t6ehqZ9egWXwEMtA26exB1DXi3kelKupc98dgGlgHgHVARAaQ6gDSqBVlGDWrdxifNcPgBEWMg6XkcsFMBJa7oaGLpdT2zxB3w2hARoaYKyJsafhMMvH7jLLkFW5yxyhVmNA5qk/11O7q08naH9FSFtgdc91e/J9RvSubxJ+/OXrrp+76dtP7x5BCN/0dQ37cLp+GmMvJLrJwwnoOBDsHuvxCBa8aZ0aBq6z2nQbGJcfm67Zt7u2PkHrDXm5K6pmemmaDqasYFx1ac6eDYWWuMYvsAZxiHWTz50XIm54GYTseshr0A4A2AidKw95lwcErYWXEVCn1vNIFgqA4SCy68+XvvPwVDfwmPqjXMED1sE2Q4tfS6zyNb6TPtkM2TR+AUxu6nKB5akdL6f61cdSbhaGBku3P7U7uDS+KSMLOEIFxdifJw9fzt041WJB6lsRwFJEnNr13VS3XQuzrdjur4NustKfexgCgokPAbgZmlswBiAPqAFplt/I3a6rDHUzeUkvqHjXCvVtcDfqFE4cLxeB3KgQLFhi+ambz4/N8Mvbv5nbqX4+JZuxEOAS+4Vf3n5uvPwYLIAW3DzBKBwTbiTcUX5/48rxStMsepnYFOwImQ2G75UthEagPzNyyROHPN8mf/0oys1alYMgtEGSCFq/Qo1R1zxO/RkQRBHp9anZ1/MJOknMtsxAXxpY5oobA7eJtrvJt/ZgRgFw+30zNN0OOlhQPCvRXgdnsN4Qx8gFewYZYXNjp0H6rp/Ux05uuo3YbDQZDJnoRuXi+lzTTkdod+K6zW2Snfw4EFpdRCHbdMfaU4e4EBQBN85wbxCu6RyoaQcoFSEYl9KX+nyBJTqP2IZoMBhIIgyl+XLpYeshWGCFS5zmyzTUuwmGnyDTDuC+PsGiUFxauSmifVNP8+BrPyJ47JsXuGu/LZ996+kips0GpbNvh9Erlzfr8zTBbBnn93AnHZPhDSKDYB6mIxR2hD3uBxily5gKWIPqT5YA+F11HtLFlcpf68WWoVKf2snbBkUs79BA1UTUrof22dvf8RAhV4GqKh0O0EVp6SRZFkiyB/G3IoAUI7jUf3LjCnS13CQPEDriX5Z7p6C1OtSOzemyn08wDURsCo+N13GJkP+xPXgpA8do2q/PSFycM5ZYrlkgdNFj/yI6HSBLxLdk28zbHkcEtPap6aZ2D8yeRhhHu4e1zKb44CLb87l5auupgR0ocSvxNrtnP9kEI9CKfIDPFfdnKf1nVdxCzHE+EnAJvyLCTsGY4FBzXkD53SMakdo0XPt3mBWLTVeCcf6KAjZAgwdEa0q2OGC0CmY/H1h8oLfS68POaZNhek14F68XlkcUW203elESBVvHQOLj5J0JoBgPUmC1n9+CrTcAqz4ngqJ1tmsktFtsu+d+t6CJg84A1fLcf/Zt4objA7uC9VawSxDuXHlbi+D5n6ud6Z/gEVdEfvD2/kG3u9lp+9y8QuIR9eK11w0NOGKXeWofh3qAUTXC7k/2azvXmq6LTmjIz079zgtRwQMPLaTKIdsf2h0MjEHxOEH4XH+GR473Hz+f664+eOuN8Lpz3cGeUB4RHc5w642CnTUXpn9q997xk7g3dxtwPk2tt/fDwcY8APTbE9hpwiY0lNvOr7YN/PYy9Bev0x6R0R0MKwgiqjLx3juoC5J1glHXePINhsCwe/uHGMGG90qC7PoXmGkiegjdBWykSEQo62YvM1UROun30DVCvrHRwPZyGrvjKKrvdvovxrihwWkl4pA1Gsifv8Isnkc4d995B6IxTR24ow7KaVmK9sOTvwGJOHGTUJ6xB686bCln0TELN4w9KK9lEhGT+hevvIloe17q3ef64J2+3tbhpR6mdjefaijaPCLkClAYqElE2LzU3s2VGAtYDSX272W4HFyjn70lQZZtdMCQPv14WhwEoeCubgnem78R4tqZc8aueykkVBZoNB6CoAId37/ov4fiSsEpRJC5jUUDUkhXsIErY+Izq9tiWLtj4AQg3VzDyzMRuGuEcc38pZIzdOCYyziLv3TpytU5NAudsWj4T2+zdyRbO3DBwZtpLhd+/ok4370Mzb4Z/KAVUZRehubZayMFywkA5tcQ4WrAg8oC5xcxkpHwes/77JXEwdPsBQJv34F4RFRWkGsWG2z6O9Dy8iDQ6W0RD6iELUgSoU4JJC4KTO/WeA2mTryKQjQHYKM2IsQPTT16ZUn4UNcF23upenuPY6B+m9uhOfu3NlDwuiAAnuYBcBqs2pAP5XVLgqw65cCio+zcHSXVMsa5IXYU89wdbnw7bmwu9eDtOoK30JAL99vsH8HhoA2u5FqBYHGkGm6QlS6kV/DfuBFmWr8bhw9jMy1ydXCrh5Zwby/1MDZtN71tsqkeDs2UPdenucmmoT3DDBaxXRibaauEiPCysZlGfy8ZPCGPvppjsNaL4yDs3BZOENFpN7RDWN5yEF8ZbupQ33xwwOvhsLxT7lYpZlMTuoso0PgJOLhHcWV77OeT13+LqOr8rmaw2HcNoT23Xh2NgkcR6/pzax+NDm6xwhWhA/i5vVwWsooI22N/9jrgEfu58dLs2v2r33sLlvUuqH8BP8bbBIzXhog4qV/6V8wZUVw0mvy7RMHjdJ+hMfMu8UX0Ou2fBXf3lI4/ryQfDKGhYcd9XmH2UuZs2ByWrxXtkgbsIKOYW0YSzpMICu7VV86aBILFragYuzd/Yw62T4JpuVgB9a6BOeUAXZ77eih2sDCL2W6pP1fvJnPngCx0kCGAvLIluB1x9DnVjx5UMBi6UMcaZsLg3ZT7v+CZjvB6yF2u7N9uYDH02gGGHBKxw5mO3unNXSHHrb6m4wwxBa+WueTbs1euBYGcHu8EPpa579srT7Ixp/fT0B4OfoMOBS98u8sbZu8S0yaQ/rZPw0J7Dh49upDgHMa7tR2+ZxxbrE2zfwQR7BRsYXm9ND//LVE3e2EhG5GSptdLD9NRxCZ17trfoCKCnz2FD5fmrmvEp3HeQVxwLw/oT63XrY+ouOfRS6FBf3ZJwVtzwbsXN915Hv0T4YhoMo/N+fV6U1tfQF/kcxS8YePj8rew2zc5oaEZBG9XmzA45rOqeWw8Dpzvt5KVZiVaRg+F4+3KZfygESAf2rkHv4IneAizYcwQ7RpzEU1AhSVwowMh9zqM2TuEWqsW4aIIDqf/2ya8OGyPbmKIv+/q3RrEwSuAPhy8oxM8cAhQ/bvPdSxdrwByPzJY3kYCZ++yswC3RjfuFdkKyMfy89dlfyEYOpAH7J0shNa9kV3s/w4D94gR4fa5GTx1R7QDn1v4HXiE07zUnnTCvTwHqDntvI1vRLJ8OcLrqCj4QcTKrZ6X1jthDt7icPn0G7jEvdZ137mKwOWdGQXv2Xgs9N4tseCVfA9uNYw5B2RkZZu0juLtRzVAMOdE7DBfa9giDn5m5ij6tZ+hnL43ZL72s3d8HRe7PqXJpb00p7ZrkvcfP3379n/PKOaK828AAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA+09247cOHb/Ij/ED1pZvImSMTPAJA+bABtkNw42D16joa5WVQmukmp06Xav4X8PeC0eSlSx7N15ylPTEs+F535Iqvw1GfqXMXn/8Wvyue2ekvc4Tbr63CTvkz/O7VMzJmkyD6fkfXLun+ZTM75Tj7PjdD4labI71ePYjMn7JPmWGhzkiuTXh7/M7e7zw4epHiaL67ke2vrRwQamreBOk0s9NN10ZWuV2r8+/Kl5bob60HaHhz+f5kPbjWGia7PvpH0l3XZPzZeFsOTTTVkV1KKYx+a///jB4tjP3W5q+85gUa+3GVRcrPF38aRhOLwE172B5d2lGcZ2nELYHvT7bayssHj/rOb/10Uu2KJtu6kZ9vVuBTOE2JaKz/WVB5Tjq/zH1273naTfaNgo+h6CIDtTP9SH5rs5suA/yJRjob7arybqcxQ2gCi9XC1untrT0mrl023ryiuO2BXPh2aamuHX4fA/r5erTKfXi8UGZmwzrpjaJPZhqqfmVymdEDVnyn3kCsbI1XceHqaNJflE3tjpG7Q8wI2V/rU+zU1QpPbtfetzIvrh1D/WJzcsXsO4omFn3CnDq1Xvhqaemg/z425oH5thxboVJW/ej9KT5naLmJz0g5T+ve8/36AjpvyYyav8uWoF6tU/ycQd5HGmrRkNBN22a6dIOpmee5tYphn7hyxPktUY/4Duoa8YDiy87/7tWHeHaC6c+b+3AAxpIwRylxAs46seI0T0v+109ItH3228ed/toaqoi6G4mHmnv1qSL+10/EOoHBQvH2JqwkWUWWEcIFOztpkGrEUay21yb/T4RnhwiRtwvbTVZb9sKg0w8xKrtX+gAHyab9wH94jChXPXfGWPooqSnN6otZY90Rt/YlxTs0Jurdpapwdnfh9BL9etELIzvpPAeju01rO9WczdrLU3iN7o6RS166TvJROOeMEY9GYN5i4Huka/n2Qb1dWnXwJNxYOZ8PBjBZFbs7oJzcEfV7RmDssbLcf8OHr1a4DqdeZ3E4/O3mGyccXalboD/09hxFZUZoC/h7UMINtQ13/Ok5szA6yqWb+rmhySd6tILyq86j+149R0t03UzPtdVw6I3r12u7Rvn1Id399/TZ5FuOy75H2CM5JVSZrs2+b0JDZcFXNpsuvPZ4Hzk37312Y39YOYoaa8y5P0Y54SliHGP31KPxoI+UI+kNNQkn5Ea9PEC5ySDHGSkhRliKY0zbMCFSnTf4sUZbSkKU9RlldFWurnVZpntChSlKd5VnGSIiRnpAjrGYiYgcGJDFJUpHnGS5QibqBLRR5V6i/O9VSM9Axs8GKDFxu82ODFgtu8KFPMzRPDLxaIWYVSYjATpEgRnOKMkJQQTYkYvMTgJYUZCLwMs5QovDQllX5FBV6KcUqRnkMNx5SYVzRFGc5ZSpkWABWYy4KklGuBUsMxFZg5YinL9SsmZYFxyrB5QjQ4E5hZjlNmMDMhC0xZyrgZCMykLFJmlFcYzIXhucBmYKRcGGkU1iQEz4SgtDBSLkqDx0iDG8wcmSdGGtxg5gYzN5h5oZXEDWZeaolxob+qrNLS6K9EeqUlTlFWVDQtjTRKap4wpeOy0LotudZbacRcaourDN5K20WFJUWWVto1KqrRV4bfythFZfitrH8YSaA81yJFObLPrJPk1kty6ya59ZNcE7j6Mha+nPM1b8bSm3HGCy7dFiMm3ZZzLN0Vl8pbicAsFomxdEWU8aISrogygpnwOJQxXApvyrOqoMIzUCa4kuYvwIlQS14SZfWYUWX1RU6UscsnTA+k2VKkTFPEEiaNHmFhmkItVJkmpUQZoqAgDZEYaxNcFDJEcKZsC5fCNvKsKoVpqKnSIqTasWZYGoJYlDQAOUd6Q8WENlFGmFGQFEouPYSjFOXSKrAIa7l5hpAdYTsSoslF4JJRjuc8RTLMqbeFZhnJQCfEg1Bpn1UGFlsa2NKQ8U7ikwFPjah9ywzPuLAjbt/adWBLQ8Y9IX1EjKoQkd5OWIpk8JMQxK6DMAtR2LeWhjIBibkyz6hdhzQHoXxErayopUHtOigzWGQkrMoUyUgoGaB2GdSSYLlwbc5TxKyomLEVxCwJZkmoiMhSxOwqmCXBLAlmrAgVuTYRVFgShV1FYUkUlkRhVyGtVcq2sJKS0VFKubDL4FZSMkBKXrjVOLc0uNUGt1bFC/uMG7rSF9QzS6O0dl3adZR2HaW13JIanktmsJQqL7EUqYhJBBYrq9LKqrI0KkujsjQqosNOZUVVWRKVVUfFtbuiypKozDKwdE/BHs6RfWY0jnNin1E7YnZU2BG3o9KOLA3r5BgZdWDr5BhZGsjSsE6OkaWBLA1UqoVjZCSFcW5HdhnYksCWhPVxjC0JbEkYH78mBCKiPi7XEgIBVSBN0o8lSXGRFYiAeVQmDpQViKVFijPBA09xlovogcRAOLJMKZyLtCBe6SQgYGiuX1FiBlSg4al0b/lA1pEIiTpHD2SELapUerR4wgQpWpWivNFPiBlQMzAIZXkjwbkZlGZQ6cmFwVwiDSWjfy5MnZpHyNJHEnleSo/Vj0qDHdsCEhMDgGUJqUbYviX2GbUjpkZXZTCZxgXaLGcMaIMBrRVCN6RYU28BJnI5kackz/K8ABM5mFjKiasGU+oKohTSKWlKM5ZTac0kqyp6xVEJ9oUJLIlVLg5RBYdwINGkiBS0YpHynTQ0EYNoJQYVE7WAKGdUbiKZiM8ibwirqaT6cFZwmmJSpVRaJqa5HQnrKhFPMcX2GVEjhynZElG6tjL5zpkq6y3KVqdiOFU6KV2VF4JeiqQzCi9hGSMUTqVwKpNTVzWJoBUhaUa0Wp0K7QhJQ2KrbaV8J+RdFCpCiJqokApATDiXGmCGUppR8W8m2ssSVylmRD1zKElzY3SVUqkpCalx/VcGCF5oSkwUrXJUiVquEprOOXHwS1NkbBV/pfGLbEpKaUKyXiMZy1EqLSCraJmKqyg0K0RdzLgdlWrklOXKmIVNZTkvYV0Ou3GMwhrG0MSwNDG2qjYMTQyTDazQxLA0sWJVwxiaGGYbWKGJYWlixeo+g3yndMbTKiWZSNbSbrDo6woh9kKU0qUdVURPE7lePcOFcFwRYLFomMXIIS9MUxTXK9FEvvv/BPe7Jjhc6gyHmO4m8hTxDFHPN0poRDKxyJ2cpRZNZimw6G/zrCKqv6UlUzqjeal0xpXwheFKmWPOzH4IV/IUSij1A5lVci4aTJyRSvSX6m8p91SoEipXHaP4t+oORa8iJUVEGpKSKqpCJiQ9TYpbdCdKyoIWlk2fmCcKQiy7VSVvmSUlFjUidkTtiJlRQQ0W2XpUIgzKZaiRWqETakke9mMCwxORu4VotZCQ7wSZssRS9OKvFL3ovGQYFQPJCWWF2JDBWU5LKTGcMSE3IpbNSaUttBQuwOQWXF5pkYkoIfox/azM7cg+qyzmiutnolHQo4LakeCJ58JAKjOS+lUjZEfYjogaORLBG8KDUZiQcE1AYBQmNFwTEBiFCQsnFwKjMCnCZSCBiZ7wcP1FYMlIynBwJdCDifRSvprU5TunIVFGidZ4pdAoqcyZophYmQpzJt3QFoXaohs5k3rNk9QWX60lKNQW3ciZFGqLSm3x1eqeQm1RvoFVaUueLjw3w9Q8/Yc6Zfj4MUnSr8mDPnSwpy1fv10PF95/TZB6gtUfqv6U6k+l33H9V/772zdBPndxi12029gVIHIBixtw1GVAw//07oghcbSFREFhH6pit4HMWY8jRMotWIIMd2aRRP9l6i/J9V8jW/NXz6N6HlWrc7lQ9GtAurhHgShfU12aEGd59cNv8nL9qO7gOxJ11hhibbdrxhGoclMLwAQUcPt4ArJlNyx0xRbq3dBDLugNKa0heXpyMZAIa6qfntux9vgvIiyqPp3Aksn93J6Gpn56BZbBQ5ID2j6NPYC6XvLzoFxNnfvuAEwD8wioDoDQGEIdUAKtogSzbuUW47t+AIywkHG4jFwugJHQcjc0dLmc2uYJ+m4Zo6EBxpoYexoOs3zsLrMMWZW7zBFqNQZknvpzPbW7+nTy7C8UxcHqnuv25PsMCoI6hB9/+brr52769tO7RxDCN31dwz6crt/y2MuNbvJwAjoOBLvHejyCBW9ap4aB66w23QbG5cema/btrq1P0HpDgckVVTO9NE0HU1YwruYO4OzZUGiJa/wCaxCnYjf53Hkh4oaXQciuh7wG7QCAjdC58pB3eUDQWnjIj12oU+t5JAsFwHAQ2fXnS995eKobePAyClo8YB1sM7T4tcQqX+M76ZPNkE3jF8Dkpi4XWJ7a8XKqX30s5WZhaLB0+1O7g0vjmzKygCNUUIz9efLw5dyNUy0WpL47ASxFxKld301127Uw24qmfx10k5X+3MMQEF4fgJuhuQVjAPKAGpBm+Y3c7brKUDeTl/SC5ZdrhfpmuRt1CieOV4tAblQIFiyx/NTN58dm+OXt38xNVz+fks1YCHCJfuGXt58bmB+DlSFecPMEo3BMuJFwR/ktjyvHK02z6GViU7AjZDZYra20EBqB/mTJJU8d8uU2+esHVi6C3EEQapAkgtavUGPUNY9TfwYEUUR6fWr29XyCThLTlhnoSwPLXHED4TbRdjf51h7MKABuv2+GpttBBwuKZyXa6+AM1hviGLlgzyAjbDZ2GqTv+kl9OOWm24hmo8lgyEQ3KhfX55p2OkK7E/d3bpPs5IeG0OoiCtmmO9aeOsQNowi4cYa9Qbimc6CmHaBUhGBcSl/q8wWW6DyiDdFgMJBEGErz5dLDrYdggRUucZov01DvJhg9gl7pAO7rEywKxRWYmyLaN/U0D772I4LHvnmBXdNt+exbTxcx22xQOvt2GL1yebM+TxNcLOP8HnbSMRneIDII5mE6QmFH2ON+gFG6jKmANaj+/AmA31XnIV1coTJcbBkq9amdvDYoYnmHBqomonY9tM9ef8dD+nQVqKrS4QBd1NlmSVARSLIH8eMWQIoRXOrfCLkCOek8DxA64l+WvVPQWh1qx+Z02c8nmAYimsJj4+24RMj/2B68lIFjNO3XZyQuzhlLXN2Ihy567F/ETgfIEvFbsm3mtccRAa19arqp3QOzpxHG0e5hLbMpPrjI9nxuntp6auAOlLjjeJvds59sghFoRT7A54LbeeE4rH8Hxi3ErkgSEnAJvyIS10GubU5ov0pA+btHNCK1abj27zArFpuuBOP8FQXcAA0eEK0p2eKA0YqHlOwDi4/9Vvb6sHNEYZheE97F2wvLI4qtthu9KImCW8dA4uPknQmgGA9SYLWf34JbbwBWfZoEReu0ayTULbbdc79b0BRn6zFqee4/+zZxw/GBXcF6i90wp5Vexmstgud/rnamf4FHXBH5wev9g253c6ftc/MKiUfUi9e9bmjAEV3mqX0c6gFG1Qi7P9kv91xrcvZiaMjPTv3OC1HBAw8tJCeanvpDu4OBMeg2Dti5/gyPHO8/fj7XXX3w1hvhdee6g3tCeUR0OMPWGwV31lyY/qnde8dP4mb9bcD5NLVe74eDG/MA0N+ewE7PmFAaMIDzq90GfnsZ+ou30x6R0R0MKwgiqjLx3juoC0I5wahrPPkG64Gwe/uHGMEN75UE2fUvMNNE7CF0F9BIkYhQ1s1eZqoidNLvoWuEfGNjA9vLaeyOo6i+2+lfn3F16vQeOGSNBvLnrzCL5xHO3XfegWjMpg7sqINyWpai/fDkNyARJ24SyjP24FWHLeUsdsyKGOoCytsyiYhJ/YtX3kRse17q3ef64J2+3tbhpR6mdjefaijaPCLkClAYqElE2LzU3s2VGAtYDSX2tzdcDq5xzN6SIMttdMCQPv14WhwEoWBXtwTvze+NuHbmnLFrkyKhskCj8RAEFegcYV/0b6u4UnDyEDZSYAEppCvYwJUx8cXWbTGs3TFwmjZ95wsvz0Rg1wjjmvnVkzN04JjLOIuf5nTl6hRqQYUo+E9vs3ckWztwwcGbaS4Xfv6JON+9DM2+GfygFVGUXobm2dtGCpYTAMyvIYJ32rAHlQXOL2IkI+F1z/vslcTB0+wFAq/vQMFdwQXkmsUGN/0daHl5EOj0togHVMItSBKhTgkkLgpM79Z4DaZOvIpCbA7AjdqIED809eiVJeFzUhds76Xq7R7HQP02t0Nz9m9toOB1QQA8zQPgNFi1IR/K2y0JGq9TDix2lJ0tFrrc6AUhdhTz3A43fjtubC714HUdwX0I5ML9NvtHcDhogyu5ViBYHKkGW3NXUqO31x88i/C2fjcOH8ZmWuTqYKuHlnBvL/UwNm03vW2yqR4OzZQ9i19mzaahPcMMFtEujM20VUJEeNnYTKPfS4b7+nBZtJCSxFovjoOwc1s4QfpWNgl1CMtbDuKzw00d6psPDng9HJZ3yt2rGqapCe0ICzR+Ag72KK5sj/188vbfIqo6f1czWOy7htCeW6+ORsGjiHX9kSU62GKFK0IH8HN7uSxkFRG2x/7s7YBH9HPjpdm1+1d/7y1Y1rug/gX8GG8TMN42RMRJ/dK/Ys6I4qLR5N8lCh6n+wyNmXeJL2Kv0/6OudtTOv4cugN2hYaGHfd5hemlzNmwOSxfK9olDbiDjGJuGUk4TyIo2KuvnDUJBItbUTF2b36vDu6sBl2er4B6t7icNpQuvyXxUOxgYRbTbqnf13eTuXOqFrp3JoC8siXYjjj1ylQ/elBBybhQxxpmwuDl2/u/4JmO8HrIXa7s324oYui1Aww5JKLDmY7e6c1dIcetvqbjDDEFr5a55NuzV64FQ7KzxzuBj2Xu+/bKk2zM6f00tIeDv0GHghe+3eUNs3eJaRNIf9unYaE9B48eXUhwDuPd2g5fu4ot1qbZP4II7hRsYXm9ND//LVE3e2EhG5GSptdLD9NRRJM6d+1vUBHBz57Ch0tz1zXi0zjvIC7YywP6U+vt1kdU3PPopdCgP7uk4K254N2Lm+48j/6JcEQ0mcfm/Hq9qa0voC/yOQresPFx+S3s9k1OaGgGwdvVTRgc81nVPDYeB873W8myGTFiJcjH8XblMn7QCBbQzj34FTzBQ5gNY4Zo15iL2ARUWAI3OpATsa69Q2hr1SJcFMHh9H/bhBeH7dGbGOK3Yr1bgzh4BdCHg3d0ggcOAap/97mOpesVQO4t/7XyznEVubMAW6Mb94psBeRj+fnrcn8hGDqQB+ydLITWvZFdJJplF++YIlqeMRhQ/Z/UwPYyIlI/N4NnKRE7ic8t/IQ8wt9eak+w4Y9XHKDmtPN65og8+3KEN1lR8FuKlQtBL613OB38xsnl09/7Je7R8H1HMgKXd9wU3geEYL13wSx4m9+DW42AztkaWXHBdRRvP6oBgukqojl9reHucvALNUdUr/0M5fS90fa1n72T77iw9ylNLu2lObVdk7z/+Onbt/8DM7snTN9wAAA="; \ No newline at end of file diff --git a/docs/functions/index.useRGS.html b/docs/functions/index.useRGS.html index 373bbc3e..b6fa37c5 100644 --- a/docs/functions/index.useRGS.html +++ b/docs/functions/index.useRGS.html @@ -3,10 +3,10 @@ unique key - unique across the app to make this state accessible to all client components.

Type Parameters

Parameters

Returns [T, SetStateAction<T>]

Example

const [state, setState] = useRGS<number>("counter", 1);
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/plugins_persist.persist.html b/docs/functions/plugins_persist.persist.html index d0c6c3d7..d07db6bd 100644 --- a/docs/functions/plugins_persist.persist.html +++ b/docs/functions/plugins_persist.persist.html @@ -1,3 +1,3 @@ persist | React18 Global Store

Function persist

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.createHook.html b/docs/functions/utils.createHook.html index 5955c9ab..9d05ffb8 100644 --- a/docs/functions/utils.createHook.html +++ b/docs/functions/utils.createHook.html @@ -1,2 +1,2 @@ createHook | React18 Global Store

Function createHook

Settings

Member Visibility

Theme

\ No newline at end of file +

Type Parameters

Parameters

Returns [T, SetStateAction<T>]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.createSetter.html b/docs/functions/utils.createSetter.html index 1c4e7eed..2fb889dc 100644 --- a/docs/functions/utils.createSetter.html +++ b/docs/functions/utils.createSetter.html @@ -1,2 +1,2 @@ createSetter | React18 Global Store

Function createSetter

Settings

Member Visibility

Theme

\ No newline at end of file +

Type Parameters

Parameters

Returns SetStateAction<unknown>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.createSubcriber.html b/docs/functions/utils.createSubcriber.html index 917022cd..abebb633 100644 --- a/docs/functions/utils.createSubcriber.html +++ b/docs/functions/utils.createSubcriber.html @@ -1,2 +1,2 @@ createSubcriber | React18 Global Store

Function createSubcriber

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

Returns Subscriber

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.initWithPlugins.html b/docs/functions/utils.initWithPlugins.html index c46cfe4e..7d031b5f 100644 --- a/docs/functions/utils.initWithPlugins.html +++ b/docs/functions/utils.initWithPlugins.html @@ -1,2 +1,2 @@ initWithPlugins | React18 Global Store

Function initWithPlugins

  • initWithPlugins<T>(key, value?, plugins?, doNotInit?): void

  • Initialize the named store when invoked for the first time.

    -

    Type Parameters

    • T

    Parameters

    • key: string
    • Optional value: T
    • plugins: Plugin<T>[] = []
    • doNotInit: boolean = false

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +

Type Parameters

Parameters

Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.useRGSWithPlugins.html b/docs/functions/utils.useRGSWithPlugins.html index 07558772..d2e04981 100644 --- a/docs/functions/utils.useRGSWithPlugins.html +++ b/docs/functions/utils.useRGSWithPlugins.html @@ -3,7 +3,7 @@ unique key - unique across the app to make this state accessible to all client components.

Type Parameters

Parameters

Returns [T, SetStateAction<T>]

Example

const [state, setState] = useRGS<number>("counter", 1);
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/with_plugins.create.html b/docs/functions/with_plugins.create.html index 36c6ef98..63f87968 100644 --- a/docs/functions/with_plugins.create.html +++ b/docs/functions/with_plugins.create.html @@ -7,4 +7,4 @@

Example

// in hook file, e.g., store.ts
export const useMyRGS = create<type>(key, value, plugins);

// in component file
const [state, setState] = useMyRGS();
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/with_plugins.withPlugins.html b/docs/functions/with_plugins.withPlugins.html index 334a167a..9d60a046 100644 --- a/docs/functions/with_plugins.withPlugins.html +++ b/docs/functions/with_plugins.withPlugins.html @@ -1,4 +1,4 @@ withPlugins | React18 Global Store

Function withPlugins

  • withPlugins<T>(plugins): (<U>(key, value?, doNotInit?) => [U, SetStateAction<U>])

  • Creates a hook similar to useRGS, but with plugins to be applied on first invocation.

    Type Parameters

    • T

    Parameters

    • plugins: Plugin<T>[]

      Plugins to be applied to the store.

    Returns (<U>(key, value?, doNotInit?) => [U, SetStateAction<U>])

    A hook that automatically initializes the store (if not already initialized) with the given plugins.

    -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 4579d3c5..a24133fe 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,6 +1,10 @@ React18 Global Store

React18 Global Store

React18GlobalStore

test Maintainability codecov Version Downloads npm bundle size Gitpod ready-to-code

Motivation

I've developed fantastic libraries leveraging React18 features using Zustand, and they performed admirably. However, when attempting to import from specific folders for better tree-shaking, the libraries encountered issues. Each import resulted in a separate Zustand store being created, leading to increased package size.

As a solution, I set out to create a lightweight, bare minimum store that facilitates shared state even when importing components from separate files, optimizing tree-shaking.

+
+

If you need fully featured state management solution, consider using Zustand with treeshakable +To understand the issue with treeshakability and importing from subpath, see - https://treeshakable.vercel.app

+

Features

✅ Full TypeScript Support

✅ Unleash the full power of React18 Server components

✅ Compatible with all build systems/tools/frameworks for React18

@@ -9,6 +13,9 @@

Simple Global State Shared Across Multiple Components

Utilize this hook similarly to the useState hook. However, ensure to pass a unique key, unique across the app, to identify and make this state accessible to all client components.

const [state, setState] = useRGS<number>("counter", 1);
+

or

+
const [state, setState] = useRGS<number>("counter", () => 1);
+

For detailed instructions, see Getting Started

diff --git a/docs/interfaces/plugins_persist.PersistOptions.html b/docs/interfaces/plugins_persist.PersistOptions.html index c58d8204..0d66f415 100644 --- a/docs/interfaces/plugins_persist.PersistOptions.html +++ b/docs/interfaces/plugins_persist.PersistOptions.html @@ -1,7 +1,7 @@ -PersistOptions | React18 Global Store

Interface PersistOptions

interface PersistOptions {
    storage?: "local" | "session" | "cookie";
    sync?: boolean;
}

Properties

storage? +PersistOptions | React18 Global Store

Interface PersistOptions

interface PersistOptions {
    storage?: "local" | "session" | "cookie";
    sync?: boolean;
}

Properties

storage? sync?

Properties

Optional storage

storage?: "local" | "session" | "cookie"

Default Value

local
-

Optional sync

sync?: boolean

Default Value

true
+

Optional sync

sync?: boolean

Default Value

true
-

Settings

Member Visibility

Theme

On This Page

storagesync
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

storagesync
\ No newline at end of file diff --git a/docs/md-docs/1.getting-started.md b/docs/md-docs/1.getting-started.md index e1d28c0d..e951f864 100644 --- a/docs/md-docs/1.getting-started.md +++ b/docs/md-docs/1.getting-started.md @@ -34,6 +34,16 @@ You can access the same state across all client-side components using a unique k > It's advisable to store your keys in a separate file to prevent typos and unnecessary conflicts. +### Initializing the state with a function + +In some cases you might want to initialize the state with a function, for example, when reading from `localStorage`. We support initializer function as well. + +```tsx +const [state, setState] = useRGS("counter", () => + typeof localStorage === "undefined" ? 1 : localStorage.getItem("counter") ?? 1, +); +``` + ### Example ```tsx diff --git a/docs/modules/Guides.html b/docs/modules/Guides.html index 7c928394..b064b150 100644 --- a/docs/modules/Guides.html +++ b/docs/modules/Guides.html @@ -1,3 +1,3 @@ -Guides | React18 Global Store

Module Guides

Index

Variables

A_Quick_Start +Guides | React18 Global Store

Module Guides

Index

Variables

A_Quick_Start B_Leveraging_Plugins

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html index beaad817..5177fc16 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ -index | React18 Global Store

Module index

References

Plugin +index | React18 Global Store

Module index

References

Plugin SetStateAction SetterArgType

Functions

useRGS diff --git a/docs/modules/plugins.html b/docs/modules/plugins.html index 861c363c..69d00a42 100644 --- a/docs/modules/plugins.html +++ b/docs/modules/plugins.html @@ -1,3 +1,3 @@ -plugins | React18 Global Store

Module plugins

References

PersistOptions +plugins | React18 Global Store

Module plugins

References

PersistOptions persist

References

PersistOptions

Re-exports PersistOptions

persist

Re-exports persist

Settings

Member Visibility

Theme

On This Page

PersistOptionspersist
\ No newline at end of file diff --git a/docs/modules/plugins_persist.html b/docs/modules/plugins_persist.html index 110adb33..c35e34a1 100644 --- a/docs/modules/plugins_persist.html +++ b/docs/modules/plugins_persist.html @@ -1,3 +1,3 @@ -plugins/persist | React18 Global Store

Module plugins/persist

Index

Interfaces

PersistOptions +plugins/persist | React18 Global Store

Module plugins/persist

Index

Interfaces

PersistOptions

Functions

persist

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/utils.html b/docs/modules/utils.html index b22e54f4..19f5d2f4 100644 --- a/docs/modules/utils.html +++ b/docs/modules/utils.html @@ -1,7 +1,8 @@ -utils | React18 Global Store

Module utils

Index

Modules

<internal> +utils | React18 Global Store

Module utils

Index

Modules

<internal>

Type Aliases

Plugin SetStateAction SetterArgType +ValueType

Variables

globalRGS

Functions

createHook createSetter diff --git a/docs/modules/with_plugins.html b/docs/modules/with_plugins.html index 9a8ed173..a9d28deb 100644 --- a/docs/modules/with_plugins.html +++ b/docs/modules/with_plugins.html @@ -1,4 +1,4 @@ -with-plugins | React18 Global Store

Module with-plugins

References

useRGSWithPlugins +with-plugins | React18 Global Store

Module with-plugins

References

useRGSWithPlugins

Functions

create withPlugins

References

useRGSWithPlugins

Re-exports useRGSWithPlugins

Settings

Member Visibility

Theme

On This Page

useRGSWithPlugins
\ No newline at end of file diff --git a/docs/types/utils.Plugin.html b/docs/types/utils.Plugin.html index 10dcbfee..ae7e8ce8 100644 --- a/docs/types/utils.Plugin.html +++ b/docs/types/utils.Plugin.html @@ -1 +1 @@ -Plugin | React18 Global Store

Type alias Plugin<T>

Plugin<T>: {
    init?: ((key, value, mutate) => void);
    onChange?: ((key, value?) => void);
}

Type Parameters

  • T

Type declaration

  • Optional init?: ((key, value, mutate) => void)
      • (key, value, mutate): void

      • Parameters

        • key: string
        • value: T | undefined
        • mutate: Mutate<T>

        Returns void

  • Optional onChange?: ((key, value?) => void)
      • (key, value?): void

      • Parameters

        • key: string
        • Optional value: T

        Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +Plugin | React18 Global Store

Type alias Plugin<T>

Plugin<T>: {
    init?: ((key, value, mutate) => void);
    onChange?: ((key, value?) => void);
}

Type Parameters

  • T

Type declaration

  • Optional init?: ((key, value, mutate) => void)
      • (key, value, mutate): void

      • Parameters

        • key: string
        • value: T | undefined
        • mutate: Mutate<T>

        Returns void

  • Optional onChange?: ((key, value?) => void)
      • (key, value?): void

      • Parameters

        • key: string
        • Optional value: T

        Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils.SetStateAction.html b/docs/types/utils.SetStateAction.html index 54574575..5348a433 100644 --- a/docs/types/utils.SetStateAction.html +++ b/docs/types/utils.SetStateAction.html @@ -1 +1 @@ -SetStateAction | React18 Global Store

Type alias SetStateAction<T>

SetStateAction<T>: ((value) => void)

Type Parameters

  • T

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file +SetStateAction | React18 Global Store

Type alias SetStateAction<T>

SetStateAction<T>: ((value) => void)

Type Parameters

  • T

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils.SetterArgType.html b/docs/types/utils.SetterArgType.html index c578c8bd..ef2e2cb1 100644 --- a/docs/types/utils.SetterArgType.html +++ b/docs/types/utils.SetterArgType.html @@ -1 +1 @@ -SetterArgType | React18 Global Store

Type alias SetterArgType<T>

SetterArgType<T>: T | ((prevState) => T)

Type Parameters

  • T

Type declaration

    • (prevState): T

    • Parameters

      • prevState: T

      Returns T

Settings

Member Visibility

Theme

\ No newline at end of file +SetterArgType | React18 Global Store

Type alias SetterArgType<T>

SetterArgType<T>: T | ((prevState) => T)

Type Parameters

  • T

Type declaration

    • (prevState): T

    • Parameters

      • prevState: T

      Returns T

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils.ValueType.html b/docs/types/utils.ValueType.html new file mode 100644 index 00000000..9c5fdf06 --- /dev/null +++ b/docs/types/utils.ValueType.html @@ -0,0 +1 @@ +ValueType | React18 Global Store

Type alias ValueType<T>

ValueType<T>: T | (() => T)

Type Parameters

  • T

Type declaration

    • (): T

    • Returns T

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils._internal_.Listener.html b/docs/types/utils._internal_.Listener.html index 3f392760..d1abaafd 100644 --- a/docs/types/utils._internal_.Listener.html +++ b/docs/types/utils._internal_.Listener.html @@ -1 +1 @@ -Listener | React18 Global Store

Type alias Listener

Listener: (() => void)

Type declaration

    • (): void

    • Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +Listener | React18 Global Store

Type alias Listener

Listener: (() => void)

Type declaration

    • (): void

    • Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils._internal_.Mutate.html b/docs/types/utils._internal_.Mutate.html index 512d454c..318c82a1 100644 --- a/docs/types/utils._internal_.Mutate.html +++ b/docs/types/utils._internal_.Mutate.html @@ -1 +1 @@ -Mutate | React18 Global Store

Type alias Mutate<T>

Mutate<T>: ((value?) => void)

Type Parameters

  • T

Type declaration

    • (value?): void

    • Parameters

      • Optional value: T

      Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +Mutate | React18 Global Store

Type alias Mutate<T>

Mutate<T>: ((value?) => void)

Type Parameters

  • T

Type declaration

    • (value?): void

    • Parameters

      • Optional value: T

      Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils._internal_.RGS.html b/docs/types/utils._internal_.RGS.html index f2cbfa4a..42266dd2 100644 --- a/docs/types/utils._internal_.RGS.html +++ b/docs/types/utils._internal_.RGS.html @@ -1 +1 @@ -RGS | React18 Global Store

Type alias RGS

RGS: [unknown, Listener[], SetStateAction<unknown> | null, Subscriber]

Settings

Member Visibility

Theme

\ No newline at end of file +RGS | React18 Global Store

Type alias RGS

RGS: [unknown, Listener[], SetStateAction<unknown> | null, Subscriber]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils._internal_.Subscriber.html b/docs/types/utils._internal_.Subscriber.html index d1ede753..a21f585f 100644 --- a/docs/types/utils._internal_.Subscriber.html +++ b/docs/types/utils._internal_.Subscriber.html @@ -1 +1 @@ -Subscriber | React18 Global Store

Type alias Subscriber

Subscriber: ((l) => (() => void))

Type declaration

    • (l): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +Subscriber | React18 Global Store

Type alias Subscriber

Subscriber: ((l) => (() => void))

Type declaration

    • (l): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/Guides.A_Quick_Start.html b/docs/variables/Guides.A_Quick_Start.html index e239fce3..81a3f109 100644 --- a/docs/variables/Guides.A_Quick_Start.html +++ b/docs/variables/Guides.A_Quick_Start.html @@ -21,4 +21,4 @@ 
// components/counter.tsx
"use client";

import useRGS from "r18gs";
import { COUNTER } from "../constants/global-states";

export default function Counter() {
    const [count, setCount] = useRGS(COUNTER, 0);
    return (
        <div>
            <h2>Client Component 1</h2>
            <input
                onChange={e => {
                    setCount(parseInt(e.target.value.trim()));
                }}
                type="number"
                value={count}
            />
        </div>
    );
}
-

Settings

Member Visibility

Theme

On This Page

Quick Start
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Quick Start
\ No newline at end of file diff --git a/docs/variables/Guides.B_Leveraging_Plugins.html b/docs/variables/Guides.B_Leveraging_Plugins.html index 281da47b..9bc9e453 100644 --- a/docs/variables/Guides.B_Leveraging_Plugins.html +++ b/docs/variables/Guides.B_Leveraging_Plugins.html @@ -18,4 +18,4 @@ 
export function MyComponent(props: MyComponentProps) {
const [state, setState] = useMyRGS(props.key, props.initialVal, props.doNotInit);
// ...
}

You can also create your own plugins. Refer to Creating Plugins.

-

Settings

Member Visibility

Theme

On This Page

Leveraging Plugins
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Leveraging Plugins
\ No newline at end of file diff --git a/docs/variables/utils.globalRGS.html b/docs/variables/utils.globalRGS.html index 0969e678..5a757183 100644 --- a/docs/variables/utils.globalRGS.html +++ b/docs/variables/utils.globalRGS.html @@ -1 +1 @@ -globalRGS | React18 Global Store

Variable globalRGSConst

globalRGS: Record<string, undefined | RGS> = globalThisForBetterMinification.rgs

Settings

Member Visibility

Theme

\ No newline at end of file +globalRGS | React18 Global Store

Variable globalRGSConst

globalRGS: Record<string, undefined | RGS> = globalThisForBetterMinification.rgs

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/lib/r18gs/README.md b/lib/r18gs/README.md index 082bdb44..2596ffe4 100644 --- a/lib/r18gs/README.md +++ b/lib/r18gs/README.md @@ -8,6 +8,9 @@ I've developed fantastic libraries leveraging React18 features using Zustand, an As a solution, I set out to create a lightweight, bare minimum store that facilitates shared state even when importing components from separate files, optimizing tree-shaking. +> If you need fully featured state management solution, consider using Zustand with [`treeshakable`](https://github.com/react18-tools/treeshakable/) +> To understand the issue with treeshakability and importing from subpath, see - + ## Features ✅ Full TypeScript Support @@ -28,6 +31,12 @@ Utilize this hook similarly to the `useState` hook. However, ensure to pass a un const [state, setState] = useRGS("counter", 1); ``` +**_or_** + +```tsx +const [state, setState] = useRGS("counter", () => 1); +``` + > For detailed instructions, see [Getting Started](./md-docs/1.getting-started.md) ## Using Plugins