From 7b92bf44db659b76c4384e36e1f1d1c216540041 Mon Sep 17 00:00:00 2001 From: mayank1513 Date: Mon, 1 Jan 2024 16:52:29 +0000 Subject: [PATCH] upgrade deps && docs --- docs/assets/main.js | 4 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/assets/style.css | 50 +++++++++---- ...color_switch_color_switch.ColorSwitch.html | 6 +- ...e_force_color_scheme.ForceColorScheme.html | 2 +- ...nt_force_theme_force_theme.ForceTheme.html | 2 +- ...switcher_theme_switcher.ThemeSwitcher.html | 2 +- ...tcher_theme_switcher.useThemeSwitcher.html | 2 +- ...r_side_wrapper.NextJsSSGThemeSwitcher.html | 4 +- ...server_side_wrapper.ServerSideWrapper.html | 6 +- docs/functions/store.useTheme-1.html | 2 - docs/functions/store.useTheme.destroy.html | 2 - docs/functions/store.useTheme.getState.html | 1 - docs/functions/store.useTheme.html | 8 ++ docs/functions/store.useTheme.setState.html | 1 - docs/functions/store.useTheme.subscribe.html | 1 - .../utils.getResolvedColorScheme.html | 2 +- docs/functions/utils.getResolvedTheme.html | 2 +- docs/functions/utils.resolveTheme.html | 2 +- docs/index.html | 2 +- ..._switch_color_switch.ColorSwitchProps.html | 6 +- ...eme_switcher_theme_switcher.DataProps.html | 4 +- ...her_theme_switcher.ThemeSwitcherProps.html | 6 +- ...e_switcher_theme_switcher.UpdateProps.html | 4 +- ...e_wrapper.NextJsSSRThemeSwitcherProps.html | 74 +++++++++---------- ...r_side_wrapper.ServerSideWrapperProps.html | 74 +++++++++---------- docs/modules/client.html | 4 +- docs/modules/client_color_switch.html | 4 +- .../client_color_switch_color_switch.html | 4 +- docs/modules/client_force_color_scheme.html | 4 +- ...force_color_scheme_force_color_scheme.html | 4 +- docs/modules/client_force_theme.html | 4 +- .../client_force_theme_force_theme.html | 4 +- docs/modules/client_theme_switcher.html | 4 +- .../client_theme_switcher_theme_switcher.html | 4 +- ...rver_side_wrapper_server_side_wrapper.html | 4 +- docs/modules/store.html | 7 +- docs/modules/store.useTheme.html | 5 -- docs/modules/utils.html | 4 +- ...rapper_server_side_wrapper.ForcedPage.html | 2 +- docs/types/store.ColorSchemeType.html | 2 +- docs/types/store.ThemeStoreActionsType.html | 2 +- docs/types/store.ThemeStoreType.html | 2 +- docs/variables/store.initialState.html | 2 +- 45 files changed, 177 insertions(+), 162 deletions(-) delete mode 100644 docs/functions/store.useTheme-1.html delete mode 100644 docs/functions/store.useTheme.destroy.html delete mode 100644 docs/functions/store.useTheme.getState.html create mode 100644 docs/functions/store.useTheme.html delete mode 100644 docs/functions/store.useTheme.setState.html delete mode 100644 docs/functions/store.useTheme.subscribe.html delete mode 100644 docs/modules/store.useTheme.html diff --git a/docs/assets/main.js b/docs/assets/main.js index d0aa8d5f..7270cff8 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,8 +1,8 @@ "use strict"; "use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.handleValueChange()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(e=>{e.style.display="block";let n=Array.from(e.querySelectorAll(".tsd-index-link")).every(r=>r.offsetParent==null);e.style.display=n?"none":"block"})}};var Z=class extends C{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 8f0a1aab..ab6afcd9 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -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 +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62XUW/aMBDHv4v7CqOltFN5m1a10h6mqjDtoaoiNznAW0gix1Cqie8+YYcS4rNzhjxi/v797fOdz3n5xxRsFBuzOBWQKdZjBVcLNmbLPFmlUA7M+JeFWqasx/6KLGHjYY/FC5EmEjI2fvlEfM/TXE7ehYoXXs7FsdAwR1d3o+vL0baH4Z5kXpRk5l7tAt9zxQnEusyFeshlDMY6XsAS/ERE7QVPichpC0z/b2ID0s9rSklIQjBRvQv+q0i4AgL1WOjCrUoIiACidoHj3VH2S2/GR1oUGVFXZWRDO64pv0FbwIPjclaQGhsRmQI54zHFqUlpWN/c4qE7mM1WWaxEnoV5Hdvcjrav29ea02xX0/0qiN5rJdLSvY+WkqJHvbZc/JCb7KzddL9B68Ropk0g6QgVYbcqbE/elmAhae0hcLGdLNxxDLbBYXJLyLW8unTcd3zlsJeR1t/6XsCgpOcDqS2h9O77dLtNB20bNem2i6MWAU39pDzqKK3s3uW3+UT4GpcvBUINbZbPGU2IUMsahLxLzz0TsD/rwqEkY6BhE4RecvVrrgS5BjnIYKP+lAPzq1+KBPrvkhcFSGzMzmIjigwmqn7tpkTVFGyMlNY/YaN+lBM9e8rlHJCPytPdL1C8q5Yr8eSZWAOnrcvj4stYs4eJSOC3AXW9LtzAtyTdbJMnPq91avVRnLyCA6/henn39epmiJzUY2tZnXdGj9QKt4LX3VosNFL0tYJXuUTeZXo44FNJv1qnH4V9shrUELUdl4nibuY3Ewo3GZXS+RQwhSgyoQRPJ4qrGm/NpeBvh3jWVcfE6yFy/aM5oUF7hfdoV0qkyFNJD5OOdg7qGco8XUPS8rFjmLjeUwW1Cc4NW2h84weoNLoWYF2FdcX/ilQ6bbsUAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 06fccdcf..d1077f23 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81cW4/b2A3+L5pXjaNzl+ataLBFi8V2sU7bB2MwcG1lRo3HY1hKdtMg/7040pFFSoeyZMlOnzz2HJIf+ZE8F12+Bce33/PgYfUt+JTtt8EDD4P9+jUNHoLNLkv3xbvN2+7teJ//nhWbF/QlCIPPx13wELy+bT/v0vxdJfBUjnmqxqAvi5fidReEwWa3zvM0Dx6C4HtY29XyZPjPVmaJbXz8vN8U2dt+gBUg7rEYBof1Md0XQxxs0HGlffB+Pb4d8hPGbF+kx4/rzZBQtJXMhpRFvIlknv03nQ/enVN3GcaOThL0p+yw/JoX6euc0KHS+R3orZohhdJbGx3tH9+Om/Te2di8pK+p5yfKbDmyNl6O9Pw0tFZ/spJVYLDRTsEOM9vWN6guhoVjVDyHB+8S5gqAsThvrgDRKkaz82EIL10TjewIDrqODYvFAP9HxZnQN46r0qyr4fRIQawiV4+aYuEig2Psg8z4nFfcLtvGOvnRb66tZ1Cu9LvtxTsL2OshhesDZOXcCmEE4OHrhKGo0bRbltoWN4uZ8N5h3Zdj9xjod8c3M83rFLZwE9eK9fE5LZbpLt0Ub8fZ/eqov41TduSH43qfZ7ai5/eqo/8mbuXF23H9PH/yNXqv5QZsae/XxXpaJztpuF4DKzX+sp5Q6RjkHVQ4IcpN8Ajg23Wxvi9e5oJt1T2V6m4Aekpj9eOe3EiHQfcu9ufwAO4NbuJIfpgXf6lvZtiwmfzjsF0X6bR2AnRcr6Ec0/xt92XqmqgN9a6tdkKoYSjPODHHSoh0ZbZF0GUO/XpMP17VKWfguo5NmAE6Pkxt/364zf41T49f0uO7ffpH8Z/8XfXtPs+26f3vx/XhkB59v3U2tNWYp0rLk/tmJZ6chO+3oTvcX9I/ir/ly+Vfzm0dL0PhV9/fjC6Lmte7ZTlwmW3Tf7WCO9Wxjubr+sSjxDDF8ZHV9le4Zi6+Hi5Olkbdld0AE1ydGr8NOwmYln8eI9f1FK+5X7Ld9ph6t2vX8esOmJzRwT679D78+YZ+V9Z+sMsfT+V0w1S+w1ZvHwLJEimiztRS6vtQnpbMOLXdebVfv2t1+v7MDcuv/4a9atZy7fHmCpVKcHOzptznrbcfF/n2Psvvs/1LesyKdHvrEFylT/VFgWpRPyAQHB0+di+tlb/2X6dqrcnATujD10NnYVbqa405U9clMNpg1Y3tINIeHjLOnFZKNI3v6akYYeTuNLzHVkuw98x7pOFF/wmZV9xBJk+Rjp8+XIIECs6GZpc9vxQXwUGSs+HZEMcMA0F1xWdD5j+eGohr2CHUBFS+86aR2IacKl2A0HehcyCyIdcxL0Y0IWLDL0VegO7p6ZAe8ywvfll+3W/+figPF8YipJRMQUnPGn+qTkAGTB5g5NXnkLatsVMJ9Iq63JgO6p0EkgUQHw2py898IToBc0bumZoAsXGTjuL7gZNiD+D3o6fHG0bzBK6OqJgY0MZbOqg/D53be4D/PH6Wv2FYG3R1XJOJcQX+nqn5JTiGuKy6ln1HDT+48pdpcSp+M0fxW2fpiFJXl0aDH3oV6QfGtwXxFOaJUW57Tgf7p8Ersh4vfrpgbXbDIAN4dYCnpjH0+Fxwhy8uz/pwyTLz5oGGt5C7cE9dMnS9p4P+m9vCXO4G0PB/F+Ia26lTTG0VJ2fpiC5bN9KNBr08c8fcD4yng3YK59S1WO1qg1c0u6RsnxXZercs1kUD+cv6mK3/3ZwOwkEj90Xde8x9l6ZLK/WAezbORo8JfMhZ/3vkaWSjvsh2eUd3+evQ2xDcYQYViEoXHNSPtULktfTc1FG/tfbAOSz2PwLUsTv4CZ+29falON+zguces7rDQoOfBhsGA182G4OllpwDEPlc1rDnme488iMfwToHzl+3xHM/d0hk6INIk/JmbKpMz46LEmJ6DlxE+BR2RzLaY4p8isln0DP4QrPDbV7D4PkU8g6/0HT31n+fRTjqQkO+24J9pvC46yaO7+G6sXlE32x8SVp5Ed0ATu+sdhbToJltMLBzKenFMzRDh8M4n7BeIMPztwPlMQyy/Tb9I3j4Fnyxl1Pe9sFDwBdiYU8ZP2bpbmtf5VABDIPN2+ur1ffo/vfP8oEuO6Ia8i4KwlUUcrFQOglZyPXCxDzk7pfHx3BV6yiHlj+UgiwIVyIUepEwjYYxNIwH4Ur6hnE0TAThSoVSL6LYoGECDZNBuNK+YRINU5VTySJmwvpS/oHGKzReB+HKhEwuokiFccjVguk4TEIWL2KjQxaFTC0Yw+HQSIUJwhVjPkcNGhdXppJFbLg1xRZSCWuh+gtJxkgygZKM11Qx4X5DognmylLHvDSwFqustGIjIIzVXf2FRTDDzDLJvOQxTLLd1K6YrolhxscMw4wz6WRchprTX7GLAJbGiWCvEa1Y4nUcpwCzdPLIOxIzbY+eV9xLNcNcM0sg56GMFkrFeCTmllm+uPCOxFRyyxeXvmhzTCW3NHEvL7xVo5Ym7q0rjhnklhxuvPWMeeOWCB57dWKOuCWCJ3XOiciXFRyzxS0lp+wMT9JYBvPGLTndirPCngLimEoeY5AsFGIRG0wVx6Ryy5zg3mBhUoVlTnjpF5hUUbZd6R2JSRWWOeHvqa3ea5kTkVcnJlVY5oSu+2IZiIXkoYhPP9VNE6vBjAtLpoy80DDPwlIomXckZldYviT3jsRUCsuSFN6RmEBhWZL+YGMCpWVJKt9IiQmUliWpvSMxgbKcOo13tsMESsuS9NaabM2fksaJOZKK9F1ijqSmPcIcyZKjxIsTcyQtEcqbIRJzJC0RypshEnOkLBGKh1wuIsnwagBzpFjVXYRcsARnssIcKUuE8uaSwhypcoXj7dsKc6QsEcpbuKq1zFFk21CYI6XJtqEwR8qQc5bCHKmYnLMU5kiVHHnnF4U50iVH3pzXmCPNSDY15kiXHHmrQ2OOtKB1Yo50yZE3kzXmSCtaZ2sRaonQ3pzXmCNtaJ2YI22J0N7q0JgjndA6MUfGEqG9ndZgjgzNkcEcGUuE9taRwRwZmiODOTLlZsFbcQZzZGiODObIlBx5a9O09gM0RwZzZEqOvNVhMEeG5shgjuKSI28dxZij2BKhY18Vx5ijmNMjMUexJUJ7qyPGHMWWCOPN+RhzFFsijDeTY8xRXO7mvPkZY45iQ+1h49amLaZ2sTFmKE7IbWCMGUroLVmCGUrInXaCCUrIvXaC+UkEiTLB/CSSRon5SeidVoL5SeidVoL5SeidVoIJSmJyX5K0dtH0ojxpb5ojevMYtbbNEaO3j1FrvxxxegMZtXbMEb3hqv4Hx0rStep/j4/l6dGX9Fik279Wp0irVXNz7z7/ut+81fflfgue3ElT84TYt0AlwcO379+bkyX7zZqqL4ADMQ7EIjswDDRzn8J9Kvdp3GdSfRo3zrhxxo0zbpyhYDSPIjVApGyACGdAKkqBPY2rTs8aDTxuNHBJSlavnWvEmGrEGO8Vqy7qQeGokXXBoyE3V72gBtNo0JWGuPpwMWCsX6F7zAT4AxKBOWYYGY62QzEFh5s+FdWlxEN54xxILhBa1Quhku8kJwivjHvl3ZW/RlaAKDhHXFomZEQbTYfq2BekJ8gtp67micwZ+4IWAIgBFZQz9lGdDqMK+KIoa/adMKgaEmDOFSbXkMuwD0ax7oSAg1TlLrESFwTb5/yqyoQHHKNUBSFxkGKX9kmvvi2hkEPWnSZFOVlpOpT3GgGiQUMUVM43ojhJQOlJl3VS9+rokM2Bfeaiq3pxdDsASFbm2lJSf1Jl+JwW9fM8RHANQBZTXgE1HVwG0B1TfdLd0ZRXtz01whpkXxwRwuWjZd36AfFQVF5VT3dWD3IW7mluwCywLqkSdCry5xJB83pQoAY0NEFFoFZzRGq6HQnkuqBy/AylAk66LmEVRa1HV7vhC9DwBRUmMj8E9KieTqkoOS3dJAMhjqlk97SiaPTEB99gDFUlLU0+Uc8TxSgSoJEI0olSzD5zfHpvD8gOUGuiHwbQ0E0ysB6QVOnkadGTExq0DUMVbp4W/qkPBpMORNE7K2iQ5easkg4GDdLSUEmdp4W/+WiYWDQRp66JZEE5mR7Z00smgSjIIEN1hzz1NEu4AuzxtmpOuEtqkHSaNJptcdWbIblevtEeoAQylMin7JC7N8kDiCCfKcFuNDkQ42RQyttTYfGA5JVkF+msXEG9nNlTwJffo2bW0kCK4p7BABNndw74jWRIDcggUrx89wYIFSBUOq8lLWun5/z04lsQOrhMp1wv8D4B1Ge9ThZUTnV9Bb0BbdiaxbaithuFf/pgvKWSEi3zbV3dudvZOcFtJR2IWktHHGSQ7AfhySMOQspcFBJdbxR6w0GudjhAxOqNnKl1UiVZ6izAy4SBQpBxnML0ubwHqANGAIp4vWGp6Y+otP2cd1crGtRKXO9TKW9qBd7aBb2GuTROVA2JygB33zzAA9TEVBV4lhsiGdDE8dtSkHh8TvwxDA7ZId1l+zR4WD1+//4/MJSVEhFnAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81cW4/byg3+L9pXreO5aUb7VjRI0eIgDY7T9sFYLFxb2VXjtQ1LSU4a5L8XI40sUhrKkiU7ffLaOyQ/8iM5F11+BMf9tyx4WP4IPqe7TfDAw2C3ek2Ch2C9TZNd/ma93+6P99m3NF+/oC9BGHw5boOH4HW/+bJNsjelwFMx5qkcg77MXvLXbRAG6+0qy5IseAiCn2FlN5Inw3+2Mgts49OX3TpP97seVoC4x2IYHFbHZJf3cbBGx1Xkg/fhuD9kJ4zpLk+On1brPqFoKpkMKZvzOpJZ+t9kOnh3Tt1lGFs6SdCf08Pie5Ynr1NCh0qnd6CzavoUSmdttLR/2h/Xyb2zsX5JXhPPT5TZYmRlvBjp+alvrb6zkmVgsNFWwfYz29TXqy76hWNQPPsH7xLmcoAxP28uB9HKB7PzsQ8vbRO17AAO2o71i0UP/wfFmdA3jKvCrKvh5EhBLCNXjRpj4SKDQ+yDzPiSldwumsZa+dFtrqmnV650u+3FOwnY6yGF6wNk5dwKYQDg/uuEvqjRtFuU2gY3i4nw3mHdl2P3GOh2xzczTesUtnAT1/LV8TnJF8k2Wef74+R+tdTfxik78uNxtctSW9HTe9XSfxO3snx/XD1Pn3y13mu5AVva21W+GtfJThqu18AKje9XIyodg7yDCkdEuQ4eAXyzylf3+ctUsK26p0LdDUCPaax+3KMbaT/o3sX+FB7AvcFNHMkO0+Iv9E0MGzaTfxw2qzwZ106Ajus1lGOS7bdfx66JmlDvmmpHhBqG8owTU6yESFcmWwRd5tCHY/Lpqk45A9d1bMQM0PJhbPv3w633r1ly/Joc3+ySP/L/ZG/Kb/dZuknuvx1Xh0Ny9P3W2tCWY55KLU/um5V4chK+3/rucN8nf+R/yxaLv5zbOl6Gwq++uxldFjWvd4ti4CLdJP9qBHesYy3N1/WJz2PNFMdHVpsPcM2cfz9cnCy1uiu7ASa4KjV+73cSMC7/PEau6ylec7+k280x8W7XruPXHTA5oYNddul9+PMN/S6t/WKXP53K6YapfIet3j4EksVSzFtTS6HvY3FaMuHUdufVfv2u1er7Ezcsv/4b9qpJy7XDmytUKsHNzZpyl7fefpxnm/s0u093L8kxzZPNrUNwlT7VFQWqRf2CQHB0+Ni+tFb82n2dqrEmAzuhj98PrYVZoa8x5kxdF8Bog2U3toNIe3jIMHORUqJufE9P+QAjd6fhHbYagp1n3gMNz7pPyLziDjJ5inT8/PESJFBwMjTb9PklvwgOkpwMz5o4ZugJqi0+GTL/8VRPXP0OoUag8p03DcTW51TpAoS+C509kfW5jnkxohER638p8gJ0T0+H5JilWf5+8X23/vuhOFwYipBSMgYlPWv8qTwB6TF5gJFXn0OatoZOJdAr6nJj0qt3EkhmQHwwpDY/04XoBMwZuWdqBMTaTTqKb3tOih2A3w6eHm8YzRO4KqJiZEBrb+mg/tZ3bu8A/tvwWf6GYa3RVXGNR8YV+Hum5hfgGOKy6lp0HTX84spfJPmp+PUUxW+dpSNKXV0aDL7vVaRfGN8GxFOYR0a56Tkd7He9V2QdXry7YG12wyADeFWAx6Yx9PhccPsvLs/6cMky8+aBhreQu3CPXTK0vaeD/rvbwlzuBtDwfxfiCtupU4xtFSdn6YguGjfSDQa9OHPH3C+Mp4N2CufYtVjlao1X1LukdJfm6Wq7yFd5Dfnr6piu/l2fDsJBA/dF7XvMfZemCyvVgIGHhbWBPN3WO9HqfLP4te9dAu6sgcJZ6oKDurGWiLyWnus077bWHDiFxe4ndFp2ez+A07TevFLme5Tv3FNQd1io98Na/WDgq1pDsFSSUwAiH5vq97jRnUd+4BNS58B9PA8rb+DpdUOb/9mg4XkzNFXGZ8dFCTE+By4ifAy7AxntMEU+ZOQz6Bl8odn+Nq9h8HwKeYdfaLp9Z77PIhx1oSHfXbs+U3jcdRPH9+zb0Dyi7wW+JK28iG4Ap3NWO4up18zWG9i5lPTi6Zuh/WGcT1gvkP7524LyGAbpbpP8ETz8CL7aqx37XfAQ8JmY2UPAT2my3dg3LZQAw2C9f321+h7d//5ZPG9lR5RD3syDcDkPuZjZvQYLeTTTSoTc/fL4GC4rHcXQ4odCkAXhUoQimhlh0DCGhvEgXErfMI6GiSBcqlBGszmTaJhAw2QQLiPfMImGqdKpeKajyPpS/IHGKzQ+CsKlDpmYxYaHJuRqxrgK45CZmVEmZPOQqdk81khFhFToIFwy5nNUo3GmNBXPjFDWFJtJpq2F8i8kaZBkDCUZr6hiwv2GRGPMlaWOeWlgDVZZYYWr2dwoq7v8C4tghpllknnJY5hku+dcsqgihmkfMwwzzqSTcRmqT38ZFwEsjRPBXsJZstjrOE4BZunkc+9IzLQ9GV5yL9UMc80sgZyHcj6ThuORmFtm+eLCOxJTyS1fXPqizTGV3NLEvbzwRo1amri3rjhmkFtyuPbWM+aNWyK48erEHHFLBI+rnBNzX1ZwzBa3lJyyMzxJYxnMG7fktCvOCnsKiGMqucEgWSjEzIiGY5hUbpkT3BssTKqwzAkv/QKTKoq2K70jManCMif8PbXRey1zYu7ViUkVlrmi9oq+KHQo2EwYGQpz+q3qmlgPplxYNuXciw0TLSyHknlHYnqFJUxy70jMpbA0SeEdiRkUlibpjzZmUFqapPKNlJhBaWmSkXckZlAWc6f2TneYQWlpkt5ik40JVNI4MUdSkb5LzJGMaI8wR7LgKPbixBxJS4TyZojEHElLhPJmiMQcKUuEKpY2cWPaUJgjxcr2IuSMscbCAXOkLBHKm0sKc6SKJY63cSvMkbJEKG/lqsY6R5F9Q2GOVET2DYU5UpqctBTmSBly0lKYI1Vw5J1gFOYoKjjy5nyEOYoYyWaEOYoKjrzVEWGOIkHrxBxFBUfeTI4wR5GidTZWoZaIyJvzEeYo0rROzFFkiYi81RFhjqKY1ok50paIyNtpNeZI0xxpzJG2RETeOtKYI01zpDFHutgteCtOY440zZHGHOmCI29t6saGgOZIY450wZG3OjTmSNMcacyRKTjy1pHBHBlLROStDoM5MgVH3pw3mCNjidDeTDaYI2OJ0N78NJgjY4nQ3qwzmCMTUVtTgykymtqcmsamzZC7O4MZMjG50zKYoXhOoYwxQTGjUMaYn5iTKGPMTyxIlDHmJ5bkBirG/MSK3EDFmJ84IjdQMSYo1uR2I8YMxYZca8eNbXRMe9TcNc/pPeG8sW+eM3pXOG9smOecdKv8HxwrSMfK/z0+FkdCX5Njnmz+Wh4NLZf1DbW77Ptuva/uhf0RPLnjo/qprB+BioOHHz9/1sdF9ps1VV10BmIciM3twDCImPsU7lO5T+0+4/JTu3HajdNunHbjNAWjfvynBiJlDUQ4A1JRCuwRW3kkVmvgptbAJSlZvuqtFmOqFmO8U6y8UgeF57WsCx4Nub6UBTXoWkNUajDlh4sBY90K3aMdwB+QCMwxw8hwNB0yFByuu1SU1wcPxc1qILlAaFUnhFK+lZwgvNJ0yrvLebWsAFFwjjiH4vl5TYfyLBekJ8gtp85leUwSZF+KAgAxoIJyxj4e02JUAV8UlaH2PSyoGmJgzhUmjyCXYReMfNUKAQepyl1ixU6T7XN+VUXCA45RqoKQOEWmyv5OfRtCIYesuwJSlJOlpkNxfw8gGjREQeV8LYqTBJSedFkno04dLbI5sM9cMFQnjnYHAMnKXFsyLhqxIFQ9J3n1DA0RXA2QGarNATUtXBrQbah24O4iyspbjWrhCGSfoSq4eJyrXT8gHoryv3yisnx4MndPUANmgXVJpaZTkT0XCOpXcgI1oKEJKoSVmiNS0+5IINcFleNnKBVw0nUJq6iE9ehqNnwBGr6gwkTmh4AeVdMpFSWnpZ1kIMSGItvTiuaDJz741mCoKm5o8ol6nuJFkQCNRFCVUorZ53xP78oB2QFqTXTDABraSQbWA5KMZpJ35EQE2oamCjdLcv/UB4NJByLvnBUikOX6rJIWhgikpaaSOktyf/OJYGLRRJy6JpIF5aQ7ZE8vdgSiIIM01R2yxNMs4Qqww9uyOeEuGYGki0ij6QZXve6T68Vb5AFKIEOJfE4PmXt7O4AI8pkSbEeTAzFOBqW45xQWD0heSXaR1soV1MuZPQV84TxqZg0NpCjuGQwwcXbngN8ChtSADCLFi/ddgFABQqXzWtKydnrOTi+bBaGDy3TK9RzvE0B9VutkQeVU21fQG9CGrV5sK2p/kPunD8YbKinRIt9W5e24rZ0T3FbSgai0tMRBBsluEJ484iCkrNp0qWqj0I2GWu1wgIhVO6+o0tkZ4hy8wBcoBBnHKfkvxY09LTACUMSrhbWpwFDJ8yVrr1YiUCuGROEEvTULegxzMY6l+6SYc/fAAxhAi6H6m2eVIeIevRu/mASJm3Pij2FwSA/JNt0lwcPy8efP/wEmHIa4fGYAAA=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 07a385b7..98a43779 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -29,7 +29,7 @@ --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-type-parameter: #a55c0e; --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); @@ -69,7 +69,7 @@ --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-type-parameter: #e07d13; --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); @@ -266,12 +266,12 @@ h6 { line-height: 1.2; } -h1 > a, -h2 > a, -h3 > a, -h4 > a, -h5 > a, -h6 > a { +h1 > a:not(.link), +h2 > a:not(.link), +h3 > a:not(.link), +h4 > a:not(.link), +h5 > a:not(.link), +h6 > a:not(.link) { text-decoration: none; color: var(--color-text); } @@ -649,6 +649,28 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { font-weight: bold; } +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + .tsd-panel-group.tsd-index-group { margin-bottom: 0; } @@ -714,12 +736,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } .tsd-navigation > a, .tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.5rem); + width: calc(100% - 0.25rem); + display: flex; + align-items: center; } .tsd-navigation a, .tsd-navigation summary > span, .tsd-page-navigation a { - display: inline-flex; + display: flex; + width: calc(100% - 0.25rem); align-items: center; padding: 0.25rem; color: var(--color-text); @@ -759,11 +784,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { margin-left: -1.5rem; } -.tsd-nested-navigation > li > a, -.tsd-nested-navigation > li > span { - width: calc(100% - 1.75rem - 0.5rem); -} - .tsd-page-navigation ul { padding-left: 1.75rem; } diff --git a/docs/functions/client_color_switch_color_switch.ColorSwitch.html b/docs/functions/client_color_switch_color_switch.ColorSwitch.html index c8e11bfc..5526ec90 100644 --- a/docs/functions/client_color_switch_color_switch.ColorSwitch.html +++ b/docs/functions/client_color_switch_color_switch.ColorSwitch.html @@ -1,7 +1,7 @@ -ColorSwitch | Code Documentation

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 23190f04..17a7241a 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 b84ec9b6..52bad212 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 3ca16a8b..3d0e2f4b 100644 --- a/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html +++ b/docs/functions/client_theme_switcher_theme_switcher.ThemeSwitcher.html @@ -1,2 +1,2 @@ ThemeSwitcher | Code Documentation

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns null

Component

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 d65886a0..9c124936 100644 --- a/docs/functions/client_theme_switcher_theme_switcher.useThemeSwitcher.html +++ b/docs/functions/client_theme_switcher_theme_switcher.useThemeSwitcher.html @@ -1,3 +1,3 @@ useThemeSwitcher | Code Documentation

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

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 43ddc972..ccb69578 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 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 0b8108e6..ef345b7d 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 diff --git a/docs/functions/store.useTheme-1.html b/docs/functions/store.useTheme-1.html deleted file mode 100644 index 080de997..00000000 --- a/docs/functions/store.useTheme-1.html +++ /dev/null @@ -1,2 +0,0 @@ -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 deleted file mode 100644 index 721433d5..00000000 --- a/docs/functions/store.useTheme.destroy.html +++ /dev/null @@ -1,2 +0,0 @@ -destroy | Code Documentation
  • Returns void

    Deprecated

    Use unsubscribe returned by subscribe

    -

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 deleted file mode 100644 index c7ba3762..00000000 --- a/docs/functions/store.useTheme.getState.html +++ /dev/null @@ -1 +0,0 @@ -getState | Code Documentation

Generated using TypeDoc

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

Properties

destroy: (() => void)

Type declaration

    • (): void
    • Returns void

      Deprecated

      Use unsubscribe returned by subscribe

      +

Deprecated

Use unsubscribe returned by subscribe

+
setState: ((partial, replace?) => void)

Type declaration

subscribe: ((listener) => (() => void))

Type declaration

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 deleted file mode 100644 index b4e4344a..00000000 --- a/docs/functions/store.useTheme.setState.html +++ /dev/null @@ -1 +0,0 @@ -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 deleted file mode 100644 index 50eb40f9..00000000 --- a/docs/functions/store.useTheme.subscribe.html +++ /dev/null @@ -1 +0,0 @@ -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 index 249a97e9..73c84b44 100644 --- a/docs/functions/utils.getResolvedColorScheme.html +++ b/docs/functions/utils.getResolvedColorScheme.html @@ -1 +1 @@ -getResolvedColorScheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file +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 index da368eb2..b1f667e7 100644 --- a/docs/functions/utils.getResolvedTheme.html +++ b/docs/functions/utils.getResolvedTheme.html @@ -1 +1 @@ -getResolvedTheme | Code Documentation

Generated using TypeDoc

\ No newline at end of file +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 index 7bbadc14..f5fb7428 100644 --- a/docs/functions/utils.resolveTheme.html +++ b/docs/functions/utils.resolveTheme.html @@ -1 +1 @@ -resolveTheme | Code Documentation

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 08fa3c61..8f2361e8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -152,4 +152,4 @@
-

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 6209e38e..33bb1332 100644 --- a/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html +++ b/docs/interfaces/client_color_switch_color_switch.ColorSwitchProps.html @@ -1,5 +1,5 @@ -ColorSwitchProps | Code Documentation
interface ColorSwitchProps {
    size?: number;
    skipSystem?: boolean;
}

Properties

size? +ColorSwitchProps | Code Documentation

Generated using TypeDoc

\ No newline at end of file +
skipSystem?: boolean

Skip system colorScheme while toggling

+

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 index 7d102c8b..dade7562 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.DataProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.DataProps.html @@ -1,6 +1,6 @@ -DataProps | Code Documentation
interface DataProps {
    className: string;
    data-color-scheme?: "dark" | "light";
    data-csp?: ColorSchemeType;
    data-th?: string;
    data-theme?: string;
}

Properties

className +DataProps | Code Documentation

Generated using TypeDoc

\ No newline at end of file +

Properties

className: string
data-color-scheme?: "dark" | "light"
data-csp?: "" | "system" | "dark" | "light"
data-th?: string
data-theme?: string

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 e769420b..82ec7cb2 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.ThemeSwitcherProps.html @@ -1,8 +1,8 @@ -ThemeSwitcherProps | Code Documentation
interface ThemeSwitcherProps {
    forcedColorScheme?: ColorSchemeType;
    forcedTheme?: string;
    storage?: StorageType;
    targetSelector?: string;
    themeTransition?: string;
}

Properties

forcedColorScheme? +ThemeSwitcherProps | Code Documentation
interface ThemeSwitcherProps {
    forcedColorScheme?: "" | "system" | "dark" | "light";
    forcedTheme?: string;
    storage?: "localStorage" | "sessionStorage" | "cookies";
    targetSelector?: string;
    themeTransition?: string;
}

Properties

forcedColorScheme?: ColorSchemeType
forcedTheme?: string
storage?: StorageType

defaultValue "cookies" +

Properties

forcedColorScheme?: "" | "system" | "dark" | "light"
forcedTheme?: string
storage?: "localStorage" | "sessionStorage" | "cookies"

defaultValue "cookies" set storage to localStorage or sessionsStorage when using only client side or when you must avoid using cookies

-
targetSelector?: string
themeTransition?: string

Generated using TypeDoc

\ No newline at end of file +
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 index e03491bf..05929cb4 100644 --- a/docs/interfaces/client_theme_switcher_theme_switcher.UpdateProps.html +++ b/docs/interfaces/client_theme_switcher_theme_switcher.UpdateProps.html @@ -1,5 +1,5 @@ -UpdateProps | Code Documentation
interface UpdateProps {
    resolvedColorScheme: "dark" | "light";
    resolvedColorSchemePref: ColorSchemeType;
    resolvedTheme: string;
    th: string;
}

Properties

resolvedColorScheme +UpdateProps | Code Documentation

Generated using TypeDoc

\ No newline at end of file +

Properties

resolvedColorScheme: "dark" | "light"
resolvedColorSchemePref: ColorSchemeType
resolvedTheme: string
th: string

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 2a7ecf90..d12d3ec0 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?: "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" | "none" | "text" | "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?: boolean | "true" | "false";
    aria-autocomplete?: "none" | "list" | "inline" | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: boolean | "true" | "false";
    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?: boolean | "true" | "false";
    aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup";
    aria-errormessage?: string;
    aria-expanded?: boolean | "true" | "false";
    aria-flowto?: string;
    aria-grabbed?: boolean | "true" | "false";
    aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree";
    aria-hidden?: boolean | "true" | "false";
    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?: boolean | "true" | "false";
    aria-multiline?: boolean | "true" | "false";
    aria-multiselectable?: boolean | "true" | "false";
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?: boolean | "true" | "false" | "mixed";
    aria-readonly?: boolean | "true" | "false";
    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
    aria-required?: boolean | "true" | "false";
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: boolean | "true" | "false";
    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?: boolean | "true" | "false" | "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?: boolean | "true" | "false";
    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" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal";
    integrity?: string;
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | string | number | bigint;
    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?: null | string | ((instance) => void) | RefObject<HTMLElement>;
    rel?: string;
    required?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    reversed?: boolean;
    role?: "search" | "link" | "button" | string & {} | "grid" | "none" | "article" | "dialog" | "figure" | "form" | "img" | "main" | "menu" | "option" | "table" | "switch" | "math" | "marquee" | "menuitem" | "list" | "alert" | "alertdialog" | "application" | "banner" | "cell" | "checkbox" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "directory" | "document" | "feed" | "gridcell" | "group" | "heading" | "listbox" | "listitem" | "log" | "menubar" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "note" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "tab" | "tablist" | "tabpanel" | "term" | "textbox" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem";
    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?: boolean | "true" | "false";
    src?: string;
    srcDoc?: string;
    srcLang?: string;
    srcSet?: string;
    start?: number;
    step?: string | number;
    style?: CSSProperties;
    summary?: string;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex?: number;
    tag?: "symbol" | "object" | "map" | "filter" | "search" | "big" | "link" | "small" | "sub" | "sup" | "button" | "style" | "clipPath" | "mask" | "marker" | "th" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "label" | "legend" | "li" | "main" | "mark" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "select" | "slot" | "source" | "span" | "strong" | "summary" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "animate" | "animateMotion" | "animateTransform" | "circle" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view" | "center" | "keygen" | "menuitem" | "param" | "noindex" | "webview";
    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 (view full)

Properties

about? accept? acceptCharset? accessKey? @@ -372,15 +372,15 @@

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.

+
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?: boolean | "true" | "false"

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.

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.

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?: boolean | "true" | "false"
aria-checked?: boolean | "true" | "false" | "mixed"

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

See

  • aria-pressed
  • aria-selected.
  • @@ -408,7 +408,7 @@

See

related aria-describedby.

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?: boolean | "true" | "false"

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

See

  • aria-hidden
  • aria-readonly.
  • @@ -420,13 +420,13 @@
  • aria-invalid
  • aria-describedby.
-
aria-expanded?: Booleanish

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

+
aria-expanded?: boolean | "true" | "false"

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?: boolean | "true" | "false"

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

Deprecated

in ARIA 1.1

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.

+
aria-hidden?: boolean | "true" | "false"

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.

See

aria-errormessage.

@@ -437,9 +437,9 @@

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-modal?: boolean | "true" | "false"

Indicates whether an element is modal when displayed.

+
aria-multiline?: boolean | "true" | "false"

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

+
aria-multiselectable?: boolean | "true" | "false"

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.

@@ -453,11 +453,11 @@
  • aria-checked
  • aria-selected.
  • -
    aria-readonly?: Booleanish

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

    +
    aria-readonly?: boolean | "true" | "false"

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

    See

    aria-disabled.

    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-required?: boolean | "true" | "false"

    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.

    @@ -473,7 +473,7 @@
  • aria-rowindex
  • aria-colspan.
  • -
    aria-selected?: Booleanish

    Indicates the current "selected" state of various widgets.

    +
    aria-selected?: boolean | "true" | "false"

    Indicates the current "selected" state of various widgets.

    See

    • aria-checked
    • aria-pressed.
    • @@ -487,33 +487,33 @@

    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']. +

    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?: boolean | "true" | "false" | "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" | "none" | "text" | "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

    +
    defaultValue?: string | number | readonly string[]
    defer?: boolean
    dir?: string
    disabled?: boolean
    download?: any
    draggable?: boolean | "true" | "false"
    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" | "none" | "text" | "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

    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 | string | number | bigint
    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?: null | string | ((instance) => void) | RefObject<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'
    +

    Type declaration

      • (instance): void
      • Parameters

        • instance: null | HTMLElement

        Returns void

    rel?: string
    required?: boolean
    resource?: string
    results?: number
    rev?: string
    reversed?: boolean
    role?: "search" | "link" | "button" | string & {} | "grid" | "none" | "article" | "dialog" | "figure" | "form" | "img" | "main" | "menu" | "option" | "table" | "switch" | "math" | "marquee" | "menuitem" | "list" | "alert" | "alertdialog" | "application" | "banner" | "cell" | "checkbox" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "directory" | "document" | "feed" | "gridcell" | "group" | "heading" | "listbox" | "listitem" | "log" | "menubar" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "note" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "tab" | "tablist" | "tabpanel" | "term" | "textbox" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem"

    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?: boolean | "true" | "false"
    src?: string
    srcDoc?: string
    srcLang?: string
    srcSet?: string
    start?: number
    step?: string | number
    style?: CSSProperties
    summary?: string
    suppressContentEditableWarning?: boolean
    suppressHydrationWarning?: boolean
    tabIndex?: number
    tag?: "symbol" | "object" | "map" | "filter" | "search" | "big" | "link" | "small" | "sub" | "sup" | "button" | "style" | "clipPath" | "mask" | "marker" | "th" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "label" | "legend" | "li" | "main" | "mark" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "select" | "slot" | "source" | "span" | "strong" | "summary" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "animate" | "animateMotion" | "animateTransform" | "circle" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view" | "center" | "keygen" | "menuitem" | "param" | "noindex" | "webview"

    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 3c49f5cd..d272863d 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?: "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" | "none" | "text" | "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?: boolean | "true" | "false";
        aria-autocomplete?: "none" | "list" | "inline" | "both";
        aria-braillelabel?: string;
        aria-brailleroledescription?: string;
        aria-busy?: boolean | "true" | "false";
        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?: boolean | "true" | "false";
        aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup";
        aria-errormessage?: string;
        aria-expanded?: boolean | "true" | "false";
        aria-flowto?: string;
        aria-grabbed?: boolean | "true" | "false";
        aria-haspopup?: boolean | "grid" | "dialog" | "menu" | "true" | "false" | "listbox" | "tree";
        aria-hidden?: boolean | "true" | "false";
        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?: boolean | "true" | "false";
        aria-multiline?: boolean | "true" | "false";
        aria-multiselectable?: boolean | "true" | "false";
        aria-orientation?: "horizontal" | "vertical";
        aria-owns?: string;
        aria-placeholder?: string;
        aria-posinset?: number;
        aria-pressed?: boolean | "true" | "false" | "mixed";
        aria-readonly?: boolean | "true" | "false";
        aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
        aria-required?: boolean | "true" | "false";
        aria-roledescription?: string;
        aria-rowcount?: number;
        aria-rowindex?: number;
        aria-rowindextext?: string;
        aria-rowspan?: number;
        aria-selected?: boolean | "true" | "false";
        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?: boolean | "true" | "false" | "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?: boolean | "true" | "false";
        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" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal";
        integrity?: string;
        is?: string;
        itemID?: string;
        itemProp?: string;
        itemRef?: string;
        itemScope?: boolean;
        itemType?: string;
        key?: null | string | number | bigint;
        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?: null | string | ((instance) => void) | RefObject<HTMLElement>;
        rel?: string;
        required?: boolean;
        resource?: string;
        results?: number;
        rev?: string;
        reversed?: boolean;
        role?: "search" | "link" | "button" | string & {} | "grid" | "none" | "article" | "dialog" | "figure" | "form" | "img" | "main" | "menu" | "option" | "table" | "switch" | "math" | "marquee" | "menuitem" | "list" | "alert" | "alertdialog" | "application" | "banner" | "cell" | "checkbox" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "directory" | "document" | "feed" | "gridcell" | "group" | "heading" | "listbox" | "listitem" | "log" | "menubar" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "note" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "tab" | "tablist" | "tabpanel" | "term" | "textbox" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem";
        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?: boolean | "true" | "false";
        src?: string;
        srcDoc?: string;
        srcLang?: string;
        srcSet?: string;
        start?: number;
        step?: string | number;
        style?: CSSProperties;
        summary?: string;
        suppressContentEditableWarning?: boolean;
        suppressHydrationWarning?: boolean;
        tabIndex?: number;
        tag?: "symbol" | "object" | "map" | "filter" | "search" | "big" | "link" | "small" | "sub" | "sup" | "button" | "style" | "clipPath" | "mask" | "marker" | "th" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "label" | "legend" | "li" | "main" | "mark" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "select" | "slot" | "source" | "span" | "strong" | "summary" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "animate" | "animateMotion" | "animateTransform" | "circle" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view" | "center" | "keygen" | "menuitem" | "param" | "noindex" | "webview";
        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 (view full)

    Properties

    about? accept? acceptCharset? accessKey? @@ -372,15 +372,15 @@

    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.

    +
    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?: boolean | "true" | "false"

    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.

    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.

    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?: boolean | "true" | "false"
    aria-checked?: boolean | "true" | "false" | "mixed"

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

    See

    • aria-pressed
    • aria-selected.
    • @@ -408,7 +408,7 @@

    See

    related aria-describedby.

    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?: boolean | "true" | "false"

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

    See

    • aria-hidden
    • aria-readonly.
    • @@ -420,13 +420,13 @@
    • aria-invalid
    • aria-describedby.
    -
    aria-expanded?: Booleanish

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

    +
    aria-expanded?: boolean | "true" | "false"

    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?: boolean | "true" | "false"

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

    Deprecated

    in ARIA 1.1

    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.

    +
    aria-hidden?: boolean | "true" | "false"

    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.

    See

    aria-errormessage.

    @@ -437,9 +437,9 @@

    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-modal?: boolean | "true" | "false"

    Indicates whether an element is modal when displayed.

    +
    aria-multiline?: boolean | "true" | "false"

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

    +
    aria-multiselectable?: boolean | "true" | "false"

    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.

    @@ -453,11 +453,11 @@
  • aria-checked
  • aria-selected.
  • -
    aria-readonly?: Booleanish

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

    +
    aria-readonly?: boolean | "true" | "false"

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

    See

    aria-disabled.

    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-required?: boolean | "true" | "false"

    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.

    @@ -473,7 +473,7 @@
  • aria-rowindex
  • aria-colspan.
  • -
    aria-selected?: Booleanish

    Indicates the current "selected" state of various widgets.

    +
    aria-selected?: boolean | "true" | "false"

    Indicates the current "selected" state of various widgets.

    See

    • aria-checked
    • aria-pressed.
    • @@ -487,33 +487,33 @@

    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']. +

    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?: boolean | "true" | "false" | "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" | "none" | "text" | "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

    +
    defaultValue?: string | number | readonly string[]
    defer?: boolean
    dir?: string
    disabled?: boolean
    download?: any
    draggable?: boolean | "true" | "false"
    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" | "none" | "text" | "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

    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 | string | number | bigint
    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?: null | string | ((instance) => void) | RefObject<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'
    +

    Type declaration

      • (instance): void
      • Parameters

        • instance: null | HTMLElement

        Returns void

    rel?: string
    required?: boolean
    resource?: string
    results?: number
    rev?: string
    reversed?: boolean
    role?: "search" | "link" | "button" | string & {} | "grid" | "none" | "article" | "dialog" | "figure" | "form" | "img" | "main" | "menu" | "option" | "table" | "switch" | "math" | "marquee" | "menuitem" | "list" | "alert" | "alertdialog" | "application" | "banner" | "cell" | "checkbox" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "directory" | "document" | "feed" | "gridcell" | "group" | "heading" | "listbox" | "listitem" | "log" | "menubar" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "note" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "tab" | "tablist" | "tabpanel" | "term" | "textbox" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem"

    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?: boolean | "true" | "false"
    src?: string
    srcDoc?: string
    srcLang?: string
    srcSet?: string
    start?: number
    step?: string | number
    style?: CSSProperties
    summary?: string
    suppressContentEditableWarning?: boolean
    suppressHydrationWarning?: boolean
    tabIndex?: number
    tag?: "symbol" | "object" | "map" | "filter" | "search" | "big" | "link" | "small" | "sub" | "sup" | "button" | "style" | "clipPath" | "mask" | "marker" | "th" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "canvas" | "caption" | "cite" | "code" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "label" | "legend" | "li" | "main" | "mark" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "select" | "slot" | "source" | "span" | "strong" | "summary" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "animate" | "animateMotion" | "animateTransform" | "circle" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "image" | "line" | "linearGradient" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "stop" | "svg" | "switch" | "text" | "textPath" | "tspan" | "use" | "view" | "center" | "keygen" | "menuitem" | "param" | "noindex" | "webview"

    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 index 5d07de76..51c22a28 100644 --- a/docs/modules/client.html +++ b/docs/modules/client.html @@ -1,4 +1,4 @@ -client | Code Documentation

    References

    ColorSwitch +client | Code Documentation

    Generated using TypeDoc

    \ No newline at end of file +

    References

    Re-exports ColorSwitch
    Re-exports ColorSwitchProps
    Re-exports DataProps
    Re-exports ForceColorScheme
    Re-exports ForceTheme
    Re-exports ThemeSwitcher
    Re-exports ThemeSwitcherProps
    Re-exports UpdateProps
    Re-exports useThemeSwitcher

    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 index 1951006e..f0d06284 100644 --- a/docs/modules/client_color_switch.html +++ b/docs/modules/client_color_switch.html @@ -1,3 +1,3 @@ -client/color-switch | Code Documentation

    Module client/color-switch

    References

    ColorSwitch +client/color-switch | Code Documentation

    Generated using TypeDoc

    \ No newline at end of file +

    References

    Re-exports ColorSwitch
    Re-exports ColorSwitchProps

    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 b3e99f98..a349422f 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

    Generated using TypeDoc

    \ No newline at end of file +

    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 index addfab0f..d6799879 100644 --- a/docs/modules/client_force_color_scheme.html +++ b/docs/modules/client_force_color_scheme.html @@ -1,2 +1,2 @@ -client/force-color-scheme | Code Documentation

    Generated using TypeDoc

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

    Module client/force-color-scheme

    References

    References

    Re-exports ForceColorScheme

    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 6776eed1..d1c4a64e 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 index 28a6d16a..ec235273 100644 --- a/docs/modules/client_force_theme.html +++ b/docs/modules/client_force_theme.html @@ -1,2 +1,2 @@ -client/force-theme | Code Documentation

    Generated using TypeDoc

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

    Module client/force-theme

    References

    References

    Re-exports ForceTheme

    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 3b46452c..3e1d16bd 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 index 2ba4696e..a7d07ffa 100644 --- a/docs/modules/client_theme_switcher.html +++ b/docs/modules/client_theme_switcher.html @@ -1,6 +1,6 @@ -client/theme-switcher | Code Documentation

    Module client/theme-switcher

    References

    DataProps +client/theme-switcher | Code Documentation

    Generated using TypeDoc

    \ No newline at end of file +

    References

    Re-exports DataProps
    Re-exports ThemeSwitcher
    Re-exports ThemeSwitcherProps
    Re-exports UpdateProps
    Re-exports useThemeSwitcher

    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 fdfd11b0..7056fc27 100644 --- a/docs/modules/client_theme_switcher_theme_switcher.html +++ b/docs/modules/client_theme_switcher_theme_switcher.html @@ -1,6 +1,6 @@ -client/theme-switcher/theme-switcher | Code Documentation

    Module client/theme-switcher/theme-switcher

    Index

    Interfaces

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

    Generated using TypeDoc

    \ No newline at end of file +

    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 9af5eed5..65f6f80e 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 133e2167..e13009a0 100644 --- a/docs/modules/store.html +++ b/docs/modules/store.html @@ -1,7 +1,6 @@ -store | Code Documentation

    Index

    Namespaces

    Type Aliases

    ColorSchemeType +store | Code Documentation

    Generated using TypeDoc

    \ No newline at end of file +

    Functions

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/store.useTheme.html b/docs/modules/store.useTheme.html deleted file mode 100644 index 93cd6f3f..00000000 --- a/docs/modules/store.useTheme.html +++ /dev/null @@ -1,5 +0,0 @@ -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 4b55427f..a08ef377 100644 --- a/docs/modules/utils.html +++ b/docs/modules/utils.html @@ -1,4 +1,4 @@ -utils | Code Documentation

    Index

    Functions

    getResolvedColorScheme +utils | Code Documentation

    Generated using TypeDoc

    \ No newline at end of file +

    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 25e0dd5a..f4e4f806 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
    ForcedPage: {
        pathMatcher: RegExp | string;
        props: {
            forcedColorScheme?: ColorSchemeType;
            forcedTheme?: string;
        };
    } | [pathMatcher: RegExp | string, themes: {
        colorScheme?: ColorSchemeType;
        theme?: string;
    }]

    Type declaration

    • pathMatcher: RegExp | string
    • props: {
          forcedColorScheme?: ColorSchemeType;
          forcedTheme?: string;
      }

    Generated using TypeDoc

    \ No newline at end of file +ForcedPage | Code Documentation
    ForcedPage: {
        pathMatcher: RegExp | string;
        props: {
            forcedColorScheme?: ColorSchemeType;
            forcedTheme?: string;
        };
    } | [pathMatcher: RegExp | string, themes: {
        colorScheme?: ColorSchemeType;
        theme?: string;
    }]

    Type declaration

    • pathMatcher: RegExp | string
    • props: {
          forcedColorScheme?: ColorSchemeType;
          forcedTheme?: string;
      }

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/store.ColorSchemeType.html b/docs/types/store.ColorSchemeType.html index f43cf165..c0f25af5 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

    Type alias ColorSchemeType

    ColorSchemeType: "" | "system" | "dark" | "light"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/store.ThemeStoreActionsType.html b/docs/types/store.ThemeStoreActionsType.html index b18d3d2a..3b707175 100644 --- a/docs/types/store.ThemeStoreActionsType.html +++ b/docs/types/store.ThemeStoreActionsType.html @@ -1 +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);
        setStorage: ((storage) => 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

    • setStorage: ((storage) => void)
        • (storage): void
        • Parameters

          • storage: StorageType

          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 +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);
        setStorage: ((storage) => 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

    • setStorage: ((storage) => void)
        • (storage): void
        • Parameters

          • storage: StorageType

          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 be7f8016..c01909fa 100644 --- a/docs/types/store.ThemeStoreType.html +++ b/docs/types/store.ThemeStoreType.html @@ -1 +1 @@ -ThemeStoreType | Code Documentation

    Type alias ThemeStoreType

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

    Type declaration

    • __persistNSyncOptions: PersistNSyncOptionsType
    • colorSchemePref: ColorSchemeType
    • darkTheme: string
    • Optional forcedColorScheme?: ColorSchemeType
    • Optional forcedTheme?: string
    • lightTheme: string
    • resolvedColorScheme: ColorSchemeType
    • resolvedTheme: string
    • theme: string

    Generated using TypeDoc

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

    Type alias ThemeStoreType

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

    Type declaration

    • __persistNSyncOptions: PersistNSyncOptionsType
    • colorSchemePref: ColorSchemeType
    • darkTheme: string
    • Optional forcedColorScheme?: ColorSchemeType
    • Optional forcedTheme?: string
    • lightTheme: string
    • resolvedColorScheme: ColorSchemeType
    • resolvedTheme: string
    • theme: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/store.initialState.html b/docs/variables/store.initialState.html index 7ef35c33..51fefde1 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

    Variable initialStateConst

    initialState: ThemeStoreType = ...

    Generated using TypeDoc

    \ No newline at end of file