diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/assets/highlight.css b/assets/highlight.css new file mode 100644 index 0000000..05e2efb --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,120 @@ +:root { + --light-hl-0: #AF00DB; + --dark-hl-0: #C586C0; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #001080; + --dark-hl-2: #9CDCFE; + --light-hl-3: #A31515; + --dark-hl-3: #CE9178; + --light-hl-4: #0000FF; + --dark-hl-4: #569CD6; + --light-hl-5: #795E26; + --dark-hl-5: #DCDCAA; + --light-hl-6: #800000; + --dark-hl-6: #808080; + --light-hl-7: #267F99; + --dark-hl-7: #4EC9B0; + --light-hl-8: #FF0000; + --dark-hl-8: #9CDCFE; + --light-hl-9: #008000; + --dark-hl-9: #6A9955; + --light-hl-10: #0070C1; + --dark-hl-10: #4FC1FF; + --light-hl-11: #000000FF; + --dark-hl-11: #D4D4D4; + --light-hl-12: #800000; + --dark-hl-12: #569CD6; + --light-hl-13: #098658; + --dark-hl-13: #B5CEA8; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +pre, code { background: var(--code-background); } diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 0000000..b949086 --- /dev/null +++ b/assets/main.js @@ -0,0 +1,54 @@ +"use strict"; +"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(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 h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}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(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+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),u=0;u1?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 ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function j(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r}),r.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends k{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{Ae(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"?fe(e,-1):s.key==="ArrowDown"?fe(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 He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function Ae(t,e,n,r){if(He(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${pe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function fe(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 pe(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(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",B="mouseup",Z={x:0,y:0},ge=!1,se=!1,je=!1,H=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(je=!0,F="touchstart",ye="touchmove",B="touchend");document.addEventListener(F,t=>{se=!0,H=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(!!se&&!H){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);H=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends k{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){H||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!H&&this.active&&n.target.closest(".col-menu")){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 oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends k{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()),Le.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),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 te=class extends k{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();j(X,".menu-highlight");j(K,"a[data-toggle]");j(te,".tsd-index-accordion");j(ee,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("theme");Se&&be(Se);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); +/*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + */ +/*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */ diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 0000000..71b4a9c --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":2,\"name\":\"@croz/nrich-form-configuration-core\",\"url\":\"modules/_croz_nrich_form_configuration_core.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":2,\"name\":\"@croz/nrich-notification-core\",\"url\":\"modules/_croz_nrich_notification_core.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":2,\"name\":\"@croz/nrich-notification-mui\",\"url\":\"modules/_croz_nrich_notification_mui.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":256,\"name\":\"FormConfiguration\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.FormConfiguration.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":1024,\"name\":\"formId\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.FormConfiguration.html#formId\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfiguration\"},{\"kind\":1024,\"name\":\"constrainedPropertyConfigurationList\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.FormConfiguration.html#constrainedPropertyConfigurationList\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfiguration\"},{\"kind\":256,\"name\":\"FormYupConfiguration\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.FormYupConfiguration.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":1024,\"name\":\"formId\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.FormYupConfiguration.html#formId\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.FormYupConfiguration\"},{\"kind\":1024,\"name\":\"yupSchema\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.FormYupConfiguration.html#yupSchema\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.FormYupConfiguration\"},{\"kind\":256,\"name\":\"ConstrainedPropertyConfiguration\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyConfiguration.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":1024,\"name\":\"path\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyConfiguration.html#path\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.ConstrainedPropertyConfiguration\"},{\"kind\":1024,\"name\":\"propertyType\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyConfiguration.html#propertyType\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.ConstrainedPropertyConfiguration\"},{\"kind\":1024,\"name\":\"javascriptType\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyConfiguration.html#javascriptType\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.ConstrainedPropertyConfiguration\"},{\"kind\":1024,\"name\":\"validatorList\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyConfiguration.html#validatorList\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.ConstrainedPropertyConfiguration\"},{\"kind\":256,\"name\":\"ConstrainedPropertyClientValidatorConfiguration\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyClientValidatorConfiguration.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyClientValidatorConfiguration.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.ConstrainedPropertyClientValidatorConfiguration\"},{\"kind\":1024,\"name\":\"argumentMap\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyClientValidatorConfiguration.html#argumentMap\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.ConstrainedPropertyClientValidatorConfiguration\"},{\"kind\":1024,\"name\":\"errorMessage\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyClientValidatorConfiguration.html#errorMessage\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.ConstrainedPropertyClientValidatorConfiguration\"},{\"kind\":256,\"name\":\"ValidatorConverter\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ValidatorConverter.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":2048,\"name\":\"supports\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ValidatorConverter.html#supports\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.ValidatorConverter\"},{\"kind\":2048,\"name\":\"convert\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.ValidatorConverter.html#convert\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.ValidatorConverter\"},{\"kind\":256,\"name\":\"FormConfigurationConfiguration\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.FormConfigurationConfiguration.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":1024,\"name\":\"url\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.FormConfigurationConfiguration.html#url\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationConfiguration\"},{\"kind\":1024,\"name\":\"requestOptionsResolver\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.FormConfigurationConfiguration.html#requestOptionsResolver\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationConfiguration\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.FormConfigurationConfiguration.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationConfiguration\"},{\"kind\":1024,\"name\":\"additionalValidatorConverters\",\"url\":\"interfaces/_croz_nrich_form_configuration_core.FormConfigurationConfiguration.html#additionalValidatorConverters\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationConfiguration\"},{\"kind\":4194304,\"name\":\"FormConfigurationOptions\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationOptions\"},{\"kind\":1024,\"name\":\"formYupConfigurations\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html#__type.formYupConfigurations\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationOptions.__type\"},{\"kind\":1024,\"name\":\"formConfigurationLoaded\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html#__type.formConfigurationLoaded\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationOptions.__type\"},{\"kind\":1024,\"name\":\"set\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html#__type.set\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html#__type.__type-5\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationOptions.__type\"},{\"kind\":1024,\"name\":\"add\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html#__type.add\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationOptions.__type\"},{\"kind\":1024,\"name\":\"remove\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html#__type.remove\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html#__type.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationOptions.__type\"},{\"kind\":1024,\"name\":\"setFormConfigurationLoaded\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html#__type.setFormConfigurationLoaded\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html#__type.__type-7\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-form-configuration-core.FormConfigurationOptions.__type\"},{\"kind\":4194304,\"name\":\"UseFormConfiguration\",\"url\":\"types/_croz_nrich_form_configuration_core.UseFormConfiguration.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_croz_nrich_form_configuration_core.UseFormConfiguration.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"@croz/nrich-form-configuration-core.UseFormConfiguration\"},{\"kind\":64,\"name\":\"useFormConfiguration\",\"url\":\"functions/_croz_nrich_form_configuration_core.useFormConfiguration-1.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":64,\"name\":\"useYupFormConfiguration\",\"url\":\"functions/_croz_nrich_form_configuration_core.useYupFormConfiguration.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":4194304,\"name\":\"Props\",\"url\":\"types/_croz_nrich_form_configuration_core.Props.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":64,\"name\":\"FormConfigurationProvider\",\"url\":\"functions/_croz_nrich_form_configuration_core.FormConfigurationProvider.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"@croz/nrich-form-configuration-core\"},{\"kind\":4194304,\"name\":\"NotificationSeverity\",\"url\":\"types/_croz_nrich_notification_core.NotificationSeverity.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-core\"},{\"kind\":256,\"name\":\"Notification\",\"url\":\"interfaces/_croz_nrich_notification_core.Notification.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-core\"},{\"kind\":1024,\"name\":\"title\",\"url\":\"interfaces/_croz_nrich_notification_core.Notification.html#title\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-notification-core.Notification\"},{\"kind\":1024,\"name\":\"content\",\"url\":\"interfaces/_croz_nrich_notification_core.Notification.html#content\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-notification-core.Notification\"},{\"kind\":1024,\"name\":\"messageList\",\"url\":\"interfaces/_croz_nrich_notification_core.Notification.html#messageList\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-notification-core.Notification\"},{\"kind\":1024,\"name\":\"severity\",\"url\":\"interfaces/_croz_nrich_notification_core.Notification.html#severity\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-notification-core.Notification\"},{\"kind\":1024,\"name\":\"uxNotificationOptions\",\"url\":\"interfaces/_croz_nrich_notification_core.Notification.html#uxNotificationOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-notification-core.Notification\"},{\"kind\":1024,\"name\":\"timestamp\",\"url\":\"interfaces/_croz_nrich_notification_core.Notification.html#timestamp\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-notification-core.Notification\"},{\"kind\":256,\"name\":\"NotificationResponse\",\"url\":\"interfaces/_croz_nrich_notification_core.NotificationResponse.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-core\"},{\"kind\":1024,\"name\":\"notification\",\"url\":\"interfaces/_croz_nrich_notification_core.NotificationResponse.html#notification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-notification-core.NotificationResponse\"},{\"kind\":64,\"name\":\"fetchNotificationInterceptor\",\"url\":\"functions/_croz_nrich_notification_core.fetchNotificationInterceptor.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-core\"},{\"kind\":64,\"name\":\"xhrNotificationInterceptor\",\"url\":\"functions/_croz_nrich_notification_core.xhrNotificationInterceptor.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-core\"},{\"kind\":4194304,\"name\":\"NotificationOptions\",\"url\":\"types/_croz_nrich_notification_core.NotificationOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-core\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_croz_nrich_notification_core.NotificationOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"@croz/nrich-notification-core.NotificationOptions\"},{\"kind\":1024,\"name\":\"notifications\",\"url\":\"types/_croz_nrich_notification_core.NotificationOptions.html#__type.notifications\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-notification-core.NotificationOptions.__type\"},{\"kind\":1024,\"name\":\"add\",\"url\":\"types/_croz_nrich_notification_core.NotificationOptions.html#__type.add\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-notification-core.NotificationOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_croz_nrich_notification_core.NotificationOptions.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-notification-core.NotificationOptions.__type\"},{\"kind\":1024,\"name\":\"remove\",\"url\":\"types/_croz_nrich_notification_core.NotificationOptions.html#__type.remove\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-notification-core.NotificationOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_croz_nrich_notification_core.NotificationOptions.html#__type.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"@croz/nrich-notification-core.NotificationOptions.__type\"},{\"kind\":4194304,\"name\":\"UseNotifications\",\"url\":\"types/_croz_nrich_notification_core.UseNotifications.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-core\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/_croz_nrich_notification_core.UseNotifications.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"@croz/nrich-notification-core.UseNotifications\"},{\"kind\":64,\"name\":\"useNotifications\",\"url\":\"functions/_croz_nrich_notification_core.useNotifications-1.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-core\"},{\"kind\":4194304,\"name\":\"NotificationPosition\",\"url\":\"types/_croz_nrich_notification_mui.NotificationPosition.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-mui\"},{\"kind\":4194304,\"name\":\"NotificationOrigin\",\"url\":\"types/_croz_nrich_notification_mui.NotificationOrigin.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-mui\"},{\"kind\":256,\"name\":\"NotificationsProviderProps\",\"url\":\"interfaces/_croz_nrich_notification_mui.NotificationsProviderProps.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-mui\"},{\"kind\":1024,\"name\":\"autoClose\",\"url\":\"interfaces/_croz_nrich_notification_mui.NotificationsProviderProps.html#autoClose\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-notification-mui.NotificationsProviderProps\"},{\"kind\":1024,\"name\":\"position\",\"url\":\"interfaces/_croz_nrich_notification_mui.NotificationsProviderProps.html#position\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@croz/nrich-notification-mui.NotificationsProviderProps\"},{\"kind\":64,\"name\":\"Notifications\",\"url\":\"functions/_croz_nrich_notification_mui.Notifications.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"@croz/nrich-notification-mui\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,14.588,1,18.657,2,18.657,3,16.204]],[\"comment/0\",[]],[\"name/1\",[0,17.77,3,19.738,4,16.3]],[\"comment/1\",[]],[\"name/2\",[0,17.77,4,16.3,5,22.727]],[\"comment/2\",[]],[\"name/3\",[6,40.311]],[\"comment/3\",[]],[\"name/4\",[7,35.011]],[\"comment/4\",[]],[\"name/5\",[8,40.311]],[\"comment/5\",[]],[\"name/6\",[9,40.311]],[\"comment/6\",[]],[\"name/7\",[7,35.011]],[\"comment/7\",[]],[\"name/8\",[10,40.311]],[\"comment/8\",[]],[\"name/9\",[11,40.311]],[\"comment/9\",[]],[\"name/10\",[12,40.311]],[\"comment/10\",[]],[\"name/11\",[13,40.311]],[\"comment/11\",[]],[\"name/12\",[14,40.311]],[\"comment/12\",[]],[\"name/13\",[15,40.311]],[\"comment/13\",[]],[\"name/14\",[16,40.311]],[\"comment/14\",[]],[\"name/15\",[17,40.311]],[\"comment/15\",[]],[\"name/16\",[18,40.311]],[\"comment/16\",[]],[\"name/17\",[19,40.311]],[\"comment/17\",[]],[\"name/18\",[20,40.311]],[\"comment/18\",[]],[\"name/19\",[21,40.311]],[\"comment/19\",[]],[\"name/20\",[22,40.311]],[\"comment/20\",[]],[\"name/21\",[23,40.311]],[\"comment/21\",[]],[\"name/22\",[24,40.311]],[\"comment/22\",[]],[\"name/23\",[25,40.311]],[\"comment/23\",[]],[\"name/24\",[26,19.176]],[\"comment/24\",[]],[\"name/25\",[27,40.311]],[\"comment/25\",[]],[\"name/26\",[28,40.311]],[\"comment/26\",[]],[\"name/27\",[26,19.176]],[\"comment/27\",[]],[\"name/28\",[29,40.311]],[\"comment/28\",[]],[\"name/29\",[30,40.311]],[\"comment/29\",[]],[\"name/30\",[31,40.311]],[\"comment/30\",[]],[\"name/31\",[26,19.176]],[\"comment/31\",[]],[\"name/32\",[32,35.011]],[\"comment/32\",[]],[\"name/33\",[26,19.176]],[\"comment/33\",[]],[\"name/34\",[33,35.011]],[\"comment/34\",[]],[\"name/35\",[26,19.176]],[\"comment/35\",[]],[\"name/36\",[34,40.311]],[\"comment/36\",[]],[\"name/37\",[26,19.176]],[\"comment/37\",[]],[\"name/38\",[35,35.011]],[\"comment/38\",[]],[\"name/39\",[26,19.176]],[\"comment/39\",[]],[\"name/40\",[35,35.011]],[\"comment/40\",[]],[\"name/41\",[36,40.311]],[\"comment/41\",[]],[\"name/42\",[37,40.311]],[\"comment/42\",[]],[\"name/43\",[38,40.311]],[\"comment/43\",[]],[\"name/44\",[39,40.311]],[\"comment/44\",[]],[\"name/45\",[4,28.912]],[\"comment/45\",[]],[\"name/46\",[40,40.311]],[\"comment/46\",[]],[\"name/47\",[41,40.311]],[\"comment/47\",[]],[\"name/48\",[42,40.311]],[\"comment/48\",[]],[\"name/49\",[43,40.311]],[\"comment/49\",[]],[\"name/50\",[44,40.311]],[\"comment/50\",[]],[\"name/51\",[45,40.311]],[\"comment/51\",[]],[\"name/52\",[46,40.311]],[\"comment/52\",[]],[\"name/53\",[4,28.912]],[\"comment/53\",[]],[\"name/54\",[47,40.311]],[\"comment/54\",[]],[\"name/55\",[48,40.311]],[\"comment/55\",[]],[\"name/56\",[49,40.311]],[\"comment/56\",[]],[\"name/57\",[26,19.176]],[\"comment/57\",[]],[\"name/58\",[50,35.011]],[\"comment/58\",[]],[\"name/59\",[32,35.011]],[\"comment/59\",[]],[\"name/60\",[26,19.176]],[\"comment/60\",[]],[\"name/61\",[33,35.011]],[\"comment/61\",[]],[\"name/62\",[26,19.176]],[\"comment/62\",[]],[\"name/63\",[51,35.011]],[\"comment/63\",[]],[\"name/64\",[26,19.176]],[\"comment/64\",[]],[\"name/65\",[51,35.011]],[\"comment/65\",[]],[\"name/66\",[52,40.311]],[\"comment/66\",[]],[\"name/67\",[53,40.311]],[\"comment/67\",[]],[\"name/68\",[54,40.311]],[\"comment/68\",[]],[\"name/69\",[55,40.311]],[\"comment/69\",[]],[\"name/70\",[56,40.311]],[\"comment/70\",[]],[\"name/71\",[50,35.011]],[\"comment/71\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":26,\"name\":{\"24\":{},\"27\":{},\"31\":{},\"33\":{},\"35\":{},\"37\":{},\"39\":{},\"57\":{},\"60\":{},\"62\":{},\"64\":{}},\"comment\":{}}],[\"add\",{\"_index\":32,\"name\":{\"32\":{},\"59\":{}},\"comment\":{}}],[\"additionalvalidatorconverters\",{\"_index\":27,\"name\":{\"25\":{}},\"comment\":{}}],[\"argumentmap\",{\"_index\":18,\"name\":{\"16\":{}},\"comment\":{}}],[\"autoclose\",{\"_index\":55,\"name\":{\"69\":{}},\"comment\":{}}],[\"configuration\",{\"_index\":2,\"name\":{\"0\":{}},\"comment\":{}}],[\"constrainedpropertyclientvalidatorconfiguration\",{\"_index\":16,\"name\":{\"14\":{}},\"comment\":{}}],[\"constrainedpropertyconfiguration\",{\"_index\":11,\"name\":{\"9\":{}},\"comment\":{}}],[\"constrainedpropertyconfigurationlist\",{\"_index\":8,\"name\":{\"5\":{}},\"comment\":{}}],[\"content\",{\"_index\":41,\"name\":{\"47\":{}},\"comment\":{}}],[\"convert\",{\"_index\":22,\"name\":{\"20\":{}},\"comment\":{}}],[\"core\",{\"_index\":3,\"name\":{\"0\":{},\"1\":{}},\"comment\":{}}],[\"croz/nrich\",{\"_index\":0,\"name\":{\"0\":{},\"1\":{},\"2\":{}},\"comment\":{}}],[\"errormessage\",{\"_index\":19,\"name\":{\"17\":{}},\"comment\":{}}],[\"fetchnotificationinterceptor\",{\"_index\":47,\"name\":{\"54\":{}},\"comment\":{}}],[\"form\",{\"_index\":1,\"name\":{\"0\":{}},\"comment\":{}}],[\"formconfiguration\",{\"_index\":6,\"name\":{\"3\":{}},\"comment\":{}}],[\"formconfigurationconfiguration\",{\"_index\":23,\"name\":{\"21\":{}},\"comment\":{}}],[\"formconfigurationloaded\",{\"_index\":30,\"name\":{\"29\":{}},\"comment\":{}}],[\"formconfigurationoptions\",{\"_index\":28,\"name\":{\"26\":{}},\"comment\":{}}],[\"formconfigurationprovider\",{\"_index\":38,\"name\":{\"43\":{}},\"comment\":{}}],[\"formid\",{\"_index\":7,\"name\":{\"4\":{},\"7\":{}},\"comment\":{}}],[\"formyupconfiguration\",{\"_index\":9,\"name\":{\"6\":{}},\"comment\":{}}],[\"formyupconfigurations\",{\"_index\":29,\"name\":{\"28\":{}},\"comment\":{}}],[\"javascripttype\",{\"_index\":14,\"name\":{\"12\":{}},\"comment\":{}}],[\"messagelist\",{\"_index\":42,\"name\":{\"48\":{}},\"comment\":{}}],[\"mui\",{\"_index\":5,\"name\":{\"2\":{}},\"comment\":{}}],[\"name\",{\"_index\":17,\"name\":{\"15\":{}},\"comment\":{}}],[\"notification\",{\"_index\":4,\"name\":{\"1\":{},\"2\":{},\"45\":{},\"53\":{}},\"comment\":{}}],[\"notificationoptions\",{\"_index\":49,\"name\":{\"56\":{}},\"comment\":{}}],[\"notificationorigin\",{\"_index\":53,\"name\":{\"67\":{}},\"comment\":{}}],[\"notificationposition\",{\"_index\":52,\"name\":{\"66\":{}},\"comment\":{}}],[\"notificationresponse\",{\"_index\":46,\"name\":{\"52\":{}},\"comment\":{}}],[\"notifications\",{\"_index\":50,\"name\":{\"58\":{},\"71\":{}},\"comment\":{}}],[\"notificationseverity\",{\"_index\":39,\"name\":{\"44\":{}},\"comment\":{}}],[\"notificationsproviderprops\",{\"_index\":54,\"name\":{\"68\":{}},\"comment\":{}}],[\"path\",{\"_index\":12,\"name\":{\"10\":{}},\"comment\":{}}],[\"position\",{\"_index\":56,\"name\":{\"70\":{}},\"comment\":{}}],[\"propertytype\",{\"_index\":13,\"name\":{\"11\":{}},\"comment\":{}}],[\"props\",{\"_index\":37,\"name\":{\"42\":{}},\"comment\":{}}],[\"remove\",{\"_index\":33,\"name\":{\"34\":{},\"61\":{}},\"comment\":{}}],[\"requestoptionsresolver\",{\"_index\":25,\"name\":{\"23\":{}},\"comment\":{}}],[\"set\",{\"_index\":31,\"name\":{\"30\":{}},\"comment\":{}}],[\"setformconfigurationloaded\",{\"_index\":34,\"name\":{\"36\":{}},\"comment\":{}}],[\"severity\",{\"_index\":43,\"name\":{\"49\":{}},\"comment\":{}}],[\"supports\",{\"_index\":21,\"name\":{\"19\":{}},\"comment\":{}}],[\"timestamp\",{\"_index\":45,\"name\":{\"51\":{}},\"comment\":{}}],[\"title\",{\"_index\":40,\"name\":{\"46\":{}},\"comment\":{}}],[\"url\",{\"_index\":24,\"name\":{\"22\":{}},\"comment\":{}}],[\"useformconfiguration\",{\"_index\":35,\"name\":{\"38\":{},\"40\":{}},\"comment\":{}}],[\"usenotifications\",{\"_index\":51,\"name\":{\"63\":{},\"65\":{}},\"comment\":{}}],[\"useyupformconfiguration\",{\"_index\":36,\"name\":{\"41\":{}},\"comment\":{}}],[\"uxnotificationoptions\",{\"_index\":44,\"name\":{\"50\":{}},\"comment\":{}}],[\"validatorconverter\",{\"_index\":20,\"name\":{\"18\":{}},\"comment\":{}}],[\"validatorlist\",{\"_index\":15,\"name\":{\"13\":{}},\"comment\":{}}],[\"xhrnotificationinterceptor\",{\"_index\":48,\"name\":{\"55\":{}},\"comment\":{}}],[\"yupschema\",{\"_index\":10,\"name\":{\"8\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 0000000..e509385 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1257 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-text: #222; + --light-color-text-aside: #707070; + --light-color-link: #4da6ff; + --light-color-ts: #db1373; + --light-color-ts-interface: #139d2c; + --light-color-ts-enum: #9c891a; + --light-color-ts-class: #2484e5; + --light-color-ts-function: #572be7; + --light-color-ts-namespace: #b111c9; + --light-color-ts-private: #707070; + --light-color-ts-variable: #4d68ff; + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + --dark-color-ts: #ff6492; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-class: #61b0ff; + --dark-color-ts-function: #9772ff; + --dark-color-ts-namespace: #e14dff; + --dark-color-ts-private: #e2e2e2; + --dark-color-ts-variable: #4d68ff; + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-function: var(--light-color-ts-function); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-private: var(--light-color-ts-private); + --color-ts-variable: var(--light-color-ts-variable); + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-private: var(--dark-color-ts-private); + --color-ts-variable: var(--dark-color-ts-variable); + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-function: var(--light-color-ts-function); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-private: var(--light-color-ts-private); + --color-ts-variable: var(--light-color-ts-variable); + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-private: var(--dark-color-ts-private); + --color-ts-variable: var(--dark-color-ts-variable); + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1600px; + padding: 0 2rem; +} + +@media (min-width: 640px) { + .container { + padding: 0 4rem; + } +} +@media (min-width: 1200px) { + .container { + padding: 0 8rem; + } +} +@media (min-width: 1600px) { + .container { + padding: 0 12rem; + } +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + display: flex; + justify-content: space-between; + position: relative; + margin: 0 auto; +} + +.col-4, +.col-8 { + box-sizing: border-box; + float: left; + padding: 2rem 1rem; +} + +.col-4 { + flex: 0 0 25%; +} +.col-8 { + flex: 1 0; + flex-wrap: wrap; + padding-left: 0; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + padding: 10px; + border: 0.1em solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +@media (max-width: 1024px) { + html .col-content { + float: none; + max-width: 100%; + width: 100%; + padding-top: 3rem; + } + html .col-menu { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + max-width: 25rem; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-menu > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu :is(header, footer, .col-content) { + animation: shift-to-left 0.4s; + } + + .to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu :is(header, footer, .col-content) { + animation: unshift-to-left 0.4s; + } + + .from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu :is(header, footer, .col-content) { + transform: translate(-25%, 0); + } + .has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + display: grid; + align-items: center; + grid-template-rows: auto 1fr; + grid-gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel a.tsd-parent-kind-module { + color: var(--color-ts); +} +.tsd-index-panel a.tsd-parent-kind-interface { + color: var(--color-ts-interface); +} +.tsd-index-panel a.tsd-parent-kind-enum { + color: var(--color-ts-enum); +} +.tsd-index-panel a.tsd-parent-kind-class { + color: var(--color-ts-class); +} +.tsd-index-panel a.tsd-kind-module { + color: var(--color-ts-namespace); +} +.tsd-index-panel a.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-index-panel a.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-index-panel a.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-index-panel a.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-index-panel a.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-index-panel a.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-index-panel a.tsd-is-private { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member [data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member [data-tsd-kind="Interface"] { + color: var(--color-ts-interface); +} +.tsd-member [data-tsd-kind="Enum"] { + color: var(--color-ts-enum); +} +.tsd-member [data-tsd-kind="Class"] { + color: var(--color-ts-class); +} +.tsd-member [data-tsd-kind="Private"] { + color: var(--color-ts-private); +} + +.tsd-navigation a { + display: block; + margin: 0.4rem 0; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary .tsd-accordion-details > ul { + margin-top: 0.75rem; +} +.tsd-navigation.primary a { + padding: 0.75rem 0.5rem; + margin: 0; +} +.tsd-navigation.primary ul li a { + margin-left: 0.5rem; +} +.tsd-navigation.primary ul li li a { + margin-left: 1.5rem; +} +.tsd-navigation.primary ul li li li a { + margin-left: 2.5rem; +} +.tsd-navigation.primary ul li li li li a { + margin-left: 3.5rem; +} +.tsd-navigation.primary ul li li li li li a { + margin-left: 4.5rem; +} +.tsd-navigation.primary ul li li li li li li a { + margin-left: 5.5rem; +} +.tsd-navigation.primary li.current > a { + border-left: 0.15rem var(--color-text) solid; +} +.tsd-navigation.primary li.selected > a { + font-weight: bold; + border-left: 0.2rem var(--color-text) solid; +} +.tsd-navigation.primary ul li a:hover { + border-left: 0.2rem var(--color-text-aside) solid; +} +.tsd-navigation.primary li.globals + li > span, +.tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary > ul { + display: inline; + padding-right: 0.5rem; + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 0; +} +.tsd-navigation.secondary ul li li a { + padding-left: 1.1rem; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 2.2rem; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 3.3rem; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 4.4rem; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 5.5rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + margin: 0.25rem 0; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; +} +.tsd-accordion-summary > h1, +.tsd-accordion-summary > h2, +.tsd-accordion-summary > h3, +.tsd-accordion-summary > h4, +.tsd-accordion-summary > h5 { + display: inline-flex; + align-items: center; + vertical-align: middle; + margin-bottom: 0; + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; +} +.tsd-accordion-summary { + display: block; + cursor: pointer; +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; +} +.tsd-index-accordion .tsd-accordion-summary svg { + margin-right: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +@media (min-width: 1024px) { + .col-content { + margin: 2rem auto; + } + + .menu-sticky-wrap { + position: sticky; + height: calc(100vh - 2rem); + top: 4rem; + right: 0; + padding: 0 1.5rem; + padding-top: 1rem; + margin-top: 3rem; + transition: 0.3s ease-in-out; + transition-property: top, padding-top, padding, height; + overflow-y: auto; + } + .col-menu { + border-left: 1px solid var(--color-accent); + } + .col-menu--hide { + top: 1rem; + } + .col-menu .tsd-navigation:not(:last-child) { + padding-bottom: 1.75rem; + } +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +@media (max-width: 1024px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through; +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} diff --git a/functions/_croz_nrich_form_configuration_core.FormConfigurationProvider.html b/functions/_croz_nrich_form_configuration_core.FormConfigurationProvider.html new file mode 100644 index 0000000..ed804ed --- /dev/null +++ b/functions/_croz_nrich_form_configuration_core.FormConfigurationProvider.html @@ -0,0 +1,73 @@ +FormConfigurationProvider | nrich-frontend
+
+ +
+
+
+
+ +

Function FormConfigurationProvider

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/_croz_nrich_form_configuration_core.useFormConfiguration-1.html b/functions/_croz_nrich_form_configuration_core.useFormConfiguration-1.html new file mode 100644 index 0000000..6648240 --- /dev/null +++ b/functions/_croz_nrich_form_configuration_core.useFormConfiguration-1.html @@ -0,0 +1,71 @@ +useFormConfiguration | nrich-frontend
+
+ +
+
+
+
+ +

Function useFormConfiguration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/_croz_nrich_form_configuration_core.useYupFormConfiguration.html b/functions/_croz_nrich_form_configuration_core.useYupFormConfiguration.html new file mode 100644 index 0000000..aacaff6 --- /dev/null +++ b/functions/_croz_nrich_form_configuration_core.useYupFormConfiguration.html @@ -0,0 +1,83 @@ +useYupFormConfiguration | nrich-frontend
+
+ +
+
+
+
+ +

Function useYupFormConfiguration

+
+
    + +
  • +

    A hook which extracts a specific Yup configuration from the form configuration identified by the form id. +Uses the internal useFormConfigurationStore hook for managing the form configuration state.

    + +

    Returns

    Mapped Yup configuration from the form configuration identified by the form id, or undefined if no matching form configuration is found.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends Record<string, any> = any

    +
    +

    Parameters

    +
      +
    • +
      formId: string
      +

      Registered form id for a specific form configuration.

      +
    +

    Returns default<T, AnyObject, TypeOfShape<T>, AssertsShape<T> | Extract<TypeOfShape<T>, null>>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/_croz_nrich_notification_core.fetchNotificationInterceptor.html b/functions/_croz_nrich_notification_core.fetchNotificationInterceptor.html new file mode 100644 index 0000000..1f75e00 --- /dev/null +++ b/functions/_croz_nrich_notification_core.fetchNotificationInterceptor.html @@ -0,0 +1,67 @@ +fetchNotificationInterceptor | nrich-frontend
+
+ +
+
+
+
+ +

Function fetchNotificationInterceptor

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/_croz_nrich_notification_core.useNotifications-1.html b/functions/_croz_nrich_notification_core.useNotifications-1.html new file mode 100644 index 0000000..2430cf3 --- /dev/null +++ b/functions/_croz_nrich_notification_core.useNotifications-1.html @@ -0,0 +1,67 @@ +useNotifications | nrich-frontend
+
+ +
+
+
+
+ +

Function useNotifications

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/_croz_nrich_notification_core.xhrNotificationInterceptor.html b/functions/_croz_nrich_notification_core.xhrNotificationInterceptor.html new file mode 100644 index 0000000..277b85b --- /dev/null +++ b/functions/_croz_nrich_notification_core.xhrNotificationInterceptor.html @@ -0,0 +1,67 @@ +xhrNotificationInterceptor | nrich-frontend
+
+ +
+
+
+
+ +

Function xhrNotificationInterceptor

+
+
    + +
  • +

    XHR interceptor which listens for the response to be acquired +and checks whether the response matches the proposed notification format.

    + +

    Returns

    A function which can be called to register the interceptor.

    +
    +

    Returns void

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/_croz_nrich_notification_mui.Notifications.html b/functions/_croz_nrich_notification_mui.Notifications.html new file mode 100644 index 0000000..454fc1b --- /dev/null +++ b/functions/_croz_nrich_notification_mui.Notifications.html @@ -0,0 +1,67 @@ +Notifications | nrich-frontend
+
+ +
+
+
+
+ +

Function Notifications

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..05e37c0 --- /dev/null +++ b/index.html @@ -0,0 +1,108 @@ +nrich-frontend
+
+ +
+
+
+
+

nrich-frontend

+

Build +codecov.io +Documentation +License

+

npm (scoped) +npm (scoped) +npm (scoped)

+ + +

nrich-frontend

+ +

React monorepo providing bindings to simplify the integration with nrich libraries.

+

The overall project is built on top of the concept of Yarn workspaces using Turborepo as a build management system.

+

For the demonstration of the integrations provided here, please visit the nrich-demo-frontend +repository.

+ + +

Workspace/module overview

+ +

Workspace is divided in config and libs subcategories. +config contains common configuration used throughout the libs implementations.

+

libs contains implementation of specific modules separated in two categories. First is a core module which contains common logic +and custom hooks for the module. Second are adapters for specific UI component library, currently only mui.

+

The following workspaces/modules are available:

+ + + +

Development of new modules

+ +

When developing a new module, the workspaces are to be organized as in the example:

+
    +
  • libs/foo-core, where foo is the name of the module matching the naming conventions of the complementary backend module
    • +
  • libs/foo-bar, where foo is the name of the module matching the naming conventions of the complementary backend module, and bar +is the name of the UI component library
    • +
+ + +

Common commands

+ + + +

Build

+ +

To build all modules, run yarn build.

+

To build specific module(s), run yarn build -filter=foo, where foo is the workspace name (e.g. @croz/nrich-notification-core). +This specific command receives a variable number of arguments.

+ + +

Clean

+ +

To clean build artifacts, run yarn clean.

+ + +

Lint

+ +

To execute the linting process in a read-only mode (without actually affecting the files), run yarn lint.

+

To automatically apply changes, run yarn lint --fix.

+ + +

Test

+ +

To run tests, use yarn test.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyClientValidatorConfiguration.html b/interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyClientValidatorConfiguration.html new file mode 100644 index 0000000..679d0f3 --- /dev/null +++ b/interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyClientValidatorConfiguration.html @@ -0,0 +1,92 @@ +ConstrainedPropertyClientValidatorConfiguration | nrich-frontend
+
+ +
+
+
+
+ +

Interface ConstrainedPropertyClientValidatorConfiguration

+
+

Hierarchy

+
    +
  • ConstrainedPropertyClientValidatorConfiguration
+
+
+
+ +
+
+

Properties

+
argumentMap +errorMessage +name +
+
+

Properties

+
+

argumentMap

+
argumentMap: Record<string, unknown>
+

Constraint arguments as a map.

+
+
+

errorMessage

+
errorMessage: string
+

Error message that should be shown if validation fails.

+
+
+

name

+
name: string
+

Constraint name (i.e. NotNull).

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyConfiguration.html b/interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyConfiguration.html new file mode 100644 index 0000000..3a37f04 --- /dev/null +++ b/interfaces/_croz_nrich_form_configuration_core.ConstrainedPropertyConfiguration.html @@ -0,0 +1,101 @@ +ConstrainedPropertyConfiguration | nrich-frontend
+
+ +
+
+
+
+ +

Interface ConstrainedPropertyConfiguration

+
+

Hierarchy

+
    +
  • ConstrainedPropertyConfiguration
+
+
+
+ +
+
+

Properties

+
javascriptType +path +propertyType +validatorList +
+
+

Properties

+
+

javascriptType

+
javascriptType: string
+

JavascriptType of constrained property.

+
+
+

path

+
path: string
+

Path to the property relative to a parent class that is mapped to form id.

+
+
+

propertyType

+
propertyType: string
+

Type of constrained property.

+
+
+

validatorList

+
validatorList: ConstrainedPropertyClientValidatorConfiguration[]
+

List of ConstrainedPropertyClientValidatorConfiguration instances that hold client side validation configuration.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/_croz_nrich_form_configuration_core.FormConfiguration.html b/interfaces/_croz_nrich_form_configuration_core.FormConfiguration.html new file mode 100644 index 0000000..ebfb9f8 --- /dev/null +++ b/interfaces/_croz_nrich_form_configuration_core.FormConfiguration.html @@ -0,0 +1,83 @@ +FormConfiguration | nrich-frontend
+
+ +
+
+
+
+ +

Interface FormConfiguration

+
+

Hierarchy

+
    +
  • FormConfiguration
+
+
+
+ +
+
+

Properties

+
constrainedPropertyConfigurationList +formId +
+
+

Properties

+
+

constrainedPropertyConfigurationList

+
constrainedPropertyConfigurationList: ConstrainedPropertyConfiguration[]
+

List of ConstrainedPropertyConfiguration instances holding property configuration for each property defined in the class that form id was mapped to.

+
+
+

formId

+
formId: string
+

Registered form id for this form configuration.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/_croz_nrich_form_configuration_core.FormConfigurationConfiguration.html b/interfaces/_croz_nrich_form_configuration_core.FormConfigurationConfiguration.html new file mode 100644 index 0000000..89c8bf2 --- /dev/null +++ b/interfaces/_croz_nrich_form_configuration_core.FormConfigurationConfiguration.html @@ -0,0 +1,100 @@ +FormConfigurationConfiguration | nrich-frontend
+
+ +
+
+
+
+ +

Interface FormConfigurationConfiguration

+
+

Hierarchy

+
    +
  • FormConfigurationConfiguration
+
+
+
+ +
+
+

Properties

+
additionalValidatorConverters? +requestOptionsResolver? +url? +
+
+

Properties

+
+

Optional additionalValidatorConverters

+
additionalValidatorConverters?: ValidatorConverter[]
+

Additional converters to use for custom constraints.

+
+
+

Optional requestOptionsResolver

+
requestOptionsResolver?: (() => RequestInit)
+
+

Type declaration

+
    +
  • +
      +
    • (): RequestInit
      • +
    • +

      Additional configuration options to send with fetch request i.e. if some authentication information is required.

      +
      +

      Returns RequestInit

+
+

Optional url

+
url?: string
+

Url where to fetch configuration from. It represents the part of the path till /fetch-all.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/_croz_nrich_form_configuration_core.FormYupConfiguration.html b/interfaces/_croz_nrich_form_configuration_core.FormYupConfiguration.html new file mode 100644 index 0000000..d869e60 --- /dev/null +++ b/interfaces/_croz_nrich_form_configuration_core.FormYupConfiguration.html @@ -0,0 +1,88 @@ +FormYupConfiguration | nrich-frontend
+
+ +
+
+
+
+ +

Interface FormYupConfiguration<T>

+
+

Type Parameters

+
    +
  • +

    T extends Record<string, never> = any

+
+

Hierarchy

+
    +
  • FormYupConfiguration
+
+
+
+ +
+
+

Properties

+
formId +yupSchema +
+
+

Properties

+
+

formId

+
formId: string
+

Registered form id for this form configuration.

+
+
+

yupSchema

+
yupSchema: default<T, AnyObject, TypeOfShape<T>, AssertsShape<T> | Extract<TypeOfShape<T>, null>>
+

List of yup ObjectSchema instances holding property configuration for each property defined in the class that form id was mapped to.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/_croz_nrich_form_configuration_core.ValidatorConverter.html b/interfaces/_croz_nrich_form_configuration_core.ValidatorConverter.html new file mode 100644 index 0000000..fe5cd50 --- /dev/null +++ b/interfaces/_croz_nrich_form_configuration_core.ValidatorConverter.html @@ -0,0 +1,107 @@ +ValidatorConverter | nrich-frontend
+
+ +
+
+
+
+ +

Interface ValidatorConverter

+
+

Hierarchy

+
    +
  • ValidatorConverter
+
+
+
+ +
+
+

Methods

+
convert +supports +
+
+

Methods

+
+

convert

+
+
+

supports

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/_croz_nrich_notification_core.Notification.html b/interfaces/_croz_nrich_notification_core.Notification.html new file mode 100644 index 0000000..8df35b4 --- /dev/null +++ b/interfaces/_croz_nrich_notification_core.Notification.html @@ -0,0 +1,122 @@ +Notification | nrich-frontend
+
+ +
+
+
+
+ +

Interface Notification

+
+

Hierarchy

+
    +
  • Notification
+
+
+
+ +
+
+

Properties

+
content +messageList +severity +timestamp +title +uxNotificationOptions? +
+
+

Properties

+
+

content

+
content: string
+

Content of the notification (i.e. for exception +notification this will contain resolved message for exception or 'Error occurred' text).

+
+
+

messageList

+
messageList: string[]
+

List of messages (i.e. for validation failure notification +this will contain all validation failure messages).

+
+
+

severity

+
severity: NotificationSeverity
+

Severity indicating importance of notification.

+
+
+

timestamp

+
timestamp: Date
+

Timestamp of notification.

+
+
+

title

+
title: string
+

Title of the notification.

+
+
+

Optional uxNotificationOptions

+
uxNotificationOptions?: Record<string, unknown>
+

Custom override data sent from the server. Each component library will have its own data here. +For example current supported options in mui implementation are position and autoClose.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/_croz_nrich_notification_core.NotificationResponse.html b/interfaces/_croz_nrich_notification_core.NotificationResponse.html new file mode 100644 index 0000000..991a7b4 --- /dev/null +++ b/interfaces/_croz_nrich_notification_core.NotificationResponse.html @@ -0,0 +1,74 @@ +NotificationResponse | nrich-frontend
+
+ +
+
+
+
+ +

Interface NotificationResponse

+
+

Hierarchy

+
    +
  • NotificationResponse
+
+
+
+ +
+
+

Properties

+
notification +
+
+

Properties

+
+

notification

+
notification: Notification
+

Notification

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/interfaces/_croz_nrich_notification_mui.NotificationsProviderProps.html b/interfaces/_croz_nrich_notification_mui.NotificationsProviderProps.html new file mode 100644 index 0000000..f4a2746 --- /dev/null +++ b/interfaces/_croz_nrich_notification_mui.NotificationsProviderProps.html @@ -0,0 +1,83 @@ +NotificationsProviderProps | nrich-frontend
+
+ +
+
+
+
+ +

Interface NotificationsProviderProps

+
+

Hierarchy

+
    +
  • NotificationsProviderProps
+
+
+
+ +
+
+

Properties

+
autoClose? +position? +
+
+

Properties

+
+

Optional autoClose

+
autoClose?: number
+

Number of milliseconds before notification is closed.

+
+
+

Optional position

+
position?: NotificationPosition
+

Position of notification.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/modules.html b/modules.html new file mode 100644 index 0000000..112f121 --- /dev/null +++ b/modules.html @@ -0,0 +1,50 @@ +nrich-frontend
+
+ +
+
+
+
+

nrich-frontend

+
+
+

Index

+
+

Modules

+
@croz/nrich-form-configuration-core +@croz/nrich-notification-core +@croz/nrich-notification-mui +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/modules/_croz_nrich_form_configuration_core.html b/modules/_croz_nrich_form_configuration_core.html new file mode 100644 index 0000000..8a2017a --- /dev/null +++ b/modules/_croz_nrich_form_configuration_core.html @@ -0,0 +1,168 @@ +@croz/nrich-form-configuration-core | nrich-frontend
+
+ +
+
+
+
+ +

Module @croz/nrich-form-configuration-core

+
+
+ +

@croz/nrich-form-configuration-core

+ + + +

Overview

+ +

@croz/nrich-form-configuration-core is a module for generating automatic validations for forms in the application. +It's a frontend part of nrich-form-configuration backend module. +Together, they allow the user to define validations in a single place (backend).

+

For validation schemas this lib uses yup.

+ + +

Setup

+ +

To use this module in your project run npm install @croz/nrich-form-configuration-core or yarn add @croz/nrich-form-configuration-core

+ + +

Basic usage

+ +

On some upper level of your app, wrap your components in FormConfigurationProvider.

+
import { FormConfigurationProvider } from "@croz/nrich-form-configuration-core";

const App = () => (
  <FormConfigurationProvider loader="Loading...">
    {/* rest of the app... */}
  </FormConfigurationProvider>
);
+
+

In your form component, use useYupFormConfiguration with your form id defined on backend.

+
import React, { useState } from "react";
import { useYupFormConfiguration } from "@croz/nrich-form-configuration-core";
import { Form, Formik } from "formik";

type CreateForm = {
  /* fields of the form */
}

export const SomeFormComponent = () => {
  const [formValues, setFormValues] = useState({});
  const validationSchema = useYupFormConfiguration<CreateForm>('user.create-form');

  return (
    <Formik
      validationSchema={validationSchema}
      onSubmit={(values) => setFormValues(values)}
    >
      <Form>
        { /* Rest of the form */}
      </Form>
    </Formik>
  );
};
+
+

NOTE: Formik is used just as an example, you can use any form lib compatible with yup.

+ + +

Details

+ +

FormConfigurationProvider component has the following props:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Prop nameDescriptionRequiredDefault value
childrenComponent tree that will be using nrich form configurationyesnone
loaderCustom component used while waiting for configuration fetch to finishnonone
urlBackend form configuration pathno/nrich/form/configuration
requestOptionsResolverFunction that creates options for the initial fetch call to backendnonone
additionalValidatorConvertersList of ValidatorConverters used to allow custom validationsnonone
+ + +

Registering and using custom validations

+ +

For custom validations to work, you need to provide a ValidatorConverter for it. ValidatorConverter contains two fields supports and convert.

+

supports is used to check if this is the correct validation for a given form validation configuration, while convert serves as an implementation of the +validation. convert will usually use the yup's Schema.test method.

+
import oib from "oib.js";
import { FormConfigurationProvider } from "@croz/nrich-form-configuration-core";

const additionalValidatorConverters = [
  {
    supports: (configuration) => configuration.name === "ValidOib",
    convert: (configuration, validator) => validator.test("validOib", configuration.errorMessage, value => oib.validate(value))
  }
];

const getRequestParams = (): RequestInit => ({
  headers: {
    Authorization: "Bearer token",
  },
});

const App = () => (
  <FormConfigurationProvider loader="Loading..."
                             additionalValidatorConverters={additionalValidatorConverters}
                             requestOptionsResolver={getRequestParams}>
    {/* rest of the app... */}
  </FormConfigurationProvider>
);
+
+
+
+
+

Index

+
+

Interfaces

+
ConstrainedPropertyClientValidatorConfiguration +ConstrainedPropertyConfiguration +FormConfiguration +FormConfigurationConfiguration +FormYupConfiguration +ValidatorConverter +
+
+

Type Aliases

+
FormConfigurationOptions +Props +UseFormConfiguration +
+
+

Functions

+
FormConfigurationProvider +useFormConfiguration +useYupFormConfiguration +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/modules/_croz_nrich_notification_core.html b/modules/_croz_nrich_notification_core.html new file mode 100644 index 0000000..4f35bd2 --- /dev/null +++ b/modules/_croz_nrich_notification_core.html @@ -0,0 +1,112 @@ +@croz/nrich-notification-core | nrich-frontend
+
+ +
+
+
+
+ +

Module @croz/nrich-notification-core

+
+
+ +

@croz/nrich-notification-core

+ + + +

Overview

+ +

@croz/nrich-notification-core is a module which serves for showing automatic messages from backend on user interface. +It's a frontend part of nrich-notification backend module.

+

Internally, it intercepts http calls and scans for sign of nrich notification object, and shows it if it exists.

+ + +

Setup

+ +

To use this module in your project run npm install @croz/nrich-notification-core or yarn add @croz/nrich-notification-core

+ + +

Usage

+ +
    +

  1. On top level of your app, register an appropriate interceptor for notifications.

    +
      +
    • If you use fetch API or a lib that uses fetch internally, use fetchNotificationInterceptor().
      • +
    • If you use a lib that uses XMLHttpRequest, eg. axios, use xhrNotificationInterceptor().
      • +
    +
    2. +

  2. Using useNotification() custom hook you get an object containing notifications array and remove and add methods for working with that array.

    +
    3. +
+

Example:

+
import { useNotifications } from "@croz/nrich-notification-core";

const Notification = ({ title, content, onRemove }) => (
  <div>
    <h3>{title}</h3>
    <div>{content}</div>
    <button onClick={onRemove}>×</button>
  </div>
)

export const Notifications = () => {
  const { notifications, remove } = useNotifications();

  return (
    <div>
      {notifications.map(notification => <Notification {...notification} onRemove={() => remove(notification)}/>)}
    </div>
  )
}
+
+

If you're using this module alone, you need to provide your own notification UI. For the prepared implementation in MUI, see @croz/nrich-notification-mui docs

+
+
+
+

Index

+
+

Interfaces

+
Notification +NotificationResponse +
+
+

Type Aliases

+
NotificationOptions +NotificationSeverity +UseNotifications +
+
+

Functions

+
fetchNotificationInterceptor +useNotifications +xhrNotificationInterceptor +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/modules/_croz_nrich_notification_mui.html b/modules/_croz_nrich_notification_mui.html new file mode 100644 index 0000000..d09c394 --- /dev/null +++ b/modules/_croz_nrich_notification_mui.html @@ -0,0 +1,117 @@ +@croz/nrich-notification-mui | nrich-frontend
+
+ +
+
+
+
+ +

Module @croz/nrich-notification-mui

+
+
+ +

@croz/nrich-notification-mui

+ + + +

Overview

+ +

@croz/nrich-notification-mui is a MUI wrapper for the @croz/nrich-notification-core module. +For the display of the notifications a Snackbar and Alert are used.

+ + +

Setup

+ +

To use this module in your project run npm install @croz/nrich-notification-mui or yarn add @croz/nrich-notification-mui

+ + +

Usage

+ +
    +
  1. Add Notifications component on a part of your app, usually on App or some other higher level component.
    2. +
+
import { Notifications } from "@croz/nrich-notification-mui";

const App = () => {
  return (
    <div>
      <Notifications autoClose={3000} position="top-right"/>
      {/* other components... */}
    </div>
  )
}
+
+

Available props for the Notifications component are:

+ + + + + + + + + + + + + + + + + + + + + +
Prop nameDescriptionPossible valuesDefault value
autoCloseThe duration after which the notification closes
expressed in milliseconds. If left undefined, it doesn't close.		number in milliseconds, or undefinedundefined
positionSpecifies the notification position on the page,
derived from a set of predefined positions available in MUI		top-left, top-center, top-right,
bottom-left, bottom-center, bottom-right		bottom-right
+
+
+
+

Index

+
+

Interfaces

+
NotificationsProviderProps +
+
+

Type Aliases

+
NotificationOrigin +NotificationPosition +
+
+

Functions

+
Notifications +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html b/types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html new file mode 100644 index 0000000..47ea801 --- /dev/null +++ b/types/_croz_nrich_form_configuration_core.FormConfigurationOptions.html @@ -0,0 +1,140 @@ +FormConfigurationOptions | nrich-frontend
+
+ +
+
+
+
+ +

Type alias FormConfigurationOptions

+
FormConfigurationOptions: {
    add: ((formConfiguration: FormYupConfiguration) => void);
    formConfigurationLoaded: boolean;
    formYupConfigurations: FormYupConfiguration[];
    remove: ((formConfiguration: FormYupConfiguration) => void);
    set: ((formConfigurations: FormYupConfiguration[]) => void);
    setFormConfigurationLoaded: ((formConfigurationLoaded: boolean) => void);
}
+
+

Type declaration

+
    +
  • +
    add: ((formConfiguration: FormYupConfiguration) => void)
    +
    • +
  • +
    formConfigurationLoaded: boolean
    +

    Flag that indicates weather form configuration is fetched from API.

    +
    • +
  • +
    formYupConfigurations: FormYupConfiguration[]
    +

    Array of current state form configurations.

    +
    • +
  • +
    remove: ((formConfiguration: FormYupConfiguration) => void)
    +
    • +
  • +
    set: ((formConfigurations: FormYupConfiguration[]) => void)
    +
      +
    • +
        +
      • (formConfigurations: FormYupConfiguration[]): void
        • +
      • +

        Sets form configurations to state. +Use on initial call to find-all endpoint.

        +
        +
        +

        Parameters

        +
        +

        Returns void

    • +
  • +
    setFormConfigurationLoaded: ((formConfigurationLoaded: boolean) => void)
    +
      +
    • +
        +
      • (formConfigurationLoaded: boolean): void
        • +
      • +

        Sets form configuration loaded to state.

        +
        +
        +

        Parameters

        +
          +
        • +
          formConfigurationLoaded: boolean
        +

        Returns void

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/_croz_nrich_form_configuration_core.Props.html b/types/_croz_nrich_form_configuration_core.Props.html new file mode 100644 index 0000000..7260f21 --- /dev/null +++ b/types/_croz_nrich_form_configuration_core.Props.html @@ -0,0 +1,62 @@ +Props | nrich-frontend
+
+ +
+
+
+
+ +

Type alias Props

+
Props: {
    children: React.ReactNode;
    loader?: React.ReactNode;
} & FormConfigurationConfiguration
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/_croz_nrich_form_configuration_core.UseFormConfiguration.html b/types/_croz_nrich_form_configuration_core.UseFormConfiguration.html new file mode 100644 index 0000000..436ad75 --- /dev/null +++ b/types/_croz_nrich_form_configuration_core.UseFormConfiguration.html @@ -0,0 +1,70 @@ +UseFormConfiguration | nrich-frontend
+
+ +
+
+
+
+ +

Type alias UseFormConfiguration

+
UseFormConfiguration: (() => FormConfigurationOptions)
+
+

Type declaration

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/_croz_nrich_notification_core.NotificationOptions.html b/types/_croz_nrich_notification_core.NotificationOptions.html new file mode 100644 index 0000000..adbb77d --- /dev/null +++ b/types/_croz_nrich_notification_core.NotificationOptions.html @@ -0,0 +1,97 @@ +NotificationOptions | nrich-frontend
+
+ +
+
+
+
+ +

Type alias NotificationOptions

+
NotificationOptions: {
    add: ((notification: Notification) => void);
    notifications: Notification[];
    remove: ((notification: Notification) => void);
}
+
+

Type declaration

+
    +
  • +
    add: ((notification: Notification) => void)
    +
      +
    • +
        +
      • (notification: Notification): void
        • +
      • +

        Adds notification to state.

        +
        +
        +

        Parameters

        +
        +

        Returns void

    • +
  • +
    notifications: Notification[]
    +

    Array of current state notifications.

    +
    • +
  • +
    remove: ((notification: Notification) => void)
    +
      +
    • +
        +
      • (notification: Notification): void
        • +
      • +

        Removes notification from state.

        +
        +
        +

        Parameters

        +
        +

        Returns void

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/_croz_nrich_notification_core.NotificationSeverity.html b/types/_croz_nrich_notification_core.NotificationSeverity.html new file mode 100644 index 0000000..05bbe50 --- /dev/null +++ b/types/_croz_nrich_notification_core.NotificationSeverity.html @@ -0,0 +1,58 @@ +NotificationSeverity | nrich-frontend
+
+ +
+
+
+
+ +

Type alias NotificationSeverity

+
NotificationSeverity: "INFO" | "WARNING" | "ERROR"
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/_croz_nrich_notification_core.UseNotifications.html b/types/_croz_nrich_notification_core.UseNotifications.html new file mode 100644 index 0000000..b121015 --- /dev/null +++ b/types/_croz_nrich_notification_core.UseNotifications.html @@ -0,0 +1,66 @@ +UseNotifications | nrich-frontend
+
+ +
+
+
+
+ +

Type alias UseNotifications

+
UseNotifications: (() => NotificationOptions)
+
+

Type declaration

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/_croz_nrich_notification_mui.NotificationOrigin.html b/types/_croz_nrich_notification_mui.NotificationOrigin.html new file mode 100644 index 0000000..982e839 --- /dev/null +++ b/types/_croz_nrich_notification_mui.NotificationOrigin.html @@ -0,0 +1,56 @@ +NotificationOrigin | nrich-frontend
+
+ +
+
+
+
+ +

Type alias NotificationOrigin

+
NotificationOrigin: ["top" | "bottom", "left" | "right" | "center"]
+

Represents a set of possibilities of where to place the notification on the screen.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/_croz_nrich_notification_mui.NotificationPosition.html b/types/_croz_nrich_notification_mui.NotificationPosition.html new file mode 100644 index 0000000..2cf4038 --- /dev/null +++ b/types/_croz_nrich_notification_mui.NotificationPosition.html @@ -0,0 +1,56 @@ +NotificationPosition | nrich-frontend
+
+ +
+
+
+
+ +

Type alias NotificationPosition

+
NotificationPosition: "top-left" | "top-right" | "top-center" | "bottom-left" | "bottom-right" | "bottom-center"
+

Represents an extended set of possibilities of where to place the notification on the screen based on NotificationOrigin.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file