diff --git a/.deepsource.toml b/.deepsource.toml new file mode 100644 index 00000000..88907392 --- /dev/null +++ b/.deepsource.toml @@ -0,0 +1,12 @@ +version = 1 + +[[analyzers]] +name = "javascript" + + [analyzers.meta] + plugins = ["react"] + environment = [ + "nodejs", + "browser", + "vitest" + ] \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 3f95b61d..c50d30d7 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,42 +1,41 @@ :root { - --light-hl-0: #795e26; - --dark-hl-0: #dcdcaa; - --light-hl-1: #000000; - --dark-hl-1: #d4d4d4; - --light-hl-2: #a31515; - --dark-hl-2: #ce9178; - --light-hl-3: #008000; - --dark-hl-3: #6a9955; - --light-hl-4: #af00db; - --dark-hl-4: #c586c0; - --light-hl-5: #001080; - --dark-hl-5: #9cdcfe; - --light-hl-6: #0000ff; - --dark-hl-6: #569cd6; - --light-hl-7: #800000; - --dark-hl-7: #808080; - --light-hl-8: #267f99; - --dark-hl-8: #4ec9b0; - --light-hl-9: #e50000; - --dark-hl-9: #9cdcfe; - --light-hl-10: #000000ff; - --dark-hl-10: #d4d4d4; - --light-hl-11: #800000; - --dark-hl-11: #569cd6; - --light-hl-12: #800000; - --dark-hl-12: #d7ba7d; - --light-hl-13: #0451a5; - --dark-hl-13: #ce9178; - --light-hl-14: #0070c1; - --dark-hl-14: #4fc1ff; - --light-hl-15: #098658; - --dark-hl-15: #b5cea8; - --light-code-background: #ffffff; - --dark-code-background: #1e1e1e; + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #008000; + --dark-hl-3: #6A9955; + --light-hl-4: #AF00DB; + --dark-hl-4: #C586C0; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #0000FF; + --dark-hl-6: #569CD6; + --light-hl-7: #800000; + --dark-hl-7: #808080; + --light-hl-8: #267F99; + --dark-hl-8: #4EC9B0; + --light-hl-9: #E50000; + --dark-hl-9: #9CDCFE; + --light-hl-10: #000000FF; + --dark-hl-10: #D4D4D4; + --light-hl-11: #800000; + --dark-hl-11: #569CD6; + --light-hl-12: #800000; + --dark-hl-12: #D7BA7D; + --light-hl-13: #0451A5; + --dark-hl-13: #CE9178; + --light-hl-14: #0070C1; + --dark-hl-14: #4FC1FF; + --light-hl-15: #098658; + --dark-hl-15: #B5CEA8; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; } -@media (prefers-color-scheme: light) { - :root { +@media (prefers-color-scheme: light) { :root { --hl-0: var(--light-hl-0); --hl-1: var(--light-hl-1); --hl-2: var(--light-hl-2); @@ -54,11 +53,9 @@ --hl-14: var(--light-hl-14); --hl-15: var(--light-hl-15); --code-background: var(--light-code-background); - } -} +} } -@media (prefers-color-scheme: dark) { - :root { +@media (prefers-color-scheme: dark) { :root { --hl-0: var(--dark-hl-0); --hl-1: var(--dark-hl-1); --hl-2: var(--dark-hl-2); @@ -76,98 +73,62 @@ --hl-14: var(--dark-hl-14); --hl-15: var(--dark-hl-15); --code-background: var(--dark-code-background); - } -} +} } -:root[data-theme="light"] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); - --hl-14: var(--light-hl-14); - --hl-15: var(--light-hl-15); - --code-background: var(--light-code-background); +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); + --code-background: var(--light-code-background); } -:root[data-theme="dark"] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); - --hl-14: var(--dark-hl-14); - --hl-15: var(--dark-hl-15); - --code-background: var(--dark-code-background); +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); + --code-background: var(--dark-code-background); } -.hl-0 { - color: var(--hl-0); -} -.hl-1 { - color: var(--hl-1); -} -.hl-2 { - color: var(--hl-2); -} -.hl-3 { - color: var(--hl-3); -} -.hl-4 { - color: var(--hl-4); -} -.hl-5 { - color: var(--hl-5); -} -.hl-6 { - color: var(--hl-6); -} -.hl-7 { - color: var(--hl-7); -} -.hl-8 { - color: var(--hl-8); -} -.hl-9 { - color: var(--hl-9); -} -.hl-10 { - color: var(--hl-10); -} -.hl-11 { - color: var(--hl-11); -} -.hl-12 { - color: var(--hl-12); -} -.hl-13 { - color: var(--hl-13); -} -.hl-14 { - color: var(--hl-14); -} -.hl-15 { - color: var(--hl-15); -} -pre, -code { - background: var(--code-background); -} +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +.hl-14 { color: var(--hl-14); } +.hl-15 { color: var(--hl-15); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index f6a25e26..8f0a1aab 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACq2WUW+bMBDHv8rEXsPSpGmn5nVSK/VhqkakPVRR5BineHUA2Ue6aup3n2NDAdsYp80Tsvnf/3d35oDHfxGQvxAtI8woyWGKC1bwWLxQwFlvEU2iEkEmlfsirRgRUx2xUaKNFvUW3zLYMxn2TPM0Ws4nEc4oSznJo+XjO/bHMSBR+gdelKLF0BwI3yEcQjJdDPTV9dvERWxhuyrHQIv8NFYfc714W3c4dUN3BcckrjuJM7Injq3B5ippw1dSx1ZQo2+PYTp3A2nVHgY1DcObAZ0uQED50EkBTit4FVSqDWiDQ8pSMfWcEG4sB4vT1EZmLINKVAkmdcTo+Ph5tpdviHpqT39PYFqNbmmVIOcBmkbewxWEH+Rp5nL1R0z1KhY0JfELR2Upbzn27NPWoo222dSrY8imDnHtBR3/T3m5F4mKXiH+ROCc9K9Oe53QYnazuLzoHlEtTn4FPpMfy8tD8T2tuoZEOv3WRufOyw3wpaReMOkDeuq8neC1/HAGrZ9Bvbj5PruaO07qbnSkPndGd6HTbTXvfLlY1v6Bh4I7vkVqO2ggm9fLkEdzv2+2cJulRAAvXp3N6LvVSrM2acuQEMqq5AQjIOkXEGlMRSwRhOeIRZ3y5YAnIEUBxEY6jPRwRDhHfIpTbQXmdBsEarQnkNbWT6X6D1rJKbZmWtEM0dig6vk5Rg5b9jVjjjSnQBEzun9AnKJt+5R2VX3Hy7njozze3XjmHbsKKBP2yKjtoLHjRBTsoFm3vNiP/OVqY0+QI9v1f34BAjApDQAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62XTW/bMAyG/8qgXuOlTdMOzW3YsAI7DEWTYYeiCFSbTbQ5tiExbYph/32IZTe2Rct04mOcV88rUqQ+Hv4KhB2KmQhjBQmKkcgkrsVMbNJoG4MZ2+8f17iJxUj8UUkkZpORCNcqjjQkYvbwjviSxqmevyoM117OWV1omdOLm+nl+fTfiMLd6TQzbGapbgN/lSgZxKqsDfUt1SFY63ANG/ATCbUXvGAiFx2w/H+bG9B+XlPKQjKSSerb4D+zSCIwqHVhG25roEcGCHUd/FhB24HjcL+mgfGW/jIXLa1oqH5yoQM3l9+AznxHgvpn66TUNcJTCYJ+liHHqUlpWF9d0wk9mD1vkxBVmvTzqttckwl93vd9UGTSu/Usc2lplktZKeRubW387t2OFdZpkQ4fvLOkPNMmkL/GyAgZ+wXmPVccpO+M8c+6bwSDRNOyQK7BYTBnMfIxxabVfoQUNqWMFUTndYSCsm4nrFOPpA9/Dei2GeBWQJoMe0kgLY65M9QL6rj6Gqjc3DPRb/OO8B2IvtLoa+iyfM5kofS1rEDYUXo2oR7xObsRp0h7GjZB3h3QgH4BPU5gh7/N2P4KjIogeNUyy0BT39wKtqKlxSyLX/shy2II9Y1V0j9gh9/NPB+9kHoFxDv2ePczEt+2jxTi+T2z/o+bl8fFV602hrmK4JcFDT0v2sA3pfwUju7kqnKE41t29AwOvIbr+c2ni6sJsVK3nS112hrdcrvbSd5wc3HQ/obHVBMXtvwzqyHL7aWNUf5fh01pWAQGdfpGJqNOK5TN2EYijKUxOSrTEEqE6AOaKFAmgB2CTmQsKuGvAOcokbxTNhxLabulx8fwfcxJPtsnE2r1xDIqtT2cHp1ncP7EWbxlbk/nbg1RV6Pa/tmP/Gwn3U4mpXw+B8whqkShknFjdV+kVvLp0AVVVZ14OSEO/e7VCy68bb1FFRNX5/wzq61XgPdg0vgFoo63sWXSes8OWBnQGrKDpp9wB6i2ug5gVUVk8fE/cs9IUCoXAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 917ac47d..76f7ae35 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACsVaS4/iRhD+L56rYeiHDcw10kbJIVqFUXIYjRABM+Osecj27CYZzX9PPwyuclcbwxr2hk3VV4+vqtrd9nuQ774VwcPTe/Al3a6CBx4G28UmCR6CZZYm2/J+uct2+aD4lpbLV3QRhMFbninBzW71liXFvVWYG5m5lUEXw9dykymtZbYoikQZDYKP8GA3lkfDP2mdGbaxftsuy3S37WAFqBMWw2C/yBVAlwBr73gUU+59znf74uhjui2TfL1YdklFE6Q3T9mI15ks0v+S/ty7q+Au89HBhOltFt16ly+TQaW+fE02CXHLV4BG8hCPkSRudS3GT1rTuo6NOhXZzWwTrxPx3dJxMp8l0CxPZ7AEMZRn5+yxS7ZcE7XuGZlxA2vJhRGoijLJG5e+jFhHD1KNy655MWHNmpac1LTbQiCdctQeMOnpW5H04mwTp1d/4VBGVk6N5TMS3H04d/UaDWhTsivcKj35e4exL/edMNAeDjUt+w0KW7hJaOUif0nKWZIly3KX9x6XA3+toOpxWCT5V6W8Tf4p/y7u7dWgSFfJ4Fu+2O/VX8Q9Zz5amblFmVdXWmNeaVD3ug7M3xTqr8Vs9vOpYXSZFzR8e7dfljUyupkRnCm5PxvJ/d7AHOTrxsRH0zGLOF7/V58XL3X/l//uLy6WGu7KYYD15FAav3dbWL6v/ggj140UTbbla5qtFPDt4roDJnsMsM2uf6y/3DBua+0Hh7w+ttMNS/kOW719CiSbSjFylhaD92gW3x6XtjsS/fpTy5n7PQ8sGv+Gs6rXdm2J5gqd6uHmZkO5LVpyHpfFapAWg3Sruiktk9WtU3CVOdWWBd+I+gGJAE/pajvgntOYu61P0c1nMrBlelTPYs0HM4PXkDnR18Yxv0E7jbWQ1x4WOc9cHEWiHnzzeXmGkbujeIuthqJ3IqFtbjfDw7J150qqVy57vFgt8i+Pl3gCFXvzJktfXsuL3EGavfmzrOv6c56sz3XKVe/NM+r8p6NXXY53LvaIOsI5y68uJzTdvBP1SEm3aZkuslm5KGu3vi7ydPFXPRSh0JkjxT3/pHbkxspBYMDOs9FiAs/2w99nDuEavkyzwsE2d7uevuRJscu+Wjc+5btN+1sQC92i0x6J9ffjOVQsr5J/gof3QC2RhYJWf/KhGE6V9DpNspV+W2ldVFi7zUbrP1f//WGOz7SEFbkfBeHTKOR8yMdxyA4/ePXj+Tl8OmAYUXPDKDJ1JUIxHkYxQ2IMiXF1JSkxjsSEuoooMYHEpLpSboqhFNNwHPJ4yEZROAlZNJwIEU6rHwhBIoRIXbERZSlCcrG1NBlORwr+mBjGq3tINUaqY22CTM0YyU20nDwiR8dfMZX9CdKdat0xZWOKWdKksQnJU4NPzRubkpKYUqap4yqHbDiZcCyJWWWaPc5ISUws0yxxTlrHBDLNExcHytVkrqqAR8d7MVUHDBPMNGmcTCHDfDJNG6dziBllmiRO5xDzxzRNgqxDhhnkmiZB5pBjBrlpSU5KNppS06QSRUliBrmmSdANjBnkmiZB9jDHDPLI7yfmiMf+2DFHfOyPCHPENRHqyZjyE3PEDUdkhXDMkTAckRUiMEfCcERWiMAcCU0EI7MkGrNTEyHJWhKYI6GJkIyUxBwJTYQk+1FgjkTsnQYCcyTG3mkgMEdCEyHJESowR0ITISWJiTmSI6+kxBxJTYQkK1lijqRZ3chakpYjs1yrdVrtin+xy7ZaeA+7q/dgXq3lqiKqh4r3QNXBw/vHR7126ysDfTyEAIqsVlTjQImGgWoNDwD4AgWCjGqMUbuqeXaFqnGtKq31E8arnV2NwGQNMfHpNj0eN8z6dOyHH3uzKam1JQfZjk7rO2wB82oStOlXH2kB3VrVy3OtubfHk8B1YNmjrnesTpYl4FgNBVrTsAviRjQBAF/K7M7GA8BBpTJha0W1fRvS3rwgAxCgS5ivVmpVlDgBEs951Sjt5p0kcpADVmEIX70bDLfagRs+69UGrbC7OMAh0BW+8M0BgUs/SL7wdYw9o7PHcWV1Jg8SCEvPV0EVRPFiPKi/GQI5BL3DfLk7wOQIxmkGAfnw9WG14TJIa7Xh8pSnhJPM11qu2vT0IILfo0HVSQdV4vAUJRNOE19XWjV9vHr8RAEgAC+YryAdBJeJCBSHNxoFgGzLLt6bTyprJWDIV4TViTDwDnDLfY3jjmp+elmEn3GiNu+qitlg8em1EH/UgrSj09rmtQ3IDIiRs2oq+qiwM6E4foIDMgVgmI9+11+gFVfT1Nd5Jd1DjDUgfKqmJpx1HBS/8PHknWQMTDLf8GmfXwyuZ76ngbfCXUUk6BwxtamTvgAOAGQMsP29APakDJgHhSZ9flPDJu7Q8Pi1EFKPTqmrp+19uk+ydKuEnp4/Pv4HqOclO74vAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81cbW/jyA3+L8pXxet500j5VvRwRYvrYXHZth+CIHBjbeKe4wSW9qVd7H8/jDSySImUR5bs7Sc7zpB8yIfkzEgafYv2r1+K6ObuW/T7ZreObmQc7VYveXQTPW43+a589/i6fd1fF1825eMz+iOKo0/7bXQTvbyuP23z4l0t8FCNeajHoD8Wz+XLNoqjx+2qKPIiuomi73FjN9EHw392MrfYxsdPu8dy87oLsALECYtx9Lba57syxMEWnTQJBe/9/vWtOGDc7Mp8/3H1GBKKrpLZkIqlbCNZbP6Xzwfvyqs7DWNPJwzvUNKF5NlgavW0f3zdP+bX3sbjc/6SEz9xZquRjfFqJPFTaKr/7CTrwGCjvXwPM9vVF5RWYeEYFc/w4J3CXAkwlsfNlSBa5Wh2PoTw0jfRyo7goO9YWCwC/B8VZ0bfOK4qs76G8z0HsY5cM2qKhZMMjrEPMqMi9rZrqZccw7aQkqAsGXaYRPqpyGcB29UzK144vSIrxybYEQEOn2ZDUaOptiq1NW4WM+G9wrpPx04YGHaHmpnmdQpbuIhr5Wr/lJe3+TZ/LF/3s/vVU38Zp9zID/vVrti4op7fq57+c7kFe8FPq3I1rQUcNJyv8iuNv64mlAgGeQUVTohyGzwG+HpVrq7L57lgO3UPlboLgJ7SkWjckztQGHRylTyHB3BRfRFHird58Vf6ZoYNm8k/3tarMp/WToCO8zWUfV68bj9PXUx0oV511U4INQzlESfmWEKwrsy2ejjNoff7/ONZnfIGzuvYhBmg58PU9k/DbTd+Rb7/nO/f7fKv5X+Kd/Vf18VmnV9/2a/e3vI99VtvJ1iPeai1PPi/nMSDl6B+C90a/pp/Lf9W3N7+5di26zQUtPrhZnRa1EjvbquBt5t1/q9OcKc61tN8Xp/kMrPCSHytZ/1+9dS2qfK/bycnS6vuzNQYo9op7uHBYT6HA1cH1TP6AYxwzeltVT7/fYVLaH63FtjMeVxc+BBynqKFyTl89AYu5R1cezVd67ewqzvTWiNh5LxFiLeDz5vtep+TW/Dz+HUFTM5J7hBp7LWVpwv6XVv7wS5/PJTABVP5Clu9fAi0yLRa9lY9lb4P1RWwGVddV6T2M60LQNfqLUlmbli0/gv2qlnLdcCbM1Qqw83FmvKQt2Q/Lov19aa43uye8/2mzNeXDsFZ+tRQFLgW9QMCATaQ5eu+f7u0+nX43mNnuwA26R+IJXelrzPmSF1XwHiDdTd2g1h7eMg4cyH7CM7I0b0BITh4H2Ok4cXwxVtSfHgtvl7tf/9wChIoOBua7ebpuTwJDpKcDc8jcwUsEFRffDZk9JXTQFxh10cnoKIuhY7EFnLB8wSE1M3rQGQh96ZPRjQhYuG3l8PQ8f34T/Vlr4C2DEaevTt3bY1t0tAr7unCPKgrMUgWQHw0pD4/84XoAMwbuRZqAsTWTT6KPwVONwOAfxo98VwwmgdwTUSnBrT1lg/qL6Gz5gDwX8bPnxcMa4uuiWs2Ma7A3yM1fws2+KdV1+3QJv4HV/5tXh6K38xR/M5ZPqLcLcXR4ENvHf7A+HYgHsI8Mcpdz/lg/xy81hnw4ucTVj0XDDKA1wTYTgww9PhYcMOXbUd9OGUBd/FAwwfufbindo2+93zQf/Obg9PdABr+70LcYDt0iqmt4uBsi1i16/rNblNuVtvbclW2oD+v9pvVv9srRXDQyJV8/8ls6g56ZaUZcC3G2RgwgS94Nf8eeWWqVV9utkVPd/Vr6NMSfmPLBaLWBQcNY60RkZaeWuaHrXUHzmFx+IhPz27wCZ6u9e5tGeoo3bFjVFdYKPi0VxgMfAtlDJb3g/evxwFiz12FnVe6IuRHHrE6Bo6uW+ZczxUSCT1oNClvxqbK9Ow4KSGm58BJhE9hdySjA6boJ9Aoa92RJxpkDxtRNonBc/h5PIXI4Sea7p9QoCzCUScaop5epkzhcWdMHOrk3Kg84p+GPjGtSEQjsywcVHDSHQ9U0MwWDOxYSpJ4QjM0HMbxhCWBhOdvD8p9HG126/xrdPMt+pzvC3dO6SaSC7Vw18U+bvLt2r3poAYYR4+vLy9O373/3z+rA1tuRD3k3TKK75axVAuzVLGIZbKwUsXS/3J/H981Oqqh1Q+VoIjiOxWrZGFNioYJNExG8Z2mhkk0TEXxnYm1WWRaoGEKDdM12mxhRepAVl/QeI3Gmyi+S2KhFplJYxtLs1imKk5jkS5SLeIsFmaxtAZpMEhDEsV3Ykk5kKBxtraULWxmnSWxUKkzUH9BghYJplBQHBgQ0v+GRFMkmjlsJAcZpmpZ2XDeq0pz/Q2z1mHXsSg0xYjABAtHpDANKSKhWBGYbXezoZLxaZccvlnvP5bGSSAcxyIlcw/T765r3omMHIlpFo5NSfIsMNHC0SdFrJcLvcSZIzCzwrElJTkSEykcX1KR0cZUSkeTJHmRmEHpaJKGLL1OiTpyZELqxLxJR4S0TSbJlOJaYrZkxZY8yFgq+yTmTTpyekXkZImakJhJmWCMWazUwmZYBFMqHW+KJF9iSqXjTZHkS0ypdLwpknyJKVWON0WSrzClqqI0pXQqTKlyvCnd9DllYiUWSrtKOPxm/Tesp9OWHZcqJbFhmpVjUGXkSEyucnzpJTkSU6kcTVq45pAmHX8xg8rRpCWpEzOoHE2ajjZmUDmaNFlqCjOoHU3aULxozKB2NOmEHIkZ1NXEacmRmCPtiNAkR7ozezoiNMmRxhxpw+PEHOmE9x1zpC3vEeZIOyIMmSEac6QdEUaQIzFHxhFhyAwxmCMj2KwzmCMj69am9GKpNB6JOTLV+obMOoM5Mo4IQ2ad6axtHBGGXDQZzJFJ2K5lMEfGsl3LYI5Myk6DBnNkMnYaNJijpOKInIgSzFHCc5RgjhJHhLGkTsxRonidmKOk4oisuARzlBheZ2ed6YgwZG0mmKPE8joxR0m1tiTrKMEcJRmvE3Nkq7UkWXEWc2R5jizmyDoiErI2LebI8hxZzJF1RCRkxVnMkeU5spgj64hIyNq0nd0Az5HFHNmKI7KKLebIOiISsidbzFG6ZEemmKPUEZGQ1ZFijtKKIzLnU8xR6ohIyExOMUepI8KS+ZlijlLD7TZTTFGacPvNFDOUWnZjl3Y2aCm7zUoxQ2nGosQEZUsOZYb5yQSLMsP8ZJLfDGJ+MsVunzLMT6bZ7VOG+ckMu33KMEFZwm5LMsxQxq/KM8xQlvIedXbMGe9Rd8+85HeEy85mecnvter/wbGSdav+3/19dY3nc74v8/Vf62s9d3eHW8zfogd/AUiL5jrUt0gl0c2373FkRP2ZNJ/Kfxr/af1nVn9aP876cdaPs9W47+0FJPdXhfVw7AMAMS0QvawV6IRT4K521VenWg0yaTVIyUrWr21rxYRuxYQYFKtvmkHhZSvbYB7WUN1VghoA6CZs9Udaf4jlsEL/SD/wBwRSSK9EcUq6DlkOjjRDKupbdW/Vo1StMgOgmAD5bnIakJw6G5T3d9ZaWQWi4APqHUoDNPkjwCA9QW55Nb5aMpYg954WkJ4ZUMEltjsW0WPUAF8Mx6R7NQwyB5iUvjClhlzGQzDKVS8EErApfUyzpMlSrnKqhAcco1QF5eMVpT7dskF9a0ahlIB1X0CGo7vW9Fa9yAAQDTApLmdbUZwkIObap4nmmmCto0e2BDkvfDBMOqSj3wFAvvgWnfpgZFxffMrL5ugEE1sLApNyXQ6o6cFKQAGkXBr7B4aK+qkiIAySz3LhqE7x9MsH1K7hgNcH6eozc6U/OAuITQGxHHSvoniqELRv1wQ9CahRx9TskZp+QwJeKS7F3dsaXlY9HBqUieLys28RpJXiKDiSRApYlj43DYeA0NWdYRTExDViNiMVqDXZtAuuJ3ot/bQGpKZcefUjkY2eaOEbh6GmtKOJEiVOi6JAwGRifajE3HnSw+uCgAbgj+KKrKehn2NAjebVlAMpkQBSLZcSRV7SUy0IZjJgf3AWSkBS2qNK+gkFasTyZJRMtwMRTLhcLto2jSyDNLADsn2jYOJLBiDXLQ331gQuAri24nIGpZsJSdjqLewAJZDhROpTz0AGoNMsut7qE1B4ZF8AXwCPJvGOBlYU16EA+4mjq3/8cjGkBhDKilfvKgC1C0xrvz7UXEeq59ji8PJXEDq4cucmthJHG1Rts9ZV3AKy7ysgC2262gWz4VKspFuyEB2VnGiVb6v66dbe7gfEM+FyoNXSEwdumWFxKo9ASIWPQuZDmw27xK1YJCgl0WyeTBPwQYQleJ8uUAg3ZZz8p+oxmR4YBcDIZs9hGzAc3Z8KYv4HNNlmuc2i8QrIkIPOLXxcsib0XCH4J8sBHFC5KVcD1ARuAzoqfrcEEk+Oid/H0dvmLd9udnl0c3f//fsfcpFKwFJlAAA="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 1011473f..07a385b7 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1,87 +1,178 @@ :root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: var(--light-color-ts-type-alias); - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; } @media (prefers-color-scheme: light) { - :root { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { --color-background: var(--light-color-background); --color-background-secondary: var(--light-color-background-secondary); --color-background-warning: var(--light-color-background-warning); @@ -107,7 +198,9 @@ --color-ts-method: var(--light-color-ts-method); --color-ts-call-signature: var(--light-color-ts-call-signature); --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var(--light-color-ts-constructor-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); --color-ts-parameter: var(--light-color-ts-parameter); --color-ts-type-parameter: var(--light-color-ts-type-parameter); --color-ts-accessor: var(--light-color-ts-accessor); @@ -117,11 +210,9 @@ --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); - } } -@media (prefers-color-scheme: dark) { - :root { +:root[data-theme="dark"] { --color-background: var(--dark-color-background); --color-background-secondary: var(--dark-color-background-secondary); --color-background-warning: var(--dark-color-background-warning); @@ -147,7 +238,9 @@ --color-ts-method: var(--dark-color-ts-method); --color-ts-call-signature: var(--dark-color-ts-call-signature); --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var(--dark-color-ts-constructor-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); --color-ts-parameter: var(--dark-color-ts-parameter); --color-ts-type-parameter: var(--dark-color-ts-type-parameter); --color-ts-accessor: var(--dark-color-ts-accessor); @@ -157,96 +250,11 @@ --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); - } -} - -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} - -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var(--light-color-ts-constructor-signature); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} - -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var(--dark-color-ts-constructor-signature); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); } .always-visible, .always-visible .tsd-signatures { - display: inherit !important; + display: inherit !important; } h1, @@ -255,7 +263,7 @@ h3, h4, h5, h6 { - line-height: 1.2; + line-height: 1.2; } h1 > a, @@ -264,1123 +272,1123 @@ h3 > a, h4 > a, h5 > a, h6 > a { - text-decoration: none; - color: var(--color-text); + text-decoration: none; + color: var(--color-text); } h1 { - font-size: 1.875rem; - margin: 0.67rem 0; + font-size: 1.875rem; + margin: 0.67rem 0; } h2 { - font-size: 1.5rem; - margin: 0.83rem 0; + font-size: 1.5rem; + margin: 0.83rem 0; } h3 { - font-size: 1.25rem; - margin: 1rem 0; + font-size: 1.25rem; + margin: 1rem 0; } h4 { - font-size: 1.05rem; - margin: 1.33rem 0; + font-size: 1.05rem; + margin: 1.33rem 0; } h5 { - font-size: 1rem; - margin: 1.5rem 0; + font-size: 1rem; + margin: 1.5rem 0; } h6 { - font-size: 0.875rem; - margin: 2.33rem 0; + font-size: 0.875rem; + margin: 2.33rem 0; } .uppercase { - text-transform: uppercase; + text-transform: uppercase; } dl, menu, ol, ul { - margin: 1em 0; + margin: 1em 0; } dd { - margin: 0 0 0 40px; + margin: 0 0 0 40px; } .container { - max-width: 1700px; - padding: 0 2rem; + max-width: 1700px; + padding: 0 2rem; } /* Footer */ .tsd-generator { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; } .tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; } .container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); } @keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } + from { + opacity: 0; + } + to { + opacity: 1; + } } @keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } } @keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } } @keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } } @keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } } @keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } } body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); } a { - color: var(--color-link); - text-decoration: none; + color: var(--color-link); + text-decoration: none; } a:hover { - text-decoration: underline; + text-decoration: underline; } a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; } code, pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; } pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); } pre code { - padding: 0; - font-size: 100%; + padding: 0; + font-size: 100%; } pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; } pre:hover > button, pre > button.visible { - opacity: 1; + opacity: 1; } blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; } .tsd-typography { - line-height: 1.333em; + line-height: 1.333em; } .tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; + list-style: square; + padding: 0 0 0 20px; + margin: 0; } .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { - font-size: 1em; + font-size: 1em; } .tsd-typography h5, .tsd-typography h6 { - font-weight: normal; + font-weight: normal; } .tsd-typography p, .tsd-typography ul, .tsd-typography ol { - margin: 1em 0; + margin: 1em 0; } .tsd-typography table { - border-collapse: collapse; - border: none; + border-collapse: collapse; + border: none; } .tsd-typography td, .tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); + padding: 6px 13px; + border: 1px solid var(--color-accent); } .tsd-typography thead, .tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); + background-color: var(--color-background-secondary); } .tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); + margin: 0; + padding: 0; + color: var(--color-text-aside); } .tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; + color: var(--color-text-aside); + text-decoration: none; } .tsd-breadcrumb a:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-breadcrumb li { - display: inline; + display: inline; } .tsd-breadcrumb li:after { - content: " / "; + content: " / "; } .tsd-comment-tags { - display: flex; - flex-direction: column; + display: flex; + flex-direction: column; } dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; } dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; } dl.tsd-comment-tag-group dd { - margin: 0; + margin: 0; } code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; } h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; + margin-left: 0.25em; } dl.tsd-comment-tag-group dd:before, dl.tsd-comment-tag-group dd:after { - content: " "; + content: " "; } dl.tsd-comment-tag-group dd pre, dl.tsd-comment-tag-group dd:after { - clear: both; + clear: both; } dl.tsd-comment-tag-group p { - margin: 0; + margin: 0; } .tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; } .tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; + margin-bottom: 0; } .tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; } .tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; + margin-bottom: 0.5rem; } .tsd-filter-input { - display: flex; - width: fit-content; - width: -moz-fit-content; - align-items: center; - user-select: none; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - cursor: pointer; + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; } .tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; } .tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; + pointer-events: none; } .tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. Don't remove unless you know what you're doing. */ - opacity: 0.99; + opacity: 0.99; } .tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); + transform: scale(0.95); } .tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); + transform: scale(1); } .tsd-checkbox-background { - fill: var(--color-accent); + fill: var(--color-accent); } input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); + stroke: var(--color-text); } .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; } .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); + stroke: var(--color-accent); } .tsd-theme-toggle { - padding-top: 0.75rem; + padding-top: 0.75rem; } .tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; + display: inline; + vertical-align: middle; + margin-right: 0.75rem; } .tsd-hierarchy { - list-style: square; - margin: 0; + list-style: square; + margin: 0; } .tsd-hierarchy .target { - font-weight: bold; + font-weight: bold; } .tsd-panel-group.tsd-index-group { - margin-bottom: 0; + margin-bottom: 0; } .tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; } @media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } } @media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } } .tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; } .tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; } .tsd-anchor { - position: relative; - top: -100px; + position: relative; + top: -100px; } .tsd-member { - position: relative; + position: relative; } .tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; } .tsd-navigation.settings { - margin: 1rem 0; + margin: 1rem 0; } .tsd-navigation > a, .tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.5rem); + width: calc(100% - 0.5rem); } .tsd-navigation a, .tsd-navigation summary > span, .tsd-page-navigation a { - display: inline-flex; - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; } .tsd-navigation a.current, .tsd-page-navigation a.current { - background: var(--color-active-menu-item); + background: var(--color-active-menu-item); } .tsd-navigation a:hover, .tsd-page-navigation a:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-navigation ul, .tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; } .tsd-navigation li, .tsd-page-navigation li { - padding: 0; - max-width: 100%; + padding: 0; + max-width: 100%; } .tsd-nested-navigation { - margin-left: 3rem; + margin-left: 3rem; } .tsd-nested-navigation > li > details { - margin-left: -1.5rem; + margin-left: -1.5rem; } .tsd-small-nested-navigation { - margin-left: 1.5rem; + margin-left: 1.5rem; } .tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; + margin-left: -1.5rem; } .tsd-nested-navigation > li > a, .tsd-nested-navigation > li > span { - width: calc(100% - 1.75rem - 0.5rem); + width: calc(100% - 1.75rem - 0.5rem); } .tsd-page-navigation ul { - padding-left: 1.75rem; + padding-left: 1.75rem; } #tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; } #tsd-sidebar-links a:last-of-type { - margin-bottom: 0; + margin-bottom: 0; } a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); } .tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ } .tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ + display: none; /* hide marker on safari */ } .tsd-accordion-summary, .tsd-accordion-summary a { - user-select: none; - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; - cursor: pointer; + cursor: pointer; } .tsd-accordion-summary a { - width: calc(100% - 1.5rem); + width: calc(100% - 1.5rem); } .tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; } .tsd-index-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; + margin-left: 0.25rem; } .tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; + margin-top: 0.75rem; } .tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; + margin-top: 1.5rem; + margin-bottom: 0.75rem; } .tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; } .tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); + transform-origin: center; + transform: scale(1.1); } .tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; + margin-right: 0.8rem; } .tsd-panel { - margin-bottom: 2.5rem; + margin-bottom: 2.5rem; } .tsd-panel.tsd-member { - margin-bottom: 4rem; + margin-bottom: 4rem; } .tsd-panel:empty { - display: none; + display: none; } .tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; } .tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; + margin-bottom: 0; + border-bottom: none; } .tsd-panel-group { - margin: 4rem 0; + margin: 4rem 0; } .tsd-panel-group.tsd-index-group { - margin: 2rem 0; + margin: 2rem 0; } .tsd-panel-group.tsd-index-group details { - margin: 2rem 0; + margin: 2rem 0; } #tsd-search { - transition: background-color 0.2s; + transition: background-color 0.2s; } #tsd-search .title { - position: relative; - z-index: 2; + position: relative; + z-index: 2; } #tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; } #tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); } #tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; + position: absolute; + overflow: hidden; + right: -40px; } #tsd-search .field input, #tsd-search .title, #tsd-toolbar-links a { - transition: opacity 0.2s; + transition: opacity 0.2s; } #tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; + background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); + background-color: var(--color-background-secondary); } #tsd-search .results li.state { - display: none; + display: none; } #tsd-search .results li.current:not(.no-results), #tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); + background-color: var(--color-accent); } #tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { - top: 10px; + top: 10px; } #tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; + color: var(--color-text-aside); + font-weight: normal; } #tsd-search.has-focus { - background-color: var(--color-accent); + background-color: var(--color-accent); } #tsd-search.has-focus .field input { - top: 0; - opacity: 1; + top: 0; + opacity: 1; } #tsd-search.has-focus .title, #tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; + z-index: 0; + opacity: 0; } #tsd-search.has-focus .results { - visibility: visible; + visibility: visible; } #tsd-search.loading .results li.state.loading { - display: block; + display: block; } #tsd-search.failure .results li.state.failure { - display: block; + display: block; } #tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; } #tsd-toolbar-links a { - margin-left: 1.5rem; + margin-left: 1.5rem; } #tsd-toolbar-links a:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; } .tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; + color: var(--color-ts-keyword); + font-weight: normal; } .tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; + color: var(--color-text-aside); + font-weight: normal; } .tsd-signature-type { - font-style: italic; - font-weight: normal; + font-style: italic; + font-weight: normal; } .tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; } .tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; } .tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; + border-width: 1px; } ul.tsd-parameter-list, ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; + list-style: square; + margin: 0; + padding-left: 20px; } ul.tsd-parameter-list > li.tsd-parameter-signature, ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; + list-style: none; + margin-left: -20px; } ul.tsd-parameter-list h5, ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; + font-size: 16px; + margin: 1em 0 0.5em 0; } .tsd-sources { - margin-top: 1rem; - font-size: 0.875em; + margin-top: 1rem; + font-size: 0.875em; } .tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; + color: var(--color-text-aside); + text-decoration: underline; } .tsd-sources ul { - list-style: none; - padding: 0; + list-style: none; + padding: 0; } .tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; } .tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; + color: var(--color-text); + text-decoration: none; } .tsd-page-toolbar a.title { - font-weight: bold; + font-weight: bold; } .tsd-page-toolbar a.title:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; } .tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; + position: relative; + white-space: nowrap; + line-height: 40px; } .tsd-page-toolbar .table-cell:first-child { - width: 100%; + width: 100%; } .tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; + box-sizing: border-box; + line-height: 0; + padding: 12px 0; } .tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; } .tsd-widget:hover { - opacity: 0.9; + opacity: 0.9; } .tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); + opacity: 1; + background-color: var(--color-accent); } .tsd-widget.no-caption { - width: 40px; + width: 40px; } .tsd-widget.no-caption:before { - margin: 0; + margin: 0; } .tsd-widget.options, .tsd-widget.menu { - display: none; + display: none; } input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; + background-position: -120px 0; } input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; + background-position: -160px 0; } img { - max-width: 100%; + max-width: 100%; } .tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); } .tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; + width: 1em; + height: 1em; + visibility: hidden; } .tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; + visibility: visible; } .deprecated { - text-decoration: line-through !important; + text-decoration: line-through !important; } .warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); } .tsd-kind-project { - color: var(--color-ts-project); + color: var(--color-ts-project); } .tsd-kind-module { - color: var(--color-ts-module); + color: var(--color-ts-module); } .tsd-kind-namespace { - color: var(--color-ts-namespace); + color: var(--color-ts-namespace); } .tsd-kind-enum { - color: var(--color-ts-enum); + color: var(--color-ts-enum); } .tsd-kind-enum-member { - color: var(--color-ts-enum-member); + color: var(--color-ts-enum-member); } .tsd-kind-variable { - color: var(--color-ts-variable); + color: var(--color-ts-variable); } .tsd-kind-function { - color: var(--color-ts-function); + color: var(--color-ts-function); } .tsd-kind-class { - color: var(--color-ts-class); + color: var(--color-ts-class); } .tsd-kind-interface { - color: var(--color-ts-interface); + color: var(--color-ts-interface); } .tsd-kind-constructor { - color: var(--color-ts-constructor); + color: var(--color-ts-constructor); } .tsd-kind-property { - color: var(--color-ts-property); + color: var(--color-ts-property); } .tsd-kind-method { - color: var(--color-ts-method); + color: var(--color-ts-method); } .tsd-kind-call-signature { - color: var(--color-ts-call-signature); + color: var(--color-ts-call-signature); } .tsd-kind-index-signature { - color: var(--color-ts-index-signature); + color: var(--color-ts-index-signature); } .tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); + color: var(--color-ts-constructor-signature); } .tsd-kind-parameter { - color: var(--color-ts-parameter); + color: var(--color-ts-parameter); } .tsd-kind-type-literal { - color: var(--color-ts-type-literal); + color: var(--color-ts-type-literal); } .tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); + color: var(--color-ts-type-parameter); } .tsd-kind-accessor { - color: var(--color-ts-accessor); + color: var(--color-ts-accessor); } .tsd-kind-get-signature { - color: var(--color-ts-get-signature); + color: var(--color-ts-get-signature); } .tsd-kind-set-signature { - color: var(--color-ts-set-signature); + color: var(--color-ts-set-signature); } .tsd-kind-type-alias { - color: var(--color-ts-type-alias); + color: var(--color-ts-type-alias); } /* if we have a kind icon, don't color the text by kind */ .tsd-kind-icon ~ span { - color: var(--color-text); + color: var(--color-text); } * { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); } *::-webkit-scrollbar { - width: 0.75rem; + width: 0.75rem; } *::-webkit-scrollbar-track { - background: var(--color-icon-background); + background: var(--color-icon-background); } *::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); } /* mobile */ @media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } - - .container-main { - display: flex; - } - html .col-content { - float: none; - max-width: 100%; - width: 100%; - } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-sidebar > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } } /* one sidebar */ @media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } } @media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; - } - .site-menu { - margin-top: 1rem; - } + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } } /* two sidebars */ @media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 1rem 0; - } - - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - } + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } } diff --git a/docs/functions/client_color_switch_color_switch.ColorSwitch.html b/docs/functions/client_color_switch_color_switch.ColorSwitch.html index 4c6d626e..ada002e7 100644 --- a/docs/functions/client_color_switch_color_switch.ColorSwitch.html +++ b/docs/functions/client_color_switch_color_switch.ColorSwitch.html @@ -4,4 +4,4 @@

custom size

<ColorSwitch size={20} />
 
-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html b/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html index 74280e05..2e71bad9 100644 --- a/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html +++ b/docs/functions/client_force_color_scheme_force_color_scheme.ForceColorScheme.html @@ -1 +1 @@ -ForceColorScheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file +ForceColorScheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/client_force_theme_force_theme.ForceTheme.html b/docs/functions/client_force_theme_force_theme.ForceTheme.html index 60259053..933fcfd4 100644 --- a/docs/functions/client_force_theme_force_theme.ForceTheme.html +++ b/docs/functions/client_force_theme_force_theme.ForceTheme.html @@ -1 +1 @@ -ForceTheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file +ForceTheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html b/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html index 9636d5e9..97512c71 100644 --- a/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html +++ b/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html @@ -1 +1 @@ -ThemeSwitcher | Code Documentation

Generated using TypeDoc

\ No newline at end of file +ThemeSwitcher | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/client_theme_switcher_theme_switcher.useThemeSwitcher.html b/docs/functions/client_theme_switcher_theme_switcher.useThemeSwitcher.html index 34ac53f9..0aaed080 100644 --- a/docs/functions/client_theme_switcher_theme_switcher.useThemeSwitcher.html +++ b/docs/functions/client_theme_switcher_theme_switcher.useThemeSwitcher.html @@ -1 +1 @@ -useThemeSwitcher | Code Documentation

Generated using TypeDoc

\ No newline at end of file +useThemeSwitcher | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSGThemeSwitcher.html b/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSGThemeSwitcher.html index 7b28f866..579a9997 100644 --- a/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSGThemeSwitcher.html +++ b/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSGThemeSwitcher.html @@ -1,3 +1,3 @@ NextJsSSGThemeSwitcher | Code Documentation

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapper.html b/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapper.html index f3c7dec7..83514f39 100644 --- a/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapper.html +++ b/docs/functions/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapper.html @@ -1,4 +1,4 @@ ServerSideWrapper | Code Documentation

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/store.useTheme-1.html b/docs/functions/store.useTheme-1.html index df49fb92..b8ff4574 100644 --- a/docs/functions/store.useTheme-1.html +++ b/docs/functions/store.useTheme-1.html @@ -1,2 +1,2 @@ -useTheme | Code Documentation
  • Returns ThemeStoreType & ThemeStoreActionsType

  • Type Parameters

    • U

    Parameters

    • selector: ((state) => U)
        • (state): U
        • Parameters

          Returns U

    Returns U

  • Type Parameters

    • U

    Parameters

    • selector: ((state) => U)
        • (state): U
        • Parameters

          Returns U

    • equalityFn: ((a, b) => boolean)
        • (a, b): boolean
        • Parameters

          • a: U
          • b: U

          Returns boolean

    Returns U

    Deprecated

    Use createWithEqualityFn from 'zustand/traditional'

    -

Generated using TypeDoc

\ No newline at end of file +useTheme | Code Documentation
  • Returns ThemeStoreType & ThemeStoreActionsType

  • Type Parameters

    • U

    Parameters

    Returns U

  • Type Parameters

    • U

    Parameters

    • selector: ((state) => U)
    • equalityFn: ((a, b) => boolean)
        • (a, b): boolean
        • Parameters

          • a: U
          • b: U

          Returns boolean

    Returns U

    Deprecated

    Use createWithEqualityFn from 'zustand/traditional'

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/store.useTheme.destroy.html b/docs/functions/store.useTheme.destroy.html index 81dc56ce..82ebe8f2 100644 --- a/docs/functions/store.useTheme.destroy.html +++ b/docs/functions/store.useTheme.destroy.html @@ -1,2 +1,2 @@ destroy | Code Documentation
  • Returns void

    Deprecated

    Use unsubscribe returned by subscribe

    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/store.useTheme.getState.html b/docs/functions/store.useTheme.getState.html index 82a93930..2f81ed11 100644 --- a/docs/functions/store.useTheme.getState.html +++ b/docs/functions/store.useTheme.getState.html @@ -1 +1 @@ -getState | Code Documentation
  • Returns ThemeStoreType & ThemeStoreActionsType

Generated using TypeDoc

\ No newline at end of file +getState | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/store.useTheme.setState.html b/docs/functions/store.useTheme.setState.html index 53bf094b..64812a15 100644 --- a/docs/functions/store.useTheme.setState.html +++ b/docs/functions/store.useTheme.setState.html @@ -1 +1 @@ -setState | Code Documentation
  • Parameters

    Returns void

Generated using TypeDoc

\ No newline at end of file +setState | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/store.useTheme.subscribe.html b/docs/functions/store.useTheme.subscribe.html index c9bd546f..c10508ba 100644 --- a/docs/functions/store.useTheme.subscribe.html +++ b/docs/functions/store.useTheme.subscribe.html @@ -1 +1 @@ -subscribe | Code Documentation
  • Parameters

    • listener: ((state, prevState) => void)
        • (state, prevState): void
        • Parameters

          Returns void

    Returns (() => void)

      • (): void
      • Returns void

Generated using TypeDoc

\ No newline at end of file +subscribe | Code Documentation
  • Parameters

    Returns (() => void)

      • (): void
      • Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/utils.getResolvedColorScheme.html b/docs/functions/utils.getResolvedColorScheme.html new file mode 100644 index 00000000..842e580e --- /dev/null +++ b/docs/functions/utils.getResolvedColorScheme.html @@ -0,0 +1 @@ +getResolvedColorScheme | Code Documentation

Function getResolvedColorScheme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/utils.getResolvedTheme.html b/docs/functions/utils.getResolvedTheme.html new file mode 100644 index 00000000..5f571bfe --- /dev/null +++ b/docs/functions/utils.getResolvedTheme.html @@ -0,0 +1 @@ +getResolvedTheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/utils.resolveTheme.html b/docs/functions/utils.resolveTheme.html new file mode 100644 index 00000000..1aaefd27 --- /dev/null +++ b/docs/functions/utils.resolveTheme.html @@ -0,0 +1 @@ +resolveTheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/utils.resolveThemeFromColorScheme.html b/docs/functions/utils.resolveThemeFromColorScheme.html deleted file mode 100644 index 5757c8f1..00000000 --- a/docs/functions/utils.resolveThemeFromColorScheme.html +++ /dev/null @@ -1 +0,0 @@ -resolveThemeFromColorScheme | Code Documentation

Function resolveThemeFromColorScheme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 4d8e1b1b..d9d817a5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,28 +1,32 @@ -Code Documentation

Code Documentation

Nextjs-Themes Version codecov Downloads npm bundle size Publish to npm and GitHub Contact me on Codementor

+Code Documentation

Code Documentation

Nextjs-Themes

test Maintainability codecov Version Downloads npm bundle size Contact me on Codementor

+

This is a sister package of react18-themes. Initially we targeted only Next.js and thus this package was named nextjs-themes. However, we have expanded support for Vite and Remix as well. And thus published a package with more generic name, react18-themes.

-

We recommend using react18-themes for latest updates. Though this package is also maintained with specific focus on Next.js, all the functionality of this package along with extended support for other build tools is available in react18-themes

+

We recommend using react18-themes for Remix. This package is maintained with specific focus on Next.js and Vite. Most of the functionality of this package along with extended support for other build tools is available in react18-themes

🤟 👉 Unleash the Power of React Server Components

-

This project is inspired by next-themes. Next-themes is an awesome package, however, it requires wrapping everything in a provider. The provider has to be a client component as it uses hooks. And thus, it takes away all the benefits of Server Components.

-

nextjs-themes removes this limitation and enables you to unleash the full power of React 18 Server Components. In addition, more features are coming up soon... Stay tuned!

+

This project was originally inspired by next-themes. Next-themes is an awesome package, however, it requires wrapping everything in a provider. The provider has to be a client component as it uses hooks. And thus, it takes away all the benefits of Server Components.

+

nextjs-themes removes this limitation and enables you to unleash the full power of React 18 Server Components. In addition, it adds more features and control over how you theme your app. Stay tuned!

    +
  • ✅ Perfect dark mode in 2 lines of code
  • ✅ Fully Treeshakable (import from nextjs-themes/client/component)
  • ✅ Designed for excellence
  • ✅ Full TypeScript Support
  • ✅ Unleash the full power of React18 Server components
  • -
  • ✅ Works with all build systems/tools/frameworks for React18
  • ✅ Perfect dark mode in 2 lines of code
  • ✅ System setting with prefers-color-scheme
  • ✅ Themed browser UI with color-scheme
  • ✅ Support for Next.js 13 & Next.js 14 appDir
  • +
  • ✅ No flash on load (for all - SSG, SSR, ISG, Server Components)
  • ✅ Sync theme across tabs and windows
  • ✅ Disable flashing when changing themes
  • ✅ Force pages to specific themes
  • -
  • ✅ Class or data attribute selector
  • +
  • ✅ Class and data attribute selector
  • ✅ Manipulate theme via useTheme hook
  • -
  • ✅ Doccumented with Typedoc (Docs)
  • +
  • ✅ Documented with Typedoc (Docs)
  • +
  • ✅ Use combinations of [data-th=""] and [data-color-scheme=""] for dark/light varients of themes
  • +
  • ✅ Use [data-csp=""] to style based on colorSchemePreference.

Check out the live example.

Install

$ pnpm add nextjs-themes
# or
$ npm install nextjs-themes
# or
$ yarn add nextjs-themes @@ -33,11 +37,11 @@

You need Zustand as a peer-dependency

To do

    -
  • Update examples
  • +
  • Update examples, docs and Readme

Usage

SPA (e.g., Vite, CRA) and Next.js pages directory (No server components)

The best way is to add a Custom App to use by modifying _app as follows:

Adding dark mode support takes 2 lines of code:

-
import { ThemeSwitcher } from "nextjs-themes";

function MyApp({ Component, pageProps }) {
return (
<>
<ThemeSwitcher forcedTheme={Component.theme} />
<Component {...pageProps} />
</>
);
}

export default MyApp; +
import { ThemeSwitcher } from "nextjs-themes";

function MyApp({ Component, pageProps }) {
return (
<>
<ThemeSwitcher forcedTheme={Component.theme} />
<Component {...pageProps} />
</>
);
}

export default MyApp;

⚡🎉Boom! Just a couple of lines and your dark mode is ready!

Check out examples for advanced usage.

@@ -46,30 +50,64 @@ When using this approach, you need to use CSS general sibling Combinator (~) to make sure your themed CSS is properly applied. See (HTML & CSS)[#html--css].

Update your app/layout.jsx to add ThemeSwitcher from nextjs-themes, and NextJsSSGThemeSwitcher from nextjs-themes/server. NextJsSSGThemeSwitcher is required to avoid flash of un-themed content on reload.

-
// app/layout.jsx
import { ThemeSwitcher } from "nextjs-themes";
import { NextJsSSGThemeSwitcher } from "nextjs-themes/server/nextjs";

export default function Layout({ children }) {
return (
<html lang="en">
<head />
<body>
/** use NextJsSSGThemeSwitcher as first element inside body */
<NextJsSSGThemeSwitcher />
<ThemeSwitcher />
{children}
</body>
</html>
);
} +
// app/layout.jsx
import { ThemeSwitcher } from "nextjs-themes";
import { NextJsSSGThemeSwitcher } from "nextjs-themes/server/nextjs";

export default function Layout({ children }) {
return (
<html lang="en">
<head />
<body>
/** use NextJsSSGThemeSwitcher as first element inside body */
<NextJsSSGThemeSwitcher />
<ThemeSwitcher />
{children}
</body>
</html>
);
}

Woohoo! You just added multiple theme modes and you can also use Server Component! Isn't that awesome!

Prefer SSR over SSG - Use wrapper component

If your app is serving dynamic content and you want to utilize SSR, continue using ServerSideWrapper component to replace html tag in layout.tsx file.

Update your app/layout.jsx to add ThemeSwitcher and ServerSideWrapper from nextjs-themes. ServerSideWrapper is required to avoid flash of un-themed content on reload.

-
// app/layout.jsx
import { ThemeSwitcher } from "nextjs-themes";
import { ServerSideWrapper } from "nextjs-themes/server/nextjs";

export default function Layout({ children }) {
return (
<ServerSideWrapper tag="html" lang="en">
<head />
<body>
<ThemeSwitcher />
{children}
</body>
</ServerSideWrapper>
);
} +
// app/layout.jsx
import { ThemeSwitcher } from "nextjs-themes";
import { ServerSideWrapper } from "nextjs-themes/server/nextjs";

export default function Layout({ children }) {
return (
<ServerSideWrapper tag="html" lang="en">
<head />
<body>
<ThemeSwitcher />
{children}
</body>
</ServerSideWrapper>
);
}

Woohoo! You just added dark mode and you can also use Server Component! Isn't that awesome!

HTML & CSS

That's it, your Next.js app fully supports dark mode, including System preference with prefers-color-scheme. The theme is also immediately synced between tabs. By default, nextjs-themes modifies the data-theme attribute on the html element, which you can easily use to style your app:

-
:root {
/* Your default theme */
--background: white;
--foreground: black;
}

[data-theme="dark"] {
--background: black;
--foreground: white;
}

// v2 onwards when using NextJsSSGThemeSwitcher, we need to use CSS Combinators
[data-theme="dark"] ~ * {
--background: black;
--foreground: white;
} +
:root {
/* Your default theme */
--background: white;
--foreground: black;
}

[data-theme="dark"] {
--background: black;
--foreground: white;
}

// v2 onwards when using NextJsSSGThemeSwitcher, we need to use CSS Combinators
[data-theme="dark"] ~ * {
--background: black;
--foreground: white;
} +
+

Images

You can also show different images based on the current theme.

+
import Image from "next/image";
import { useTheme } from "nextjs-themes";

function ThemedImage() {
const { resolvedTheme } = useTheme();
let src;

switch (resolvedTheme) {
case "light":
src = "/light.png";
break;
case "dark":
src = "/dark.png";
break;
default:
src = "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7";
break;
}

return <Image src={src} width={400} height={400} />;
}

export default ThemedImage;

useTheme

In case your components need to know the current theme and be able to change it. The useTheme hook provides theme information:

-
import { useTheme } from "nextjs-themes";

const ThemeChanger = () => {
/* you can also improve performance by using selectors
* const [theme, setTheme] = useTheme(state => [state.theme, state.setTheme]);
*/
const { theme, setTheme } = useTheme();

return (
<div>
The current theme is: {theme}
<button onClick={() => setTheme("light")}>Light Mode</button>
<button onClick={() => setTheme("dark")}>Dark Mode</button>
</div>
);
}; +
import { useTheme } from "nextjs-themes";

const ThemeChanger = () => {
/* you can also improve performance by using selectors
* const [theme, setTheme] = useTheme(state => [state.theme, state.setTheme]);
*/
const { theme, setTheme } = useTheme();

return (
<div>
The current theme is: {theme}
<button onClick={() => setTheme("light")}>Light Mode</button>
<button onClick={() => setTheme("dark")}>Dark Mode</button>
</div>
);
};
-

Force per page theme and color-scheme

Next.js app router

import { ForceTheme } from "nextjs-themes";

function MyPage() {
return (
<>
<ForceTheme theme={"my-theme"} />
...
</>
);
}

export default MyPage; +

Force per page theme and color-scheme

Next.js app router

import { ForceTheme } from "nextjs-themes";

function MyPage() {
return (
<>
<ForceTheme theme={"my-theme"} />
...
</>
);
}

export default MyPage;

Next.js pages router

For pages router, you have 2 options. One is the same as the app router and the other option which is compatible with next-themes is to add theme to your page component as follows.

-
function MyPage() {
return <>...</>;
}

MyPage.theme = "my-theme";

export default MyPage; +
function MyPage() {
return <>...</>;
}

MyPage.theme = "my-theme";

export default MyPage;

In a similar way, you can also force color scheme.

Forcing color scheme will apply your defaultDark or defaultLight theme, configurable via hooks.

-

Migrating from v1 to v2

Motivation:

For server side syncing, we need to use cookies and headers. This means that this component and its children can not be static. They will be rendered server side for each request. Thus, we are avoiding the wrapper. Now, only the NextJsSSGThemeSwitcher will be rendered server side for each request and rest of your app can be server statically.

+

With Styled Components and any CSS-in-JS

Next Themes is completely CSS independent, it will work with any library. For example, with Styled Components you just need to createGlobalStyle in your custom App:

+
// pages/_app.js
import { createGlobalStyle } from "styled-components";
import { ThemeSwitcher } from "nextjs-themes";

// Your themeing variables
const GlobalStyle = createGlobalStyle`
:root {
--fg: #000;
--bg: #fff;
}

[data-theme="dark"] {
--fg: #fff;
--bg: #000;
}
`;

function MyApp({ Component, pageProps }) {
return (
<>
<GlobalStyle />
<ThemeSwitcher forcedTheme={Component.theme} />
<Component {...pageProps} />
</>
);
} +
+

With Tailwind

In your tailwind.config.js, set the dark mode property to class:

+
// tailwind.config.js
module.exports = {
darkMode: "class",
}; +
+

⚡🎉Boom! You are ready to use darkTheme in tailwind.

+
+

Caution! Your class must be set to "dark", which is the default value we have used for this library. Tailwind, as of now, requires that class name must be "dark" for dark-theme.

+
+

That's it! Now you can use dark-mode specific classes:

+
<h1 className="text-black dark:text-white">
+
+

Migrating from v1 to v2

2.0.0

Major Changes

    +
  • 6f17cce: # Additonal CSS Combinations + Ensure seamless support for Tailwind

    +
      +
    • No changes required for client side code as [data-theme=] selectors work as before.
    • +
    • If you are using ServerSideWrapper or NextJsServerTarget or NextJsSSGThemeSwitcher, you need to convert forcedPages elements to objects of the shape { pathMatcher: RegExp | string; props: ThemeSwitcherProps }.
    • +
    • Use resolvedColorScheme for more sturdy dark/light/system modes
    • +
    • Use combinations of [data-th=""] and [data-color-scheme=""] for dark/light varients of themes
    • +
    • Use [data-csp=""] to style based on colorSchemePreference.
    • +
    +
  • +
+

Minor Changes

    +
  • Support custom themeTransition

      +
    • Provide themeTransition prop to ThemeSwitcher component to apply smooth transition while changing theme.
    • +
    • Use setThemeSet to set lightTheme and darkTheme together.
    • +
    +
  • +
+

Motivation:

For server side syncing, we need to use cookies and headers. This means that this component and its children can not be static. They will be rendered server side for each request. Thus, we are avoiding the wrapper. Now, only the NextJsSSGThemeSwitcher will be rendered server side for each request and rest of your app can be server statically.

Take care of the following while migrating to v2.

  • No changes required for projects not using Next.js app router or server components other than updating cookies policy if needed.
  • @@ -85,10 +123,20 @@

Docs

Typedoc

🤩 Don't forger to start this repo!

Want handson course for getting started with Turborepo? Check out React and Next.js with TypeScript

+

FAQ

Do I need to use CSS variables with this library?

+

Nope. It's just a convenient way. You can hard code values for every class as follows.

+
.my-class {
color: #555;
}

[data-theme="dark"] .my-class {
color: white;
} +
+

Why is resolvedTheme and resolvedColorScheme necessary?

+

When supporting the System theme preference, and forced theme/colorScheme pages, you want to make sure that's reflected in your UI. This means your buttons, selects, dropdowns, or whatever you use to indicate the current colorScheme should say "system" when the System colorScheme preference is active. And also the appropreate theme is available in resolvedTheme.

+

resolvedTheme is then useful for modifying behavior or styles at runtime:

+
const { resolvedTheme, resolvedColorScheme } = useTheme();

const background = getBackground(resolvedTheme);

<div style={{ color: resolvedColorScheme === 'dark' ? white : black, background }}> +
+

If we didn't have resolvedTheme and only used theme, you'd lose information about the state of your UI (you would only know the theme is "system", and not what it resolved to).

License

Licensed as MIT open source.

Note: This package uses cookies to sync theme with server components


-

with 💖 by Mayank Kumar Chaudhari

Generated using TypeDoc

\ No newline at end of file +

with 💖 by Mayank Kumar Chaudhari

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html index 43ebb4ce..b8db584e 100644 --- a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html +++ b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html @@ -1,3 +1,3 @@ -ColorSwitchProps | Code Documentation
interface ColorSwitchProps {
    size?: number;
}

Properties

size? +ColorSwitchProps | Code Documentation

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.DataProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.DataProps.html new file mode 100644 index 00000000..83cdb823 --- /dev/null +++ b/docs/interfaces/client_theme_switcher_theme_switcher.DataProps.html @@ -0,0 +1,6 @@ +DataProps | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html index cc73c465..3917ae18 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html @@ -1,4 +1,5 @@ -ThemeSwitcherProps | Code Documentation
interface ThemeSwitcherProps {
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    targetSelector?: string;
}

Properties

forcedColorScheme? +ThemeSwitcherProps | Code Documentation

Generated using TypeDoc

\ No newline at end of file +themeTransition? +

Properties

forcedColorScheme?: ColorSchemeType
forcedTheme?: string
targetSelector?: string
themeTransition?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.UpdateProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.UpdateProps.html new file mode 100644 index 00000000..476fd879 --- /dev/null +++ b/docs/interfaces/client_theme_switcher_theme_switcher.UpdateProps.html @@ -0,0 +1,5 @@ +UpdateProps | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSRThemeSwitcherProps.html b/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSRThemeSwitcherProps.html index 500f6cbf..743467ec 100644 --- a/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSRThemeSwitcherProps.html +++ b/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.NextJsSSRThemeSwitcherProps.html @@ -1,4 +1,4 @@ -NextJsSSRThemeSwitcherProps | Code Documentation
interface NextJsSSRThemeSwitcherProps {
    about?: string;
    accept?: string;
    acceptCharset?: string;
    accessKey?: string;
    action?: string | ((formData) => void);
    allowFullScreen?: boolean;
    allowTransparency?: boolean;
    alt?: string;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?: "list" | "none" | "inline" | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?: boolean | "true" | "false" | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?: boolean | "time" | "page" | "step" | "true" | "false" | "date" | "location";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?: boolean | "dialog" | "menu" | "grid" | "listbox" | "tree" | "true" | "false";
    aria-hidden?: Booleanish;
    aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?: boolean | "true" | "false" | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?: "text" | "all" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?: "none" | "ascending" | "descending" | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    as?: string;
    async?: boolean;
    autoCapitalize?: string;
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoPlay?: boolean;
    autoSave?: string;
    capture?: boolean | "user" | "environment";
    cellPadding?: string | number;
    cellSpacing?: string | number;
    challenge?: string;
    charSet?: string;
    checked?: boolean;
    children?: ReactNode;
    cite?: string;
    classID?: string;
    className?: string;
    colSpan?: number;
    color?: string;
    cols?: number;
    content?: string;
    contentEditable?: Booleanish | "inherit" | "plaintext-only";
    contextMenu?: string;
    controls?: boolean;
    coords?: string;
    crossOrigin?: CrossOrigin;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    data?: string;
    datatype?: string;
    dateTime?: string;
    default?: boolean;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    defer?: boolean;
    dir?: string;
    disabled?: boolean;
    download?: any;
    draggable?: Booleanish;
    encType?: string;
    forcedPages?: ForcedPage[];
    form?: string;
    formAction?: string | ((formData) => void);
    formEncType?: string;
    formMethod?: string;
    formNoValidate?: boolean;
    formTarget?: string;
    frameBorder?: string | number;
    headers?: string;
    height?: string | number;
    hidden?: boolean;
    high?: number;
    href?: string;
    hrefLang?: string;
    htmlFor?: string;
    httpEquiv?: string;
    id?: string;
    inlist?: any;
    inputMode?: "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal";
    integrity?: string;
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | Key;
    keyParams?: string;
    keyType?: string;
    kind?: string;
    label?: string;
    lang?: string;
    list?: string;
    loop?: boolean;
    low?: number;
    manifest?: string;
    marginHeight?: number;
    marginWidth?: number;
    max?: string | number;
    maxLength?: number;
    media?: string;
    mediaGroup?: string;
    method?: string;
    min?: string | number;
    minLength?: number;
    multiple?: boolean;
    muted?: boolean;
    name?: string;
    noValidate?: boolean;
    nonce?: string;
    onAbort?: ReactEventHandler<HTMLElement>;
    onAbortCapture?: ReactEventHandler<HTMLElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationStart?: AnimationEventHandler<HTMLElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLElement>;
    onAuxClick?: MouseEventHandler<HTMLElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLElement>;
    onBeforeInput?: FormEventHandler<HTMLElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLElement>;
    onBlur?: FocusEventHandler<HTMLElement>;
    onBlurCapture?: FocusEventHandler<HTMLElement>;
    onCanPlay?: ReactEventHandler<HTMLElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>;
    onChange?: FormEventHandler<HTMLElement>;
    onChangeCapture?: FormEventHandler<HTMLElement>;
    onClick?: MouseEventHandler<HTMLElement>;
    onClickCapture?: MouseEventHandler<HTMLElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionStart?: CompositionEventHandler<HTMLElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>;
    onContextMenu?: MouseEventHandler<HTMLElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLElement>;
    onCopy?: ClipboardEventHandler<HTMLElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLElement>;
    onCut?: ClipboardEventHandler<HTMLElement>;
    onCutCapture?: ClipboardEventHandler<HTMLElement>;
    onDoubleClick?: MouseEventHandler<HTMLElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLElement>;
    onDrag?: DragEventHandler<HTMLElement>;
    onDragCapture?: DragEventHandler<HTMLElement>;
    onDragEnd?: DragEventHandler<HTMLElement>;
    onDragEndCapture?: DragEventHandler<HTMLElement>;
    onDragEnter?: DragEventHandler<HTMLElement>;
    onDragEnterCapture?: DragEventHandler<HTMLElement>;
    onDragExit?: DragEventHandler<HTMLElement>;
    onDragExitCapture?: DragEventHandler<HTMLElement>;
    onDragLeave?: DragEventHandler<HTMLElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLElement>;
    onDragOver?: DragEventHandler<HTMLElement>;
    onDragOverCapture?: DragEventHandler<HTMLElement>;
    onDragStart?: DragEventHandler<HTMLElement>;
    onDragStartCapture?: DragEventHandler<HTMLElement>;
    onDrop?: DragEventHandler<HTMLElement>;
    onDropCapture?: DragEventHandler<HTMLElement>;
    onDurationChange?: ReactEventHandler<HTMLElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLElement>;
    onEmptied?: ReactEventHandler<HTMLElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLElement>;
    onEncrypted?: ReactEventHandler<HTMLElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLElement>;
    onEnded?: ReactEventHandler<HTMLElement>;
    onEndedCapture?: ReactEventHandler<HTMLElement>;
    onError?: ReactEventHandler<HTMLElement>;
    onErrorCapture?: ReactEventHandler<HTMLElement>;
    onFocus?: FocusEventHandler<HTMLElement>;
    onFocusCapture?: FocusEventHandler<HTMLElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onInput?: FormEventHandler<HTMLElement>;
    onInputCapture?: FormEventHandler<HTMLElement>;
    onInvalid?: FormEventHandler<HTMLElement>;
    onInvalidCapture?: FormEventHandler<HTMLElement>;
    onKeyDown?: KeyboardEventHandler<HTMLElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyPress?: KeyboardEventHandler<HTMLElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyUp?: KeyboardEventHandler<HTMLElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLElement>;
    onLoad?: ReactEventHandler<HTMLElement>;
    onLoadCapture?: ReactEventHandler<HTMLElement>;
    onLoadStart?: ReactEventHandler<HTMLElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLElement>;
    onLoadedData?: ReactEventHandler<HTMLElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onMouseDown?: MouseEventHandler<HTMLElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLElement>;
    onMouseEnter?: MouseEventHandler<HTMLElement>;
    onMouseLeave?: MouseEventHandler<HTMLElement>;
    onMouseMove?: MouseEventHandler<HTMLElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLElement>;
    onMouseOut?: MouseEventHandler<HTMLElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLElement>;
    onMouseOver?: MouseEventHandler<HTMLElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLElement>;
    onMouseUp?: MouseEventHandler<HTMLElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLElement>;
    onPaste?: ClipboardEventHandler<HTMLElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLElement>;
    onPause?: ReactEventHandler<HTMLElement>;
    onPauseCapture?: ReactEventHandler<HTMLElement>;
    onPlay?: ReactEventHandler<HTMLElement>;
    onPlayCapture?: ReactEventHandler<HTMLElement>;
    onPlaying?: ReactEventHandler<HTMLElement>;
    onPlayingCapture?: ReactEventHandler<HTMLElement>;
    onPointerCancel?: PointerEventHandler<HTMLElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLElement>;
    onPointerDown?: PointerEventHandler<HTMLElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLElement>;
    onPointerEnter?: PointerEventHandler<HTMLElement>;
    onPointerEnterCapture?: PointerEventHandler<HTMLElement>;
    onPointerLeave?: PointerEventHandler<HTMLElement>;
    onPointerLeaveCapture?: PointerEventHandler<HTMLElement>;
    onPointerMove?: PointerEventHandler<HTMLElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLElement>;
    onPointerOut?: PointerEventHandler<HTMLElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLElement>;
    onPointerOver?: PointerEventHandler<HTMLElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLElement>;
    onPointerUp?: PointerEventHandler<HTMLElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLElement>;
    onProgress?: ReactEventHandler<HTMLElement>;
    onProgressCapture?: ReactEventHandler<HTMLElement>;
    onRateChange?: ReactEventHandler<HTMLElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLElement>;
    onReset?: FormEventHandler<HTMLElement>;
    onResetCapture?: FormEventHandler<HTMLElement>;
    onResize?: ReactEventHandler<HTMLElement>;
    onResizeCapture?: ReactEventHandler<HTMLElement>;
    onScroll?: UIEventHandler<HTMLElement>;
    onScrollCapture?: UIEventHandler<HTMLElement>;
    onSeeked?: ReactEventHandler<HTMLElement>;
    onSeekedCapture?: ReactEventHandler<HTMLElement>;
    onSeeking?: ReactEventHandler<HTMLElement>;
    onSeekingCapture?: ReactEventHandler<HTMLElement>;
    onSelect?: ReactEventHandler<HTMLElement>;
    onSelectCapture?: ReactEventHandler<HTMLElement>;
    onStalled?: ReactEventHandler<HTMLElement>;
    onStalledCapture?: ReactEventHandler<HTMLElement>;
    onSubmit?: FormEventHandler<HTMLElement>;
    onSubmitCapture?: FormEventHandler<HTMLElement>;
    onSuspend?: ReactEventHandler<HTMLElement>;
    onSuspendCapture?: ReactEventHandler<HTMLElement>;
    onTimeUpdate?: ReactEventHandler<HTMLElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLElement>;
    onTouchCancel?: TouchEventHandler<HTMLElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLElement>;
    onTouchEnd?: TouchEventHandler<HTMLElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLElement>;
    onTouchMove?: TouchEventHandler<HTMLElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLElement>;
    onTouchStart?: TouchEventHandler<HTMLElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLElement>;
    onVolumeChange?: ReactEventHandler<HTMLElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLElement>;
    onWaiting?: ReactEventHandler<HTMLElement>;
    onWaitingCapture?: ReactEventHandler<HTMLElement>;
    onWheel?: WheelEventHandler<HTMLElement>;
    onWheelCapture?: WheelEventHandler<HTMLElement>;
    open?: boolean;
    optimum?: number;
    pattern?: string;
    placeholder?: string;
    playsInline?: boolean;
    poster?: string;
    prefix?: string;
    preload?: string;
    property?: string;
    radioGroup?: string;
    readOnly?: boolean;
    ref?: LegacyRef<HTMLElement>;
    rel?: string;
    required?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    reversed?: boolean;
    role?: AriaRole;
    rowSpan?: number;
    rows?: number;
    sandbox?: string;
    scope?: string;
    scoped?: boolean;
    scrolling?: string;
    seamless?: boolean;
    security?: string;
    selected?: boolean;
    shape?: string;
    size?: number;
    sizes?: string;
    slot?: string;
    span?: number;
    spellCheck?: Booleanish;
    src?: string;
    srcDoc?: string;
    srcLang?: string;
    srcSet?: string;
    start?: number;
    step?: string | number;
    style?: CSSProperties;
    summary?: string;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    tag?: keyof IntrinsicElements;
    target?: string;
    title?: string;
    translate?: "yes" | "no";
    type?: string;
    typeof?: string;
    unselectable?: "on" | "off";
    useMap?: string;
    value?: string | number | readonly string[];
    vocab?: string;
    width?: string | number;
    wmode?: string;
    wrap?: string;
}

Hierarchy

Properties

about? +NextJsSSRThemeSwitcherProps | Code Documentation
interface NextJsSSRThemeSwitcherProps {
    about?: string;
    accept?: string;
    acceptCharset?: string;
    accessKey?: string;
    action?: string | ((formData) => void);
    allowFullScreen?: boolean;
    allowTransparency?: boolean;
    alt?: string;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?: "none" | "list" | "inline" | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?: boolean | "true" | "false" | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?: boolean | "true" | "false" | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?: "none" | "ascending" | "descending" | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    as?: string;
    async?: boolean;
    autoCapitalize?: string;
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoPlay?: boolean;
    autoSave?: string;
    capture?: boolean | "user" | "environment";
    cellPadding?: string | number;
    cellSpacing?: string | number;
    challenge?: string;
    charSet?: string;
    checked?: boolean;
    children?: ReactNode;
    cite?: string;
    classID?: string;
    className?: string;
    colSpan?: number;
    color?: string;
    cols?: number;
    content?: string;
    contentEditable?: Booleanish | "inherit" | "plaintext-only";
    contextMenu?: string;
    controls?: boolean;
    coords?: string;
    crossOrigin?: CrossOrigin;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    data?: string;
    datatype?: string;
    dateTime?: string;
    default?: boolean;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    defer?: boolean;
    dir?: string;
    disabled?: boolean;
    download?: any;
    draggable?: Booleanish;
    encType?: string;
    forcedPages?: ForcedPage[];
    form?: string;
    formAction?: string | ((formData) => void);
    formEncType?: string;
    formMethod?: string;
    formNoValidate?: boolean;
    formTarget?: string;
    frameBorder?: string | number;
    headers?: string;
    height?: string | number;
    hidden?: boolean;
    high?: number;
    href?: string;
    hrefLang?: string;
    htmlFor?: string;
    httpEquiv?: string;
    id?: string;
    inlist?: any;
    inputMode?: "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal";
    integrity?: string;
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | Key;
    keyParams?: string;
    keyType?: string;
    kind?: string;
    label?: string;
    lang?: string;
    list?: string;
    loop?: boolean;
    low?: number;
    manifest?: string;
    marginHeight?: number;
    marginWidth?: number;
    max?: string | number;
    maxLength?: number;
    media?: string;
    mediaGroup?: string;
    method?: string;
    min?: string | number;
    minLength?: number;
    multiple?: boolean;
    muted?: boolean;
    name?: string;
    noValidate?: boolean;
    nonce?: string;
    onAbort?: ReactEventHandler<HTMLElement>;
    onAbortCapture?: ReactEventHandler<HTMLElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationStart?: AnimationEventHandler<HTMLElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLElement>;
    onAuxClick?: MouseEventHandler<HTMLElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLElement>;
    onBeforeInput?: FormEventHandler<HTMLElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLElement>;
    onBlur?: FocusEventHandler<HTMLElement>;
    onBlurCapture?: FocusEventHandler<HTMLElement>;
    onCanPlay?: ReactEventHandler<HTMLElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>;
    onChange?: FormEventHandler<HTMLElement>;
    onChangeCapture?: FormEventHandler<HTMLElement>;
    onClick?: MouseEventHandler<HTMLElement>;
    onClickCapture?: MouseEventHandler<HTMLElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionStart?: CompositionEventHandler<HTMLElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>;
    onContextMenu?: MouseEventHandler<HTMLElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLElement>;
    onCopy?: ClipboardEventHandler<HTMLElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLElement>;
    onCut?: ClipboardEventHandler<HTMLElement>;
    onCutCapture?: ClipboardEventHandler<HTMLElement>;
    onDoubleClick?: MouseEventHandler<HTMLElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLElement>;
    onDrag?: DragEventHandler<HTMLElement>;
    onDragCapture?: DragEventHandler<HTMLElement>;
    onDragEnd?: DragEventHandler<HTMLElement>;
    onDragEndCapture?: DragEventHandler<HTMLElement>;
    onDragEnter?: DragEventHandler<HTMLElement>;
    onDragEnterCapture?: DragEventHandler<HTMLElement>;
    onDragExit?: DragEventHandler<HTMLElement>;
    onDragExitCapture?: DragEventHandler<HTMLElement>;
    onDragLeave?: DragEventHandler<HTMLElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLElement>;
    onDragOver?: DragEventHandler<HTMLElement>;
    onDragOverCapture?: DragEventHandler<HTMLElement>;
    onDragStart?: DragEventHandler<HTMLElement>;
    onDragStartCapture?: DragEventHandler<HTMLElement>;
    onDrop?: DragEventHandler<HTMLElement>;
    onDropCapture?: DragEventHandler<HTMLElement>;
    onDurationChange?: ReactEventHandler<HTMLElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLElement>;
    onEmptied?: ReactEventHandler<HTMLElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLElement>;
    onEncrypted?: ReactEventHandler<HTMLElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLElement>;
    onEnded?: ReactEventHandler<HTMLElement>;
    onEndedCapture?: ReactEventHandler<HTMLElement>;
    onError?: ReactEventHandler<HTMLElement>;
    onErrorCapture?: ReactEventHandler<HTMLElement>;
    onFocus?: FocusEventHandler<HTMLElement>;
    onFocusCapture?: FocusEventHandler<HTMLElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onInput?: FormEventHandler<HTMLElement>;
    onInputCapture?: FormEventHandler<HTMLElement>;
    onInvalid?: FormEventHandler<HTMLElement>;
    onInvalidCapture?: FormEventHandler<HTMLElement>;
    onKeyDown?: KeyboardEventHandler<HTMLElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyPress?: KeyboardEventHandler<HTMLElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyUp?: KeyboardEventHandler<HTMLElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLElement>;
    onLoad?: ReactEventHandler<HTMLElement>;
    onLoadCapture?: ReactEventHandler<HTMLElement>;
    onLoadStart?: ReactEventHandler<HTMLElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLElement>;
    onLoadedData?: ReactEventHandler<HTMLElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onMouseDown?: MouseEventHandler<HTMLElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLElement>;
    onMouseEnter?: MouseEventHandler<HTMLElement>;
    onMouseLeave?: MouseEventHandler<HTMLElement>;
    onMouseMove?: MouseEventHandler<HTMLElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLElement>;
    onMouseOut?: MouseEventHandler<HTMLElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLElement>;
    onMouseOver?: MouseEventHandler<HTMLElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLElement>;
    onMouseUp?: MouseEventHandler<HTMLElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLElement>;
    onPaste?: ClipboardEventHandler<HTMLElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLElement>;
    onPause?: ReactEventHandler<HTMLElement>;
    onPauseCapture?: ReactEventHandler<HTMLElement>;
    onPlay?: ReactEventHandler<HTMLElement>;
    onPlayCapture?: ReactEventHandler<HTMLElement>;
    onPlaying?: ReactEventHandler<HTMLElement>;
    onPlayingCapture?: ReactEventHandler<HTMLElement>;
    onPointerCancel?: PointerEventHandler<HTMLElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLElement>;
    onPointerDown?: PointerEventHandler<HTMLElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLElement>;
    onPointerEnter?: PointerEventHandler<HTMLElement>;
    onPointerEnterCapture?: PointerEventHandler<HTMLElement>;
    onPointerLeave?: PointerEventHandler<HTMLElement>;
    onPointerLeaveCapture?: PointerEventHandler<HTMLElement>;
    onPointerMove?: PointerEventHandler<HTMLElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLElement>;
    onPointerOut?: PointerEventHandler<HTMLElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLElement>;
    onPointerOver?: PointerEventHandler<HTMLElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLElement>;
    onPointerUp?: PointerEventHandler<HTMLElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLElement>;
    onProgress?: ReactEventHandler<HTMLElement>;
    onProgressCapture?: ReactEventHandler<HTMLElement>;
    onRateChange?: ReactEventHandler<HTMLElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLElement>;
    onReset?: FormEventHandler<HTMLElement>;
    onResetCapture?: FormEventHandler<HTMLElement>;
    onResize?: ReactEventHandler<HTMLElement>;
    onResizeCapture?: ReactEventHandler<HTMLElement>;
    onScroll?: UIEventHandler<HTMLElement>;
    onScrollCapture?: UIEventHandler<HTMLElement>;
    onSeeked?: ReactEventHandler<HTMLElement>;
    onSeekedCapture?: ReactEventHandler<HTMLElement>;
    onSeeking?: ReactEventHandler<HTMLElement>;
    onSeekingCapture?: ReactEventHandler<HTMLElement>;
    onSelect?: ReactEventHandler<HTMLElement>;
    onSelectCapture?: ReactEventHandler<HTMLElement>;
    onStalled?: ReactEventHandler<HTMLElement>;
    onStalledCapture?: ReactEventHandler<HTMLElement>;
    onSubmit?: FormEventHandler<HTMLElement>;
    onSubmitCapture?: FormEventHandler<HTMLElement>;
    onSuspend?: ReactEventHandler<HTMLElement>;
    onSuspendCapture?: ReactEventHandler<HTMLElement>;
    onTimeUpdate?: ReactEventHandler<HTMLElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLElement>;
    onTouchCancel?: TouchEventHandler<HTMLElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLElement>;
    onTouchEnd?: TouchEventHandler<HTMLElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLElement>;
    onTouchMove?: TouchEventHandler<HTMLElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLElement>;
    onTouchStart?: TouchEventHandler<HTMLElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLElement>;
    onVolumeChange?: ReactEventHandler<HTMLElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLElement>;
    onWaiting?: ReactEventHandler<HTMLElement>;
    onWaitingCapture?: ReactEventHandler<HTMLElement>;
    onWheel?: WheelEventHandler<HTMLElement>;
    onWheelCapture?: WheelEventHandler<HTMLElement>;
    open?: boolean;
    optimum?: number;
    pattern?: string;
    placeholder?: string;
    playsInline?: boolean;
    poster?: string;
    prefix?: string;
    preload?: string;
    property?: string;
    radioGroup?: string;
    readOnly?: boolean;
    ref?: LegacyRef<HTMLElement>;
    rel?: string;
    required?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    reversed?: boolean;
    role?: AriaRole;
    rowSpan?: number;
    rows?: number;
    sandbox?: string;
    scope?: string;
    scoped?: boolean;
    scrolling?: string;
    seamless?: boolean;
    security?: string;
    selected?: boolean;
    shape?: string;
    size?: number;
    sizes?: string;
    slot?: string;
    span?: number;
    spellCheck?: Booleanish;
    src?: string;
    srcDoc?: string;
    srcLang?: string;
    srcSet?: string;
    start?: number;
    step?: string | number;
    style?: CSSProperties;
    summary?: string;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    tag?: keyof IntrinsicElements;
    target?: string;
    title?: string;
    translate?: "yes" | "no";
    type?: string;
    typeof?: string;
    unselectable?: "on" | "off";
    useMap?: string;
    value?: string | number | readonly string[];
    vocab?: string;
    width?: string | number;
    wmode?: string;
    wrap?: string;
}

Hierarchy

Properties

Properties

about?: string

RDFa Attributes

-
accept?: string

Standard HTML Attributes

-
acceptCharset?: string
accessKey?: string

Standard HTML Attributes

-
action?: string | ((formData) => void)

Type declaration

    • (formData): void
    • Parameters

      • formData: FormData

      Returns void

allowFullScreen?: boolean
allowTransparency?: boolean
alt?: string
aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

-
aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

-
aria-autocomplete?: "list" | "none" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +

accept?: string

Standard HTML Attributes

+
acceptCharset?: string
accessKey?: string

Standard HTML Attributes

+
action?: string | ((formData) => void)

Type declaration

    • (formData): void
    • Parameters

      • formData: FormData

      Returns void

allowFullScreen?: boolean
allowTransparency?: boolean
alt?: string
aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+
aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

+
aria-autocomplete?: "none" | "list" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

-
aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

+
aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

See

aria-label.

-
aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

+
aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

See

aria-roledescription.

-
aria-busy?: Booleanish
aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+
aria-busy?: Booleanish
aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

  • aria-pressed
  • aria-selected.
-
aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

+
aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

-
aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

+
aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

  • aria-colcount
  • aria-colspan.
-
aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

+
aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

-
aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+
aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-colindex
  • aria-rowspan.
-
aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+
aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

-
aria-current?: boolean | "time" | "page" | "step" | "true" | "false" | "date" | "location"

Indicates the element that represents the current item within a container or set of related elements.

-
aria-describedby?: string

Identifies the element (or elements) that describes the object.

+
aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location"

Indicates the element that represents the current item within a container or set of related elements.

+
aria-describedby?: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

-
aria-description?: string

Defines a string value that describes or annotates the current element.

+
aria-description?: string

Defines a string value that describes or annotates the current element.

See

related aria-describedby.

-
aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

+
aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

-
aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+
aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

  • aria-hidden
  • aria-readonly.
-
aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

+
aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

-
aria-errormessage?: string

Identifies the element that provides an error message for the object.

+
aria-errormessage?: string

Identifies the element that provides an error message for the object.

See

  • aria-invalid
  • aria-describedby.
-
aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

-
aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+
aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

-
aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

+
aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

-
aria-haspopup?: boolean | "dialog" | "menu" | "grid" | "listbox" | "tree" | "true" | "false"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

-
aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

+
aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+
aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

-
aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

+
aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

-
aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

-
aria-label?: string

Defines a string value that labels the current element.

+
aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+
aria-label?: string

Defines a string value that labels the current element.

See

aria-labelledby.

-
aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

+
aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

-
aria-level?: number

Defines the hierarchical level of an element within a structure.

-
aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

-
aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

-
aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

-
aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

-
aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

-
aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +

aria-level?: number

Defines the hierarchical level of an element within a structure.

+
aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

+
aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

+
aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

+
aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

+
aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+
aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

See

aria-controls.

-
aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

-
aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

+
aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-setsize.

-
aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

+
aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

See

  • aria-checked
  • aria-selected.
-
aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

+
aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

-
aria-relevant?: "text" | "all" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+
aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

-
aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

-
aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

-
aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

+
aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

+
aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

+
aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

-
aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

+
aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

  • aria-rowcount
  • aria-rowspan.
-
aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

+
aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

See

aria-colindextext.

-
aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+
aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-rowindex
  • aria-colspan.
-
aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

+
aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

See

  • aria-checked
  • aria-pressed.
-
aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

+
aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-posinset.

-
aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

-
aria-valuemax?: number

Defines the maximum allowed value for a range widget.

-
aria-valuemin?: number

Defines the minimum allowed value for a range widget.

-
aria-valuenow?: number

Defines the current value for a range widget.

+
aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

+
aria-valuemax?: number

Defines the maximum allowed value for a range widget.

+
aria-valuemin?: number

Defines the minimum allowed value for a range widget.

+
aria-valuenow?: number

Defines the current value for a range widget.

See

aria-valuetext.

-
aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

-
as?: string
async?: boolean
autoCapitalize?: string

Non-standard Attributes

-
autoComplete?: string
autoCorrect?: string
autoFocus?: boolean
autoPlay?: boolean
autoSave?: string
capture?: boolean | "user" | "environment"
cellPadding?: string | number
cellSpacing?: string | number
challenge?: string
charSet?: string
checked?: boolean
children?: ReactNode
cite?: string
classID?: string
className?: string
colSpan?: number
color?: string
cols?: number
content?: string
contentEditable?: Booleanish | "inherit" | "plaintext-only"
contextMenu?: string
controls?: boolean
coords?: string
crossOrigin?: CrossOrigin
dangerouslySetInnerHTML?: {
    __html: string | TrustedHTML;
}

Type declaration

  • __html: string | TrustedHTML

    Should be InnerHTML['innerHTML']. +

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

+
as?: string
async?: boolean
autoCapitalize?: string

Non-standard Attributes

+
autoComplete?: string
autoCorrect?: string
autoFocus?: boolean
autoPlay?: boolean
autoSave?: string
capture?: boolean | "user" | "environment"
cellPadding?: string | number
cellSpacing?: string | number
challenge?: string
charSet?: string
checked?: boolean
children?: ReactNode
cite?: string
classID?: string
className?: string
colSpan?: number
color?: string
cols?: number
content?: string
contentEditable?: Booleanish | "inherit" | "plaintext-only"
contextMenu?: string
controls?: boolean
coords?: string
crossOrigin?: CrossOrigin
dangerouslySetInnerHTML?: {
    __html: string | TrustedHTML;
}

Type declaration

  • __html: string | TrustedHTML

    Should be InnerHTML['innerHTML']. But unfortunately we're mixing renderer-specific type declarations.

    -
data?: string
datatype?: string
dateTime?: string
default?: boolean
defaultChecked?: boolean

React-specific Attributes

-
defaultValue?: string | number | readonly string[]
defer?: boolean
dir?: string
disabled?: boolean
download?: any
draggable?: Booleanish
encType?: string
forcedPages?: ForcedPage[]
form?: string
formAction?: string | ((formData) => void)

Type declaration

    • (formData): void
    • Parameters

      • formData: FormData

      Returns void

formEncType?: string
formMethod?: string
formNoValidate?: boolean
formTarget?: string
frameBorder?: string | number
headers?: string
height?: string | number
hidden?: boolean
high?: number
href?: string
hrefLang?: string
htmlFor?: string
httpEquiv?: string
id?: string
inlist?: any
inputMode?: "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

+
data?: string
datatype?: string
dateTime?: string
default?: boolean
defaultChecked?: boolean

React-specific Attributes

+
defaultValue?: string | number | readonly string[]
defer?: boolean
dir?: string
disabled?: boolean
download?: any
draggable?: Booleanish
encType?: string
forcedPages?: ForcedPage[]
form?: string
formAction?: string | ((formData) => void)

Type declaration

    • (formData): void
    • Parameters

      • formData: FormData

      Returns void

formEncType?: string
formMethod?: string
formNoValidate?: boolean
formTarget?: string
frameBorder?: string | number
headers?: string
height?: string | number
hidden?: boolean
high?: number
href?: string
hrefLang?: string
htmlFor?: string
httpEquiv?: string
id?: string
inlist?: any
inputMode?: "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

integrity?: string
is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

+
integrity?: string
is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
key?: null | Key
keyParams?: string
keyType?: string
kind?: string
label?: string
lang?: string
list?: string
loop?: boolean
low?: number
manifest?: string
marginHeight?: number
marginWidth?: number
max?: string | number
maxLength?: number
media?: string
mediaGroup?: string
method?: string
min?: string | number
minLength?: number
multiple?: boolean
muted?: boolean
name?: string
noValidate?: boolean
nonce?: string
onAbort?: ReactEventHandler<HTMLElement>

Media Events

-
onAbortCapture?: ReactEventHandler<HTMLElement>
onAnimationEnd?: AnimationEventHandler<HTMLElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLElement>
onAnimationIteration?: AnimationEventHandler<HTMLElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>
onAnimationStart?: AnimationEventHandler<HTMLElement>

Animation Events

-
onAnimationStartCapture?: AnimationEventHandler<HTMLElement>
onAuxClick?: MouseEventHandler<HTMLElement>

MouseEvents

-
onAuxClickCapture?: MouseEventHandler<HTMLElement>
onBeforeInput?: FormEventHandler<HTMLElement>
onBeforeInputCapture?: FormEventHandler<HTMLElement>
onBlur?: FocusEventHandler<HTMLElement>
onBlurCapture?: FocusEventHandler<HTMLElement>
onCanPlay?: ReactEventHandler<HTMLElement>
onCanPlayCapture?: ReactEventHandler<HTMLElement>
onCanPlayThrough?: ReactEventHandler<HTMLElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>
onChange?: FormEventHandler<HTMLElement>

Form Events

-
onChangeCapture?: FormEventHandler<HTMLElement>
onClick?: MouseEventHandler<HTMLElement>
onClickCapture?: MouseEventHandler<HTMLElement>
onCompositionEnd?: CompositionEventHandler<HTMLElement>

Composition Events

-
onCompositionEndCapture?: CompositionEventHandler<HTMLElement>
onCompositionStart?: CompositionEventHandler<HTMLElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLElement>
onCompositionUpdate?: CompositionEventHandler<HTMLElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>
onContextMenu?: MouseEventHandler<HTMLElement>
onContextMenuCapture?: MouseEventHandler<HTMLElement>
onCopy?: ClipboardEventHandler<HTMLElement>

Clipboard Events

-
onCopyCapture?: ClipboardEventHandler<HTMLElement>
onCut?: ClipboardEventHandler<HTMLElement>
onCutCapture?: ClipboardEventHandler<HTMLElement>
onDoubleClick?: MouseEventHandler<HTMLElement>
onDoubleClickCapture?: MouseEventHandler<HTMLElement>
onDrag?: DragEventHandler<HTMLElement>
onDragCapture?: DragEventHandler<HTMLElement>
onDragEnd?: DragEventHandler<HTMLElement>
onDragEndCapture?: DragEventHandler<HTMLElement>
onDragEnter?: DragEventHandler<HTMLElement>
onDragEnterCapture?: DragEventHandler<HTMLElement>
onDragExit?: DragEventHandler<HTMLElement>
onDragExitCapture?: DragEventHandler<HTMLElement>
onDragLeave?: DragEventHandler<HTMLElement>
onDragLeaveCapture?: DragEventHandler<HTMLElement>
onDragOver?: DragEventHandler<HTMLElement>
onDragOverCapture?: DragEventHandler<HTMLElement>
onDragStart?: DragEventHandler<HTMLElement>
onDragStartCapture?: DragEventHandler<HTMLElement>
onDrop?: DragEventHandler<HTMLElement>
onDropCapture?: DragEventHandler<HTMLElement>
onDurationChange?: ReactEventHandler<HTMLElement>
onDurationChangeCapture?: ReactEventHandler<HTMLElement>
onEmptied?: ReactEventHandler<HTMLElement>
onEmptiedCapture?: ReactEventHandler<HTMLElement>
onEncrypted?: ReactEventHandler<HTMLElement>
onEncryptedCapture?: ReactEventHandler<HTMLElement>
onEnded?: ReactEventHandler<HTMLElement>
onEndedCapture?: ReactEventHandler<HTMLElement>
onError?: ReactEventHandler<HTMLElement>
onErrorCapture?: ReactEventHandler<HTMLElement>
onFocus?: FocusEventHandler<HTMLElement>

Focus Events

-
onFocusCapture?: FocusEventHandler<HTMLElement>
onGotPointerCapture?: PointerEventHandler<HTMLElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>
onInput?: FormEventHandler<HTMLElement>
onInputCapture?: FormEventHandler<HTMLElement>
onInvalid?: FormEventHandler<HTMLElement>
onInvalidCapture?: FormEventHandler<HTMLElement>
onKeyDown?: KeyboardEventHandler<HTMLElement>

Keyboard Events

-
onKeyDownCapture?: KeyboardEventHandler<HTMLElement>
onKeyPress?: KeyboardEventHandler<HTMLElement>

Deprecated

onKeyPressCapture?: KeyboardEventHandler<HTMLElement>

Deprecated

onKeyUp?: KeyboardEventHandler<HTMLElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLElement>
onLoad?: ReactEventHandler<HTMLElement>

Image Events

-
onLoadCapture?: ReactEventHandler<HTMLElement>
onLoadStart?: ReactEventHandler<HTMLElement>
onLoadStartCapture?: ReactEventHandler<HTMLElement>
onLoadedData?: ReactEventHandler<HTMLElement>
onLoadedDataCapture?: ReactEventHandler<HTMLElement>
onLoadedMetadata?: ReactEventHandler<HTMLElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>
onLostPointerCapture?: PointerEventHandler<HTMLElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>
onMouseDown?: MouseEventHandler<HTMLElement>
onMouseDownCapture?: MouseEventHandler<HTMLElement>
onMouseEnter?: MouseEventHandler<HTMLElement>
onMouseLeave?: MouseEventHandler<HTMLElement>
onMouseMove?: MouseEventHandler<HTMLElement>
onMouseMoveCapture?: MouseEventHandler<HTMLElement>
onMouseOut?: MouseEventHandler<HTMLElement>
onMouseOutCapture?: MouseEventHandler<HTMLElement>
onMouseOver?: MouseEventHandler<HTMLElement>
onMouseOverCapture?: MouseEventHandler<HTMLElement>
onMouseUp?: MouseEventHandler<HTMLElement>
onMouseUpCapture?: MouseEventHandler<HTMLElement>
onPaste?: ClipboardEventHandler<HTMLElement>
onPasteCapture?: ClipboardEventHandler<HTMLElement>
onPause?: ReactEventHandler<HTMLElement>
onPauseCapture?: ReactEventHandler<HTMLElement>
onPlay?: ReactEventHandler<HTMLElement>
onPlayCapture?: ReactEventHandler<HTMLElement>
onPlaying?: ReactEventHandler<HTMLElement>
onPlayingCapture?: ReactEventHandler<HTMLElement>
onPointerCancel?: PointerEventHandler<HTMLElement>
onPointerCancelCapture?: PointerEventHandler<HTMLElement>
onPointerDown?: PointerEventHandler<HTMLElement>

Pointer Events

-
onPointerDownCapture?: PointerEventHandler<HTMLElement>
onPointerEnter?: PointerEventHandler<HTMLElement>
onPointerEnterCapture?: PointerEventHandler<HTMLElement>
onPointerLeave?: PointerEventHandler<HTMLElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLElement>
onPointerMove?: PointerEventHandler<HTMLElement>
onPointerMoveCapture?: PointerEventHandler<HTMLElement>
onPointerOut?: PointerEventHandler<HTMLElement>
onPointerOutCapture?: PointerEventHandler<HTMLElement>
onPointerOver?: PointerEventHandler<HTMLElement>
onPointerOverCapture?: PointerEventHandler<HTMLElement>
onPointerUp?: PointerEventHandler<HTMLElement>
onPointerUpCapture?: PointerEventHandler<HTMLElement>
onProgress?: ReactEventHandler<HTMLElement>
onProgressCapture?: ReactEventHandler<HTMLElement>
onRateChange?: ReactEventHandler<HTMLElement>
onRateChangeCapture?: ReactEventHandler<HTMLElement>
onReset?: FormEventHandler<HTMLElement>
onResetCapture?: FormEventHandler<HTMLElement>
onResize?: ReactEventHandler<HTMLElement>
onResizeCapture?: ReactEventHandler<HTMLElement>
onScroll?: UIEventHandler<HTMLElement>

UI Events

-
onScrollCapture?: UIEventHandler<HTMLElement>
onSeeked?: ReactEventHandler<HTMLElement>
onSeekedCapture?: ReactEventHandler<HTMLElement>
onSeeking?: ReactEventHandler<HTMLElement>
onSeekingCapture?: ReactEventHandler<HTMLElement>
onSelect?: ReactEventHandler<HTMLElement>

Selection Events

-
onSelectCapture?: ReactEventHandler<HTMLElement>
onStalled?: ReactEventHandler<HTMLElement>
onStalledCapture?: ReactEventHandler<HTMLElement>
onSubmit?: FormEventHandler<HTMLElement>
onSubmitCapture?: FormEventHandler<HTMLElement>
onSuspend?: ReactEventHandler<HTMLElement>
onSuspendCapture?: ReactEventHandler<HTMLElement>
onTimeUpdate?: ReactEventHandler<HTMLElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLElement>
onTouchCancel?: TouchEventHandler<HTMLElement>

Touch Events

-
onTouchCancelCapture?: TouchEventHandler<HTMLElement>
onTouchEnd?: TouchEventHandler<HTMLElement>
onTouchEndCapture?: TouchEventHandler<HTMLElement>
onTouchMove?: TouchEventHandler<HTMLElement>
onTouchMoveCapture?: TouchEventHandler<HTMLElement>
onTouchStart?: TouchEventHandler<HTMLElement>
onTouchStartCapture?: TouchEventHandler<HTMLElement>
onTransitionEnd?: TransitionEventHandler<HTMLElement>

Transition Events

-
onTransitionEndCapture?: TransitionEventHandler<HTMLElement>
onVolumeChange?: ReactEventHandler<HTMLElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLElement>
onWaiting?: ReactEventHandler<HTMLElement>
onWaitingCapture?: ReactEventHandler<HTMLElement>
onWheel?: WheelEventHandler<HTMLElement>

Wheel Events

-
onWheelCapture?: WheelEventHandler<HTMLElement>
open?: boolean
optimum?: number
pattern?: string
placeholder?: string
playsInline?: boolean
poster?: string
prefix?: string
preload?: string
property?: string
radioGroup?: string

Unknown

-
readOnly?: boolean
ref?: LegacyRef<HTMLElement>

Allows getting a ref to the component instance. +

itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
key?: null | Key
keyParams?: string
keyType?: string
kind?: string
label?: string
lang?: string
list?: string
loop?: boolean
low?: number
manifest?: string
marginHeight?: number
marginWidth?: number
max?: string | number
maxLength?: number
media?: string
mediaGroup?: string
method?: string
min?: string | number
minLength?: number
multiple?: boolean
muted?: boolean
name?: string
noValidate?: boolean
nonce?: string
onAbort?: ReactEventHandler<HTMLElement>

Media Events

+
onAbortCapture?: ReactEventHandler<HTMLElement>
onAnimationEnd?: AnimationEventHandler<HTMLElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLElement>
onAnimationIteration?: AnimationEventHandler<HTMLElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>
onAnimationStart?: AnimationEventHandler<HTMLElement>

Animation Events

+
onAnimationStartCapture?: AnimationEventHandler<HTMLElement>
onAuxClick?: MouseEventHandler<HTMLElement>

MouseEvents

+
onAuxClickCapture?: MouseEventHandler<HTMLElement>
onBeforeInput?: FormEventHandler<HTMLElement>
onBeforeInputCapture?: FormEventHandler<HTMLElement>
onBlur?: FocusEventHandler<HTMLElement>
onBlurCapture?: FocusEventHandler<HTMLElement>
onCanPlay?: ReactEventHandler<HTMLElement>
onCanPlayCapture?: ReactEventHandler<HTMLElement>
onCanPlayThrough?: ReactEventHandler<HTMLElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>
onChange?: FormEventHandler<HTMLElement>

Form Events

+
onChangeCapture?: FormEventHandler<HTMLElement>
onClick?: MouseEventHandler<HTMLElement>
onClickCapture?: MouseEventHandler<HTMLElement>
onCompositionEnd?: CompositionEventHandler<HTMLElement>

Composition Events

+
onCompositionEndCapture?: CompositionEventHandler<HTMLElement>
onCompositionStart?: CompositionEventHandler<HTMLElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLElement>
onCompositionUpdate?: CompositionEventHandler<HTMLElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>
onContextMenu?: MouseEventHandler<HTMLElement>
onContextMenuCapture?: MouseEventHandler<HTMLElement>
onCopy?: ClipboardEventHandler<HTMLElement>

Clipboard Events

+
onCopyCapture?: ClipboardEventHandler<HTMLElement>
onCut?: ClipboardEventHandler<HTMLElement>
onCutCapture?: ClipboardEventHandler<HTMLElement>
onDoubleClick?: MouseEventHandler<HTMLElement>
onDoubleClickCapture?: MouseEventHandler<HTMLElement>
onDrag?: DragEventHandler<HTMLElement>
onDragCapture?: DragEventHandler<HTMLElement>
onDragEnd?: DragEventHandler<HTMLElement>
onDragEndCapture?: DragEventHandler<HTMLElement>
onDragEnter?: DragEventHandler<HTMLElement>
onDragEnterCapture?: DragEventHandler<HTMLElement>
onDragExit?: DragEventHandler<HTMLElement>
onDragExitCapture?: DragEventHandler<HTMLElement>
onDragLeave?: DragEventHandler<HTMLElement>
onDragLeaveCapture?: DragEventHandler<HTMLElement>
onDragOver?: DragEventHandler<HTMLElement>
onDragOverCapture?: DragEventHandler<HTMLElement>
onDragStart?: DragEventHandler<HTMLElement>
onDragStartCapture?: DragEventHandler<HTMLElement>
onDrop?: DragEventHandler<HTMLElement>
onDropCapture?: DragEventHandler<HTMLElement>
onDurationChange?: ReactEventHandler<HTMLElement>
onDurationChangeCapture?: ReactEventHandler<HTMLElement>
onEmptied?: ReactEventHandler<HTMLElement>
onEmptiedCapture?: ReactEventHandler<HTMLElement>
onEncrypted?: ReactEventHandler<HTMLElement>
onEncryptedCapture?: ReactEventHandler<HTMLElement>
onEnded?: ReactEventHandler<HTMLElement>
onEndedCapture?: ReactEventHandler<HTMLElement>
onError?: ReactEventHandler<HTMLElement>
onErrorCapture?: ReactEventHandler<HTMLElement>
onFocus?: FocusEventHandler<HTMLElement>

Focus Events

+
onFocusCapture?: FocusEventHandler<HTMLElement>
onGotPointerCapture?: PointerEventHandler<HTMLElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>
onInput?: FormEventHandler<HTMLElement>
onInputCapture?: FormEventHandler<HTMLElement>
onInvalid?: FormEventHandler<HTMLElement>
onInvalidCapture?: FormEventHandler<HTMLElement>
onKeyDown?: KeyboardEventHandler<HTMLElement>

Keyboard Events

+
onKeyDownCapture?: KeyboardEventHandler<HTMLElement>
onKeyPress?: KeyboardEventHandler<HTMLElement>

Deprecated

onKeyPressCapture?: KeyboardEventHandler<HTMLElement>

Deprecated

onKeyUp?: KeyboardEventHandler<HTMLElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLElement>
onLoad?: ReactEventHandler<HTMLElement>

Image Events

+
onLoadCapture?: ReactEventHandler<HTMLElement>
onLoadStart?: ReactEventHandler<HTMLElement>
onLoadStartCapture?: ReactEventHandler<HTMLElement>
onLoadedData?: ReactEventHandler<HTMLElement>
onLoadedDataCapture?: ReactEventHandler<HTMLElement>
onLoadedMetadata?: ReactEventHandler<HTMLElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>
onLostPointerCapture?: PointerEventHandler<HTMLElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>
onMouseDown?: MouseEventHandler<HTMLElement>
onMouseDownCapture?: MouseEventHandler<HTMLElement>
onMouseEnter?: MouseEventHandler<HTMLElement>
onMouseLeave?: MouseEventHandler<HTMLElement>
onMouseMove?: MouseEventHandler<HTMLElement>
onMouseMoveCapture?: MouseEventHandler<HTMLElement>
onMouseOut?: MouseEventHandler<HTMLElement>
onMouseOutCapture?: MouseEventHandler<HTMLElement>
onMouseOver?: MouseEventHandler<HTMLElement>
onMouseOverCapture?: MouseEventHandler<HTMLElement>
onMouseUp?: MouseEventHandler<HTMLElement>
onMouseUpCapture?: MouseEventHandler<HTMLElement>
onPaste?: ClipboardEventHandler<HTMLElement>
onPasteCapture?: ClipboardEventHandler<HTMLElement>
onPause?: ReactEventHandler<HTMLElement>
onPauseCapture?: ReactEventHandler<HTMLElement>
onPlay?: ReactEventHandler<HTMLElement>
onPlayCapture?: ReactEventHandler<HTMLElement>
onPlaying?: ReactEventHandler<HTMLElement>
onPlayingCapture?: ReactEventHandler<HTMLElement>
onPointerCancel?: PointerEventHandler<HTMLElement>
onPointerCancelCapture?: PointerEventHandler<HTMLElement>
onPointerDown?: PointerEventHandler<HTMLElement>

Pointer Events

+
onPointerDownCapture?: PointerEventHandler<HTMLElement>
onPointerEnter?: PointerEventHandler<HTMLElement>
onPointerEnterCapture?: PointerEventHandler<HTMLElement>
onPointerLeave?: PointerEventHandler<HTMLElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLElement>
onPointerMove?: PointerEventHandler<HTMLElement>
onPointerMoveCapture?: PointerEventHandler<HTMLElement>
onPointerOut?: PointerEventHandler<HTMLElement>
onPointerOutCapture?: PointerEventHandler<HTMLElement>
onPointerOver?: PointerEventHandler<HTMLElement>
onPointerOverCapture?: PointerEventHandler<HTMLElement>
onPointerUp?: PointerEventHandler<HTMLElement>
onPointerUpCapture?: PointerEventHandler<HTMLElement>
onProgress?: ReactEventHandler<HTMLElement>
onProgressCapture?: ReactEventHandler<HTMLElement>
onRateChange?: ReactEventHandler<HTMLElement>
onRateChangeCapture?: ReactEventHandler<HTMLElement>
onReset?: FormEventHandler<HTMLElement>
onResetCapture?: FormEventHandler<HTMLElement>
onResize?: ReactEventHandler<HTMLElement>
onResizeCapture?: ReactEventHandler<HTMLElement>
onScroll?: UIEventHandler<HTMLElement>

UI Events

+
onScrollCapture?: UIEventHandler<HTMLElement>
onSeeked?: ReactEventHandler<HTMLElement>
onSeekedCapture?: ReactEventHandler<HTMLElement>
onSeeking?: ReactEventHandler<HTMLElement>
onSeekingCapture?: ReactEventHandler<HTMLElement>
onSelect?: ReactEventHandler<HTMLElement>

Selection Events

+
onSelectCapture?: ReactEventHandler<HTMLElement>
onStalled?: ReactEventHandler<HTMLElement>
onStalledCapture?: ReactEventHandler<HTMLElement>
onSubmit?: FormEventHandler<HTMLElement>
onSubmitCapture?: FormEventHandler<HTMLElement>
onSuspend?: ReactEventHandler<HTMLElement>
onSuspendCapture?: ReactEventHandler<HTMLElement>
onTimeUpdate?: ReactEventHandler<HTMLElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLElement>
onTouchCancel?: TouchEventHandler<HTMLElement>

Touch Events

+
onTouchCancelCapture?: TouchEventHandler<HTMLElement>
onTouchEnd?: TouchEventHandler<HTMLElement>
onTouchEndCapture?: TouchEventHandler<HTMLElement>
onTouchMove?: TouchEventHandler<HTMLElement>
onTouchMoveCapture?: TouchEventHandler<HTMLElement>
onTouchStart?: TouchEventHandler<HTMLElement>
onTouchStartCapture?: TouchEventHandler<HTMLElement>
onTransitionEnd?: TransitionEventHandler<HTMLElement>

Transition Events

+
onTransitionEndCapture?: TransitionEventHandler<HTMLElement>
onVolumeChange?: ReactEventHandler<HTMLElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLElement>
onWaiting?: ReactEventHandler<HTMLElement>
onWaitingCapture?: ReactEventHandler<HTMLElement>
onWheel?: WheelEventHandler<HTMLElement>

Wheel Events

+
onWheelCapture?: WheelEventHandler<HTMLElement>
open?: boolean
optimum?: number
pattern?: string
placeholder?: string
playsInline?: boolean
poster?: string
prefix?: string
preload?: string
property?: string
radioGroup?: string

Unknown

+
readOnly?: boolean
ref?: LegacyRef<HTMLElement>

Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).

rel?: string
required?: boolean
resource?: string
results?: number
rev?: string
reversed?: boolean
role?: AriaRole

WAI-ARIA

-
rowSpan?: number
rows?: number
sandbox?: string
scope?: string
scoped?: boolean
scrolling?: string
seamless?: boolean
security?: string
selected?: boolean
shape?: string
size?: number
sizes?: string
slot?: string
span?: number
spellCheck?: Booleanish
src?: string
srcDoc?: string
srcLang?: string
srcSet?: string
start?: number
step?: string | number
style?: CSSProperties
summary?: string
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
tag?: keyof IntrinsicElements

Default Value

'div'
+
rel?: string
required?: boolean
resource?: string
results?: number
rev?: string
reversed?: boolean
role?: AriaRole

WAI-ARIA

+
rowSpan?: number
rows?: number
sandbox?: string
scope?: string
scoped?: boolean
scrolling?: string
seamless?: boolean
security?: string
selected?: boolean
shape?: string
size?: number
sizes?: string
slot?: string
span?: number
spellCheck?: Booleanish
src?: string
srcDoc?: string
srcLang?: string
srcSet?: string
start?: number
step?: string | number
style?: CSSProperties
summary?: string
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
tag?: keyof IntrinsicElements

Default Value

'div'
 
-
target?: string
title?: string
translate?: "yes" | "no"
type?: string
typeof?: string
unselectable?: "on" | "off"
useMap?: string
value?: string | number | readonly string[]
vocab?: string
width?: string | number
wmode?: string
wrap?: string

Generated using TypeDoc

\ No newline at end of file +
target?: string
title?: string
translate?: "yes" | "no"
type?: string
typeof?: string
unselectable?: "on" | "off"
useMap?: string
value?: string | number | readonly string[]
vocab?: string
width?: string | number
wmode?: string
wrap?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapperProps.html b/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapperProps.html index 31de1995..92c2c596 100644 --- a/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapperProps.html +++ b/docs/interfaces/server_nextjs_server_side_wrapper_server_side_wrapper.ServerSideWrapperProps.html @@ -1,4 +1,4 @@ -ServerSideWrapperProps | Code Documentation
interface ServerSideWrapperProps {
    about?: string;
    accept?: string;
    acceptCharset?: string;
    accessKey?: string;
    action?: string | ((formData) => void);
    allowFullScreen?: boolean;
    allowTransparency?: boolean;
    alt?: string;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?: "list" | "none" | "inline" | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?: boolean | "true" | "false" | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?: boolean | "time" | "page" | "step" | "true" | "false" | "date" | "location";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?: boolean | "dialog" | "menu" | "grid" | "listbox" | "tree" | "true" | "false";
    aria-hidden?: Booleanish;
    aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?: boolean | "true" | "false" | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?: "text" | "all" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?: "none" | "ascending" | "descending" | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    as?: string;
    async?: boolean;
    autoCapitalize?: string;
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoPlay?: boolean;
    autoSave?: string;
    capture?: boolean | "user" | "environment";
    cellPadding?: string | number;
    cellSpacing?: string | number;
    challenge?: string;
    charSet?: string;
    checked?: boolean;
    children?: ReactNode;
    cite?: string;
    classID?: string;
    className?: string;
    colSpan?: number;
    color?: string;
    cols?: number;
    content?: string;
    contentEditable?: Booleanish | "inherit" | "plaintext-only";
    contextMenu?: string;
    controls?: boolean;
    coords?: string;
    crossOrigin?: CrossOrigin;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    data?: string;
    datatype?: string;
    dateTime?: string;
    default?: boolean;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    defer?: boolean;
    dir?: string;
    disabled?: boolean;
    download?: any;
    draggable?: Booleanish;
    encType?: string;
    forcedPages?: ForcedPage[];
    form?: string;
    formAction?: string | ((formData) => void);
    formEncType?: string;
    formMethod?: string;
    formNoValidate?: boolean;
    formTarget?: string;
    frameBorder?: string | number;
    headers?: string;
    height?: string | number;
    hidden?: boolean;
    high?: number;
    href?: string;
    hrefLang?: string;
    htmlFor?: string;
    httpEquiv?: string;
    id?: string;
    inlist?: any;
    inputMode?: "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal";
    integrity?: string;
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | Key;
    keyParams?: string;
    keyType?: string;
    kind?: string;
    label?: string;
    lang?: string;
    list?: string;
    loop?: boolean;
    low?: number;
    manifest?: string;
    marginHeight?: number;
    marginWidth?: number;
    max?: string | number;
    maxLength?: number;
    media?: string;
    mediaGroup?: string;
    method?: string;
    min?: string | number;
    minLength?: number;
    multiple?: boolean;
    muted?: boolean;
    name?: string;
    noValidate?: boolean;
    nonce?: string;
    onAbort?: ReactEventHandler<HTMLElement>;
    onAbortCapture?: ReactEventHandler<HTMLElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationStart?: AnimationEventHandler<HTMLElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLElement>;
    onAuxClick?: MouseEventHandler<HTMLElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLElement>;
    onBeforeInput?: FormEventHandler<HTMLElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLElement>;
    onBlur?: FocusEventHandler<HTMLElement>;
    onBlurCapture?: FocusEventHandler<HTMLElement>;
    onCanPlay?: ReactEventHandler<HTMLElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>;
    onChange?: FormEventHandler<HTMLElement>;
    onChangeCapture?: FormEventHandler<HTMLElement>;
    onClick?: MouseEventHandler<HTMLElement>;
    onClickCapture?: MouseEventHandler<HTMLElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionStart?: CompositionEventHandler<HTMLElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>;
    onContextMenu?: MouseEventHandler<HTMLElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLElement>;
    onCopy?: ClipboardEventHandler<HTMLElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLElement>;
    onCut?: ClipboardEventHandler<HTMLElement>;
    onCutCapture?: ClipboardEventHandler<HTMLElement>;
    onDoubleClick?: MouseEventHandler<HTMLElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLElement>;
    onDrag?: DragEventHandler<HTMLElement>;
    onDragCapture?: DragEventHandler<HTMLElement>;
    onDragEnd?: DragEventHandler<HTMLElement>;
    onDragEndCapture?: DragEventHandler<HTMLElement>;
    onDragEnter?: DragEventHandler<HTMLElement>;
    onDragEnterCapture?: DragEventHandler<HTMLElement>;
    onDragExit?: DragEventHandler<HTMLElement>;
    onDragExitCapture?: DragEventHandler<HTMLElement>;
    onDragLeave?: DragEventHandler<HTMLElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLElement>;
    onDragOver?: DragEventHandler<HTMLElement>;
    onDragOverCapture?: DragEventHandler<HTMLElement>;
    onDragStart?: DragEventHandler<HTMLElement>;
    onDragStartCapture?: DragEventHandler<HTMLElement>;
    onDrop?: DragEventHandler<HTMLElement>;
    onDropCapture?: DragEventHandler<HTMLElement>;
    onDurationChange?: ReactEventHandler<HTMLElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLElement>;
    onEmptied?: ReactEventHandler<HTMLElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLElement>;
    onEncrypted?: ReactEventHandler<HTMLElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLElement>;
    onEnded?: ReactEventHandler<HTMLElement>;
    onEndedCapture?: ReactEventHandler<HTMLElement>;
    onError?: ReactEventHandler<HTMLElement>;
    onErrorCapture?: ReactEventHandler<HTMLElement>;
    onFocus?: FocusEventHandler<HTMLElement>;
    onFocusCapture?: FocusEventHandler<HTMLElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onInput?: FormEventHandler<HTMLElement>;
    onInputCapture?: FormEventHandler<HTMLElement>;
    onInvalid?: FormEventHandler<HTMLElement>;
    onInvalidCapture?: FormEventHandler<HTMLElement>;
    onKeyDown?: KeyboardEventHandler<HTMLElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyPress?: KeyboardEventHandler<HTMLElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyUp?: KeyboardEventHandler<HTMLElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLElement>;
    onLoad?: ReactEventHandler<HTMLElement>;
    onLoadCapture?: ReactEventHandler<HTMLElement>;
    onLoadStart?: ReactEventHandler<HTMLElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLElement>;
    onLoadedData?: ReactEventHandler<HTMLElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onMouseDown?: MouseEventHandler<HTMLElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLElement>;
    onMouseEnter?: MouseEventHandler<HTMLElement>;
    onMouseLeave?: MouseEventHandler<HTMLElement>;
    onMouseMove?: MouseEventHandler<HTMLElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLElement>;
    onMouseOut?: MouseEventHandler<HTMLElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLElement>;
    onMouseOver?: MouseEventHandler<HTMLElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLElement>;
    onMouseUp?: MouseEventHandler<HTMLElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLElement>;
    onPaste?: ClipboardEventHandler<HTMLElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLElement>;
    onPause?: ReactEventHandler<HTMLElement>;
    onPauseCapture?: ReactEventHandler<HTMLElement>;
    onPlay?: ReactEventHandler<HTMLElement>;
    onPlayCapture?: ReactEventHandler<HTMLElement>;
    onPlaying?: ReactEventHandler<HTMLElement>;
    onPlayingCapture?: ReactEventHandler<HTMLElement>;
    onPointerCancel?: PointerEventHandler<HTMLElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLElement>;
    onPointerDown?: PointerEventHandler<HTMLElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLElement>;
    onPointerEnter?: PointerEventHandler<HTMLElement>;
    onPointerEnterCapture?: PointerEventHandler<HTMLElement>;
    onPointerLeave?: PointerEventHandler<HTMLElement>;
    onPointerLeaveCapture?: PointerEventHandler<HTMLElement>;
    onPointerMove?: PointerEventHandler<HTMLElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLElement>;
    onPointerOut?: PointerEventHandler<HTMLElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLElement>;
    onPointerOver?: PointerEventHandler<HTMLElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLElement>;
    onPointerUp?: PointerEventHandler<HTMLElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLElement>;
    onProgress?: ReactEventHandler<HTMLElement>;
    onProgressCapture?: ReactEventHandler<HTMLElement>;
    onRateChange?: ReactEventHandler<HTMLElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLElement>;
    onReset?: FormEventHandler<HTMLElement>;
    onResetCapture?: FormEventHandler<HTMLElement>;
    onResize?: ReactEventHandler<HTMLElement>;
    onResizeCapture?: ReactEventHandler<HTMLElement>;
    onScroll?: UIEventHandler<HTMLElement>;
    onScrollCapture?: UIEventHandler<HTMLElement>;
    onSeeked?: ReactEventHandler<HTMLElement>;
    onSeekedCapture?: ReactEventHandler<HTMLElement>;
    onSeeking?: ReactEventHandler<HTMLElement>;
    onSeekingCapture?: ReactEventHandler<HTMLElement>;
    onSelect?: ReactEventHandler<HTMLElement>;
    onSelectCapture?: ReactEventHandler<HTMLElement>;
    onStalled?: ReactEventHandler<HTMLElement>;
    onStalledCapture?: ReactEventHandler<HTMLElement>;
    onSubmit?: FormEventHandler<HTMLElement>;
    onSubmitCapture?: FormEventHandler<HTMLElement>;
    onSuspend?: ReactEventHandler<HTMLElement>;
    onSuspendCapture?: ReactEventHandler<HTMLElement>;
    onTimeUpdate?: ReactEventHandler<HTMLElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLElement>;
    onTouchCancel?: TouchEventHandler<HTMLElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLElement>;
    onTouchEnd?: TouchEventHandler<HTMLElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLElement>;
    onTouchMove?: TouchEventHandler<HTMLElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLElement>;
    onTouchStart?: TouchEventHandler<HTMLElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLElement>;
    onVolumeChange?: ReactEventHandler<HTMLElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLElement>;
    onWaiting?: ReactEventHandler<HTMLElement>;
    onWaitingCapture?: ReactEventHandler<HTMLElement>;
    onWheel?: WheelEventHandler<HTMLElement>;
    onWheelCapture?: WheelEventHandler<HTMLElement>;
    open?: boolean;
    optimum?: number;
    pattern?: string;
    placeholder?: string;
    playsInline?: boolean;
    poster?: string;
    prefix?: string;
    preload?: string;
    property?: string;
    radioGroup?: string;
    readOnly?: boolean;
    ref?: LegacyRef<HTMLElement>;
    rel?: string;
    required?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    reversed?: boolean;
    role?: AriaRole;
    rowSpan?: number;
    rows?: number;
    sandbox?: string;
    scope?: string;
    scoped?: boolean;
    scrolling?: string;
    seamless?: boolean;
    security?: string;
    selected?: boolean;
    shape?: string;
    size?: number;
    sizes?: string;
    slot?: string;
    span?: number;
    spellCheck?: Booleanish;
    src?: string;
    srcDoc?: string;
    srcLang?: string;
    srcSet?: string;
    start?: number;
    step?: string | number;
    style?: CSSProperties;
    summary?: string;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    tag?: keyof IntrinsicElements;
    target?: string;
    title?: string;
    translate?: "yes" | "no";
    type?: string;
    typeof?: string;
    unselectable?: "on" | "off";
    useMap?: string;
    value?: string | number | readonly string[];
    vocab?: string;
    width?: string | number;
    wmode?: string;
    wrap?: string;
}

Hierarchy

Properties

about? +ServerSideWrapperProps | Code Documentation
interface ServerSideWrapperProps {
    about?: string;
    accept?: string;
    acceptCharset?: string;
    accessKey?: string;
    action?: string | ((formData) => void);
    allowFullScreen?: boolean;
    allowTransparency?: boolean;
    alt?: string;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?: "none" | "list" | "inline" | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?: boolean | "true" | "false" | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?: boolean | "true" | "false" | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?: "none" | "ascending" | "descending" | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    as?: string;
    async?: boolean;
    autoCapitalize?: string;
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoPlay?: boolean;
    autoSave?: string;
    capture?: boolean | "user" | "environment";
    cellPadding?: string | number;
    cellSpacing?: string | number;
    challenge?: string;
    charSet?: string;
    checked?: boolean;
    children?: ReactNode;
    cite?: string;
    classID?: string;
    className?: string;
    colSpan?: number;
    color?: string;
    cols?: number;
    content?: string;
    contentEditable?: Booleanish | "inherit" | "plaintext-only";
    contextMenu?: string;
    controls?: boolean;
    coords?: string;
    crossOrigin?: CrossOrigin;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    data?: string;
    datatype?: string;
    dateTime?: string;
    default?: boolean;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    defer?: boolean;
    dir?: string;
    disabled?: boolean;
    download?: any;
    draggable?: Booleanish;
    encType?: string;
    forcedPages?: ForcedPage[];
    form?: string;
    formAction?: string | ((formData) => void);
    formEncType?: string;
    formMethod?: string;
    formNoValidate?: boolean;
    formTarget?: string;
    frameBorder?: string | number;
    headers?: string;
    height?: string | number;
    hidden?: boolean;
    high?: number;
    href?: string;
    hrefLang?: string;
    htmlFor?: string;
    httpEquiv?: string;
    id?: string;
    inlist?: any;
    inputMode?: "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal";
    integrity?: string;
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | Key;
    keyParams?: string;
    keyType?: string;
    kind?: string;
    label?: string;
    lang?: string;
    list?: string;
    loop?: boolean;
    low?: number;
    manifest?: string;
    marginHeight?: number;
    marginWidth?: number;
    max?: string | number;
    maxLength?: number;
    media?: string;
    mediaGroup?: string;
    method?: string;
    min?: string | number;
    minLength?: number;
    multiple?: boolean;
    muted?: boolean;
    name?: string;
    noValidate?: boolean;
    nonce?: string;
    onAbort?: ReactEventHandler<HTMLElement>;
    onAbortCapture?: ReactEventHandler<HTMLElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationStart?: AnimationEventHandler<HTMLElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLElement>;
    onAuxClick?: MouseEventHandler<HTMLElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLElement>;
    onBeforeInput?: FormEventHandler<HTMLElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLElement>;
    onBlur?: FocusEventHandler<HTMLElement>;
    onBlurCapture?: FocusEventHandler<HTMLElement>;
    onCanPlay?: ReactEventHandler<HTMLElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>;
    onChange?: FormEventHandler<HTMLElement>;
    onChangeCapture?: FormEventHandler<HTMLElement>;
    onClick?: MouseEventHandler<HTMLElement>;
    onClickCapture?: MouseEventHandler<HTMLElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionStart?: CompositionEventHandler<HTMLElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>;
    onContextMenu?: MouseEventHandler<HTMLElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLElement>;
    onCopy?: ClipboardEventHandler<HTMLElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLElement>;
    onCut?: ClipboardEventHandler<HTMLElement>;
    onCutCapture?: ClipboardEventHandler<HTMLElement>;
    onDoubleClick?: MouseEventHandler<HTMLElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLElement>;
    onDrag?: DragEventHandler<HTMLElement>;
    onDragCapture?: DragEventHandler<HTMLElement>;
    onDragEnd?: DragEventHandler<HTMLElement>;
    onDragEndCapture?: DragEventHandler<HTMLElement>;
    onDragEnter?: DragEventHandler<HTMLElement>;
    onDragEnterCapture?: DragEventHandler<HTMLElement>;
    onDragExit?: DragEventHandler<HTMLElement>;
    onDragExitCapture?: DragEventHandler<HTMLElement>;
    onDragLeave?: DragEventHandler<HTMLElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLElement>;
    onDragOver?: DragEventHandler<HTMLElement>;
    onDragOverCapture?: DragEventHandler<HTMLElement>;
    onDragStart?: DragEventHandler<HTMLElement>;
    onDragStartCapture?: DragEventHandler<HTMLElement>;
    onDrop?: DragEventHandler<HTMLElement>;
    onDropCapture?: DragEventHandler<HTMLElement>;
    onDurationChange?: ReactEventHandler<HTMLElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLElement>;
    onEmptied?: ReactEventHandler<HTMLElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLElement>;
    onEncrypted?: ReactEventHandler<HTMLElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLElement>;
    onEnded?: ReactEventHandler<HTMLElement>;
    onEndedCapture?: ReactEventHandler<HTMLElement>;
    onError?: ReactEventHandler<HTMLElement>;
    onErrorCapture?: ReactEventHandler<HTMLElement>;
    onFocus?: FocusEventHandler<HTMLElement>;
    onFocusCapture?: FocusEventHandler<HTMLElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onInput?: FormEventHandler<HTMLElement>;
    onInputCapture?: FormEventHandler<HTMLElement>;
    onInvalid?: FormEventHandler<HTMLElement>;
    onInvalidCapture?: FormEventHandler<HTMLElement>;
    onKeyDown?: KeyboardEventHandler<HTMLElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyPress?: KeyboardEventHandler<HTMLElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyUp?: KeyboardEventHandler<HTMLElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLElement>;
    onLoad?: ReactEventHandler<HTMLElement>;
    onLoadCapture?: ReactEventHandler<HTMLElement>;
    onLoadStart?: ReactEventHandler<HTMLElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLElement>;
    onLoadedData?: ReactEventHandler<HTMLElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onMouseDown?: MouseEventHandler<HTMLElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLElement>;
    onMouseEnter?: MouseEventHandler<HTMLElement>;
    onMouseLeave?: MouseEventHandler<HTMLElement>;
    onMouseMove?: MouseEventHandler<HTMLElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLElement>;
    onMouseOut?: MouseEventHandler<HTMLElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLElement>;
    onMouseOver?: MouseEventHandler<HTMLElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLElement>;
    onMouseUp?: MouseEventHandler<HTMLElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLElement>;
    onPaste?: ClipboardEventHandler<HTMLElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLElement>;
    onPause?: ReactEventHandler<HTMLElement>;
    onPauseCapture?: ReactEventHandler<HTMLElement>;
    onPlay?: ReactEventHandler<HTMLElement>;
    onPlayCapture?: ReactEventHandler<HTMLElement>;
    onPlaying?: ReactEventHandler<HTMLElement>;
    onPlayingCapture?: ReactEventHandler<HTMLElement>;
    onPointerCancel?: PointerEventHandler<HTMLElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLElement>;
    onPointerDown?: PointerEventHandler<HTMLElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLElement>;
    onPointerEnter?: PointerEventHandler<HTMLElement>;
    onPointerEnterCapture?: PointerEventHandler<HTMLElement>;
    onPointerLeave?: PointerEventHandler<HTMLElement>;
    onPointerLeaveCapture?: PointerEventHandler<HTMLElement>;
    onPointerMove?: PointerEventHandler<HTMLElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLElement>;
    onPointerOut?: PointerEventHandler<HTMLElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLElement>;
    onPointerOver?: PointerEventHandler<HTMLElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLElement>;
    onPointerUp?: PointerEventHandler<HTMLElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLElement>;
    onProgress?: ReactEventHandler<HTMLElement>;
    onProgressCapture?: ReactEventHandler<HTMLElement>;
    onRateChange?: ReactEventHandler<HTMLElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLElement>;
    onReset?: FormEventHandler<HTMLElement>;
    onResetCapture?: FormEventHandler<HTMLElement>;
    onResize?: ReactEventHandler<HTMLElement>;
    onResizeCapture?: ReactEventHandler<HTMLElement>;
    onScroll?: UIEventHandler<HTMLElement>;
    onScrollCapture?: UIEventHandler<HTMLElement>;
    onSeeked?: ReactEventHandler<HTMLElement>;
    onSeekedCapture?: ReactEventHandler<HTMLElement>;
    onSeeking?: ReactEventHandler<HTMLElement>;
    onSeekingCapture?: ReactEventHandler<HTMLElement>;
    onSelect?: ReactEventHandler<HTMLElement>;
    onSelectCapture?: ReactEventHandler<HTMLElement>;
    onStalled?: ReactEventHandler<HTMLElement>;
    onStalledCapture?: ReactEventHandler<HTMLElement>;
    onSubmit?: FormEventHandler<HTMLElement>;
    onSubmitCapture?: FormEventHandler<HTMLElement>;
    onSuspend?: ReactEventHandler<HTMLElement>;
    onSuspendCapture?: ReactEventHandler<HTMLElement>;
    onTimeUpdate?: ReactEventHandler<HTMLElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLElement>;
    onTouchCancel?: TouchEventHandler<HTMLElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLElement>;
    onTouchEnd?: TouchEventHandler<HTMLElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLElement>;
    onTouchMove?: TouchEventHandler<HTMLElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLElement>;
    onTouchStart?: TouchEventHandler<HTMLElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLElement>;
    onVolumeChange?: ReactEventHandler<HTMLElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLElement>;
    onWaiting?: ReactEventHandler<HTMLElement>;
    onWaitingCapture?: ReactEventHandler<HTMLElement>;
    onWheel?: WheelEventHandler<HTMLElement>;
    onWheelCapture?: WheelEventHandler<HTMLElement>;
    open?: boolean;
    optimum?: number;
    pattern?: string;
    placeholder?: string;
    playsInline?: boolean;
    poster?: string;
    prefix?: string;
    preload?: string;
    property?: string;
    radioGroup?: string;
    readOnly?: boolean;
    ref?: LegacyRef<HTMLElement>;
    rel?: string;
    required?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    reversed?: boolean;
    role?: AriaRole;
    rowSpan?: number;
    rows?: number;
    sandbox?: string;
    scope?: string;
    scoped?: boolean;
    scrolling?: string;
    seamless?: boolean;
    security?: string;
    selected?: boolean;
    shape?: string;
    size?: number;
    sizes?: string;
    slot?: string;
    span?: number;
    spellCheck?: Booleanish;
    src?: string;
    srcDoc?: string;
    srcLang?: string;
    srcSet?: string;
    start?: number;
    step?: string | number;
    style?: CSSProperties;
    summary?: string;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    tag?: keyof IntrinsicElements;
    target?: string;
    title?: string;
    translate?: "yes" | "no";
    type?: string;
    typeof?: string;
    unselectable?: "on" | "off";
    useMap?: string;
    value?: string | number | readonly string[];
    vocab?: string;
    width?: string | number;
    wmode?: string;
    wrap?: string;
}

Hierarchy

Properties

Properties

about?: string

RDFa Attributes

-
accept?: string

Standard HTML Attributes

-
acceptCharset?: string
accessKey?: string

Standard HTML Attributes

-
action?: string | ((formData) => void)

Type declaration

    • (formData): void
    • Parameters

      • formData: FormData

      Returns void

allowFullScreen?: boolean
allowTransparency?: boolean
alt?: string
aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

-
aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

-
aria-autocomplete?: "list" | "none" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +

accept?: string

Standard HTML Attributes

+
acceptCharset?: string
accessKey?: string

Standard HTML Attributes

+
action?: string | ((formData) => void)

Type declaration

    • (formData): void
    • Parameters

      • formData: FormData

      Returns void

allowFullScreen?: boolean
allowTransparency?: boolean
alt?: string
aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

+
aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

+
aria-autocomplete?: "none" | "list" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

-
aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

+
aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

See

aria-label.

-
aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

+
aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

See

aria-roledescription.

-
aria-busy?: Booleanish
aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

+
aria-busy?: Booleanish
aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

  • aria-pressed
  • aria-selected.
-
aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

+
aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

-
aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

+
aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

  • aria-colcount
  • aria-colspan.
-
aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

+
aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

-
aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

+
aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-colindex
  • aria-rowspan.
-
aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

+
aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

-
aria-current?: boolean | "time" | "page" | "step" | "true" | "false" | "date" | "location"

Indicates the element that represents the current item within a container or set of related elements.

-
aria-describedby?: string

Identifies the element (or elements) that describes the object.

+
aria-current?: boolean | "page" | "time" | "step" | "true" | "false" | "date" | "location"

Indicates the element that represents the current item within a container or set of related elements.

+
aria-describedby?: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

-
aria-description?: string

Defines a string value that describes or annotates the current element.

+
aria-description?: string

Defines a string value that describes or annotates the current element.

See

related aria-describedby.

-
aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

+
aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

-
aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

+
aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

  • aria-hidden
  • aria-readonly.
-
aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

+
aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

-
aria-errormessage?: string

Identifies the element that provides an error message for the object.

+
aria-errormessage?: string

Identifies the element that provides an error message for the object.

See

  • aria-invalid
  • aria-describedby.
-
aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

-
aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

+
aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

-
aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

+
aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

-
aria-haspopup?: boolean | "dialog" | "menu" | "grid" | "listbox" | "tree" | "true" | "false"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

-
aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

+
aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

+
aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

-
aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

+
aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

-
aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

-
aria-label?: string

Defines a string value that labels the current element.

+
aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

+
aria-label?: string

Defines a string value that labels the current element.

See

aria-labelledby.

-
aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

+
aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

-
aria-level?: number

Defines the hierarchical level of an element within a structure.

-
aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

-
aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

-
aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

-
aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

-
aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

-
aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +

aria-level?: number

Defines the hierarchical level of an element within a structure.

+
aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

+
aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

+
aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

+
aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

+
aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

+
aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

See

aria-controls.

-
aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

-
aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

+
aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-setsize.

-
aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

+
aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

See

  • aria-checked
  • aria-selected.
-
aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

+
aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

-
aria-relevant?: "text" | "all" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

+
aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

-
aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

-
aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

-
aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

+
aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

+
aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

+
aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

-
aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

+
aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

  • aria-rowcount
  • aria-rowspan.
-
aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

+
aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

See

aria-colindextext.

-
aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

+
aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-rowindex
  • aria-colspan.
-
aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

+
aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

See

  • aria-checked
  • aria-pressed.
-
aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

+
aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-posinset.

-
aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

-
aria-valuemax?: number

Defines the maximum allowed value for a range widget.

-
aria-valuemin?: number

Defines the minimum allowed value for a range widget.

-
aria-valuenow?: number

Defines the current value for a range widget.

+
aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

+
aria-valuemax?: number

Defines the maximum allowed value for a range widget.

+
aria-valuemin?: number

Defines the minimum allowed value for a range widget.

+
aria-valuenow?: number

Defines the current value for a range widget.

See

aria-valuetext.

-
aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

-
as?: string
async?: boolean
autoCapitalize?: string

Non-standard Attributes

-
autoComplete?: string
autoCorrect?: string
autoFocus?: boolean
autoPlay?: boolean
autoSave?: string
capture?: boolean | "user" | "environment"
cellPadding?: string | number
cellSpacing?: string | number
challenge?: string
charSet?: string
checked?: boolean
children?: ReactNode
cite?: string
classID?: string
className?: string
colSpan?: number
color?: string
cols?: number
content?: string
contentEditable?: Booleanish | "inherit" | "plaintext-only"
contextMenu?: string
controls?: boolean
coords?: string
crossOrigin?: CrossOrigin
dangerouslySetInnerHTML?: {
    __html: string | TrustedHTML;
}

Type declaration

  • __html: string | TrustedHTML

    Should be InnerHTML['innerHTML']. +

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

+
as?: string
async?: boolean
autoCapitalize?: string

Non-standard Attributes

+
autoComplete?: string
autoCorrect?: string
autoFocus?: boolean
autoPlay?: boolean
autoSave?: string
capture?: boolean | "user" | "environment"
cellPadding?: string | number
cellSpacing?: string | number
challenge?: string
charSet?: string
checked?: boolean
children?: ReactNode
cite?: string
classID?: string
className?: string
colSpan?: number
color?: string
cols?: number
content?: string
contentEditable?: Booleanish | "inherit" | "plaintext-only"
contextMenu?: string
controls?: boolean
coords?: string
crossOrigin?: CrossOrigin
dangerouslySetInnerHTML?: {
    __html: string | TrustedHTML;
}

Type declaration

  • __html: string | TrustedHTML

    Should be InnerHTML['innerHTML']. But unfortunately we're mixing renderer-specific type declarations.

    -
data?: string
datatype?: string
dateTime?: string
default?: boolean
defaultChecked?: boolean

React-specific Attributes

-
defaultValue?: string | number | readonly string[]
defer?: boolean
dir?: string
disabled?: boolean
download?: any
draggable?: Booleanish
encType?: string
forcedPages?: ForcedPage[]
form?: string
formAction?: string | ((formData) => void)

Type declaration

    • (formData): void
    • Parameters

      • formData: FormData

      Returns void

formEncType?: string
formMethod?: string
formNoValidate?: boolean
formTarget?: string
frameBorder?: string | number
headers?: string
height?: string | number
hidden?: boolean
high?: number
href?: string
hrefLang?: string
htmlFor?: string
httpEquiv?: string
id?: string
inlist?: any
inputMode?: "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

+
data?: string
datatype?: string
dateTime?: string
default?: boolean
defaultChecked?: boolean

React-specific Attributes

+
defaultValue?: string | number | readonly string[]
defer?: boolean
dir?: string
disabled?: boolean
download?: any
draggable?: Booleanish
encType?: string
forcedPages?: ForcedPage[]
form?: string
formAction?: string | ((formData) => void)

Type declaration

    • (formData): void
    • Parameters

      • formData: FormData

      Returns void

formEncType?: string
formMethod?: string
formNoValidate?: boolean
formTarget?: string
frameBorder?: string | number
headers?: string
height?: string | number
hidden?: boolean
high?: number
href?: string
hrefLang?: string
htmlFor?: string
httpEquiv?: string
id?: string
inlist?: any
inputMode?: "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

integrity?: string
is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

+
integrity?: string
is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
key?: null | Key
keyParams?: string
keyType?: string
kind?: string
label?: string
lang?: string
list?: string
loop?: boolean
low?: number
manifest?: string
marginHeight?: number
marginWidth?: number
max?: string | number
maxLength?: number
media?: string
mediaGroup?: string
method?: string
min?: string | number
minLength?: number
multiple?: boolean
muted?: boolean
name?: string
noValidate?: boolean
nonce?: string
onAbort?: ReactEventHandler<HTMLElement>

Media Events

-
onAbortCapture?: ReactEventHandler<HTMLElement>
onAnimationEnd?: AnimationEventHandler<HTMLElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLElement>
onAnimationIteration?: AnimationEventHandler<HTMLElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>
onAnimationStart?: AnimationEventHandler<HTMLElement>

Animation Events

-
onAnimationStartCapture?: AnimationEventHandler<HTMLElement>
onAuxClick?: MouseEventHandler<HTMLElement>

MouseEvents

-
onAuxClickCapture?: MouseEventHandler<HTMLElement>
onBeforeInput?: FormEventHandler<HTMLElement>
onBeforeInputCapture?: FormEventHandler<HTMLElement>
onBlur?: FocusEventHandler<HTMLElement>
onBlurCapture?: FocusEventHandler<HTMLElement>
onCanPlay?: ReactEventHandler<HTMLElement>
onCanPlayCapture?: ReactEventHandler<HTMLElement>
onCanPlayThrough?: ReactEventHandler<HTMLElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>
onChange?: FormEventHandler<HTMLElement>

Form Events

-
onChangeCapture?: FormEventHandler<HTMLElement>
onClick?: MouseEventHandler<HTMLElement>
onClickCapture?: MouseEventHandler<HTMLElement>
onCompositionEnd?: CompositionEventHandler<HTMLElement>

Composition Events

-
onCompositionEndCapture?: CompositionEventHandler<HTMLElement>
onCompositionStart?: CompositionEventHandler<HTMLElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLElement>
onCompositionUpdate?: CompositionEventHandler<HTMLElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>
onContextMenu?: MouseEventHandler<HTMLElement>
onContextMenuCapture?: MouseEventHandler<HTMLElement>
onCopy?: ClipboardEventHandler<HTMLElement>

Clipboard Events

-
onCopyCapture?: ClipboardEventHandler<HTMLElement>
onCut?: ClipboardEventHandler<HTMLElement>
onCutCapture?: ClipboardEventHandler<HTMLElement>
onDoubleClick?: MouseEventHandler<HTMLElement>
onDoubleClickCapture?: MouseEventHandler<HTMLElement>
onDrag?: DragEventHandler<HTMLElement>
onDragCapture?: DragEventHandler<HTMLElement>
onDragEnd?: DragEventHandler<HTMLElement>
onDragEndCapture?: DragEventHandler<HTMLElement>
onDragEnter?: DragEventHandler<HTMLElement>
onDragEnterCapture?: DragEventHandler<HTMLElement>
onDragExit?: DragEventHandler<HTMLElement>
onDragExitCapture?: DragEventHandler<HTMLElement>
onDragLeave?: DragEventHandler<HTMLElement>
onDragLeaveCapture?: DragEventHandler<HTMLElement>
onDragOver?: DragEventHandler<HTMLElement>
onDragOverCapture?: DragEventHandler<HTMLElement>
onDragStart?: DragEventHandler<HTMLElement>
onDragStartCapture?: DragEventHandler<HTMLElement>
onDrop?: DragEventHandler<HTMLElement>
onDropCapture?: DragEventHandler<HTMLElement>
onDurationChange?: ReactEventHandler<HTMLElement>
onDurationChangeCapture?: ReactEventHandler<HTMLElement>
onEmptied?: ReactEventHandler<HTMLElement>
onEmptiedCapture?: ReactEventHandler<HTMLElement>
onEncrypted?: ReactEventHandler<HTMLElement>
onEncryptedCapture?: ReactEventHandler<HTMLElement>
onEnded?: ReactEventHandler<HTMLElement>
onEndedCapture?: ReactEventHandler<HTMLElement>
onError?: ReactEventHandler<HTMLElement>
onErrorCapture?: ReactEventHandler<HTMLElement>
onFocus?: FocusEventHandler<HTMLElement>

Focus Events

-
onFocusCapture?: FocusEventHandler<HTMLElement>
onGotPointerCapture?: PointerEventHandler<HTMLElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>
onInput?: FormEventHandler<HTMLElement>
onInputCapture?: FormEventHandler<HTMLElement>
onInvalid?: FormEventHandler<HTMLElement>
onInvalidCapture?: FormEventHandler<HTMLElement>
onKeyDown?: KeyboardEventHandler<HTMLElement>

Keyboard Events

-
onKeyDownCapture?: KeyboardEventHandler<HTMLElement>
onKeyPress?: KeyboardEventHandler<HTMLElement>

Deprecated

onKeyPressCapture?: KeyboardEventHandler<HTMLElement>

Deprecated

onKeyUp?: KeyboardEventHandler<HTMLElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLElement>
onLoad?: ReactEventHandler<HTMLElement>

Image Events

-
onLoadCapture?: ReactEventHandler<HTMLElement>
onLoadStart?: ReactEventHandler<HTMLElement>
onLoadStartCapture?: ReactEventHandler<HTMLElement>
onLoadedData?: ReactEventHandler<HTMLElement>
onLoadedDataCapture?: ReactEventHandler<HTMLElement>
onLoadedMetadata?: ReactEventHandler<HTMLElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>
onLostPointerCapture?: PointerEventHandler<HTMLElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>
onMouseDown?: MouseEventHandler<HTMLElement>
onMouseDownCapture?: MouseEventHandler<HTMLElement>
onMouseEnter?: MouseEventHandler<HTMLElement>
onMouseLeave?: MouseEventHandler<HTMLElement>
onMouseMove?: MouseEventHandler<HTMLElement>
onMouseMoveCapture?: MouseEventHandler<HTMLElement>
onMouseOut?: MouseEventHandler<HTMLElement>
onMouseOutCapture?: MouseEventHandler<HTMLElement>
onMouseOver?: MouseEventHandler<HTMLElement>
onMouseOverCapture?: MouseEventHandler<HTMLElement>
onMouseUp?: MouseEventHandler<HTMLElement>
onMouseUpCapture?: MouseEventHandler<HTMLElement>
onPaste?: ClipboardEventHandler<HTMLElement>
onPasteCapture?: ClipboardEventHandler<HTMLElement>
onPause?: ReactEventHandler<HTMLElement>
onPauseCapture?: ReactEventHandler<HTMLElement>
onPlay?: ReactEventHandler<HTMLElement>
onPlayCapture?: ReactEventHandler<HTMLElement>
onPlaying?: ReactEventHandler<HTMLElement>
onPlayingCapture?: ReactEventHandler<HTMLElement>
onPointerCancel?: PointerEventHandler<HTMLElement>
onPointerCancelCapture?: PointerEventHandler<HTMLElement>
onPointerDown?: PointerEventHandler<HTMLElement>

Pointer Events

-
onPointerDownCapture?: PointerEventHandler<HTMLElement>
onPointerEnter?: PointerEventHandler<HTMLElement>
onPointerEnterCapture?: PointerEventHandler<HTMLElement>
onPointerLeave?: PointerEventHandler<HTMLElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLElement>
onPointerMove?: PointerEventHandler<HTMLElement>
onPointerMoveCapture?: PointerEventHandler<HTMLElement>
onPointerOut?: PointerEventHandler<HTMLElement>
onPointerOutCapture?: PointerEventHandler<HTMLElement>
onPointerOver?: PointerEventHandler<HTMLElement>
onPointerOverCapture?: PointerEventHandler<HTMLElement>
onPointerUp?: PointerEventHandler<HTMLElement>
onPointerUpCapture?: PointerEventHandler<HTMLElement>
onProgress?: ReactEventHandler<HTMLElement>
onProgressCapture?: ReactEventHandler<HTMLElement>
onRateChange?: ReactEventHandler<HTMLElement>
onRateChangeCapture?: ReactEventHandler<HTMLElement>
onReset?: FormEventHandler<HTMLElement>
onResetCapture?: FormEventHandler<HTMLElement>
onResize?: ReactEventHandler<HTMLElement>
onResizeCapture?: ReactEventHandler<HTMLElement>
onScroll?: UIEventHandler<HTMLElement>

UI Events

-
onScrollCapture?: UIEventHandler<HTMLElement>
onSeeked?: ReactEventHandler<HTMLElement>
onSeekedCapture?: ReactEventHandler<HTMLElement>
onSeeking?: ReactEventHandler<HTMLElement>
onSeekingCapture?: ReactEventHandler<HTMLElement>
onSelect?: ReactEventHandler<HTMLElement>

Selection Events

-
onSelectCapture?: ReactEventHandler<HTMLElement>
onStalled?: ReactEventHandler<HTMLElement>
onStalledCapture?: ReactEventHandler<HTMLElement>
onSubmit?: FormEventHandler<HTMLElement>
onSubmitCapture?: FormEventHandler<HTMLElement>
onSuspend?: ReactEventHandler<HTMLElement>
onSuspendCapture?: ReactEventHandler<HTMLElement>
onTimeUpdate?: ReactEventHandler<HTMLElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLElement>
onTouchCancel?: TouchEventHandler<HTMLElement>

Touch Events

-
onTouchCancelCapture?: TouchEventHandler<HTMLElement>
onTouchEnd?: TouchEventHandler<HTMLElement>
onTouchEndCapture?: TouchEventHandler<HTMLElement>
onTouchMove?: TouchEventHandler<HTMLElement>
onTouchMoveCapture?: TouchEventHandler<HTMLElement>
onTouchStart?: TouchEventHandler<HTMLElement>
onTouchStartCapture?: TouchEventHandler<HTMLElement>
onTransitionEnd?: TransitionEventHandler<HTMLElement>

Transition Events

-
onTransitionEndCapture?: TransitionEventHandler<HTMLElement>
onVolumeChange?: ReactEventHandler<HTMLElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLElement>
onWaiting?: ReactEventHandler<HTMLElement>
onWaitingCapture?: ReactEventHandler<HTMLElement>
onWheel?: WheelEventHandler<HTMLElement>

Wheel Events

-
onWheelCapture?: WheelEventHandler<HTMLElement>
open?: boolean
optimum?: number
pattern?: string
placeholder?: string
playsInline?: boolean
poster?: string
prefix?: string
preload?: string
property?: string
radioGroup?: string

Unknown

-
readOnly?: boolean
ref?: LegacyRef<HTMLElement>

Allows getting a ref to the component instance. +

itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
key?: null | Key
keyParams?: string
keyType?: string
kind?: string
label?: string
lang?: string
list?: string
loop?: boolean
low?: number
manifest?: string
marginHeight?: number
marginWidth?: number
max?: string | number
maxLength?: number
media?: string
mediaGroup?: string
method?: string
min?: string | number
minLength?: number
multiple?: boolean
muted?: boolean
name?: string
noValidate?: boolean
nonce?: string
onAbort?: ReactEventHandler<HTMLElement>

Media Events

+
onAbortCapture?: ReactEventHandler<HTMLElement>
onAnimationEnd?: AnimationEventHandler<HTMLElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLElement>
onAnimationIteration?: AnimationEventHandler<HTMLElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>
onAnimationStart?: AnimationEventHandler<HTMLElement>

Animation Events

+
onAnimationStartCapture?: AnimationEventHandler<HTMLElement>
onAuxClick?: MouseEventHandler<HTMLElement>

MouseEvents

+
onAuxClickCapture?: MouseEventHandler<HTMLElement>
onBeforeInput?: FormEventHandler<HTMLElement>
onBeforeInputCapture?: FormEventHandler<HTMLElement>
onBlur?: FocusEventHandler<HTMLElement>
onBlurCapture?: FocusEventHandler<HTMLElement>
onCanPlay?: ReactEventHandler<HTMLElement>
onCanPlayCapture?: ReactEventHandler<HTMLElement>
onCanPlayThrough?: ReactEventHandler<HTMLElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>
onChange?: FormEventHandler<HTMLElement>

Form Events

+
onChangeCapture?: FormEventHandler<HTMLElement>
onClick?: MouseEventHandler<HTMLElement>
onClickCapture?: MouseEventHandler<HTMLElement>
onCompositionEnd?: CompositionEventHandler<HTMLElement>

Composition Events

+
onCompositionEndCapture?: CompositionEventHandler<HTMLElement>
onCompositionStart?: CompositionEventHandler<HTMLElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLElement>
onCompositionUpdate?: CompositionEventHandler<HTMLElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>
onContextMenu?: MouseEventHandler<HTMLElement>
onContextMenuCapture?: MouseEventHandler<HTMLElement>
onCopy?: ClipboardEventHandler<HTMLElement>

Clipboard Events

+
onCopyCapture?: ClipboardEventHandler<HTMLElement>
onCut?: ClipboardEventHandler<HTMLElement>
onCutCapture?: ClipboardEventHandler<HTMLElement>
onDoubleClick?: MouseEventHandler<HTMLElement>
onDoubleClickCapture?: MouseEventHandler<HTMLElement>
onDrag?: DragEventHandler<HTMLElement>
onDragCapture?: DragEventHandler<HTMLElement>
onDragEnd?: DragEventHandler<HTMLElement>
onDragEndCapture?: DragEventHandler<HTMLElement>
onDragEnter?: DragEventHandler<HTMLElement>
onDragEnterCapture?: DragEventHandler<HTMLElement>
onDragExit?: DragEventHandler<HTMLElement>
onDragExitCapture?: DragEventHandler<HTMLElement>
onDragLeave?: DragEventHandler<HTMLElement>
onDragLeaveCapture?: DragEventHandler<HTMLElement>
onDragOver?: DragEventHandler<HTMLElement>
onDragOverCapture?: DragEventHandler<HTMLElement>
onDragStart?: DragEventHandler<HTMLElement>
onDragStartCapture?: DragEventHandler<HTMLElement>
onDrop?: DragEventHandler<HTMLElement>
onDropCapture?: DragEventHandler<HTMLElement>
onDurationChange?: ReactEventHandler<HTMLElement>
onDurationChangeCapture?: ReactEventHandler<HTMLElement>
onEmptied?: ReactEventHandler<HTMLElement>
onEmptiedCapture?: ReactEventHandler<HTMLElement>
onEncrypted?: ReactEventHandler<HTMLElement>
onEncryptedCapture?: ReactEventHandler<HTMLElement>
onEnded?: ReactEventHandler<HTMLElement>
onEndedCapture?: ReactEventHandler<HTMLElement>
onError?: ReactEventHandler<HTMLElement>
onErrorCapture?: ReactEventHandler<HTMLElement>
onFocus?: FocusEventHandler<HTMLElement>

Focus Events

+
onFocusCapture?: FocusEventHandler<HTMLElement>
onGotPointerCapture?: PointerEventHandler<HTMLElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>
onInput?: FormEventHandler<HTMLElement>
onInputCapture?: FormEventHandler<HTMLElement>
onInvalid?: FormEventHandler<HTMLElement>
onInvalidCapture?: FormEventHandler<HTMLElement>
onKeyDown?: KeyboardEventHandler<HTMLElement>

Keyboard Events

+
onKeyDownCapture?: KeyboardEventHandler<HTMLElement>
onKeyPress?: KeyboardEventHandler<HTMLElement>

Deprecated

onKeyPressCapture?: KeyboardEventHandler<HTMLElement>

Deprecated

onKeyUp?: KeyboardEventHandler<HTMLElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLElement>
onLoad?: ReactEventHandler<HTMLElement>

Image Events

+
onLoadCapture?: ReactEventHandler<HTMLElement>
onLoadStart?: ReactEventHandler<HTMLElement>
onLoadStartCapture?: ReactEventHandler<HTMLElement>
onLoadedData?: ReactEventHandler<HTMLElement>
onLoadedDataCapture?: ReactEventHandler<HTMLElement>
onLoadedMetadata?: ReactEventHandler<HTMLElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>
onLostPointerCapture?: PointerEventHandler<HTMLElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>
onMouseDown?: MouseEventHandler<HTMLElement>
onMouseDownCapture?: MouseEventHandler<HTMLElement>
onMouseEnter?: MouseEventHandler<HTMLElement>
onMouseLeave?: MouseEventHandler<HTMLElement>
onMouseMove?: MouseEventHandler<HTMLElement>
onMouseMoveCapture?: MouseEventHandler<HTMLElement>
onMouseOut?: MouseEventHandler<HTMLElement>
onMouseOutCapture?: MouseEventHandler<HTMLElement>
onMouseOver?: MouseEventHandler<HTMLElement>
onMouseOverCapture?: MouseEventHandler<HTMLElement>
onMouseUp?: MouseEventHandler<HTMLElement>
onMouseUpCapture?: MouseEventHandler<HTMLElement>
onPaste?: ClipboardEventHandler<HTMLElement>
onPasteCapture?: ClipboardEventHandler<HTMLElement>
onPause?: ReactEventHandler<HTMLElement>
onPauseCapture?: ReactEventHandler<HTMLElement>
onPlay?: ReactEventHandler<HTMLElement>
onPlayCapture?: ReactEventHandler<HTMLElement>
onPlaying?: ReactEventHandler<HTMLElement>
onPlayingCapture?: ReactEventHandler<HTMLElement>
onPointerCancel?: PointerEventHandler<HTMLElement>
onPointerCancelCapture?: PointerEventHandler<HTMLElement>
onPointerDown?: PointerEventHandler<HTMLElement>

Pointer Events

+
onPointerDownCapture?: PointerEventHandler<HTMLElement>
onPointerEnter?: PointerEventHandler<HTMLElement>
onPointerEnterCapture?: PointerEventHandler<HTMLElement>
onPointerLeave?: PointerEventHandler<HTMLElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLElement>
onPointerMove?: PointerEventHandler<HTMLElement>
onPointerMoveCapture?: PointerEventHandler<HTMLElement>
onPointerOut?: PointerEventHandler<HTMLElement>
onPointerOutCapture?: PointerEventHandler<HTMLElement>
onPointerOver?: PointerEventHandler<HTMLElement>
onPointerOverCapture?: PointerEventHandler<HTMLElement>
onPointerUp?: PointerEventHandler<HTMLElement>
onPointerUpCapture?: PointerEventHandler<HTMLElement>
onProgress?: ReactEventHandler<HTMLElement>
onProgressCapture?: ReactEventHandler<HTMLElement>
onRateChange?: ReactEventHandler<HTMLElement>
onRateChangeCapture?: ReactEventHandler<HTMLElement>
onReset?: FormEventHandler<HTMLElement>
onResetCapture?: FormEventHandler<HTMLElement>
onResize?: ReactEventHandler<HTMLElement>
onResizeCapture?: ReactEventHandler<HTMLElement>
onScroll?: UIEventHandler<HTMLElement>

UI Events

+
onScrollCapture?: UIEventHandler<HTMLElement>
onSeeked?: ReactEventHandler<HTMLElement>
onSeekedCapture?: ReactEventHandler<HTMLElement>
onSeeking?: ReactEventHandler<HTMLElement>
onSeekingCapture?: ReactEventHandler<HTMLElement>
onSelect?: ReactEventHandler<HTMLElement>

Selection Events

+
onSelectCapture?: ReactEventHandler<HTMLElement>
onStalled?: ReactEventHandler<HTMLElement>
onStalledCapture?: ReactEventHandler<HTMLElement>
onSubmit?: FormEventHandler<HTMLElement>
onSubmitCapture?: FormEventHandler<HTMLElement>
onSuspend?: ReactEventHandler<HTMLElement>
onSuspendCapture?: ReactEventHandler<HTMLElement>
onTimeUpdate?: ReactEventHandler<HTMLElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLElement>
onTouchCancel?: TouchEventHandler<HTMLElement>

Touch Events

+
onTouchCancelCapture?: TouchEventHandler<HTMLElement>
onTouchEnd?: TouchEventHandler<HTMLElement>
onTouchEndCapture?: TouchEventHandler<HTMLElement>
onTouchMove?: TouchEventHandler<HTMLElement>
onTouchMoveCapture?: TouchEventHandler<HTMLElement>
onTouchStart?: TouchEventHandler<HTMLElement>
onTouchStartCapture?: TouchEventHandler<HTMLElement>
onTransitionEnd?: TransitionEventHandler<HTMLElement>

Transition Events

+
onTransitionEndCapture?: TransitionEventHandler<HTMLElement>
onVolumeChange?: ReactEventHandler<HTMLElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLElement>
onWaiting?: ReactEventHandler<HTMLElement>
onWaitingCapture?: ReactEventHandler<HTMLElement>
onWheel?: WheelEventHandler<HTMLElement>

Wheel Events

+
onWheelCapture?: WheelEventHandler<HTMLElement>
open?: boolean
optimum?: number
pattern?: string
placeholder?: string
playsInline?: boolean
poster?: string
prefix?: string
preload?: string
property?: string
radioGroup?: string

Unknown

+
readOnly?: boolean
ref?: LegacyRef<HTMLElement>

Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).

rel?: string
required?: boolean
resource?: string
results?: number
rev?: string
reversed?: boolean
role?: AriaRole

WAI-ARIA

-
rowSpan?: number
rows?: number
sandbox?: string
scope?: string
scoped?: boolean
scrolling?: string
seamless?: boolean
security?: string
selected?: boolean
shape?: string
size?: number
sizes?: string
slot?: string
span?: number
spellCheck?: Booleanish
src?: string
srcDoc?: string
srcLang?: string
srcSet?: string
start?: number
step?: string | number
style?: CSSProperties
summary?: string
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
tag?: keyof IntrinsicElements

Default Value

'html'
+
rel?: string
required?: boolean
resource?: string
results?: number
rev?: string
reversed?: boolean
role?: AriaRole

WAI-ARIA

+
rowSpan?: number
rows?: number
sandbox?: string
scope?: string
scoped?: boolean
scrolling?: string
seamless?: boolean
security?: string
selected?: boolean
shape?: string
size?: number
sizes?: string
slot?: string
span?: number
spellCheck?: Booleanish
src?: string
srcDoc?: string
srcLang?: string
srcSet?: string
start?: number
step?: string | number
style?: CSSProperties
summary?: string
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
tag?: keyof IntrinsicElements

Default Value

'html'
 
-
target?: string
title?: string
translate?: "yes" | "no"
type?: string
typeof?: string
unselectable?: "on" | "off"
useMap?: string
value?: string | number | readonly string[]
vocab?: string
width?: string | number
wmode?: string
wrap?: string

Generated using TypeDoc

\ No newline at end of file +
target?: string
title?: string
translate?: "yes" | "no"
type?: string
typeof?: string
unselectable?: "on" | "off"
useMap?: string
value?: string | number | readonly string[]
vocab?: string
width?: string | number
wmode?: string
wrap?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/client.html b/docs/modules/client.html new file mode 100644 index 00000000..128442cc --- /dev/null +++ b/docs/modules/client.html @@ -0,0 +1,10 @@ +client | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/client_color_switch.html b/docs/modules/client_color_switch.html new file mode 100644 index 00000000..aca3b111 --- /dev/null +++ b/docs/modules/client_color_switch.html @@ -0,0 +1,3 @@ +client/color-switch | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/client_color_switch_color_switch.html b/docs/modules/client_color_switch_color_switch.html index c0693bc3..1737db75 100644 --- a/docs/modules/client_color_switch_color_switch.html +++ b/docs/modules/client_color_switch_color_switch.html @@ -1,3 +1,3 @@ -client/color-switch/color-switch | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/client_force_color_scheme.html b/docs/modules/client_force_color_scheme.html new file mode 100644 index 00000000..64a39c7e --- /dev/null +++ b/docs/modules/client_force_color_scheme.html @@ -0,0 +1,2 @@ +client/force-color-scheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/client_force_color_scheme_force_color_scheme.html b/docs/modules/client_force_color_scheme_force_color_scheme.html index c3b84f11..cf89654c 100644 --- a/docs/modules/client_force_color_scheme_force_color_scheme.html +++ b/docs/modules/client_force_color_scheme_force_color_scheme.html @@ -1,2 +1,2 @@ -client/force-color-scheme/force-color-scheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file +client/force-color-scheme/force-color-scheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/client_force_theme.html b/docs/modules/client_force_theme.html new file mode 100644 index 00000000..4e9d0d48 --- /dev/null +++ b/docs/modules/client_force_theme.html @@ -0,0 +1,2 @@ +client/force-theme | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/client_force_theme_force_theme.html b/docs/modules/client_force_theme_force_theme.html index 89dfb0e0..e466d367 100644 --- a/docs/modules/client_force_theme_force_theme.html +++ b/docs/modules/client_force_theme_force_theme.html @@ -1,2 +1,2 @@ -client/force-theme/force-theme | Code Documentation

Generated using TypeDoc

\ No newline at end of file +client/force-theme/force-theme | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/client_theme_switcher.html b/docs/modules/client_theme_switcher.html new file mode 100644 index 00000000..a2a3d23e --- /dev/null +++ b/docs/modules/client_theme_switcher.html @@ -0,0 +1,6 @@ +client/theme-switcher | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/client_theme_switcher_theme_switcher.html b/docs/modules/client_theme_switcher_theme_switcher.html index 4ceacca0..5bb0e0da 100644 --- a/docs/modules/client_theme_switcher_theme_switcher.html +++ b/docs/modules/client_theme_switcher_theme_switcher.html @@ -1,4 +1,6 @@ -client/theme-switcher/theme-switcher | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/server_nextjs_server_side_wrapper_server_side_wrapper.html b/docs/modules/server_nextjs_server_side_wrapper_server_side_wrapper.html index daa60c83..f78ef8ef 100644 --- a/docs/modules/server_nextjs_server_side_wrapper_server_side_wrapper.html +++ b/docs/modules/server_nextjs_server_side_wrapper_server_side_wrapper.html @@ -1,7 +1,7 @@ -server/nextjs/server-side-wrapper/server-side-wrapper | Code Documentation

Module server/nextjs/server-side-wrapper/server-side-wrapper

References

NextJsServerTarget +server/nextjs/server-side-wrapper/server-side-wrapper | Code Documentation

Generated using TypeDoc

\ No newline at end of file +

References

Renames and re-exports NextJsSSGThemeSwitcher

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/store.html b/docs/modules/store.html index 0386f1b1..6d7e11b2 100644 --- a/docs/modules/store.html +++ b/docs/modules/store.html @@ -1,6 +1,7 @@ -store | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/store.useTheme.html b/docs/modules/store.useTheme.html index b1af6b12..10b0e0df 100644 --- a/docs/modules/store.useTheme.html +++ b/docs/modules/store.useTheme.html @@ -1,5 +1,5 @@ -useTheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/utils.html b/docs/modules/utils.html index 5377fecb..5b524ee4 100644 --- a/docs/modules/utils.html +++ b/docs/modules/utils.html @@ -1,2 +1,4 @@ -utils | Code Documentation

Generated using TypeDoc

\ No newline at end of file +utils | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/server_nextjs_server_side_wrapper_server_side_wrapper.ForcedPage.html b/docs/types/server_nextjs_server_side_wrapper_server_side_wrapper.ForcedPage.html index 340fb0f5..a877857a 100644 --- a/docs/types/server_nextjs_server_side_wrapper_server_side_wrapper.ForcedPage.html +++ b/docs/types/server_nextjs_server_side_wrapper_server_side_wrapper.ForcedPage.html @@ -1 +1 @@ -ForcedPage | Code Documentation

Generated using TypeDoc

\ No newline at end of file +ForcedPage | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/store.ColorSchemeType.html b/docs/types/store.ColorSchemeType.html index 67c50de3..7f6dd063 100644 --- a/docs/types/store.ColorSchemeType.html +++ b/docs/types/store.ColorSchemeType.html @@ -1 +1 @@ -ColorSchemeType | Code Documentation

Generated using TypeDoc

\ No newline at end of file +ColorSchemeType | Code Documentation

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/store.ThemeStoreActionsType.html b/docs/types/store.ThemeStoreActionsType.html new file mode 100644 index 00000000..8a816bef --- /dev/null +++ b/docs/types/store.ThemeStoreActionsType.html @@ -0,0 +1 @@ +ThemeStoreActionsType | Code Documentation

Type alias ThemeStoreActionsType

ThemeStoreActionsType: {
    setColorSchemePref: ((colorSchemePref) => void);
    setDarkTheme: ((darkTheme) => void);
    setForcedColorScheme: ((forcedColorScheme?) => void);
    setForcedTheme: ((forcedTheme?) => void);
    setLightTheme: ((lightTheme) => void);
    setResolved: ((resolved) => void);
    setTheme: ((theme) => void);
    setThemeSet: ((themeSet) => void);
}

Type declaration

  • setColorSchemePref: ((colorSchemePref) => void)
      • (colorSchemePref): void
      • Parameters

        Returns void

  • setDarkTheme: ((darkTheme) => void)
      • (darkTheme): void
      • Parameters

        • darkTheme: string

        Returns void

  • setForcedColorScheme: ((forcedColorScheme?) => void)
      • (forcedColorScheme?): void
      • Parameters

        Returns void

  • setForcedTheme: ((forcedTheme?) => void)
      • (forcedTheme?): void
      • Parameters

        • Optional forcedTheme: string

        Returns void

  • setLightTheme: ((lightTheme) => void)
      • (lightTheme): void
      • Parameters

        • lightTheme: string

        Returns void

  • setResolved: ((resolved) => void)
      • (resolved): void
      • Parameters

        Returns void

  • setTheme: ((theme) => void)
      • (theme): void
      • Parameters

        • theme: string

        Returns void

  • setThemeSet: ((themeSet) => void)
      • (themeSet): void
      • Parameters

        • themeSet: {
              darkTheme: string;
              lightTheme: string;
          }
          • darkTheme: string
          • lightTheme: string

        Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/store.ThemeStoreType.html b/docs/types/store.ThemeStoreType.html index d13da706..d510d5a3 100644 --- a/docs/types/store.ThemeStoreType.html +++ b/docs/types/store.ThemeStoreType.html @@ -1 +1 @@ -ThemeStoreType | Code Documentation

Type alias ThemeStoreType

ThemeStoreType: {
    colorSchemePref: ColorSchemeType;
    darkTheme: string;
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    lightTheme: string;
    theme: string;
}

Type declaration

  • colorSchemePref: ColorSchemeType
  • darkTheme: string
  • Optional forcedColorScheme?: ColorSchemeType
  • Optional forcedTheme?: string
  • lightTheme: string
  • theme: string

Generated using TypeDoc

\ No newline at end of file +ThemeStoreType | Code Documentation

Type alias ThemeStoreType

ThemeStoreType: {
    colorSchemePref: ColorSchemeType;
    darkTheme: string;
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    lightTheme: string;
    resolvedColorScheme: ColorSchemeType;
    resolvedTheme: string;
    theme: string;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/store.initialState.html b/docs/variables/store.initialState.html index e9f3244a..93d455d2 100644 --- a/docs/variables/store.initialState.html +++ b/docs/variables/store.initialState.html @@ -1 +1 @@ -initialState | Code Documentation

Generated using TypeDoc

\ No newline at end of file +initialState | Code Documentation

Generated using TypeDoc

\ No newline at end of file