diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index e323cb001..3e51bb44f 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -13,6 +13,12 @@ --dark-hl-5: #C586C0; --light-hl-6: #098658; --dark-hl-6: #B5CEA8; + --light-hl-7: #800000; + --dark-hl-7: #808080; + --light-hl-8: #800000; + --dark-hl-8: #569CD6; + --light-hl-9: #267F99; + --dark-hl-9: #4EC9B0; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -25,6 +31,9 @@ --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); --code-background: var(--light-code-background); } } @@ -36,6 +45,9 @@ --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); --code-background: var(--dark-code-background); } } @@ -47,6 +59,9 @@ --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); --code-background: var(--light-code-background); } @@ -58,6 +73,9 @@ --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); --code-background: var(--dark-code-background); } @@ -68,4 +86,7 @@ .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); } pre, code { background: var(--code-background); } diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index a6cfaf67b..9cc681079 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WUXWvCMBSG/0uudZ1uOuadzI4NlAmtVzJKlh7XYk0kOXWT4X8fbXVN2qxWvCqH857n5Xykyx+C8I1kRFgSA0fSISyKk1ACJ6NlmRSJkF31FSOLHD0gHbKlGJER2YgwTUA5BSfIRUEhMoKbCDcJ6ZB1zEMy6tv9nrICL9fPpdiq0ibmCHJFWRunKqViPRgeOjbH0myVcoax4Jd5mTbD+8O75oMRbOA4PJCOGf47zVwWnGSVsNVEp4KG3p4zCD2kCGen2uxoozVN18/KvWP1ld51VpPzYhtShMnb7EpXk9O614ZbuqBLy0XpN8UEV0g5Ksv9nFKtjqQwzTZqH9QfrBSef1Ms084lrEACZxoZ91sDapVX+LePD71BX/OYuM/jxdQPXicleEdlTD/M9kudSbyzwfwXd+YGnj/23XZUraCG1zcVAkuopNkd1HelJStda4RIiLVyUgXd/GDqlFwQpAqKi2q194UC36RpW68CT+Kmzac1YHn+Vd5J2+01/jgVyB1Ip/h0kcpPQDOqz6JIB8dPoTKjVuPx8gq/YlJ21MJGR9he8y9tSCSpiAcAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WTXU/CMBSG/0u9BQFBDNwRwWiCkWTjipildge3OFrSHVBi+O9mG9h2q6PIVXPW9zzvzkcX3wThC8mQsCQGjqRBWBQnoQROhgt1KRIhm+lnjCxq6QFpkDXFiAzJSoSbBNJWwQlyUVCIjOA6wlVCGuQj5iEZ3tj97rMEL9fPpFinyibmCHJJmYtTmVKyvu3vGzZHZbbccIax4Od5mTb93v5V88EIVnBoHsiWGf7ZzVwWHGWl0KmjU0FDb8cZhB5ShJNdrXe00eq662fp3iH7Qu8qq855vg4pwvjl+UJXk+Nca80unVGlZaP0nWKCp0g5ppb9OV45LUlhmk3U3qhfmBKeflMs084kLEECZxoZd2sDapWX+O3BXef2RvMYTx5G86kfPI0VeEtlTN/M8pXOJHZtMP9x8jwJPH/kT9yoWkIFr08qBJZQSbM9qM5KuyxVrREiIT4sc84/O814nkI+vTrGlSYqYL3OoNdt97Qf2bhwjqJmp57UxBpUsEmheB7/LFBb4TLwKK5b42ql6i2XeargE282BbkF2SqOJlL5DmhG1W4U18HhKFRm5NQgL8/wSyaqJgcbHWEr9AemrZo9VwgAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 6062124c6..e1a6a9ce8 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81aW2/iRhT+L5PXgTAXG8zbqpuqK+2qK0H7YkXIxZPGWrCRZ8h2G+W/V+MLnmPPGAPOqk+Ow7l853znMsa8ojz7LtEyfEXfkjRGS4pRGu0FWqLtLhGput9muyyfyO+J2j6DG4TRMd+hJdpn8XEn5H2psClkNqUMuJk+q/0OYbTdRVIKiZYIveHar89Pjn/ROivo4+mYblWSpQO8GOoWjxgdolykakiADTrq+TZ4X/PsIE8Yk1SJ/CnaDklF28hoSMmMNplUUf63UJ/i8SDeGSavw9qx6wIvk3/FiMArc+8N+ltyWP2QSuzHhG4aHT+ATsurZ7EXlaLIW7euti+kNrVU63Zo66+11qrtqdP8/b6AkUGN1R+wfQwAL+cGwQWAh4+DoagvHQlXgR08GHpRW6y7AomzVK1+pNvRAzEM/5RACsV1HqUy0UU+PjEd++8Vltken7Mo1lkU8UpFStzWIDZj79ciUqgyTO1rfMx3bfs30GHN8nt1vjsia+8rGU8SOUnSZ5EnSsTvGtzN08AdnHUe/NTgxpoQPQT2zIj3DtWcGn8c4kiJj79/uW1eQDP/42VqATrSIm1lsq+ybptz1hBGGm/Dgri5920hjHMKcAZgnLmzVKooVbJ7sK4/6T09s8bUx4dfP/zxeb359PFk6yXKk+gvaK0RO9MZJ2QG7lkwJx5tPQxvddRfc/EkcpFum1pSPw7As1X6ChCdY7izgk+uG7nL/YFq2/ZGPMT3ncvEGUSGHefRpXhKNNJ8GTCb+u2g1OVA1C3OLR2x/u3hy8Nmtf6wfhjUGob85eXiex5rCnSz0V1wlde7k+65PNjivKp+r4A3vbacbXariC8u72twX1Ptl2NWN+Mc2gyDsDW9EYvtLsojcKKsV4/xWe/yaaw9Z9k3eX+UYgIDri0Wn2+OUpTLd+gXQkcp1sBe811Q22ItOiH9LdtG6jiJth0bc6vtuZa91u+wadnr9czEbPk+6d685PpBXTYZLgU5aNn1Axw+Ai4FlwuZ7V5EfBM8u5GRsidU/+FteBLdlq6G2rtDb0Y2PbNYXQCnzlDPfJV0FfT1rXyPlsTyrjQwoVelrY2NGjnKX0R+X14m5dMvvOssk/LTTXUpheDd0P2yKpTW0E2zYwY4Mi30L4ABgb49YpSksfgHLV/Ri8ilXs5LRKdsGiCMnhKxi/Xb2hI+Rttsv9fGH6vP/hRbleVaohS5nyEczjCdTReLAJP6D1r98fiIw9pGIVr8o1AkCIcMM3/qBQsgRoAYRTjkNjEKxBjCoYcpnwbBHIgxIMYRDn2bNQ7EPITDuU3MA2I+wuGiDjk4JWFmC94HmnOEQ0JsHuZAbqHlqE1uAeQCV/gBzLmmgDBM51PfIzDrLXY0C4RjRqZ0xqEkJIhoIohnZRJyRDQXxJp+Amki3BUPgUQRzx0Q5Ir47oAgN6Qgx0o/geyQhRMmpIdoGsjC6hwyRN0MUcgQLRgKrK3RaiFNA51ZJSFDVNNAiS0iChmi3BkRhRRRz20TUkQ1D5RaY4cUUc0DZVabkCKqiaD2AQI5opoI6lm9Q47YzBkRgxwx4oyIQY4YdUbEWpOu4MjaRQxyxHhpkyymxPcxnWNq0YFssYItK68MssV8tyRki7nZYpAttnBnFrLFAndmIVu8YMvaJxyyxYuVZO0TDtni1FkrHLLFNSXMOul5azVxt03IEddEsHrFYsZOf3Hb5uGQN67JYdZ5zUveiiPCi8iViD+VR4UwPB3uXtGmOj9Qrz7kvCIaoOXrG0acVleur2/N+UHfFa6Mn5GYxmaNrVm/avUc2qguGlXfpardyeJIfTCeHoxYiBELK2OgXnlls+q66LVe/Zyssckak+S85qF8H9WocwORU/30zX6jRwJD0eUYfDVjpMFvdBlz6j5Fx53aJDFQNRikLsC1avV6pPxS3bBhxuzKtn5vIov3JkbMZq4rukhFH3XV0+lhAkCYGxlwFfEui2JZvG8sQuhQR4zOIK5c1I/eRm0CIAaN3BUCOPCD2qOGtterXT8BGcoGfO5qKSnU2a5iRk1wVylKoTotzYx25K46rBU7ZUSMKiZO7eLXeo2SoeOiXf9KTla/kmsUjYJxJrozG+j5cWf+xg5EN1QVVgSZnR+T8CWjqR0MUC4y46pmI2DqV/OUVNfAYdFSmXxAWYPnXqDNBmvD2Wb0Q7UbqnVHeHV1DatOIqmBgc6rBFRLk1XW2LzPWrfcjQVIKmDUVcOlCVt9GHXV779S7k49g+PefCjjZyCGusEtqUqDuIrtWLz2jrN9F4XRj8QVyFGKLjNGGlm9+q3+HzE6JAexS1KBluHj29t/osWuT+QuAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81aW2/aSBT+L5NXQzwXA+at2ma1lVptJWhfUIS8eLKxAjayh3S7KP99Nb7gOfYcY8Cp9slxOJfvnO9cxpgjSZMfGZmvjuQlikMyZw6Jg50kc7LZRjJW95tkm6Sj7EekNs/ghjjkkG7JnOyS8LCV2X2hsM5l1oUMuBk/q92WOGSzDbJMZmROyJtT+Z2Ik+PftM4C+ng6xBsVJXEPL4a6xaND9kEqY9UnwBod8yY2eF/TZJ+dMEaxkulTsOmTiqaRwZBSl9WZVEH6t1SfwuEg3hkmr8PasouBz6J/5YDAS3PvDfol2i9+ZkruhoRuGh0+gFbLq2e5k6WiTBu3WNvnUutKqnHbt/WXWmvR9NRq/m5fwEivxuoO2D4GgJdzg+ACwP3HQV/Ul46Eq8D2HgydqC3WsUDCJFaLn/Fm8EAMw78kkFxxmQZxFukiH56Ylv33Cstsj89JEOosynChAiVvaxCbsfdrkUyqIkzta3jMd037N9BhzfJ7dT4ekbX3VRaOomwUxc8yjZQM3zW4m6cBHpx1HvzS4IaaEB0EdsyI9w7VnBrf9mGg5Mc/v9w2L6CZ//EytQAdaJE2MtlVWbfNOWsIA423fkHc3Pu2EIY5BaABGGfuJM5UEKusfbCuPuk8PfPa1MeH3z98+7xcf/p4svUapFHwF7RWi53pjBMyA7frT6nHGg/DGx3111Q+yVTGm7qW1M898GyVvgJE6xiOVvDJdS13uT9QbZvOiPv4vsNMnEFk2EGPLvlTopHmy4DZ1G8HpS4Hom5xbumI5R8PXx7Wi+WH5UOv1jDkLy+XiefxukDXa90FV3m9O+mey4Mtzqvq9wp442vL2Wa3jPji8r4G9zXVfjlmdTPOvs3QC1vdG6HcbIM0ACfKavUYn3Uun9rac5K8tFdY/t9LLNwfMjmCKQO21odMFuu771dKh0wugb3626SmxUp0RLubvokUOcs2HRuTr+m5kr3Wb7952+n1zMxt+D7p3rwmu0FdNlsuBdlrXXYD7D9ELgWXyizZvsrwJnh2IwNlT6ru41//JOKWrobauYVvRjY+s5oxgGM01DNfRl0FfXkr34MlsbgrDIzYVWlrYmNGjtJXmd4Xl1Hx/AzvWsuk+HRdXgoheNd3vyxypSV0U++YHo5MC90LoEegNUZBfcHdjkXYXtJ39QbspqjDTWvtWdwYMp1OHh0SxaH8h8yP5FWmmT6qzAkb87FPHPIUyW2o310Xrh2ySXY7rf9YfvZdblSSaolC5N4lzsp1GB1TMXNo9Qcr/3h8dFaVjVw0/0euSImz4g6fjinzgRgFYow4K2ETY0CME2flOcwbexMGxDgQE8RZTWzWBBDziLOa2sQ8IDYhzmpWheyfkuDagp8AzSlxVpTaPEyB3EzLMZvcDMj5WPg+zLmmgHKHzcbMhfhogx3NAhUOp+OpBwUhP1TzQD0rkZAiqqmg1uxTyBIVWDgU8kQ9PB5IFZ2g8UBmaE6NlXwKuaEzFCUkh2oS6MzmG9LDcHoYpIfl9PjWvmj0jyaBuVZJyA/TJDBqC4hBfpjAAmKQH+bhJiE/TLPAmDV0SBDTLDButQkJYpoGZh8ekCGmeWCe1TukiLtoRBxSxCkaEYcUcYZGxBtTLqfI2kIcUsQ1EcxaxhxyxL3CO52NPU/Dddhk7Isp1IFs8Zwt34oYssWnuCRki8/wLEC2uI9zANkSLsqBgGyJfB1Z20RAtoSmhFtnt4BsCY5WlWisJU0Jt855AdkSHm4TciQ0EZxXW4mL01+ebT8JyJvQ5HD7qoS8iRnKsIC8CR+XLHjLDyevMlUy/FQcUlar0xH5SNblyYV51dHoSJhP5sc3hwheXj19fatPLvoud2X8nMc05ta23G7V8mm+Vp3VqhNMVbvL8geTvfEMZsRCjVjKGJhXXLlbXv1O6+XP+mqbvDZJz2vui/eCtbowEKHqpzcstR71DUXMMfiKzEjDpNblHNV9Cg5btY5CoGowyDDAlWr5mqp4uWHYMGOeYTaSWGX5+ysjZjPXJV20pI9h9VR+sWe4nxrRiy4t/SAHNI0a5Fjpb5MgzPK3xXngLcKp0U8Uy2D1tYdR0aDmDBYERj542ALaRhoF1kuFWvX0aSgbtSOmqLI624vc6EWB5SGTqjUI6tcjRyIw/irFVvFRAz/Far/4rWWtZMaMqbxE+6z8jWOtaJQaVi/ticLOD0nzF5Igur6qsCKoe364wlfEprbfQznPDFLNzAiYTcopTMsNg4VhqUyvR1mD7xyAtuitDSei4bXcKOWSpKK8YiOulUhmNCablolg5bVaU53W2uVujCxaAmNYDRcmbPVh1BXW80C5PfUMjjsjUMaPeAx1gx1algbFWDrkP1oIk10bhdGPFAvkkMk2M0aN86pES4bErLxaDw6PDtlHe7mNYknmq8e3t/8AVBnLn7IwAAA="; \ No newline at end of file diff --git a/docs/functions/client_color_switch_color_switch.ColorSwitch.html b/docs/functions/client_color_switch_color_switch.ColorSwitch.html index 99bb7a7c9..60b53bded 100644 --- a/docs/functions/client_color_switch_color_switch.ColorSwitch.html +++ b/docs/functions/client_color_switch_color_switch.ColorSwitch.html @@ -1,7 +1,8 @@ -ColorSwitch | Code Documentation

Function ColorSwitch

Settings

Member Visibility

Theme

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 bfbb1647f..889fe1592 100644 --- a/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html +++ b/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html @@ -1 +1,3 @@ -ThemeSwitcher | Code Documentation

Function ThemeSwitcher

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function ThemeSwitcher

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/hooks_use_theme.useTheme-1.html b/docs/functions/hooks_use_theme.useTheme-1.html index b1dc9cee0..5a3543172 100644 --- a/docs/functions/hooks_use_theme.useTheme-1.html +++ b/docs/functions/hooks_use_theme.useTheme-1.html @@ -1 +1,4 @@ -useTheme | Code Documentation

Function useTheme

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function useTheme

  • useTheme(targetId?): UseTheme

  • use this hook to gain access to theme state and setters from your components.

    +

    Parameters

    • Optional targetId: string

      targetId corresponding to ThemeSwitcher and others tied to specific container.

      +

    Returns UseTheme

    themeState and setter fucntions

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/server_server_target_server_target.ServerTarget.html b/docs/functions/server_server_target_server_target.ServerTarget.html index 88885ee36..20af33378 100644 --- a/docs/functions/server_server_target_server_target.ServerTarget.html +++ b/docs/functions/server_server_target_server_target.ServerTarget.html @@ -1,5 +1,4 @@ -ServerTarget | Code Documentation

Function ServerTarget

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Function ServerTarget

  • ServerTarget(__namedParameters): Element

  • Server Side target for avoiding flash of un-themed content.

    +

    Parameters

    • __namedParameters: ServerTargetProps

    Returns Element

    Example

    <html>
      ...
      <body>
        <ServerTarget />
        ...
      </body>
    </html>
+
    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index f7e240189..5bbb15578 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -Code Documentation

Code Documentation

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Code Documentation

Code Documentation

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 6952268e1..047bf73c7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -11,4 +11,4 @@

This package also serves as an example to demonstrate how to build and publish React.js library compatible with React Server Components

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

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 b259b7b95..97e8c3a5e 100644 --- a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html +++ b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html @@ -1,7 +1,7 @@ -ColorSwitchProps | Code Documentation

Interface ColorSwitchProps

interface ColorSwitchProps {
    size?: number;
    skipSystem?: boolean;
    targetId?: string;
}

Properties

size? +ColorSwitchProps | Code Documentation

Interface ColorSwitchProps

interface ColorSwitchProps {
    size?: number;
    skipSystem?: boolean;
    targetId?: string;
}

Properties

size? skipSystem? targetId?

Properties

Optional size

size?: number

Diameter of the color switch

-

Optional skipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

-

Optional targetId

targetId?: string

id of target element if you are applying theme only to specific container.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional skipSystem

skipSystem?: boolean

Skip system colorScheme while toggling

+

Optional targetId

targetId?: string

id of target element if you are applying theme only to specific container. Should be same as corresponding ThemeSwitcher, etc.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.LoadSyncedStateProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.LoadSyncedStateProps.html index a1a8f8c35..be5123983 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.LoadSyncedStateProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.LoadSyncedStateProps.html @@ -1,8 +1,8 @@ -LoadSyncedStateProps | Code Documentation

Interface LoadSyncedStateProps

interface LoadSyncedStateProps {
    dontSync?: boolean;
    setThemeState: SetStateAction<ThemeState>;
    targetId?: string;
    themeTransition?: string;
}

Hierarchy (view full)

Properties

dontSync? +LoadSyncedStateProps | Code Documentation

Interface LoadSyncedStateProps

interface LoadSyncedStateProps {
    dontSync?: boolean;
    setThemeState: SetStateAction<ThemeState>;
    targetId?: string;
    themeTransition?: string;
}

Hierarchy (view full)

Properties

dontSync? setThemeState targetId? themeTransition?

Properties

Optional dontSync

dontSync?: boolean

To stop persisting and syncing theme between tabs.

-

setThemeState

setThemeState: SetStateAction<ThemeState>

Optional targetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

-

Optional themeTransition

themeTransition?: string

force apply CSS transition property to all the elements during theme switching. E.g., all .3s

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

setThemeState

setThemeState: SetStateAction<ThemeState>

Optional targetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

+

Optional themeTransition

themeTransition?: string

force apply CSS transition property to all the elements during theme switching. E.g., all .3s

+

Settings

Member Visibility

Theme

On This Page

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 86ebf29ac..f68a3fd6e 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html @@ -1,7 +1,7 @@ -ThemeSwitcherProps | Code Documentation

Interface ThemeSwitcherProps

interface ThemeSwitcherProps {
    dontSync?: boolean;
    targetId?: string;
    themeTransition?: string;
}

Hierarchy (view full)

Properties

dontSync? +ThemeSwitcherProps | Code Documentation

Interface ThemeSwitcherProps

interface ThemeSwitcherProps {
    dontSync?: boolean;
    targetId?: string;
    themeTransition?: string;
}

Hierarchy (view full)

Properties

dontSync? targetId? themeTransition?

Properties

Optional dontSync

dontSync?: boolean

To stop persisting and syncing theme between tabs.

-

Optional targetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

-

Optional themeTransition

themeTransition?: string

force apply CSS transition property to all the elements during theme switching. E.g., all .3s

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional targetId

targetId?: string

id of target element to apply classes to. This is useful when you want to apply theme only to specific container.

+

Optional themeTransition

themeTransition?: string

force apply CSS transition property to all the elements during theme switching. E.g., all .3s

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/client_theme_switcher_theme_switcher.UpdateDOMProps.html b/docs/interfaces/client_theme_switcher_theme_switcher.UpdateDOMProps.html index c0ed471c8..d3535ad73 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.UpdateDOMProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.UpdateDOMProps.html @@ -1,4 +1,4 @@ -UpdateDOMProps | Code Documentation

Interface UpdateDOMProps

interface UpdateDOMProps {
    dontSync?: boolean;
    targetId?: string;
    themeState: ThemeState;
}

Properties

dontSync? +UpdateDOMProps | Code Documentation

Interface UpdateDOMProps

interface UpdateDOMProps {
    dontSync?: boolean;
    targetId?: string;
    themeState: ThemeState;
}

Properties

dontSync? targetId? themeState -

Properties

Optional dontSync

dontSync?: boolean

Optional targetId

targetId?: string

themeState

themeState: ThemeState

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional dontSync

dontSync?: boolean

Optional targetId

targetId?: string

themeState

themeState: ThemeState

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/constants.ThemeState.html b/docs/interfaces/constants.ThemeState.html index 04b25173e..addc33e48 100644 --- a/docs/interfaces/constants.ThemeState.html +++ b/docs/interfaces/constants.ThemeState.html @@ -1,4 +1,4 @@ -ThemeState | Code Documentation

Interface ThemeState

interface ThemeState {
    colorSchemePreference: ColorSchemePreference;
    systemColorScheme: "dark" | "light";
    theme: string;
}

Properties

colorSchemePreference +ThemeState | Code Documentation

Interface ThemeState

interface ThemeState {
    colorSchemePreference: ColorSchemePreference;
    systemColorScheme: "dark" | "light";
    theme: string;
}

Properties

colorSchemePreference systemColorScheme theme -

Properties

colorSchemePreference

colorSchemePreference: ColorSchemePreference

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

colorSchemePreference

colorSchemePreference: ColorSchemePreference

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/hooks_use_theme.UseTheme.html b/docs/interfaces/hooks_use_theme.UseTheme.html index 5e3f32675..4f3fa2dff 100644 --- a/docs/interfaces/hooks_use_theme.UseTheme.html +++ b/docs/interfaces/hooks_use_theme.UseTheme.html @@ -1,7 +1,7 @@ -UseTheme | Code Documentation

Interface UseTheme

interface UseTheme {
    colorSchemePreference: ColorSchemePreference;
    resolvedColorScheme: "dark" | "light";
    setColorSchemePreference: ((colorSchemePreference) => void);
    setTheme: ((theme) => void);
    systemColorScheme: "dark" | "light";
    theme: string;
}

Properties

colorSchemePreference +UseTheme | Code Documentation

Interface UseTheme

interface UseTheme {
    colorSchemePreference: ColorSchemePreference;
    resolvedColorScheme: "dark" | "light";
    setColorSchemePreference: ((colorSchemePreference) => void);
    setTheme: ((theme) => void);
    systemColorScheme: "dark" | "light";
    theme: string;
}

Properties

colorSchemePreference resolvedColorScheme setColorSchemePreference setTheme systemColorScheme theme -

Properties

colorSchemePreference

colorSchemePreference: ColorSchemePreference

resolvedColorScheme

resolvedColorScheme: "dark" | "light"

setColorSchemePreference

setColorSchemePreference: ((colorSchemePreference) => void)

Type declaration

setTheme

setTheme: ((theme) => void)

Type declaration

    • (theme): void

    • Parameters

      • theme: string

      Returns void

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

colorSchemePreference

colorSchemePreference: ColorSchemePreference

resolvedColorScheme

resolvedColorScheme: "dark" | "light"

setColorSchemePreference

setColorSchemePreference: ((colorSchemePreference) => void)

Type declaration

setTheme

setTheme: ((theme) => void)

Type declaration

    • (theme): void

    • Parameters

      • theme: string

      Returns void

systemColorScheme

systemColorScheme: "dark" | "light"

theme

theme: string

Settings

Member Visibility

Theme

On This Page

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 eea328876..1bbb76662 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

Module client/color-switch/color-switch

Index

Interfaces

ColorSwitchProps +client/color-switch/color-switch | Code Documentation

Module client/color-switch/color-switch

Index

Interfaces

ColorSwitchProps

Functions

ColorSwitch -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 d77625357..21dce64f3 100644 --- a/docs/modules/client_theme_switcher_theme_switcher.html +++ b/docs/modules/client_theme_switcher_theme_switcher.html @@ -1,5 +1,5 @@ -client/theme-switcher/theme-switcher | Code Documentation

Module client/theme-switcher/theme-switcher

Index

Interfaces

LoadSyncedStateProps +client/theme-switcher/theme-switcher | Code Documentation

Module client/theme-switcher/theme-switcher

Index

Interfaces

LoadSyncedStateProps ThemeSwitcherProps UpdateDOMProps

Functions

ThemeSwitcher -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/constants.html b/docs/modules/constants.html index f67097de9..ed220bed1 100644 --- a/docs/modules/constants.html +++ b/docs/modules/constants.html @@ -1,5 +1,5 @@ -constants | Code Documentation

Module constants

Index

Interfaces

ThemeState +constants | Code Documentation

Module constants

Index

Interfaces

ThemeState

Type Aliases

ColorSchemePreference

Variables

DEFAULT_ID DEFAULT_THEME_STATE -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/declaration.html b/docs/modules/declaration.html index 2cbb194bf..80c572e4d 100644 --- a/docs/modules/declaration.html +++ b/docs/modules/declaration.html @@ -1 +1 @@ -declaration | Code Documentation

Module declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Module declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/hooks.html b/docs/modules/hooks.html new file mode 100644 index 000000000..1f3c0fe03 --- /dev/null +++ b/docs/modules/hooks.html @@ -0,0 +1,3 @@ +hooks | Code Documentation

Module hooks

References

UseTheme +useTheme +

References

UseTheme

Re-exports UseTheme

useTheme

Re-exports useTheme

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/hooks_use_theme.html b/docs/modules/hooks_use_theme.html index 345b25d25..9416f0882 100644 --- a/docs/modules/hooks_use_theme.html +++ b/docs/modules/hooks_use_theme.html @@ -1,3 +1,3 @@ -hooks/use-theme | Code Documentation

Module hooks/use-theme

Index

Interfaces

UseTheme +hooks/use-theme | Code Documentation

Module hooks/use-theme

Index

Interfaces

UseTheme

Functions

useTheme -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/server_server_target_server_target.html b/docs/modules/server_server_target_server_target.html index 74eac03f8..7a18fb7b0 100644 --- a/docs/modules/server_server_target_server_target.html +++ b/docs/modules/server_server_target_server_target.html @@ -1,2 +1,2 @@ -server/server-target/server-target | Code Documentation

Module server/server-target/server-target

Index

Functions

ServerTarget -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +server/server-target/server-target | Code Documentation

Module server/server-target/server-target

Index

Functions

ServerTarget +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/constants.ColorSchemePreference.html b/docs/types/constants.ColorSchemePreference.html index d09702ae1..ab9f54c08 100644 --- a/docs/types/constants.ColorSchemePreference.html +++ b/docs/types/constants.ColorSchemePreference.html @@ -1 +1 @@ -ColorSchemePreference | Code Documentation

Type alias ColorSchemePreference

ColorSchemePreference: "system" | "dark" | "light"

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ColorSchemePreference

ColorSchemePreference: "system" | "dark" | "light"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/constants.DEFAULT_ID.html b/docs/variables/constants.DEFAULT_ID.html index 7b3adfe45..0127bd9c5 100644 --- a/docs/variables/constants.DEFAULT_ID.html +++ b/docs/variables/constants.DEFAULT_ID.html @@ -1,2 +1,2 @@ DEFAULT_ID | Code Documentation

Variable DEFAULT_IDConst

DEFAULT_ID: "nthul" = "nthul"

shared constants -- keep in separate files for better tree-shaking and dependency injection

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/constants.DEFAULT_THEME_STATE.html b/docs/variables/constants.DEFAULT_THEME_STATE.html index ac3520703..d0ede3768 100644 --- a/docs/variables/constants.DEFAULT_THEME_STATE.html +++ b/docs/variables/constants.DEFAULT_THEME_STATE.html @@ -1 +1 @@ -DEFAULT_THEME_STATE | Code Documentation

Variable DEFAULT_THEME_STATEConst

DEFAULT_THEME_STATE: {
    colorSchemePreference: ColorSchemePreference;
    systemColorScheme: "dark" | "light";
    theme: string;
} = ...

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable DEFAULT_THEME_STATEConst

DEFAULT_THEME_STATE: {
    colorSchemePreference: ColorSchemePreference;
    systemColorScheme: "dark" | "light";
    theme: string;
} = ...

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file