https://cromwellcms.com/assets/js/93fa0121.b0ae71ee.js

1"use strict";(self.webpackChunk_cromwell_website=self.webpackChunk_cromwell_website||[]).push([[2765],{3640:function(e,t,n){n.r(t),n.d(t,{frontMatter:function(){return p},contentTitle:function(){return d},metadata:function(){return o},toc:function(){return m},default:function(){return s}});var a=n(5773),r=n(808),l=(n(7378),n(5318)),i=["components"],p={title:"frontend"},d="Module: frontend",o={unversionedId:"api/modules/frontend",id:"api/modules/frontend",isDocsHomePage:!1,title:"frontend",description:"CromwellCMS Frontend SDK",source:"@site/docs/api/modules/frontend.md",sourceDirName:"api/modules",slug:"/api/modules/frontend",permalink:"/docs/api/modules/frontend",tags:[],version:"current",frontMatter:{title:"frontend"},sidebar:"tutorialSidebar",previous:{title:"ESharedComponentNames",permalink:"/docs/api/enums/common.ESharedComponentNames"},next:{title:"CContainer",permalink:"/docs/api/classes/frontend.CContainer"}},m=[{value:"Install",id:"install",children:[]},{value:"Use",id:"use",children:[]},{value:"Table of contents",id:"table-of-contents",children:[{value:"Classes",id:"classes",children:[]},{value:"Type aliases",id:"type-aliases",children:[]},{value:"Variables",id:"variables",children:[]},{value:"Functions",id:"functions",children:[]}]},{value:"Type aliases",id:"type-aliases-1",children:[{value:"CContainerProps",id:"ccontainerprops",children:[]},{value:"SignInProps",id:"signinprops",children:[]},{value:"SignUpProps",id:"signupprops",children:[]},{value:"TApiClient",id:"tapiclient",children:[]},{value:"TAppPropsContext",id:"tapppropscontext",children:[]},{value:"TAuthClientOperationResult",id:"tauthclientoperationresult",children:[]},{value:"TBaseButton",id:"tbasebutton",children:[]},{value:"TBaseButtonProps",id:"tbasebuttonprops",children:[]},{value:"TBaseTextField",id:"tbasetextfield",children:[]},{value:"TBaseTextFieldProps",id:"tbasetextfieldprops",children:[]},{value:"TCGalleryProps",id:"tcgalleryprops",children:[]},{value:"TCGraphQLClient",id:"tcgraphqlclient",children:[]},{value:"TCList",id:"tclist",children:[]},{value:"TCListProps",id:"tclistprops",children:[]},{value:"TCRestApiClient",id:"tcrestapiclient",children:[]},{value:"TCStoreOperationResult",id:"tcstoreoperationresult",children:[]},{value:"TCssClasses",id:"tcssclasses",children:[]},{value:"TDynamicLoader",id:"tdynamicloader",children:[]},{value:"TElements",id:"telements",children:[]},{value:"TErrorInfo",id:"terrorinfo",children:[]},{value:"TGetCStoreOptions",id:"tgetcstoreoptions",children:[]},{value:"TGetFilteredOptions",id:"tgetfilteredoptions",children:[]},{value:"TGraphQLErrorInfo",id:"tgraphqlerrorinfo",children:[]},{value:"TImageComponent",id:"timagecomponent",children:[]},{value:"TListItemProps",id:"tlistitemprops",children:[]},{value:"TListenerType",id:"tlistenertype",children:[]},{value:"TPaginationProps",id:"tpaginationprops",children:[]},{value:"TRequestOptions",id:"trequestoptions",children:[]},{value:"TSignInFromType",id:"tsigninfromtype",children:[]},{value:"WidgetNames",id:"widgetnames",children:[]},{value:"WidgetTypes",id:"widgettypes",children:[]},{value:"Widget_DashboardProps",id:"widget_dashboardprops",children:[]},{value:"Widget_EntityActions",id:"widget_entityactions",children:[]},{value:"Widget_PostActions",id:"widget_postactions",children:[]}]},{value:"Variables",id:"variables-1",children:[{value:"AppPropsContext",id:"apppropscontext",children:[]},{value:"BaseButton",id:"basebutton",children:[]},{value:"BaseTextField",id:"basetextfield",children:[]},{value:"BlockContentConsumer",id:"blockcontentconsumer",children:[]},{value:"BlockContentProvider",id:"blockcontentprovider",children:[]},{value:"BlockStoreConsumer",id:"blockstoreconsumer",children:[]},{value:"BlockStoreProvider",id:"blockstoreprovider",children:[]},{value:"blockCssClass",id:"blockcssclass",children:[]},{value:"pageRootContainerId",id:"pagerootcontainerid",children:[]}]},{value:"Functions",id:"functions-1",children:[{value:"AdminPanelWidgetPlace",id:"adminpanelwidgetplace",children:[]},{value:"EntityHead",id:"entityhead",children:[]},{value:"Link",id:"link",children:[]},{value:"LoadBox",id:"loadbox",children:[]},{value:"SignIn",id:"signin",children:[]},{value:"SignUp",id:"signup",children:[]},{value:"awaitImporter",id:"awaitimporter",children:[]},{value:"cleanParseContext",id:"cleanparsecontext",children:[]},{value:"fetch",id:"fetch",children:[]},{value:"getAuthClient",id:"getauthclient",children:[]},{value:"getBlockById",id:"getblockbyid",children:[]},{value:"getBlockData",id:"getblockdata",children:[]},{value:"getBlockDataById",id:"getblockdatabyid",children:[]},{value:"getBlockElementById",id:"getblockelementbyid",children:[]},{value:"getBlockHtmlId",id:"getblockhtmlid",children:[]},{value:"getBlockHtmlType",id:"getblockhtmltype",children:[]},{value:"getBlockIdFromHtml",id:"getblockidfromhtml",children:[]},{value:"getBlockTypeFromHtml",id:"getblocktypefromhtml",children:[]},{value:"getCStore",id:"getcstore",children:[]},{value:"getCentralServerClient",id:"getcentralserverclient",children:[]},{value:"getDynamicLoader",id:"getdynamicloader",children:[]},{value:"getGraphQLClient",id:"getgraphqlclient",children:[]},{value:"getHtmlPluginBlockName",id:"gethtmlpluginblockname",children:[]},{value:"getLoadableFrontendBundle",id:"getloadablefrontendbundle",children:[]},{value:"getModuleImporter",id:"getmoduleimporter",children:[]},{value:"getNamedWidgetForPlace",id:"getnamedwidgetforplace",children:[]},{value:"getParserTransform",id:"getparsertransform",children:[]},{value:"getPluginStaticUrl",id:"getpluginstaticurl",children:[]},{value:"getRestApiClient",id:"getrestapiclient",children:[]},{value:"getServiceSecret",id:"getservicesecret",children:[]},{value:"getWidgets",id:"getwidgets",children:[]},{value:"getWidgetsForPlace",id:"getwidgetsforplace",children:[]},{value:"iconFromPath",id:"iconfrompath",children:[]},{value:"isAdminPanel",id:"isadminpanel",children:[]},{value:"loadFrontendBundle",id:"loadfrontendbundle",children:[]},{value:"makeParserContext",id:"makeparsercontext",children:[]},{value:"onWidgetRegister",id:"onwidgetregister",children:[]},{value:"parseHtml",id:"parsehtml",children:[]},{value:"registerPluginSSR",id:"registerpluginssr",children:[]},{value:"registerWidget",id:"registerwidget",children:[]},{value:"useAppPropsContext",id:"useapppropscontext",children:[]},{value:"useAuthClient",id:"useauthclient",children:[]},{value:"useCart",id:"usecart",children:[]},{value:"useCmsSettings",id:"usecmssettings",children:[]},{value:"useCurrency",id:"usecurrency",children:[]},{value:"useForceUpdate",id:"useforceupdate",children:[]},{value:"useUserInfo",id:"useuserinfo",children:[]},{value:"useViewedItems",id:"usevieweditems",children:[]},{value:"useWishlist",id:"usewishlist",children:[]}]}],k={toc:m};function s(e){var t=e.components,n=(0,r.Z)(e,i);return(0,l.kt)("wrapper",(0,a.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("h1",{id:"module-frontend"},"Module: frontend"),(0,l.kt)("p",null,"CromwellCMS Frontend SDK"),(0,l.kt)("p",null,"Exports Blocks, React components, API clients and frontend helpers. "),(0,l.kt)("h3",{id:"install"}

1,"Install"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"npm i @cromwell/core-frontend\n")),(0,l.kt)("h3",{id:"use"},"Use"),(0,l.kt)("p",null,"Example of usage"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ts"},"import { getGraphQLClient } from '@cromwell/core-frontend';\n\nconst products = await getGraphQLClient().getProducts();\n")),(0,l.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,l.kt)("h3",{id:"classes"},"Classes"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CContainer"},"CContainer")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CEditor"},"CEditor")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CGallery"},"CGallery")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CGraphQLClient"},"CGraphQLClient")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CHTML"},"CHTML")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CImage"},"CImage")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CList"},"CList")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CPlugin"},"CPlugin")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CRestApiClient"},"CRestApiClient")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CStore"},"CStore")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CText"},"CText")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.CentralServerClient"},"CentralServerClient")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/frontend.Importer"},"Importer"))),(0,l.kt)("h3",{id:"type-aliases"},"Type aliases"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#ccontainerprops"},"CContainerProps")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#signinprops"},"SignInProps")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#signupprops"},"SignUpProps")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tapiclient"},"TApiClient")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tapppropscontext"},"TAppPropsContext")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tauthclientoperationresult"},"TAuthClientOperationResult")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tbasebutton"},"TBaseButton")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tbasebuttonprops"},"TBaseButtonProps")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tbasetextfield"},"TBaseTextField")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tbasetextfieldprops"},"TBaseTextFieldProps")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tcgalleryprops"},"TCGalleryProps")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tcgraphqlclient"},"TCGraphQLClient")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tclist"},"TCList")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tclistprops"},"TCListProps")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tcrestapiclient"},"TCRestApiClient")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tcstoreoperationresult"},"TCStoreOperationResult")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tcssclasses"}

1,"TCssClasses")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tdynamicloader"},"TDynamicLoader")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#telements"},"TElements")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#terrorinfo"},"TErrorInfo")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tgetcstoreoptions"},"TGetCStoreOptions")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tgetfilteredoptions"},"TGetFilteredOptions")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tgraphqlerrorinfo"},"TGraphQLErrorInfo")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#timagecomponent"},"TImageComponent")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tlistitemprops"},"TListItemProps")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tlistenertype"},"TListenerType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tpaginationprops"},"TPaginationProps")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#trequestoptions"},"TRequestOptions")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#tsigninfromtype"},"TSignInFromType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#widgetnames"},"WidgetNames")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#widgettypes"},"WidgetTypes")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#widget_dashboardprops"},"Widget","_","DashboardProps")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#widget_entityactions"},"Widget","_","EntityActions")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#widget_postactions"},"Widget","_","PostActions"))),(0,l.kt)("h3",{id:"variables"},"Variables"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#apppropscontext"},"AppPropsContext")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#basebutton"},"BaseButton")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#basetextfield"},"BaseTextField")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#blockcontentconsumer"},"BlockContentConsumer")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#blockcontentprovider"},"BlockContentProvider")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#blockstoreconsumer"},"BlockStoreConsumer")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#blockstoreprovider"},"BlockStoreProvider")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#blockcssclass"},"blockCssClass")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#pagerootcontainerid"},"pageRootContainerId"))),(0,l.kt)("h3",{id:"functions"},"Functions"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#adminpanelwidgetplace"},"AdminPanelWidgetPlace")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#entityhead"},"EntityHead")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#link"},"Link")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#loadbox"},"LoadBox")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#signin"},"SignIn")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#signup"},"SignUp")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#awaitimporter"},"awaitImporter")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#cleanparsecontext"},"cleanParseContext")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#fetch"},"fetch")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getauthclient"},"getAuthClient")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getblockbyid"},"getBlockById")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getblockdata"},"getBlockData")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getblockdatabyid"},"getBlockDataById")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getblockelementbyid"},"getBlockElementById")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getblockhtmlid"},"getBlockHtmlId")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getblockhtmltype"},"getBlockHtmlType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getblockidfromhtml"},"getBlockIdFromHtml")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getblocktypefromhtml"},"getBlockTypeFromHtml")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getcstore"},"getCStore")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getcentralserverclient"},"getCentralServerClient")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getdynamicloader"},"getDynamicLoader")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getgraphqlclient"},"getGraphQLClient")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#gethtmlpluginblockname"},"getHtmlPluginBlockName")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getloadablefrontendbundle"},"getLoadableFrontendBundle")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getmoduleimporter"},"getModuleImporter")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getnamedwidgetforplace"},"getNamedWidgetForPlace")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getparsertransform"},"getParserTransform")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getpluginstaticurl"},"getPluginStaticUrl")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getrestapiclient"},"getRestApiClient")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getservicesecret"},"getServiceSecret")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getwidgets"},"getWidgets")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#getwidgetsforplace"},"getWidgetsForPlace")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#iconfrompath"},"iconFromPath")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#isadminpanel"},"isAdminPanel")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#loadfrontendbundle"},"loadFrontendBundle")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#makeparsercontext"},"makeParserContext")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#onwidgetregister"},"onWidgetRegister")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#parsehtml"},"parseHtml")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#registerpluginssr"},"registerPluginSSR")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#registerwidget"},"registerWidget")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#useapppropscontext"},"useAppPropsContext")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#useauthclient"},"useAuthClient")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#usecart"},"useCart")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#usecmssettings"},"useCmsSettings")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#usecurrency"},"useCurrency")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#useforceupdate"},"useForceUpdate")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#useuserinfo"},"useUserInfo")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#usevieweditems"},"useViewedItems")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#usewishlist"},"useWishlist"))),(0,l.kt)("h2",{id:"type-aliases-1"},"Type aliases"),(0,l.kt)("h3",{id:"ccontainerprops"},"CContainerProps"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"CContainerProps"),": { ",(0,l.kt)("inlineCode",{parentName:"p"},"children?"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"React.ReactNode"),"  } & ",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlockProps")),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/CContainer/CContainer.tsx#L6"},"system/core/frontend/src/components/CContainer/CContainer.tsx:6")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"signinprops"},"SignInProps"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"SignInProps"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"}

1,"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"classes?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,l.kt)("inlineCode",{parentName:"td"},'"root"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},'"resetPassInstructions"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},'"forgotPassButton"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},'"backToSignInButton"'),", ",(0,l.kt)("inlineCode",{parentName:"td"},"string"),">",">"),(0,l.kt)("td",{parentName:"tr",align:"left"},"CSS classes to pass to elements")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Object")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Custom components to override default ones")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements.Button?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tbasebutton"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseButton"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements.CodeField?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tbasetextfield"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseTextField"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements.EmailField?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tbasetextfield"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseTextField"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements.PasswordField?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tbasetextfield"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseTextField"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements.TextField?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tbasetextfield"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseTextField"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"initialFormType?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tsigninfromtype"},(0,l.kt)("inlineCode",{parentName:"a"},"TSignInFromType"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Type of form to open initially. ",(0,l.kt)("inlineCode",{parentName:"td"},"sign-in")," by default;")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"text?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Object")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Translate/change text on elements")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"text.backToSignIn?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"text.fieldRequired?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"text.forgotPass?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"text.forgotPassButton?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"text.loginButton?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"text.resetPassButton?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"text.resetPassInstructions?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"onForgotPasswordEmailSent?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"email"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"any")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"onForgotPasswordFailure?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"error"),": ",(0,l.kt)("a",{parentName:"td",href:"#tauthclientoperationresult"},(0,l.kt)("inlineCode",{parentName:"a"},"TAuthClientOperationResult")),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"any")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"onResetPasswordFailure?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"error"),": ",(0,l.kt)("a",{parentName:"td",href:"#tauthclientoperationresult"},(0,l.kt)("inlineCode",{parentName:"a"},"TAuthClientOperationResult")),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"any")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"onResetPasswordSuccess?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"email?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"newPassword?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"any")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"onSignInError?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"error"),": ",(0,l.kt)("a",{parentName:"td",href:"#tauthclientoperationresult"},(0,l.kt)("inlineCode",{parentName:"a"},"TAuthClientOperationResult")),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"any")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"onSignInSuccess?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"user"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"TUser"),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"any")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/SignIn/SignIn.tsx#L14"},"system/core/frontend/src/components/SignIn/SignIn.tsx:14")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"signupprops"},"SignUpProps"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"SignUpProps"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"}

1,"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"classes?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,l.kt)("inlineCode",{parentName:"td"},'"root"'),", ",(0,l.kt)("inlineCode",{parentName:"td"},"string"),">",">"),(0,l.kt)("td",{parentName:"tr",align:"left"},"CSS classes to pass to elements")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Object")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Custom components to override default ones")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements.Button?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tbasebutton"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseButton"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements.EmailField?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tbasetextfield"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseTextField"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements.NameField?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tbasetextfield"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseTextField"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements.PasswordField?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tbasetextfield"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseTextField"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements.TextField?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tbasetextfield"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseTextField"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"text?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Object")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Translate/change text on elements")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"text.fieldRequired?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"text.signUpButton?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"onSignUpError?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"error"),": ",(0,l.kt)("a",{parentName:"td",href:"#tauthclientoperationresult"},(0,l.kt)("inlineCode",{parentName:"a"},"TAuthClientOperationResult")),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"any")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"onSignUpSuccess?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"user"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"TUser"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"password"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"any")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/SignUp/SignUp.tsx#L12"},"system/core/frontend/src/components/SignUp/SignUp.tsx:12")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tapiclient"},"TApiClient"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TApiClient"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"getAttributes")),(0,l.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,l.kt)("inlineCode",{parentName:"td"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"TAttribute"),"[]",">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"getCouponsByCodes?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"codes"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"string"),"[]) => ",(0,l.kt)("inlineCode",{parentName:"td"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"}

1,"TCoupon"),"[]",">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"getProductById")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"id"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"TProduct"),">")))),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/CStore.ts#L27"},"system/core/frontend/src/helpers/CStore.ts:27")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tapppropscontext"},"TAppPropsContext"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TAppPropsContext"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"TProps"),">",": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TProps")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,l.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"pageProps?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TCromwellPageCoreProps")," & ",(0,l.kt)("inlineCode",{parentName:"td"},"TProps"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"routeInfo?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Object"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"routeInfo.fullUrl?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"routeInfo.origin?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"router?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"NextRouter"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"forceUpdatePage?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,l.kt)("inlineCode",{parentName:"td"},"void"))))),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L81"},"system/core/frontend/src/constants.ts:81")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tauthclientoperationresult"},"TAuthClientOperationResult"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TAuthClientOperationResult"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("p",null,"Common object with info about result of used operation."),(0,l.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"}

1,"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"code")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Available codes: 200 - Sing in success; 201 - Sing out success; 202 - Reset password procedure initiation success (forgot pass); 203 - Reset password success. Password changed in DB; 204 - User registration (sign up) success. 400 - Empty email or password (frontend validation); 401 - Incorrect email or password (server validation); 402 - Already processing another request; 403 - Too many requests; 404 - Failed to sing out; 405 - Empty secret code (frontend validation); 406 - Exceeded reset password attempts; 407 - Missing user credentials on user registration operation;")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"error?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"message")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"success")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"user?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TUser")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/AuthClient.ts#L10"},"system/core/frontend/src/helpers/AuthClient.ts:10")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tbasebutton"},"TBaseButton"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TBaseButton"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"React.ComponentType"),"<",(0,l.kt)("a",{parentName:"p",href:"#tbasebuttonprops"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseButtonProps")),">"),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/BaseElements/BaseButton.tsx#L16"},"system/core/frontend/src/components/BaseElements/BaseButton.tsx:16")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tbasebuttonprops"},"TBaseButtonProps"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TBaseButtonProps"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"aria-label?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"className?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"color?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},'"primary"'))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"disabled?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"id?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"onClick?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.MouseEventHandler"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"size?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},'"small"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},'"medium"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},'"large"'))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"startIcon?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ReactNode"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"style?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.CSSProperties"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"type?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"variant?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},'"outlined"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},'"text"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"}

1,'"contained"'))))),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/BaseElements/BaseButton.tsx#L3"},"system/core/frontend/src/components/BaseElements/BaseButton.tsx:3")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tbasetextfield"},"TBaseTextField"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TBaseTextField"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"React.ComponentType"),"<",(0,l.kt)("a",{parentName:"p",href:"#tbasetextfieldprops"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseTextFieldProps")),">"),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/BaseElements/BaseTextField.tsx#L24"},"system/core/frontend/src/components/BaseElements/BaseTextField.tsx:24")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tbasetextfieldprops"},"TBaseTextFieldProps"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TBaseTextFieldProps"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"className?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"disabled?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"error?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"fullWidth?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"helperText?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ReactNode"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"id?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"label?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ReactNode"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"maxRows?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"number"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"minRows?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"number"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"multiline?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"name?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"onChange?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ChangeEventHandler"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"HTMLTextAreaElement")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"HTMLInputElement"),">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"placeholder?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"rows?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"number"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"size?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},'"small"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},'"medium"'))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"style?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.CSSProperties"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"type?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"value?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"variant?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},'"outlined"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},'"filled"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},'"standard"'))))),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/BaseElements/BaseTextField.tsx#L3"},"system/core/frontend/src/components/BaseElements/BaseTextField.tsx:3")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tcgalleryprops"},"TCGalleryProps"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TCGalleryProps"),": { ",(0,l.kt)("inlineCode",{parentName:"p"},"className?"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"shouldComponentUpdate?"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean"),"  } & ",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlockProps")),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/CGallery/CGallery.tsx#L27"},"system/core/frontend/src/components/CGallery/CGallery.tsx:27")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tcgra

1phqlclient"},"TCGraphQLClient"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TCGraphQLClient"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.CGraphQLClient"},(0,l.kt)("inlineCode",{parentName:"a"},"CGraphQLClient"))),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/api/CGraphQLClient.ts#L1210"},"system/core/frontend/src/api/CGraphQLClient.ts:1210")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tclist"},"TCList"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TCList"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"DataType"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"ListItemProps"),">",": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("p",null,"Public API of CList instance"),(0,l.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"DataType")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ListItemProps")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"))))),(0,l.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"addListener")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"type"),": ",(0,l.kt)("inlineCode",{parentName:"td"},'"componentDidUpdate"'),", ",(0,l.kt)("inlineCode",{parentName:"td"},"cb"),": () => ",(0,l.kt)("inlineCode",{parentName:"td"},"void"),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"void"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"clearState")),(0,l.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,l.kt)("inlineCode",{parentName:"td"},"void"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"getPagedParams")),(0,l.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,l.kt)("inlineCode",{parentName:"td"},"TPagedParams"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"DataType"),">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"getProps")),(0,l.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,l.kt)("a",{parentName:"td",href:"#tclistprops"},(0,l.kt)("inlineCode",{parentName:"a"},"TCListProps")),"<",(0,l.kt)("inlineCode",{parentName:"td"},"DataType"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"ListItemProps"),">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"getScrollboxEl")),(0,l.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,l.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"HTMLDivElement"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"init")),(0,l.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,l.kt)("inlineCode",{parentName:"td"},"void"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"openPage")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"pageNumber"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"void"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"setPagedParams")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"val"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"TPagedParams"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"DataType"),">",") => ",(0,l.kt)("inlineCode",{parentName:"td"},"void"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"setProps")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"props"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,l.kt)("a",{parentName:"td",href:"#tclistprops"},(0,l.kt)("inlineCode",{parentName:"a"},"TCListProps")),"<",(0,l.kt)("inlineCode",{parentName:"td"},"DataType"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"ListItemProps"),">",") => ",(0,l.kt)("inlineCode",{parentName:"td"},"void"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"updateData")),(0,l.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,l.kt)("inlineCode",{parentName:"td"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"void"),">")))),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/CList/types.ts#L105"},"system/core/frontend/src/components/CList/types.ts:105")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tclistprops"},"TCListProps"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TCListProps"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"DataType"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"ListItemProps"),">

1",": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"DataType"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ListItemProps"))))),(0,l.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ListItem")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ComponentType"),"<",(0,l.kt)("a",{parentName:"td",href:"#tlistitemprops"},(0,l.kt)("inlineCode",{parentName:"a"},"TListItemProps")),"<",(0,l.kt)("inlineCode",{parentName:"td"},"DataType"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"ListItemProps"),">",">"),(0,l.kt)("td",{parentName:"tr",align:"left"},"Component that will display items")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"className?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"HTML Class attribute for wrapper container")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"cssClasses?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tcssclasses"},(0,l.kt)("inlineCode",{parentName:"a"}

1,"TCssClasses"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dataList?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"DataType"),"[]"),(0,l.kt)("td",{parentName:"tr",align:"left"},'Array of data to create components for each piece and virtualize. Won\'t work with "loader" prop')),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"disableCaching?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},'Disable caching of loaded pages from "loader" prop when open a new page by pagination. Caching is working by default')),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"elements?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#telements"},(0,l.kt)("inlineCode",{parentName:"a"},"TElements"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"firstBatch?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TPagedList"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"DataType"),">"," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"null")),(0,l.kt)("td",{parentName:"tr",align:"left"},'First batch / page. Can be used with "loader". Supposed to be used in SSR to prerender page')),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"id")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"CBlock id")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"isLoading?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Force to show preloader instead of a list")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"listItemProps?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ListItemProps")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Prop object to pass for each component in a list")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"maxDomPages?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Max pages to render at screen. 10 by default")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"minRangeToLoad?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Threshold in px where automatically request next or prev page. 200 by default. Use with useAutoLoading")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"noDataLabel?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},'Label to show when data array is empty. "No data" by default')),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"pageSize?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number")),(0,l.kt)("td",{parentName:"tr",align:"left"},'Page size to first use in TPagedParams of "loader". After first batch recieved will use pageSize from pagedMeta if pagedMeta has it')),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"paginationButtonsNum?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Max number of page links to display. 10 by default")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"pathname?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"window.location.pathname for SSR to prerender pagination links")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"}

1,"scrollContainerSelector?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"When useShowMoreButton and usePagination enabled CList needs to know container that scrolls pages to define current page during scrolling")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"useAutoLoading?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Auto load more pages when scroll reached end of start in minRangeToLoad (px)")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"usePagination?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Display pagination")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"useQueryPagination?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Parse and set pageNumber in url as query param")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"useShowMoreButton?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},"If useAutoLoading disabled can show button to load next page in the same container")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"loader?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"params"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"TPagedParams"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"DataType"),">",") => ",(0,l.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"TPagedList"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"DataType"),">"," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"DataType"),"[]",">"),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/CList/types.ts#L34"},"system/core/frontend/src/components/CList/types.ts:34")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tcrestapiclient"},"TCRestApiClient"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TCRestApiClient"),": typeof ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.CRestApiClient"},(0,l.kt)("inlineCode",{parentName:"a"},"CRestApiClient"))),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/api/CRestApiClient.ts#L880"},"system/core/frontend/src/api/CRestApiClient.ts:880")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tcstoreoperationresult"},"TCStoreOperationResult"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TCStoreOperationResult"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("p",null,'Result of cstore operation with lists. E.g. "add to cart",\n"remove from wishlist", etc.\nCodes:\n0 - add success\n1 - add failed, already in the list\n3 - add failed, invalid product\n4 - add failed, missing required attributes\n6 - remove failed, no such item in the list\n7 - remove success'),(0,l.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"code")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"message?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"success")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/CStore.ts#L44"},"system/core/frontend/src/helpers/CStore.ts:44")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tcssclasses"}

1,"TCssClasses"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TCssClasses"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"contentWrapper?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"page?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"paginationActiveLink?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"paginationArrowLink?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"paginationDisabledLink?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"paginationLink?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"scrollBox?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/CList/types.ts#L4"},"system/core/frontend/src/components/CList/types.ts:4")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tdynamicloader"},"TDynamicLoader"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TDynamicLoader"),": (",(0,l.kt)("inlineCode",{parentName:"p"},"func"),": () => ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"ComponentType"),">",", ",(0,l.kt)("inlineCode",{parentName:"p"},"options?"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),") => ",(0,l.kt)("inlineCode",{parentName:"p"},"ComponentType")),(0,l.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,l.kt)("p",null,"\u25b8 (",(0,l.kt)("inlineCode",{parentName:"p"},"func"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"ComponentType")),(0,l.kt)("h5",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"func")),(0,l.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,l.kt)("inlineCode",{parentName:"td"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"ComponentType"),">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"options?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"))))),(0,l.kt)("h5",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"ComponentType")),(0,l.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L64"},"system/core/frontend/src/constants.ts:64")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"telements"},"TElements"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TElements"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"}

1,"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"arrowFirst?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ReactNode")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"arrowLast?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ReactNode")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"arrowLeft?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ReactNode")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"arrowRight?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ReactNode")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"pagination?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ComponentType"),"<",(0,l.kt)("a",{parentName:"td",href:"#tpaginationprops"},(0,l.kt)("inlineCode",{parentName:"a"},"TPaginationProps")),">"),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"preloader?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ReactNode")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Preloader to show during first data request")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"showMore?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"React.ComponentType"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"Object"),">"),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,l.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/CList/types.ts#L21"},"system/core/frontend/src/components/CList/types.ts:21")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"terrorinfo"},"TErrorInfo"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TErrorInfo"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"disableLog?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"message")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"route")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"statusCode")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number"))))),(0,l.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/api/CRestApiClient.ts#L32"},"system/core/frontend/src/api/CRestApiClient.ts:32")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tgetcstoreoptions"},"TGetCStoreOptions"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TGetCStoreOptions"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"}

1,"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"apiClient?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tapiclient"},(0,l.kt)("inlineCode",{parentName:"a"},"TApiClient"))),(0,l.kt)("td",{parentName:"tr",align:"left"},"Provide custom apiClient instance. CGraphQLClient by default. Be careful, if ",(0,l.kt)("inlineCode",{parentName:"td"},"local: true")," is not provided, then this client will be saved globally and used for all subsequent calls.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"local?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},"If true, create and return a new CStore instance instead of returning one (singleton) from the global store. False by default.")))),(0,l.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/CStore.ts#L764"},"system/core/frontend/src/helpers/CStore.ts:764")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tgetfilteredoptions"},"TGetFilteredOptions"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TGetFilteredOptions"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"TEntity"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"TFilter"),">",": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TEntity"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TFilter"))))),(0,l.kt)("h4",{id:"type-declaration-15"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"customFragment?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"DocumentNode"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"customFragmentName?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"filterParams?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TFilter"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"pagedParams?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TPagedParams"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"TEntity"),">")))),(0,l.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/api/CGraphQLClient.ts#L66"},"system/core/frontend/src/api/CGraphQLClient.ts:66")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tgraphqlerrorinfo"},"TGraphQLErrorInfo"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TGraphQLErrorInfo"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-16"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"message?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"path?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"stacktrace?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"status?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"statusCode?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number"))))),(0,l.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/api/CGraphQLClient.ts#L58"},"system/core/frontend/src/api/CGraphQLClient.ts:58")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"timagecomponent"},"TImageComponent"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TImageComponent"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"React.ComponentClass"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"ImageProps"),">",">"),(0,l.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/CGallery/CGallery.tsx#L32"},"system/core/frontend/src/components/CGallery/CGallery.tsx:32")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tlistitemprops"},"TListItemProps"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TListItemProps"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"DataType"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"ListItemProps"),">

1",": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"DataType"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ListItemProps"))))),(0,l.kt)("h4",{id:"type-declaration-17"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"data?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"DataType"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"listItemProps?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ListItemProps"))))),(0,l.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/CList/types.ts#L131"},"system/core/frontend/src/components/CList/types.ts:131")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tlistenertype"},"TListenerType"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TListenerType"),": ",(0,l.kt)("inlineCode",{parentName:"p"},'"componentDidUpdate"')),(0,l.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/CList/types.ts#L129"},"system/core/frontend/src/components/CList/types.ts:129")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tpaginationprops"},"TPaginationProps"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TPaginationProps"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-18"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"count")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"page")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"number"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"onChange")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"page"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"void"))))),(0,l.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/CList/types.ts#L15"},"system/core/frontend/src/components/CList/types.ts:15")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"trequestoptions"},"TRequestOptions"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TRequestOptions"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-19"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"}

1,"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"disableLog?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Disable error logging")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"headers?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"string"),">"),(0,l.kt)("td",{parentName:"tr",align:"left"},"Add headers")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"input?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any")),(0,l.kt)("td",{parentName:"tr",align:"left"},"Body for 'post' and 'put' requests")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"method?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"HTTP method: 'get', 'post', 'put', etc.")))),(0,l.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/api/CRestApiClient.ts#L39"},"system/core/frontend/src/api/CRestApiClient.ts:39")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"tsigninfromtype"},"TSignInFromType"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"TSignInFromType"),": ",(0,l.kt)("inlineCode",{parentName:"p"},'"sign-in"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},'"forgot-pass"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},'"reset-pass"')),(0,l.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/SignIn/SignIn.tsx#L10"},"system/core/frontend/src/components/SignIn/SignIn.tsx:10")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"widgetnames"},"WidgetNames"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"WidgetNames"),": keyof ",(0,l.kt)("a",{parentName:"p",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes"))),(0,l.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/widget-types.ts#L35"},"system/core/frontend/src/widget-types.ts:35")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"widgettypes"},"WidgetTypes"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"WidgetTypes"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-20"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"CategoryActions")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#widget_entityactions"},(0,l.kt)("inlineCode",{parentName:"a"},"Widget_EntityActions")),"<",(0,l.kt)("inlineCode",{parentName:"td"},"TProductCategory"),">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Dashboard")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#widget_dashboardprops"},(0,l.kt)("inlineCode",{parentName:"a"},"Widget_DashboardProps")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"OrderActions")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#widget_entityactions"},(0,l.kt)("inlineCode",{parentName:"a"},"Widget_EntityActions")),"<",(0,l.kt)("inlineCode",{parentName:"td"},"TOrder"),">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"PluginSettings")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TPluginSettingsProps"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"PostActions")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#widget_postactions"},(0,l.kt)("inlineCode",{parentName:"a"},"Widget_PostActions")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ProductActions")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#widget_entityactions"},(0,l.kt)("inlineCode",{parentName:"a"},"Widget_EntityActions")),"<",(0,l.kt)("inlineCode",{parentName:"td"},"TProduct"),">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TagActions")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#widget_entityactions"},(0,l.kt)("inlineCode",{parentName:"a"},"Widget_EntityActions")),"<",(0,l.kt)("inlineCode",{parentName:"td"},"TTag"),">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ThemeEditor")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Object"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ThemeEditor.block?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TCromwellBlock"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ThemeEditor.instanceSettings?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ThemeEditor.addNewBlockAfter?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[object Object]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ThemeEditor.changeInstanceSettings?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[object Object]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ThemeEditor.deleteBlock?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[object Object]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ThemeEditor.forceUpdate?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[object Object]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ThemeEditor.modifyData?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[object Object]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ThemeEditor.updateFramesPosition?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[object Object]")))),(0,l.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/widget-types.ts#L15"},"system/core/frontend/src/widget-types.ts:15")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"widget_dashboardprops"},"Widget","_","DashboardProps"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"Widget","_","DashboardProps"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-21"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"stats")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TCmsStats")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"undefined"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"setSize")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"pluginName"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"layouts"),": { ",(0,l.kt)("inlineCode",{parentName:"td"},"lg"),": { ",(0,l.kt)("inlineCode",{parentName:"td"},"h?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"w?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"x?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"y?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"  } ; ",(0,l.kt)("inlineCode",{parentName:"td"},"md"),": { ",(0,l.kt)("inlineCode",{parentName:"td"},"h?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"w?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"x?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"y?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"  } ; ",(0,l.kt)("inlineCode",{parentName:"td"},"sm"),": { ",(0,l.kt)("inlineCode",{parentName:"td"},"h?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"w?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"x?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"y?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"  } ; ",(0,l.kt)("inlineCode",{parentName:"td"},"xs"),": { ",(0,l.kt)("inlineCode",{parentName:"td"},"h?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"w?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"x?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"y?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"  } ; ",(0,l.kt)("inlineCode",{parentName:"td"},"xxs"),": { ",(0,l.kt)("inlineCode",{parentName:"td"},"h?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"w?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"x?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,l.kt)("inlineCode",{parentName:"td"},"y?"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"number"),"  }  }) => ",(0,l.kt)("inlineCode",{parentName:"td"},"any"))))),(0,l.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/widget-types.ts#L37"},"system/core/frontend/src/widget-types.ts:37")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"widget_entityactions"},"Widget","_","EntityActions"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"Widget","_","EntityActions"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"type-declaration-22"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"data?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"setData?")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"data"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"T"),") => ",(0,l.kt)("inlineCode",{parentName:"td"},"any"))))),(0,l.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/widget-types.ts#L48"},"system/core/frontend/src/widget-types.ts:48")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"widget_postactions"},"Widget","_","PostActions"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"Widget","_","PostActions"),": ",(0,l.kt)("a",{parentName:"p",href:"#widget_entityactions"},(0,l.kt)("inlineCode",{parentName:"a"},"Widget_EntityActions")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"TPost"),">"," & { ",(0,l.kt)("inlineCode",{parentName:"p"},"editorInstance"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),"  }"),(0,l.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/widget-types.ts#L53"},"system/core/frontend/src/widget-types.ts:53")),(0,l.kt)("h2",{id:"variables-1"},"Variables"),(0,l.kt)("h3",{id:"apppropscontext"},"AppPropsContext"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"AppPropsContext"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Context"),"<",(0,l.kt)("a",{parentName:"p",href:"#tapppropscontext"},(0,l.kt)("inlineCode",{parentName:"a"},"TAppPropsContext")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,l.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L91"},"system/core/frontend/src/constants.ts:91")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"basebutton"},"BaseButton"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"BaseButton"),": ",(0,l.kt)("a",{parentName:"p",href:"#tbasebutton"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseButton"))),(0,l.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/BaseElements/BaseButton.tsx#L18"},"system/core/frontend/src/components/BaseElements/BaseButton.tsx:18")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"basetextfield"},"BaseTextField"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"BaseTextField"),": ",(0,l.kt)("a",{parentName:"p",href:"#tbasetextfield"},(0,l.kt)("inlineCode",{parentName:"a"},"TBaseTextField"))),(0,l.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/BaseElements/BaseTextField.tsx#L26"},"system/core/frontend/src/components/BaseElements/BaseTextField.tsx:26")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"blockcontentconsumer"},"BlockContentConsumer"),(0,l.kt)(

1"p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"BlockContentConsumer"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Consumer"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TBlockContentProvider"),">"),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"blockcontentprovider"},"BlockContentProvider"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"BlockContentProvider"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Provider"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TBlockContentProvider"),">"),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"blockstoreconsumer"},"BlockStoreConsumer"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"BlockStoreConsumer"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Consumer"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TBlockStoreProvider"),">"),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"blockstoreprovider"},"BlockStoreProvider"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"BlockStoreProvider"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Provider"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TBlockStoreProvider"),">"),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"blockcssclass"},"blockCssClass"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"blockCssClass"),": ",(0,l.kt)("inlineCode",{parentName:"p"},'"CB"')),(0,l.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L16"},"system/core/frontend/src/constants.ts:16")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"pagerootcontainerid"},"pageRootContainerId"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"pageRootContainerId"),": ",(0,l.kt)("inlineCode",{parentName:"p"},'"root"')),(0,l.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L68"},"system/core/frontend/src/constants.ts:68")),(0,l.kt)("h2",{id:"functions-1"},"Functions"),(0,l.kt)("h3",{id:"adminpanelwidgetplace"},"AdminPanelWidgetPlace"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"AdminPanelWidgetPlace"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,l.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,l.kt)("a",{parentName:"td",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")))))),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"props")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Object"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"props.pluginName?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"props.widgetName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"props.widgetProps?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")),"[",(0,l.kt)("inlineCode",{parentName:"td"},"T"),"]")))),(0,l.kt)("h4",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/AdminPanelWidget/AdminPanelWidgetPlace.tsx#L7"},"system/core/frontend/src/components/AdminPanelWidget/AdminPanelWidgetPlace.tsx:7")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"entityhead"},"EntityHead"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"EntityHead"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"__namedParameters"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("p",null,"Creates a default head (SEO meta tags) for any BaseEntity (e.g. Post, Product, etc. See EDBEntity)"),(0,l.kt)("h4",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"}

1,"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"__namedParameters")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Object")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"__namedParameters.entity?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TBasePageEntity")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"null")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"__namedParameters.image?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"null")),(0,l.kt)("td",{parentName:"tr",align:"left"},"-")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"__namedParameters.useFallback?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean")),(0,l.kt)("td",{parentName:"tr",align:"left"},"If ",(0,l.kt)("inlineCode",{parentName:"td"},"pageTitle")," is not defined, try to lookup for other known properties to use as ",(0,l.kt)("inlineCode",{parentName:"td"},"pageTitle"),". For example, ",(0,l.kt)("inlineCode",{parentName:"td"},"name")," in ",(0,l.kt)("inlineCode",{parentName:"td"},"Product")," entity.")))),(0,l.kt)("h4",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/EntityHead/EntityHead.tsx#L9"},"system/core/frontend/src/components/EntityHead/EntityHead.tsx:9")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"link"},"Link"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"Link"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"parameters-3"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"props")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TLinkProps"))))),(0,l.kt)("h4",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/Link/Link.tsx#L11"},"system/core/frontend/src/components/Link/Link.tsx:11")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"loadbox"},"LoadBox"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"LoadBox"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"parameters-4"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"props")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"LoadBoxProps"))))),(0,l.kt)("h4",{id:"returns-4"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/loadBox/Loadbox.tsx#L13"},"system/core/frontend/src/components/loadBox/Loadbox.tsx:13")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"signin"},"SignIn"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"SignIn"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"parameters-5"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"props")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#signinprops"},(0,l.kt)("inlineCode",{parentName:"a"},"SignInProps")))))),(0,l.kt)("h4",{id:"returns-5"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/SignIn/SignIn.tsx#L83"},"system/core/frontend/src/components/SignIn/SignIn.tsx:83")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"signup"},"SignUp"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"SignUp"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"parameters-6"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"props")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#signupprops"},(0,l.kt)("inlineCode",{parentName:"a"},"SignUpProps")))))),(0,l.kt)("h4",{id:"returns-6"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/SignUp/SignUp.tsx#L51"},"system/core/frontend/src/components/SignUp/SignUp.tsx:51")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"awaitimporter"},"awaitImporter"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"awaitImporter"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"returns-7"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,l.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L70"},"system/core/frontend/src/constants.ts:70")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"cleanparsecontext"},"cleanParseContext"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"cleanParseContext"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"contextName"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"parameters-7"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"contextName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-8"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/parserTransform.tsx#L48"},"system/core/frontend/src/helpers/parserTransform.tsx:48")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"fetch"},"fetch"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"fetch"),"(...",(0,l.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("p",null,"Isomorphic fetch"),(0,l.kt)("h4",{id:"parameters-8"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"...args")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"),"[]")))),(0,l.kt)("h4",{id:"returns-9"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"any")),(0,l.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/isomorphicFetch.ts#L7"},"system/core/frontend/src/helpers/isomorphicFetch.ts:7")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getauthclient"},"getAuthClient"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getAuthClient"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"AuthClient")),(0,l.kt)("h4",{id:"returns-10"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"AuthClient")),(0,l.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/AuthClient.ts#L444"},"system/core/frontend/src/helpers/AuthClient.ts:444")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getblockbyid"},"getBlockById"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getBlockById"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"blockId?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlock"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Component"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlockProps"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Component"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Object"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"Object"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">",">",", ",(0,l.kt)("inlineCode",{parentName:"p"},"Object"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,l.kt)("h4",{id:"parameters-9"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"blockId?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-11"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlock"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Component"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlockProps"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Component"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Object"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"Object"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">",">",", ",(0,l.kt)("inlineCode",{parentName:"p"},"Object"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,l.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L29"},"system/core/frontend/src/constants.ts:29")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getblockdata"},"getBlockData"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getBlockData"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"block"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlockData")),(0,l.kt)("h4",{id:"parameters-10"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"block")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Node")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"ParentNode")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"Element")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"HTMLElement"))))),(0,l.kt)("h4",{id:"returns-12"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlockData")),(0,l.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L43"},"system/core/frontend/src/constants.ts:43")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getblockdatabyid"},"getBlockDataById"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getBlockDataById"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"blockId"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlockData")),(0,l.kt)("h4",{id:"parameters-11"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"blockId")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-13"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlockData")),(0,l.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L36"},"system/core/frontend/src/constants.ts:36")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getblockelementbyid"},"getBlockElementById"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getBlockElementById"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"id?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p

1"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,l.kt)("h4",{id:"parameters-12"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"id?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-14"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"HTMLElement")),(0,l.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L48"},"system/core/frontend/src/constants.ts:48")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getblockhtmlid"},"getBlockHtmlId"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getBlockHtmlId"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"parameters-13"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"id")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-15"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L17"},"system/core/frontend/src/constants.ts:17")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getblockhtmltype"},"getBlockHtmlType"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getBlockHtmlType"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"type"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"parameters-14"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"type")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TCromwellBlockType"))))),(0,l.kt)("h4",{id:"returns-16"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L19"},"system/core/frontend/src/constants.ts:19")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getblockidfromhtml"},"getBlockIdFromHtml"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getBlockIdFromHtml"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"htmlId"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"parameters-15"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"htmlId")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-17"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L18"},"system/core/frontend/src/constants.ts:18")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getblocktypefromhtml"},"getBlockTypeFromHtml"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getBlockTypeFromHtml"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"className"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlockType")),(0,l.kt)("h4",{id:"parameters-16"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"className")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-18"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TCromwellBlockType")),(0,l.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L20"},"system/core/frontend/src/constants.ts:20")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getcstore"},"getCStore"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getCStore"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.CStore"},(0,l.kt)("inlineCode",{parentName:"a"},"CStore"))),(0,l.kt)("p",null,"Get CStore instance"),(0,l.kt)("h4",{id:"parameters-17"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"options?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tgetcstoreoptions"},(0,l.kt)("inlineCode",{parentName:"a"},"TGetCStoreOptions")))))),(0,l.kt)("h4",{id:"returns-19"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.CStore"},(0,l.kt)("inlineCode",{parentName:"a"},"CStore"))),(0,l.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/CStore.ts#L782"},"system/core/frontend/src/helpers/CStore.ts:782")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getcentralserverclient"},"getCentralServerClient"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getCentralServerClient"),"(): ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.CentralServerClient"},(0,l.kt)("inlineCode",{parentName:"a"},"CentralServerClient"))),(0,l.kt)("p",null,"Get CentralServerClient instance from global store (singleton)"),(0,l.kt)("h4",{id:"returns-20"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.CentralServerClient"},(0,l.kt)("inlineCode",{parentName:"a"},"CentralServerClient"))),(0,l.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/api/CentralServerClient.ts#L209"},"system/core/frontend/src/api/CentralServerClient.ts:209")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getdynamicloader"},"getDynamicLoader"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getDynamicLoader"),"(): ",(0,l.kt)("a",{parentName:"p",href:"#tdynamicloader"},(0,l.kt)("inlineCode",{parentName:"a"},"TDynamicLoader"))),(0,l.kt)("h4",{id:"returns-21"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"#tdynamicloader"},(0,l.kt)("inlineCode",{parentName:"a"},"TDynamicLoader"))),(0,l.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L65"},"system/core/frontend/src/constants.ts:65")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getgraphqlclient"},"getGraphQLClient"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getGraphQLClient"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"fetch?"),"): ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.CGra

1phQLClient"},(0,l.kt)("inlineCode",{parentName:"a"},"CGraphQLClient"))),(0,l.kt)("p",null,"Get CGraphQLClient instance from global store (singleton)"),(0,l.kt)("h4",{id:"parameters-18"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"fetch?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"))))),(0,l.kt)("h4",{id:"returns-22"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.CGraphQLClient"},(0,l.kt)("inlineCode",{parentName:"a"},"CGraphQLClient"))),(0,l.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/api/CGraphQLClient.ts#L1215"},"system/core/frontend/src/api/CGraphQLClient.ts:1215")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"gethtmlpluginblockname"},"getHtmlPluginBlockName"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getHtmlPluginBlockName"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"parameters-19"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"name")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-23"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L27"},"system/core/frontend/src/constants.ts:27")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getloadablefrontendbundle"},"getLoadableFrontendBundle"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getLoadableFrontendBundle"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"bundleName"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"loader"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"loadable?"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"fallbackComponent?"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"dynamicLoaderProps?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"ComponentType"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Object"),">"),(0,l.kt)("h4",{id:"parameters-20"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"bundleName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"loader")),(0,l.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,l.kt)("inlineCode",{parentName:"td"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"TFrontendBundle"),">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"loadable?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#tdynamicloader"},(0,l.kt)("inlineCode",{parentName:"a"},"TDynamicLoader")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"fallbackComponent?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ComponentType"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"dynamicLoaderProps?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,l.kt)("h4",{id:"returns-24"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"ComponentType"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Object"),">"),(0,l.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/loadFrontendBundle.ts#L86"},"system/core/frontend/src/helpers/loadFrontendBundle.ts:86")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getmoduleimporter"},"getModuleImporter"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getModuleImporter"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"serverPublicDir?"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"serverSide?"),"): ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.Importer"},(0,l.kt)("inlineCode",{parentName:"a"},"Importer"))),(0,l.kt)("h4",{id:"parameters-21"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"serverPublicDir?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"serverSide?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,l.kt)("h4",{id:"returns-25"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.Importer"},(0,l.kt)("inlineCode",{parentName:"a"},"Importer"))),(0,l.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/importer.ts#L447"},"system/core/frontend/src/helpers/importer.ts:447")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getnamedwidgetforplace"},"getNamedWidgetForPlace"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getNamedWidgetForPlace"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,l.kt)("inlineCode",{parentName:"p"},"widgetName"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"pluginName"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"widgetProps?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,l.kt)("a",{parentName:"td",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")))))),(0,l.kt)("h4",{id:"parameters-22"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"widgetName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"pluginName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"widgetProps?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")),"[",(0,l.kt)("inlineCode",{parentName:"td"},"T"),"]")))),(0,l.kt)("h4",{id:"returns-26"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Element")),(0,l.kt)("h4",{id:"defined-in-64"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/AdminPanelWidget/AdminPanelWidgetPlace.tsx#L30"},"system/core/frontend/src/components/AdminPanelWidget/AdminPanelWidgetPlace.tsx:30")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getparsertransform"}

1,"getParserTransform"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getParserTransform"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"contextName"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"options?"),"): (",(0,l.kt)("inlineCode",{parentName:"p"},"node"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Element"),") => ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"void")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,l.kt)("h4",{id:"parameters-23"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"contextName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"options?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TParserTransformOptions"))))),(0,l.kt)("h4",{id:"returns-27"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"fn")),(0,l.kt)("p",null,"\u25b8 (",(0,l.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"void")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,l.kt)("h5",{id:"parameters-24"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"node")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Element"))))),(0,l.kt)("h5",{id:"returns-28"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"void")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,l.kt)("h4",{id:"defined-in-65"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/parserTransform.tsx#L61"},"system/core/frontend/src/helpers/parserTransform.tsx:61")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getpluginstaticurl"},"getPluginStaticUrl"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getPluginStaticUrl"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"pluginName"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"parameters-25"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"pluginName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-29"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-66"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/contentGetters.ts#L2"},"system/core/frontend/src/helpers/contentGetters.ts:2")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getrestapiclient"},"getRestApiClient"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getRestApiClient"),"(): ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.CRestApiClient"},(0,l.kt)("inlineCode",{parentName:"a"},"CRestApiClient"))),(0,l.kt)("p",null,"Get CRestApiClient instance from global store (singleton)"),(0,l.kt)("h4",{id:"returns-30"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/frontend.CRestApiClient"},(0,l.kt)("inlineCode",{parentName:"a"},"CRestApiClient"))),(0,l.kt)("h4",{id:"defined-in-67"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/api/CRestApiClient.ts#L869"},"system/core/frontend/src/api/CRestApiClient.ts:869")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getservicesecret"},"getServiceSecret"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getServiceSecret"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"returns-31"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"defined-in-68"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/getServiceSecret.ts#L3"},"system/core/frontend/src/helpers/getServiceSecret.ts:3")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getwidgets"},"getWidgets"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getWidgets"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,l.kt)("inlineCode",{parentName:"p"},"widgetName"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"ComponentType"),"<",(0,l.kt)("a",{parentName:"p",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")),"[",(0,l.kt)("inlineCode",{parentName:"p"},"T"),"]",">",">"),(0,l.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,l.kt)("a",{parentName:"td",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")))))),(0,l.kt)("h4",{id:"parameters-26"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"widgetName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"returns-32"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"ComponentType"),"<",(0,l.kt)("a",{parentName:"p",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")),"[",(0,l.kt)("inlineCode",{parentName:"p"},"T"),"]",">",">"),(0,l.kt)("h4",{id:"defined-in-69"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/registerWidget.ts#L32"},"system/core/frontend/src/helpers/registerWidget.ts:32")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"getwidgetsforplace"},"getWidgetsForPlace"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"getWidgetsForPlace"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,l.kt)("inlineCode",{parentName:"p"},"widgetName"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"widgetProps?"),"): (",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Element"),")[]"),(0,l.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,l.kt)("a",{parentName:"td",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")))))),(0,l.kt)("h4",{id:"parameters-27"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"widgetName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"widgetProps?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")),"[",(0,l.kt)("inlineCode",{parentName:"td"},"T"),"]")))),(0,l.kt)("h4",{id:"returns-33"},"Returns"),(0,l.kt)("p",null,"(",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Element"),")[]"),(0,l.kt)("h4",{id:"defined-in-70"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/components/AdminPanelWidget/AdminPanelWidgetPlace.tsx#L41"},"system/core/frontend/src/components/AdminPanelWidget/AdminPanelWidgetPlace.tsx:41")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"iconfrompath"},"iconFromPath"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"iconFromPath"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"path"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"ComponentType"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"SVGProps"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"SVGSVGElement"),">",">"),(0,l.kt)("h4",{id:"parameters-28"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"path")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"any"))))),(0,l.kt)("h4",{id:"returns-34"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"ComponentType"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"SVGProps"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"SVGSVGElement"),">",">"),(0,l.kt)("h4",{id:"defined-in-71"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/iconFromPath.tsx#L3"},"system/core/frontend/src/helpers/iconFromPath.tsx:3")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isadminpanel"},"isAdminPanel"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"isAdminPanel"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"returns-35"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"defined-in-72"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L55"},"system/core/frontend/src/constants.ts:55")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"loadfrontendbundle"},"loadFrontendBundle"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"loadFrontendBundle"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"bundleName"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"loader"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,l.kt)("h4",{id:"parameters-29"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"bundleName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"loader")),(0,l.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,l.kt)("inlineCode",{parentName:"td"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"td"},"TFrontendBundle"),">")))),(0,l.kt)("h4",{id:"returns-36"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,l.kt)("h4",{id:"defined-in-73"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/loadFrontendBundle.ts#L10"},"system/core/frontend/src/helpers/loadFrontendBundle.ts:10")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"makeparsercontext"},"makeParserContext"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"makeParserContext"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"contextName"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"parameters-30"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"contextName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))))),(0,l.kt)("h4",{id:"returns-37"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-74"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/b

1lob/master/system/core/frontend/src/helpers/parserTransform.tsx#L40"},"system/core/frontend/src/helpers/parserTransform.tsx:40")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"onwidgetregister"},"onWidgetRegister"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"onWidgetRegister"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,l.kt)("inlineCode",{parentName:"p"},"widgetName"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"callback"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"type-parameters-10"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,l.kt)("a",{parentName:"td",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")))))),(0,l.kt)("h4",{id:"parameters-31"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"widgetName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"callback")),(0,l.kt)("td",{parentName:"tr",align:"left"},"(",(0,l.kt)("inlineCode",{parentName:"td"},"pluginName"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,l.kt)("inlineCode",{parentName:"td"},"component"),": ",(0,l.kt)("inlineCode",{parentName:"td"},"ComponentType"),"<",(0,l.kt)("a",{parentName:"td",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")),"[",(0,l.kt)("inlineCode",{parentName:"td"},"T"),"]",">",") => ",(0,l.kt)("inlineCode",{parentName:"td"},"any"))))),(0,l.kt)("h4",{id:"returns-38"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-75"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/registerWidget.ts#L26"},"system/core/frontend/src/helpers/registerWidget.ts:26")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"parsehtml"},"parseHtml"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"parseHtml"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">",">","[]"),(0,l.kt)("h4",{id:"parameters-32"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"html")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"options?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TParserTransformOptions"))))),(0,l.kt)("h4",{id:"returns-39"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"any"),">",">","[]"),(0,l.kt)("h4",{id:"defined-in-76"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/parserTransform.tsx#L103"},"system/core/frontend/src/helpers/parserTransform.tsx:103")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"registerpluginssr"},"registerPluginSSR"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"registerPluginSSR"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"pluginName"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"pageRoute"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("p",null,"Registers a Plugin on a specific page for frontend (Next.js server)\nso a plugin will be able to re

1ceive its server-side props. If you don't\nneed those props, then you can just use CPlugin without registering."),(0,l.kt)("h4",{id:"parameters-33"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"pluginName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"name in package.json on the plugin")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"pageRoute")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string")),(0,l.kt)("td",{parentName:"tr",align:"left"},"see ",(0,l.kt)("inlineCode",{parentName:"td"},"route")," in ",(0,l.kt)("a",{parentName:"td",href:"https://cromwellcms.com/docs/development/theme-development#page-config-properties"},"https://cromwellcms.com/docs/development/theme-development#page-config-properties")," ",(0,l.kt)("inlineCode",{parentName:"td"},"pageRoute")," also can have ",(0,l.kt)("inlineCode",{parentName:"td"},"*")," value to register on all pages.")))),(0,l.kt)("h4",{id:"returns-40"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-77"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/registerPlugin.ts#L9"},"system/core/frontend/src/helpers/registerPlugin.ts:9")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"registerwidget"},"registerWidget"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"registerWidget"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,l.kt)("inlineCode",{parentName:"p"},"options"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"type-parameters-11"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,l.kt)("a",{parentName:"td",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")))))),(0,l.kt)("h4",{id:"parameters-34"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"options")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Object"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"options.component")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ComponentType"),"<",(0,l.kt)("a",{parentName:"td",href:"#widgettypes"},(0,l.kt)("inlineCode",{parentName:"a"},"WidgetTypes")),"[",(0,l.kt)("inlineCode",{parentName:"td"},"T"),"]",">")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"options.pluginName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"string"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"options.widgetName")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"returns-41"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-78"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/registerWidget.ts#L6"},"system/core/frontend/src/helpers/registerWidget.ts:6")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"useapppropscontext"},"useAppPropsContext"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"useAppPropsContext"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"TProps"),">","(): ",(0,l.kt)("a",{parentName:"p",href:"#tapppropscontext"},(0,l.kt)("inlineCode",{parentName:"a"},"TAppPropsContext")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"TProps"),">"),(0,l.kt)("h4",{id:"type-parameters-12"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TProps")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,l.kt)("h4",{id:"returns-42"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"#tapppropscontext"},(0,l.kt)("inlineCode",{parentName:"a"},"TAppPropsContext")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"TProps"),">"),(0,l.kt)("h4",{id:"defined-in-79"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/constants.ts#L93"},"system/core/frontend/src/constants.ts:93")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"useauthclient"},"useAuthClient"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"useAuthClient"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"AuthClient")),(0,l.kt)("h4",{id:"returns-43"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"AuthClient")),(0,l.kt)("h4",{id:"defined-in-80"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/AuthClient.ts#L449"},"system/core/frontend/src/helpers/AuthClient.ts:449")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"usecart"},"useCart"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"useCart"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"TStoreListItem"),"[]"),(0,l.kt)("h4",{id:"parameters-35"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"options?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TUseCStorePropertyOptions"))))),(0,l.kt)("h4",{id:"returns-44"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"TStoreListItem"),"[]"),(0,l.kt)("h4",{id:"defined-in-81"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/hooks.ts#L11"},"system/core/frontend/src/helpers/hooks.ts:11")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"usecmssettings"},"useCmsSettings"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"useCmsSettings"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TCmsSettings")),(0,l.kt)("h4",{id:"returns-45"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TCmsSettings")),(0,l.kt)("h4",{id:"defined-in-82"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/hooks.ts#L81"},"system/core/frontend/src/helpers/hooks.ts:81")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"usecurrency"},"useCurrency"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"useCurrency"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"returns-46"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"defined-in-83"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/hooks.ts#L80"},"system/core/frontend/src/helpers/hooks.ts:80")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"useforceupdate"},"useForceUpdate"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"useForceUpdate"),"(): () => ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"returns-47"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"fn")),(0,l.kt)("p",null,"\u25b8 (): ",(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h5",{id:"returns-48"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"void")),(0,l.kt)("h4",{id:"defined-in-84"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/forceUpdate.ts#L3"},"system/core/frontend/src/helpers/forceUpdate.ts:3")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"useuserinfo"},"useUserInfo"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"useUserInfo"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TUser")),(0,l.kt)("h4",{id:"returns-49"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TUser")),(0,l.kt)("h4",{id:"defined-in-85"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/hooks.ts#L79"},"system/core/frontend/src/helpers/hooks.ts:79")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"usevieweditems"},"useViewedItems"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"useViewedItems"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"TStoreListItem"),"[]"),(0,l.kt)("h4",{id:"parameters-36"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"options?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TUseCStorePropertyOptions"))))),(0,l.kt)("h4",{id:"returns-50"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"TStoreListItem"),"[]"),(0,l.kt)("h4",{id:"defined-in-86"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/hooks.ts#L43"},"system/core/frontend/src/helpers/hooks.ts:43")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"usewishlist"}

1,"useWishlist"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,l.kt)("strong",{parentName:"p"},"useWishlist"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,l.kt)("inlineCode",{parentName:"p"},"TStoreListItem"),"[]"),(0,l.kt)("h4",{id:"parameters-37"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"options?")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"TUseCStorePropertyOptions"))))),(0,l.kt)("h4",{id:"returns-51"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"TStoreListItem"),"[]"),(0,l.kt)("h4",{id:"defined-in-87"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/frontend/src/helpers/hooks.ts#L27"},"system/core/frontend/src/helpers/hooks.ts:27")))}s.isMDXComponent=!0},5318:function(e,t,n){n.d(t,{Zo:function(){return m},kt:function(){return N}});var a=n(7378);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?l(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):l(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function p(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},l=Object.keys(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),o=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=o(e.components);return a.createElement(d.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},s=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),s=o(n),N=r,C=s["".concat(d,".").concat(N)]||s[N]||k[N]||l;return n?a.createElement(C,i(i({ref:t},m),{},{components:n})):a.createElement(C,i({ref:t},m))}));function N(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,i=new Array(l);i[0]=s;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,i[1]=p;for(var o=2;o<l;o++)i[o]=n[o];return a.createElement.apply(null,i)}return a.createElement.apply(null,n)}s.displayName="MDXCreateElement"}}]);