https://cromwellcms.com/assets/js/ab722dfc.90d2a47b.js

1"use strict";(self.webpackChunk_cromwell_website=self.webpackChunk_cromwell_website||[]).push([[1846],{7134:function(e,t,n){n.r(t),n.d(t,{frontMatter:function(){return p},contentTitle:function(){return s},metadata:function(){return o},toc:function(){return u},default:function(){return d}});var a=n(5773),i=n(808),l=(n(7378),n(5318)),r=["components"],p={title:"PluginInput"},s="Class: PluginInput",o={unversionedId:"api/classes/backend.PluginInput",id:"api/classes/backend.PluginInput",isDocsHomePage:!1,title:"PluginInput",description:"backend.PluginInput",source:"@site/docs/api/classes/backend.PluginInput.md",sourceDirName:"api/classes",slug:"/api/classes/backend.PluginInput",permalink:"/docs/api/classes/backend.PluginInput",tags:[],version:"current",frontMatter:{title:"PluginInput"},sidebar:"tutorialSidebar",previous:{title:"PluginEntity",permalink:"/docs/api/classes/backend.PluginEntity"},next:{title:"PluginRepository",permalink:"/docs/api/classes/backend.PluginRepository"}},u=[{value:"Hierarchy",id:"hierarchy",children:[]},{value:"Implements",id:"implements",children:[]},{value:"Table of contents",id:"table-of-contents",children:[{value:"Constructors",id:"constructors",children:[]},{value:"Properties",id:"properties",children:[]}]},{value:"Constructors",id:"constructors-1",children:[{value:"constructor",id:"constructor",children:[]}]},{value:"Properties",id:"properties-1",children:[{value:"customMeta",id:"custommeta",children:[]},{value:"defaultSettings",id:"defaultsettings",children:[]},{value:"hasAdminBundle",id:"hasadminbundle",children:[]},{value:"isEnabled",id:"isenabled",children:[]}

1,{value:"isInstalled",id:"isinstalled",children:[]},{value:"meta",id:"meta",children:[]},{value:"moduleInfo",id:"moduleinfo",children:[]},{value:"name",id:"name",children:[]},{value:"pageDescription",id:"pagedescription",children:[]},{value:"pageTitle",id:"pagetitle",children:[]},{value:"settings",id:"settings",children:[]},{value:"slug",id:"slug",children:[]},{value:"title",id:"title",children:[]}]}],m={toc:u};function d(e){var t=e.components,n=(0,i.Z)(e,r);return(0,l.kt)("wrapper",(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("h1",{id:"class-plugininput"},"Class: PluginInput"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules/backend"},"backend"),".PluginInput"),(0,l.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput"},(0,l.kt)("inlineCode",{parentName:"a"},"BasePageInput"))),(0,l.kt)("p",{parentName:"li"},"\u21b3 ",(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"PluginInput"))))),(0,l.kt)("h2",{id:"implements"},"Implements"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("inlineCode",{parentName:"li"},"TPluginEntityInput"))),(0,l.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,l.kt)("h3",{id:"constructors"},"Constructors"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#constructor"},"constructor"))),(0,l.kt)("h3",{id:"properties"},"Properties"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#custommeta"},"customMeta")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#defaultsettings"},"defaultSettings")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#hasadminbundle"},"hasAdminBundle")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#isenabled"},"isEnabled")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#isinstalled"},"isInstalled")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#meta"},"meta")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#moduleinfo"},"moduleInfo")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#name"},"name")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#pagedescription"},"pageDescription")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#pagetitle"},"pageTitle")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#settings"},"settings")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#slug"},"slug")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#title"},"title"))),(0,l.kt)("h2",{id:"constructors-1"},"Constructors"),(0,l.kt)("h3",{id:"constructor"},"constructor"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"new PluginInput"),"()"),(0,l.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput"},"BasePageInput"),".",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput#constructor"},"constructor")),(0,l.kt)("h2",{id:"properties-1"},"Properties"),(0,l.kt)("h3",{id:"custommeta"},"customMeta"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"customMeta"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,l.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.customMeta"),(0,l.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput"},"BasePageInput"),".",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput#custommeta"},"customMeta")),(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/backend/src/models/inputs/base-page.input.ts#L32"},"system/core/backend/src/models/inputs/base-page.input.ts:32")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"defaultsettings"},"defaultSettings"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"defaultSettings"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.defaultSettings"),(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/backend/src/models/inputs/plugin.input.ts#L25"},"system/core/backend/src/models/inputs/plugin.input.ts:25")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"hasadminbundle"},"hasAdminBundle"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"hasAdminBundle"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.hasAdminBundle"),(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/backend/src/models/inputs/plugin.input.ts#L19"},"system/core/backend/src/models/inputs/plugin.input.ts:19")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isenabled"},"isEnabled"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"isEnabled"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.isEnabled"),(0,l.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput"},"BasePageInput"),".",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput#isenabled"},"isEnabled")),(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/backend/src/models/inputs/base-page.input.ts#L26"},"system/core/backend/src/models/inputs/base-page.input.ts:26")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"isinstalled"},"isInstalled"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"isInstalled"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"boolean")),(0,l.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.isInstalled"),(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/backend/src/models/inputs/plugin.input.ts#L16"},"system/core/backend/src/models/inputs/plugin.input.ts:16")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"meta"},"meta"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"meta"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"TBasePageMeta")),(0,l.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.meta"),(0,l.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput"},"BasePageInput"),".",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput#meta"},"meta")),(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/backend/src/models/inputs/base-page.input.ts#L29"},"system/core/backend/src/models/inputs/base-page.input.ts:29")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"moduleinfo"},"moduleInfo"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"moduleInfo"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"implementation-of-6"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.moduleInfo"),(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/backend/src/models/inputs/plugin.input.ts#L28"},"system/core/backend/src/models/inputs/plugin.input.ts:28")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"name"},"name"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"name"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"implementation-of-7"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.name"),(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/backend/src/models/inputs/plugin.input.ts#L10"},"system/core/backend/src/models/inputs/plugin.input.ts:10")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"pagedescription"},"pageDescription"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"pageDescription"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"implementation-of-8"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.pageDescription"),(0,l.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput"},"BasePageInput"),".",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput#pagedescription"},"pageDescription")),(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/backend/src/models/inputs/base-page.input.ts#L23"},"system/core/backend/src/models/inputs/base-page.input.ts:23")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"pagetitle"},"pageTitle"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"pageTitle"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"implementation-of-9"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.pageTitle"),(0,l.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput"},"BasePageInput"),".",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput#pagetitle"},"pageTitle")),(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/backend/src/models/inputs/base-page.input.ts#L20"},"system/core/backend/src/models/inputs/base-page.input.ts:20")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"settings"},"settings"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"settings"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"implementation-of-10"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.settings"),(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/backend/src/models/inputs/plugin.input.ts#L22"},"system/core/backend/src/models/inputs/plugin.input.ts:22")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"slug"},"slug"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"slug"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"implementation-of-11"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.slug"),(0,l.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput"},"BasePageInput"),".",(0,l.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BasePageInput#slug"},"slug")),(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/backend/src/models/inputs/base-page.input.ts#L17"},"system/core/backend/src/models/inputs/base-page.input.ts:17")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"title"}

1,"title"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,l.kt)("strong",{parentName:"p"},"title"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")),(0,l.kt)("h4",{id:"implementation-of-12"},"Implementation of"),(0,l.kt)("p",null,"TPluginEntityInput.title"),(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/backend/src/models/inputs/plugin.input.ts#L13"},"system/core/backend/src/models/inputs/plugin.input.ts:13")))}d.isMDXComponent=!0},5318:function(e,t,n){n.d(t,{Zo:function(){return u},kt:function(){return c}});var a=n(7378);function i(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 r(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){i(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,i=function(e,t){if(null==e)return{};var n,a,i={},l=Object.keys(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||(i[n]=e[n]);return i}(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)&&(i[n]=e[n])}return i}var s=a.createContext({}),o=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},u=function(e){var t=o(e.components);return a.createElement(s.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,l=e.originalType,s=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),d=o(n),c=i,k=d["".concat(s,".").concat(c)]||d[c]||m[c]||l;return n?a.createElement(k,r(r({ref:t},u),{},{components:n})):a.createElement(k,r({ref:t},u))}));function c(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,r=new Array(l);r[0]=d;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p.mdxType="string"==typeof e?e:i,r[1]=p;for(var o=2;o<l;o++)r[o]=n[o];return a.createElement.apply(null,r)}return a.createElement.apply(null,n)}d.displayName="MDXCreateElement"}}]);