diff --git a/404.html b/404.html index 22263d6dc..11f7772ad 100644 --- a/404.html +++ b/404.html @@ -15,8 +15,8 @@ - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

diff --git a/assets/js/033a99ac.d67bd2f4.js b/assets/js/033a99ac.d67bd2f4.js new file mode 100644 index 000000000..bdf644dd1 --- /dev/null +++ b/assets/js/033a99ac.d67bd2f4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkadminforth=self.webpackChunkadminforth||[]).push([[2634],{8504:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>m,frontMatter:()=>d,metadata:()=>l,toc:()=>t});var i=o(4848),r=o(8453);const d={},s="AdminForthResourceColumnCommon",l={id:"api/types/Common/interfaces/AdminForthResourceColumnCommon",title:"AdminForthResourceColumnCommon",description:"Column describes one field in the table or collection in database.",source:"@site/docs/api/types/Common/interfaces/AdminForthResourceColumnCommon.md",sourceDirName:"api/types/Common/interfaces",slug:"/api/types/Common/interfaces/AdminForthResourceColumnCommon",permalink:"/docs/api/types/Common/interfaces/AdminForthResourceColumnCommon",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"apiSidebar",previous:{title:"AdminForthForeignResourceCommon",permalink:"/docs/api/types/Common/interfaces/AdminForthForeignResourceCommon"},next:{title:"AdminForthResourceColumnInputCommon",permalink:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon"}},c={},t=[{value:"Extends",id:"extends",level:2},{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"_underlineType?",id:"_underlinetype",level:3},{value:"allowMinMaxQuery?",id:"allowminmaxquery",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"backendOnly?",id:"backendonly",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"components?",id:"components",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"editReadonly?",id:"editreadonly",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"editingNote?",id:"editingnote",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"enforceLowerCase?",id:"enforcelowercase",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"enum?",id:"enum",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"extra?",id:"extra",level:3},{value:"jsonCollapsedLevel?",id:"jsoncollapsedlevel",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"fillOnCreate?",id:"filloncreate",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"foreignResource?",id:"foreignresource",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"isUnique?",id:"isunique",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"label?",id:"label",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"masked?",id:"masked",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"max?",id:"max",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"maxLength?",id:"maxlength",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"maxValue?",id:"maxvalue",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"min?",id:"min",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"minLength?",id:"minlength",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"minValue?",id:"minvalue",level:3},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"primaryKey?",id:"primarykey",level:3},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"required?",id:"required",level:3},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"showIn?",id:"showin",level:3},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"sortable?",id:"sortable",level:3},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"type?",id:"type",level:3},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"validation?",id:"validation",level:3},{value:"Inherited from",id:"inherited-from-25",level:4},{value:"virtual?",id:"virtual",level:3},{value:"Inherited from",id:"inherited-from-26",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"adminforthresourcecolumncommon",children:"AdminForthResourceColumnCommon"}),"\n",(0,i.jsx)(n.p,{children:"Column describes one field in the table or collection in database."}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/api/types/Back/interfaces/AdminForthResourceColumn",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumn"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"_underlinetype",children:"_underlineType?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"_underlineType"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Internal type which indicates original type of column in database."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"allowminmaxquery",children:"allowMinMaxQuery?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"allowMinMaxQuery"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether AdminForth will show this field in list view."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#allowminmaxquery",children:(0,i.jsx)(n.code,{children:"allowMinMaxQuery"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"backendonly",children:"backendOnly?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"backendOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"if true field will !not be passed to UI under no circumstances, but will be presented in hooks"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#backendonly",children:(0,i.jsx)(n.code,{children:"backendOnly"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"components",children:"components?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"components"}),": ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthFieldComponents",children:(0,i.jsx)(n.code,{children:"AdminForthFieldComponents"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Custom components which will be used to render this field in the admin panel."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#components",children:(0,i.jsx)(n.code,{children:"components"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"editreadonly",children:"editReadonly?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"editReadonly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether AdminForth will allow to edit this field in editing mode."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#editreadonly",children:(0,i.jsx)(n.code,{children:"editReadonly"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"editingnote",children:"editingNote?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"editingNote"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether AdminForth will show editing note near the field in edit/create form."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#editingnote",children:(0,i.jsx)(n.code,{children:"editingNote"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enforcelowercase",children:"enforceLowerCase?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"enforceLowerCase"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Will automatically convert any capital letters to lowercase in input during editing"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#enforcelowercase",children:(0,i.jsx)(n.code,{children:"enforceLowerCase"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enum",children:"enum?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"enum"}),": ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthColumnEnumItem",children:(0,i.jsx)(n.code,{children:"AdminForthColumnEnumItem"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Enum of possible values for this field."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#enum",children:(0,i.jsx)(n.code,{children:"enum"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extra",children:"extra?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"extra"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional configuration object for extra settings."}),"\n",(0,i.jsx)(n.h4,{id:"jsoncollapsedlevel",children:"jsonCollapsedLevel?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"jsonCollapsedLevel"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["How many levels of JSON should be collapsed.\n",(0,i.jsx)(n.code,{children:"0"})," means - root level will be already collapsed e.g. ",(0,i.jsx)(n.code,{children:"{a:1}"})," will show ",(0,i.jsx)(n.code,{children:"{...}"})," where ",(0,i.jsx)(n.code,{children:"'...'"})," is clickable\n",(0,i.jsx)(n.code,{children:"1"})," means - root level will be shown, but next sub-level will be collapsed e.g. ",(0,i.jsx)(n.code,{children:"{a: {b: 1}}"})," will show ",(0,i.jsx)(n.code,{children:"{a: ...}"})," where ",(0,i.jsx)(n.code,{children:"'...'"})," is clickable"]}),"\n",(0,i.jsx)(n.p,{children:"Default is 1."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#extra",children:(0,i.jsx)(n.code,{children:"extra"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"filloncreate",children:"fillOnCreate?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"fillOnCreate"}),": ",(0,i.jsx)(n.code,{children:"Function"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether AdminForth will show this field in show view."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#filloncreate",children:(0,i.jsx)(n.code,{children:"fillOnCreate"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"foreignresource",children:"foreignResource?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"foreignResource"}),": ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthForeignResourceCommon",children:(0,i.jsx)(n.code,{children:"AdminForthForeignResourceCommon"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Foreign resource which has pk column with values same that written in this column."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#foreignresource",children:(0,i.jsx)(n.code,{children:"foreignResource"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isunique",children:"isUnique?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isUnique"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether AdminForth will request user to enter unique value during creating or editing record.\nThis option causes AdminForth to make a request to database to check if value is unique.\n(Constraints are not used, so for large-tables performance make sure you have unique index in database if you set this option to true)"}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#isunique",children:(0,i.jsx)(n.code,{children:"isUnique"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"How column can be labled in the admin panel.\nUse it for renaming columns. Defaulted to column name with Uppercased first letter."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#label",children:(0,i.jsx)(n.code,{children:"label"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"masked",children:"masked?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"masked"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Masked fields will be displayed as ",(0,i.jsx)(n.code,{children:"*****"})," on Edit and Create pages."]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#masked",children:(0,i.jsx)(n.code,{children:"masked"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"max",children:"max?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"max"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#max",children:(0,i.jsx)(n.code,{children:"max"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"maxlength",children:"maxLength?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"maxLength"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Maximum length of string that can be entered in this field."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#maxlength",children:(0,i.jsx)(n.code,{children:"maxLength"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"maxvalue",children:"maxValue?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"maxValue"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Maximum value that can be entered in this field."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#maxvalue",children:(0,i.jsx)(n.code,{children:"maxValue"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"min",children:"min?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"min"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#min",children:(0,i.jsx)(n.code,{children:"min"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"minlength",children:"minLength?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"minLength"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Minimum length of string that can be entered in this field."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#minlength",children:(0,i.jsx)(n.code,{children:"minLength"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"minvalue",children:"minValue?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"minValue"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Minimum value that can be entered in this field."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-18",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#minvalue",children:(0,i.jsx)(n.code,{children:"minValue"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Column name in database."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-19",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#name",children:(0,i.jsx)(n.code,{children:"name"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"primarykey",children:"primaryKey?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"primaryKey"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether to use this column as record identifier.\nOnly one column can be primary key.\nAdminForth tries to guess primary key automatically first."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-20",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#primarykey",children:(0,i.jsx)(n.code,{children:"primaryKey"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"required",children:"required?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"required"}),": ",(0,i.jsx)(n.code,{children:"boolean"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether AdminForth will require this field to be filled in create and edit forms.\nCan be set to boolean or object with create and edit properties.\nIf boolean, it will be used for both create and edit forms."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-21",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#required",children:(0,i.jsx)(n.code,{children:"required"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"showin",children:"showIn?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"showIn"}),": (",(0,i.jsx)(n.code,{children:'"show"'})," | ",(0,i.jsx)(n.code,{children:'"list"'})," | ",(0,i.jsx)(n.code,{children:'"edit"'})," | ",(0,i.jsx)(n.code,{children:'"create"'})," | ",(0,i.jsx)(n.code,{children:'"filter"'})," | ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/enumerations/AdminForthResourcePages",children:(0,i.jsx)(n.code,{children:"AdminForthResourcePages"})}),")[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"On which AdminForth pages this field will be shown. By default all.\nExample: if you want to show field only in create and edit pages, set it to"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"showIn: [AdminForthResourcePages.CREATE, AdminForthResourcePages.EDIT]\n"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-22",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#showin",children:(0,i.jsx)(n.code,{children:"showIn"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sortable",children:"sortable?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"sortable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-23",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#sortable",children:(0,i.jsx)(n.code,{children:"sortable"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"type",children:"type?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/enumerations/AdminForthDataTypes",children:(0,i.jsx)(n.code,{children:"AdminForthDataTypes"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Type of data in column.\nAdminForth will use this information to render proper input fields in the admin panel.\nAdminForth tries to guess type of data from database column type automatically for typed databases like SQL-based.\nHowever you can explicitly set it to any value. E.g. set AdminForthDataTypes.DATETIME for your string column in SQLite, which stores ISO date strings."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-24",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#type",children:(0,i.jsx)(n.code,{children:"type"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"validation",children:"validation?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"validation"}),": ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/type-aliases/ValidationObject",children:(0,i.jsx)(n.code,{children:"ValidationObject"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Runtime validation Regexp rules for this field."}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from-25",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon",children:(0,i.jsx)(n.code,{children:"AdminForthResourceColumnInputCommon"})})," . ",(0,i.jsx)(n.a,{href:"/docs/api/types/Common/interfaces/AdminForthResourceColumnInputCommon#validation",children:(0,i.jsx)(n.code,{children:"validation"})})]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"virtual",children:"virtual?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"virtual"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Allows to make the field which does not exist in database table.\nExamples: add custom show field with user country flag:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"{\n label: 'Country Flag',\n type: AdminForthDataTypes.STRING,\n virtual: true,\n showIn: [AdminForthResourcePages.SHOW, AdminForthResourcePages.LIST],\n components: {\n show: '@@/CountryFlag.vue',\n list: '@@/CountryFlag.vue',\n },\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["This field will be displayed in show and list views with custom component ",(0,i.jsx)(n.code,{children:"CountryFlag.vue"}),". CountryFlag.vue should be placed in custom folder and can be next:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-html",children:"\n\n - - + +
Skip to main content

Build AI-Assisted blog with AdminForth and Nuxt in 20 minutes

· 19 min read
Ivan Borshcho
Ivan Borshcho
Maintainer of AdminForth

Many developers today are using copilots to write code faster and relax their minds from a routine tasks.

diff --git a/blog/archive/index.html b/blog/archive/index.html index fe96f633a..cde6117d8 100644 --- a/blog/archive/index.html +++ b/blog/archive/index.html @@ -15,8 +15,8 @@ - - + +

Archive

Archive

2024​

diff --git a/blog/chatgpt-plugin/index.html b/blog/chatgpt-plugin/index.html index 332eeb274..f6e1f28b1 100644 --- a/blog/chatgpt-plugin/index.html +++ b/blog/chatgpt-plugin/index.html @@ -15,8 +15,8 @@ - - + +

Chat-GPT plugin to co-write texts and strings

· 4 min read
Ivan Borshcho
Ivan Borshcho
Maintainer of AdminForth

Couple of days ago we released a plugin which allows you to co-write texts and strings with the AI.

diff --git a/blog/compose-ec2-deployment-github-actions/index.html b/blog/compose-ec2-deployment-github-actions/index.html index e5044d13a..50976a21d 100644 --- a/blog/compose-ec2-deployment-github-actions/index.html +++ b/blog/compose-ec2-deployment-github-actions/index.html @@ -15,8 +15,8 @@ - - + +

Deploy AdminForth to EC2 with terraform on CI

· 8 min read
Ivan Borshcho
Ivan Borshcho
Maintainer of AdminForth

Here is more advanced snippet to deploy AdminForth to Terraform.

diff --git a/blog/compose-ec2-deployment/index.html b/blog/compose-ec2-deployment/index.html index 45f1517ca..0c7cbad81 100644 --- a/blog/compose-ec2-deployment/index.html +++ b/blog/compose-ec2-deployment/index.html @@ -15,8 +15,8 @@ - - + +

Deploy AdminForth to EC2 with terraform (without CI)

· 4 min read
Ivan Borshcho
Ivan Borshcho
Maintainer of AdminForth

Here is a row snippet to deploy AdminForth to Terraform.

diff --git a/blog/index.html b/blog/index.html index 870ddf7a0..09815b207 100644 --- a/blog/index.html +++ b/blog/index.html @@ -15,8 +15,8 @@ - - + +

Deploy AdminForth to EC2 with terraform on CI

· 8 min read
Ivan Borshcho
Ivan Borshcho
Maintainer of AdminForth

Here is more advanced snippet to deploy AdminForth to Terraform.

diff --git a/blog/tags/aws/index.html b/blog/tags/aws/index.html index 4fa8d3c2b..33f957baa 100644 --- a/blog/tags/aws/index.html +++ b/blog/tags/aws/index.html @@ -15,8 +15,8 @@ - - + +

2 posts tagged with "AWS"

Amazon Web Services (AWS) is a cloud computing platform that provides a wide range of services for building and deploying applications.

View All Tags

Deploy AdminForth to EC2 with terraform on CI

· 8 min read
Ivan Borshcho
Ivan Borshcho
Maintainer of AdminForth

Here is more advanced snippet to deploy AdminForth to Terraform.

diff --git a/blog/tags/chatgpt/index.html b/blog/tags/chatgpt/index.html index b6feb6c8f..13736f20c 100644 --- a/blog/tags/chatgpt/index.html +++ b/blog/tags/chatgpt/index.html @@ -15,8 +15,8 @@ - - + +

2 posts tagged with "ChatGPT"

ChatGPT is a conversational AI model that can generate human-like responses to text inputs.

View All Tags

Build AI-Assisted blog with AdminForth and Nuxt in 20 minutes

· 19 min read
Ivan Borshcho
Ivan Borshcho
Maintainer of AdminForth

Many developers today are using copilots to write code faster and relax their minds from a routine tasks.

diff --git a/blog/tags/github-actions/index.html b/blog/tags/github-actions/index.html index bb25703c4..b40d1d2a3 100644 --- a/blog/tags/github-actions/index.html +++ b/blog/tags/github-actions/index.html @@ -15,8 +15,8 @@ - - + +

One post tagged with "GitHub Actions"

GitHub Actions is a continuous integration and continuous deployment (CI/CD) service provided by GitHub that allows you to automate your software development workflows.

View All Tags

Deploy AdminForth to EC2 with terraform on CI

· 8 min read
Ivan Borshcho
Ivan Borshcho
Maintainer of AdminForth

Here is more advanced snippet to deploy AdminForth to Terraform.

diff --git a/blog/tags/index.html b/blog/tags/index.html index b56f54128..2b96592c7 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -15,8 +15,8 @@ - - + +

Tags

diff --git a/blog/tags/nuxt/index.html b/blog/tags/nuxt/index.html index 912c29570..903090fc9 100644 --- a/blog/tags/nuxt/index.html +++ b/blog/tags/nuxt/index.html @@ -15,8 +15,8 @@ - - + +

One post tagged with "Nuxt.js"

Nuxt.js is a free and open-source web application framework based on Vue.js, Node.js, Webpack, and Babel.js.

View All Tags

Build AI-Assisted blog with AdminForth and Nuxt in 20 minutes

· 19 min read
Ivan Borshcho
Ivan Borshcho
Maintainer of AdminForth

Many developers today are using copilots to write code faster and relax their minds from a routine tasks.

diff --git a/blog/tags/plugin/index.html b/blog/tags/plugin/index.html index 4763fd878..5fa62be20 100644 --- a/blog/tags/plugin/index.html +++ b/blog/tags/plugin/index.html @@ -15,8 +15,8 @@ - - + +

One post tagged with "Plugin"

Plugins are extensions that add new features or functionality to a AdminForth.

View All Tags

Chat-GPT plugin to co-write texts and strings

· 4 min read
Ivan Borshcho
Ivan Borshcho
Maintainer of AdminForth

Couple of days ago we released a plugin which allows you to co-write texts and strings with the AI.

diff --git a/blog/tags/terraform/index.html b/blog/tags/terraform/index.html index a749cb3a9..b01c3e64a 100644 --- a/blog/tags/terraform/index.html +++ b/blog/tags/terraform/index.html @@ -15,8 +15,8 @@ - - + +

2 posts tagged with "Terraform"

Terraform is an open-source infrastructure as code software tool created by HashiCorp that enables users to define and provision data center infrastructure using a declarative configuration language.

View All Tags

Deploy AdminForth to EC2 with terraform on CI

· 8 min read
Ivan Borshcho
Ivan Borshcho
Maintainer of AdminForth

Here is more advanced snippet to deploy AdminForth to Terraform.

diff --git a/docs/api/index.html b/docs/api/index.html index 042ec6b3a..eee076c49 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -15,11 +15,11 @@ - - + + -

TypeDoc API

+
diff --git a/docs/api/types/Back/classes/Filters/index.html b/docs/api/types/Back/classes/Filters/index.html index f23d29184..b55cf9a24 100644 --- a/docs/api/types/Back/classes/Filters/index.html +++ b/docs/api/types/Back/classes/Filters/index.html @@ -15,11 +15,11 @@ - - + + -

Filters

+
+

IAdminForthFilter

\ No newline at end of file diff --git a/docs/api/types/Back/classes/Sorts/index.html b/docs/api/types/Back/classes/Sorts/index.html index 01df32039..d540882b8 100644 --- a/docs/api/types/Back/classes/Sorts/index.html +++ b/docs/api/types/Back/classes/Sorts/index.html @@ -15,11 +15,11 @@ - - + + -

Sorts

+

Sorts

Constructors​

new Sorts()​

diff --git a/docs/api/types/Back/enumerations/AdminForthMenuTypes/index.html b/docs/api/types/Back/enumerations/AdminForthMenuTypes/index.html deleted file mode 100644 index 944c12974..000000000 --- a/docs/api/types/Back/enumerations/AdminForthMenuTypes/index.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - -AdminForthMenuTypes | Vue & Node admin panel framework - - - - - - - - - - - - - - - -

AdminForthMenuTypes

-

Enumeration Members​

-
Enumeration MemberValueDescription
divider"divider"DIVIDER is a divider between menu items.
gap"gap"GAP ads some space between menu items.
group"group"GROUP is a group of menu items. Respects label, icon and children properties in AdminForthConfigMenuItem use @AdminForthMenuTypes.open to set if group is open by default
heading"heading"HEADING is just a label in the menu. Respect label and icon property in AdminForthConfigMenuItem
page"page"

PAGE is a link to a custom page. Respects label, icon, path, component, homepage, isStaticRoute, properties in AdminForthConfigMenuItem

Example:

{

type: AdminForthMenuTypes.PAGE,

label: 'Custom Page',

icon: 'home',

path: '/dash',

component: '@@/Dashboard.vue',

homepage: true,

}

resource"resource"RESOURCE is a link to a resource. Respects label, icon, resourceId, homepage, isStaticRoute properties in AdminForthConfigMenuItem
- - \ No newline at end of file diff --git a/docs/api/types/Back/index.html b/docs/api/types/Back/index.html index 793073420..703b9d697 100644 --- a/docs/api/types/Back/index.html +++ b/docs/api/types/Back/index.html @@ -15,19 +15,17 @@ - - + + -

types/Back

+

types/Back

Index​

-

Enumerations​

-
EnumerationDescription
AdminForthMenuTypes-

Classes​

ClassDescription
Filters-
Sorts-

Interfaces​

-
InterfaceDescription
AdminForthBulkAction-
AdminForthConfigMain configuration object for AdminForth
AdminForthConfigMenuItemMenu item which displayed in the left sidebar of the admin panel.
AdminForthForeignResource-
AdminForthResourceResource describes one table or collection in database. AdminForth generates set of pages for 'list', 'show', 'edit', 'create', 'filter' operations for each resource.
AdminForthResourceColumnColumn describes one field in the table or collection in database.
IAdminForth-
IAdminForthAuth-
IAdminForthDataSourceConnector-
IAdminForthDataSourceConnectorBaseInterface that exposes methods to interact with AdminForth in standard way
IAdminForthDataSourceConnectorConstructor-
IAdminForthFilter-
IAdminForthHttpResponse-
IAdminForthPlugin-
IAdminForthRestAPI-
IAdminForthSort-
ICodeInjector-
IConfigValidator-
IExpressHttpServerImplement this interface to create custom HTTP server adapter for AdminForth.
IHttpServerImplement this interface to create custom HTTP server adapter for AdminForth.
IOperationalResource-
IWebSocketBroker-
IWebSocketClient-
+
InterfaceDescription
AdminForthBulkAction-
AdminForthConfig-
AdminForthConfigCustomization-
AdminForthForeignResource-
AdminForthInputConfigMain configuration object for AdminForth
AdminForthResourceResource describes one table or collection in database. AdminForth generates set of pages for 'list', 'show', 'edit', 'create', 'filter' operations for each resource.
AdminForthResourceColumnColumn describes one field in the table or collection in database.
AdminForthResourceInput-
IAdminForth-
IAdminForthAuth-
IAdminForthDataSourceConnector-
IAdminForthDataSourceConnectorBaseInterface that exposes methods to interact with AdminForth in standard way
IAdminForthDataSourceConnectorConstructor-
IAdminForthFilter-
IAdminForthHttpResponse-
IAdminForthPlugin-
IAdminForthRestAPI-
IAdminForthSort-
ICodeInjector-
IConfigValidator-
IExpressHttpServerImplement this interface to create custom HTTP server adapter for AdminForth.
IHttpServerImplement this interface to create custom HTTP server adapter for AdminForth.
IOperationalResource-
IWebSocketBroker-
IWebSocketClient-
ResourceOptions-
ResourceOptionsInputGeneral options for resource.

Type Aliases​

-
Type aliasDescription
AdminForthDataSourceData source describes database connection which will be used to fetch data for resources. Each resource should use one data source.
AfterDataSourceResponseFunctionModify response to change how data is returned after fetching from database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
AfterSaveFunctionModify record to change how data is saved to database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
AllowedActionValueDefines whether user has access to an action, can statically be Boolean or function which returns Boolean or string with error message
AllowedActionsObject which describes allowed actions for user.
BeforeDataSourceRequestFunctionModify query to change how data is fetched from database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
BeforeLoginConfirmationFunctionAllow to get user data before login confirmation, will triger when user try to login.
BeforeSaveFunctionModify record to change how data is saved to database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
FDataFilter-
FDataSort-
ResourceOptionsGeneral options for resource.
+
Type aliasDescription
AdminForthDataSourceData source describes database connection which will be used to fetch data for resources. Each resource should use one data source.
AfterDataSourceResponseFunctionModify response to change how data is returned after fetching from database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
AfterSaveFunctionModify record to change how data is saved to database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
AllowedActionValueDefines whether user has access to an action, can statically be Boolean or function which returns Boolean or string with error message
AllowedActions-
AllowedActionsInputObject which describes allowed actions for user.
BeforeDataSourceRequestFunctionModify query to change how data is fetched from database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
BeforeLoginConfirmationFunctionAllow to get user data before login confirmation, will triger when user try to login.
BeforeSaveFunctionModify record to change how data is saved to database. Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
FDataFilter-
FDataSort-
\ No newline at end of file diff --git a/docs/api/types/Back/interfaces/AdminForthBulkAction/index.html b/docs/api/types/Back/interfaces/AdminForthBulkAction/index.html index 57890649f..2ba38890b 100644 --- a/docs/api/types/Back/interfaces/AdminForthBulkAction/index.html +++ b/docs/api/types/Back/interfaces/AdminForthBulkAction/index.html @@ -15,11 +15,11 @@ - - + + -

AdminForthBulkAction

+

AdminForthBulkAction

Extends​

\ No newline at end of file diff --git a/docs/api/types/Back/interfaces/AdminForthConfigCustomization/index.html b/docs/api/types/Back/interfaces/AdminForthConfigCustomization/index.html new file mode 100644 index 000000000..1d05a9869 --- /dev/null +++ b/docs/api/types/Back/interfaces/AdminForthConfigCustomization/index.html @@ -0,0 +1,189 @@ + + + + + +AdminForthConfigCustomization | Vue & Node admin panel framework + + + + + + + + + + + + + + + +

AdminForthConfigCustomization

+

Extends​

+
    +
  • Omit<AdminForthInputConfigCustomization, "loginPageInjections" | "globalInjections">
    • +
+

Properties​

+

announcementBadge()?​

+
+

optional announcementBadge: (user) => AnnouncementBadgeResponse

+
+

Function to return custom badge in side bar for users. Can return text or html +If function is not passed or returns null, badge will not be shown. +Execution is done on admin app load.

+

Parameters​

+
ParameterType
userAdminUser
+

Returns​

+

AnnouncementBadgeResponse

+

Inherited from​

+

Omit.announcementBadge

+
+ +
+

optional brandLogo: string

+
+

Path to your app logo

+

Example: +Place file logo.svg to ./custom folder and set this option:

+
brandLogo: '@@/logo.svg',
+

Inherited from​

+

Omit.brandLogo

+
+

brandName​

+
+

brandName: string

+
+

Overrides​

+

Omit.brandName

+
+

brandNameSlug​

+
+

brandNameSlug: string

+
+

Slug which will be used on tech side e.g. to store cookies separately. +Created automatically from brandName if not set.

+
+

customComponentsDir?​

+
+

optional customComponentsDir: string

+
+

Relative or absolute path to custom components directory +By default equals ./custom.

+

Custom .vue files, images, and any other assets placed in this directory can be accessed in AdminForth components and configs with @@/.

+

For example if file path is ./custom/comp/my.vue, you can use it in AdminForth config like this:

+
components: {
 show: '@@/comp/my.vue',
}
+

Inherited from​

+

Omit.customComponentsDir

+
+

customPages​

+
+

customPages: AdminForthPageDeclaration[]

+
+

Overrides​

+

Omit.customPages

+
+

dateFormats​

+
+

dateFormats: string

+
+
+

datesFormat?​

+
+

optional datesFormat: string

+
+

DayJS format string for all dates in the app. +Defaulted to 'MMM D, YYYY'

+

Inherited from​

+

Omit.datesFormat

+
+

emptyFieldPlaceholder?​

+
+

optional emptyFieldPlaceholder: string | object

+
+

Placeholder for empty fields in lists and show views, by default empty string ''

+

Inherited from​

+

Omit.emptyFieldPlaceholder

+
+

favicon?​

+
+

optional favicon: string

+
+

Path to your app favicon

+

Example: +Place file favicon.png to ./custom folder and set this option:

+
favicon: '@@/favicon.png',
+

Inherited from​

+

Omit.favicon

+
+

globalInjections​

+
+

globalInjections: object

+
+ +
+

header: AdminForthComponentDeclarationFull[]

+
+ +
+

sidebar: AdminForthComponentDeclarationFull[]

+
+

userMenu​

+
+

userMenu: AdminForthComponentDeclarationFull[]

+
+
+

loginPageInjections​

+
+

loginPageInjections: object

+
+

underInputs​

+
+

underInputs: AdminForthComponentDeclarationFull[]

+
+
+

showBrandNameInSidebar​

+
+

showBrandNameInSidebar: boolean

+
+

Overrides​

+

Omit.showBrandNameInSidebar

+
+

styles?​

+
+

optional styles: Object

+
+

Object to redefine default styles for AdminForth components. Use this file as reference for all possible adjustments https://github.com/devforth/adminforth/blob/main/adminforth/modules/styles.ts

+

Inherited from​

+

Omit.styles

+
+

timeFormat​

+
+

timeFormat: string

+
+

Overrides​

+

Omit.timeFormat

+
+

title?​

+
+

optional title: string

+
+

HTML title tag value, defaults to brandName

+

Inherited from​

+

Omit.title

+
+

vueUsesFile?​

+
+

optional vueUsesFile: string

+
+

Path to custom .ts file which allows to inject custom Vue uses in SPA or add custom imports.

+

Example: Create file: ./custom/vue-uses.ts with next content:

+
import HighchartsVue from 'highcharts-vue';
// import '@@/custom.scss'; // here is how you can import custom styles

export default function (app) {
   app.use(HighchartsVue);
}
+

Install HighCharts into custom folder:

+
cd custom
npm init -y
npm install highcharts highcharts-vue
+

And specify vueUsesFile in AdminForth config:

+
vueUsesFile: '@@/vue-uses.ts',
+

Inherited from​

+

Omit.vueUsesFile

+ + \ No newline at end of file diff --git a/docs/api/types/Back/interfaces/AdminForthConfigMenuItem/index.html b/docs/api/types/Back/interfaces/AdminForthConfigMenuItem/index.html deleted file mode 100644 index 341b71a43..000000000 --- a/docs/api/types/Back/interfaces/AdminForthConfigMenuItem/index.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - -AdminForthConfigMenuItem | Vue & Node admin panel framework - - - - - - - - - - - - - - - -

AdminForthConfigMenuItem

-

Menu item which displayed in the left sidebar of the admin panel.

-

Properties​

-

_itemId?​

-
-

optional _itemId: string

-
-

Item id will be automatically generated from hashed resourceId+Path+label

-
-

badge?​

-
-

optional badge: string | (user) => Promise<string>

-
-

Optional callback which will be called before rendering the menu for each item. -Result of callback if not null will be used as a small badge near the menu item.

-
-

children?​

-
-

optional children: AdminForthConfigMenuItem[]

-
-

Children menu items which will be displayed in this group. -Supported for AdminForthMenuTypes.GROUP only!

-
-

component?​

-
-

optional component: string

-
-

Component to be used for this menu item. Component should be placed in custom folder and referenced with @@/ prefix. -Supported for AdminForthMenuTypes.PAGE only! -Example:

-
component: '@@/Dashboard.vue',
-
-

homepage?​

-
-

optional homepage: boolean

-
-

If true, group will be open by default after user login to the admin panel. -Also will be used to redirect from root path.

-
-

icon?​

-
-

optional icon: string

-
-

Icon for menu item which will be displayed in the admin panel. -Supports iconify icons in format <icon set name>:<icon name> -Browse available icons here: https://icon-sets.iconify.design/

-

Example:

-
icon: 'flowbite:brain-solid',
-
-

isStaticRoute?​

-
-

optional isStaticRoute: boolean

-
-

By default all pages are imported dynamically with lazy import(). -If you wish to import page statically, set this option to true. -Homepage will be imported statically by default. but you can override it with this option.

-
-

label?​

-
-

optional label: string

-
-

Label for menu item which will be displayed in the admin panel.

-
-

meta?​

-
-

optional meta: object

-
-

title?​

-
-

optional title: string

-
-
-

open?​

-
-

optional open: boolean

-
-

Where Group is open by default -Supported for AdminForthMenuTypes.GROUP only!

-
-

path?​

-
-

optional path: string

-
-

Path to custom component which will be displayed in the admin panel.

-
-

resourceId?​

-
-

optional resourceId: string

-
-

Resource ID which will be used to fetch data from. -Supported for AdminForthMenuTypes.RESOURCE only!

-
-

type?​

-
-

optional type: "resource" | "heading" | "group" | "page" | "gap" | "divider" | AdminForthMenuTypes

-
-
-

visible()?​

-
-

optional visible: (user) => boolean

-
-

Optional callback which will be called before rendering the menu for each item. -You can use it to hide menu items depending on some user

-

Parameters​

-
ParameterType
userAdminUser
-

Returns​

-

boolean

- - \ No newline at end of file diff --git a/docs/api/types/Back/interfaces/AdminForthForeignResource/index.html b/docs/api/types/Back/interfaces/AdminForthForeignResource/index.html index a33cebd08..fab2bb500 100644 --- a/docs/api/types/Back/interfaces/AdminForthForeignResource/index.html +++ b/docs/api/types/Back/interfaces/AdminForthForeignResource/index.html @@ -15,11 +15,11 @@ - - + + -

AdminForthForeignResource

+
+

AdminForthForeignResourceCommon . resourceId

\ No newline at end of file diff --git a/docs/api/types/Back/interfaces/AdminForthInputConfig/index.html b/docs/api/types/Back/interfaces/AdminForthInputConfig/index.html new file mode 100644 index 000000000..535b6fac5 --- /dev/null +++ b/docs/api/types/Back/interfaces/AdminForthInputConfig/index.html @@ -0,0 +1,163 @@ + + + + + +AdminForthInputConfig | Vue & Node admin panel framework + + + + + + + + + + + + + + + +

AdminForthInputConfig

+

Main configuration object for AdminForth

+

Properties​

+

auth?​

+
+

optional auth: object

+
+

Authorization module configuration

+

beforeLoginConfirmation?​

+
+

optional beforeLoginConfirmation: BeforeLoginConfirmationFunction | BeforeLoginConfirmationFunction[]

+
+

Function or functions which will be called before user try to login. +Each function will resive User object as an argument

+

demoCredentials?​

+
+

optional demoCredentials: string

+
+

Pair of login and pass substitution for demo mode. Split by ':' +! This option is for demo purposes only, never use it for your projects

+

loginBackgroundImage?​

+
+

optional loginBackgroundImage: string

+
+

File path to custom background image for login page +Example: +Place file login-background.jpg to ./custom folder and set this option:

+
loginBackgroundImage: '@@/login-background.jpg',
+

loginBackgroundPosition?​

+
+

optional loginBackgroundPosition: "over" | "1/2" | "1/3" | "2/3" | "3/4" | "2/5" | "3/5"

+
+

Position of background image on login page +'over' - image will be displayed over full login page under login form +'1/2' - image will be displayed on left 1/2 of login page

+

Default: '1/2'

+

loginPromptHTML?​

+
+

optional loginPromptHTML: string

+
+

Any prompt to show users on login. Supports HTML.

+

passwordHashField​

+
+

passwordHashField: string

+
+

Field name (column name) in user resource which will be used to get hash of password. +Can be e.g. 'passwordHash'

+

rememberMeDays?​

+
+

optional rememberMeDays: number

+
+

Remember me days for "Remember Me" checkbox on login page. +If not set or set to null/0/undefined, "Remember Me" checkbox will not be displayed. +If rememberMeDays is set, then users who check "Remember Me" will be staying logged in for this amount of days.

+

resourceId?​

+
+

optional resourceId: string

+
+

Legacy field left for backward compatibility. Use usersResourceId instead.

+

userFullNameField?​

+
+

optional userFullNameField: string

+
+

Optionally if your users table has a field(column) with full name, you can set it here. +This field will be used to display user name in the top right corner of the admin panel.

+

usernameField​

+
+

usernameField: string

+
+

Field name (column name) in user resource which will be used as username for searching user in database during login. +Can be e.g. 'email' or 'username'

+

usersResourceId?​

+
+

optional usersResourceId: string

+
+

Resource ID for resource which stores user table. +Resource is a table in database where users will be stored and fetched from. Resources and their ids are defined in resources section of the config. +In other words this setting is a reference to a table in database where users will be fetched from on login.

+

websocketSubscribed()?​

+
+

optional websocketSubscribed: (topic, user) => void

+
+

callback which will be called after user subscribes to websocket topic

+
Parameters​
+
ParameterTypeDescription
topicstringtopic on which user subscribed
userAdminUseruser object
+
Returns​
+

void

+

websocketTopicAuth()?​

+
+

optional websocketTopicAuth: (topic, user) => Promise<boolean>

+
+

Can be used to limit user access when subscribing from frontend to websocket topics.

+
Parameters​
+
ParameterTypeDescription
topicstringtopic where user is trying to subscribe
userAdminUseruser object
+
Returns​
+

Promise<boolean>

+
+

baseUrl?​

+
+

optional baseUrl: string

+
+

If you want to Serve AdminForth from a subdirectory, e.g. on example.com/backoffice, you can specify it like:

+
baseUrl: '/backoffice',
+
+

customization?​

+
+

optional customization: AdminForthInputConfigCustomization

+
+

Settings which allow you to customize AdminForth

+
+

dataSources​

+
+

dataSources: AdminForthDataSource[]

+
+

List of data sources which will be used to fetch data for resources. +Datasource is one database connection

+
+

databaseConnectors?​

+
+

optional databaseConnectors: object

+
+

If you want use custom DataSource which is not supported by AdminForth yet, you can define it's class here

+

Index signature​

+

[key: string]: IAdminForthDataSourceConnectorConstructor

+
+ +
+

menu: AdminForthConfigMenuItem[]

+
+

Array of left sidebar menu items which will be displayed in the admin panel. +Menu items can be links to resources or custom pages. +Menu items can be grouped.

+
+

resources​

+
+

resources: AdminForthResourceInput[]

+
+

Array of resources which will be displayed in the admin panel. +Resource represents one table or collection in database. +Each resource has its own configuration.

+ + \ No newline at end of file diff --git a/docs/api/types/Back/interfaces/AdminForthResource/index.html b/docs/api/types/Back/interfaces/AdminForthResource/index.html index b56a86c5d..a78265f37 100644 --- a/docs/api/types/Back/interfaces/AdminForthResource/index.html +++ b/docs/api/types/Back/interfaces/AdminForthResource/index.html @@ -15,16 +15,16 @@ - - + + -

AdminForthResource

+

AdminForthResource

Resource describes one table or collection in database. AdminForth generates set of pages for 'list', 'show', 'edit', 'create', 'filter' operations for each resource.

Extends​

Properties​

columns​

@@ -42,9 +42,9 @@

dataSourceInherited from​

Omit.dataSource

-

dataSourceColumns?​

+

dataSourceColumns​

-

optional dataSourceColumns: AdminForthResourceColumn[]

+

dataSourceColumns: AdminForthResourceColumn[]

Overrides​

Omit.dataSourceColumns

@@ -161,19 +161,19 @@

  • request additional data from database before returning to frontend for soft-join
+

Overrides​

+

Omit.hooks

-

label?​

+

label​

-

optional label: string

+

label: string

-

Label for resource which will be displayed in the admin panel. -By default it equals to table name in database.

-

Inherited from​

+

Overrides​

Omit.label

-

options?​

+

options​

-

optional options: ResourceOptions

+

options: ResourceOptions

plugins?​

@@ -181,25 +181,25 @@

plugins?IAdminForthPlugin[]

Array of plugins which will be used to modify resource configuration.

+

Overrides​

+

Omit.plugins

-

recordLabel?​

+

recordLabel()​

-

optional recordLabel: Function

+

recordLabel: (record) => string

-

Hook which allow you to modify record label

-

Example:

-
recordLabel: (record) => `${record.name} - ${record.id}`,
-

Inherited from​

+

Parameters​

+
ParameterType
recordany
+

Returns​

+

string

+

Overrides​

Omit.recordLabel

-

resourceId?​

+

resourceId​

-

optional resourceId: string

+

resourceId: string

-

Unique identifier of resource. By default it equals to table name in database. -If you wish you can explicitly set it to any string. -We added to support cases when 2 datasources have tables with the same name.

-

Inherited from​

+

Overrides​

Omit.resourceId

table​

@@ -207,7 +207,7 @@

tableInherited from​

-

Omit.table

+

Inherited from​

+

Omit.table

\ No newline at end of file diff --git a/docs/api/types/Back/interfaces/AdminForthResourceColumn/index.html b/docs/api/types/Back/interfaces/AdminForthResourceColumn/index.html index 1db75afc5..95c68b0e6 100644 --- a/docs/api/types/Back/interfaces/AdminForthResourceColumn/index.html +++ b/docs/api/types/Back/interfaces/AdminForthResourceColumn/index.html @@ -15,15 +15,15 @@ - - + + -

AdminForthResourceColumn

+

AdminForthResourceColumn

Column describes one field in the table or collection in database.

Extends​

Properties​

_underlineType?​

@@ -32,7 +32,7 @@

_underlineTyp

Internal type which indicates original type of column in database.

Inherited from​

-

AdminForthResourceColumnCommon._underlineType

+

AdminForthResourceColumnCommon . _underlineType

allowMinMaxQuery?​

@@ -40,7 +40,7 @@

allowMinMax

Whether AdminForth will show this field in list view.

Inherited from​

-

AdminForthResourceColumnCommon.allowMinMaxQuery

+

AdminForthResourceColumnCommon . allowMinMaxQuery

backendOnly?​

@@ -48,7 +48,7 @@

backendOnly?

if true field will !not be passed to UI under no circumstances, but will be presented in hooks

Inherited from​

-

AdminForthResourceColumnCommon.backendOnly

+

AdminForthResourceColumnCommon . backendOnly

components?​

@@ -56,7 +56,7 @@

components?

Custom components which will be used to render this field in the admin panel.

Inherited from​

-

AdminForthResourceColumnCommon.components

+

AdminForthResourceColumnCommon . components

editReadonly?​

@@ -64,7 +64,7 @@

editReadonly?

Whether AdminForth will allow to edit this field in editing mode.

Inherited from​

-

AdminForthResourceColumnCommon.editReadonly

+

AdminForthResourceColumnCommon . editReadonly

editingNote?​

@@ -72,7 +72,7 @@

editingNote?

Whether AdminForth will show editing note near the field in edit/create form.

Inherited from​

-

AdminForthResourceColumnCommon.editingNote

+

AdminForthResourceColumnCommon . editingNote

enforceLowerCase?​

@@ -80,7 +80,7 @@

enforceLowe

Will automatically convert any capital letters to lowercase in input during editing

Inherited from​

-

AdminForthResourceColumnCommon.enforceLowerCase

+

AdminForthResourceColumnCommon . enforceLowerCase

enum?​

@@ -88,7 +88,7 @@

enum?Inherited from​

-

AdminForthResourceColumnCommon.enum

+

AdminForthResourceColumnCommon . enum

extra?​

@@ -104,7 +104,7 @@

jsonColla 1 means - root level will be shown, but next sub-level will be collapsed e.g. {a: {b: 1}} will show {a: ...} where '...' is clickable

Default is 1.

Inherited from​

-

AdminForthResourceColumnCommon.extra

+

AdminForthResourceColumnCommon . extra

fillOnCreate?​

@@ -112,14 +112,15 @@

fillOnCreate?

Whether AdminForth will show this field in show view.

Inherited from​

-

AdminForthResourceColumnCommon.fillOnCreate

+

AdminForthResourceColumnCommon . fillOnCreate

foreignResource?​

optional foreignResource: AdminForthForeignResource

+

Foreign resource which has pk column with values same that written in this column.

Overrides​

-

AdminForthResourceColumnCommon.foreignResource

+

AdminForthResourceColumnCommon . foreignResource

isUnique?​

@@ -129,7 +130,7 @@

isUnique?Inherited from​

-

AdminForthResourceColumnCommon.isUnique

+

AdminForthResourceColumnCommon . isUnique

label?​

@@ -138,7 +139,7 @@

label?Inherited from​

-

AdminForthResourceColumnCommon.label

+

AdminForthResourceColumnCommon . label

masked?​

@@ -146,14 +147,14 @@

masked?Inherited from​

-

AdminForthResourceColumnCommon.masked

+

AdminForthResourceColumnCommon . masked

max?​

optional max: number

Inherited from​

-

AdminForthResourceColumnCommon.max

+

AdminForthResourceColumnCommon . max

maxLength?​

@@ -161,7 +162,7 @@

maxLength?

Maximum length of string that can be entered in this field.

Inherited from​

-

AdminForthResourceColumnCommon.maxLength

+

AdminForthResourceColumnCommon . maxLength

maxValue?​

@@ -169,14 +170,14 @@

maxValue?Inherited from​

-

AdminForthResourceColumnCommon.maxValue

+

AdminForthResourceColumnCommon . maxValue

min?​

optional min: number

Inherited from​

-

AdminForthResourceColumnCommon.min

+

AdminForthResourceColumnCommon . min

minLength?​

@@ -184,7 +185,7 @@

minLength?

Minimum length of string that can be entered in this field.

Inherited from​

-

AdminForthResourceColumnCommon.minLength

+

AdminForthResourceColumnCommon . minLength

minValue?​

@@ -192,7 +193,7 @@

minValue?Inherited from​

-

AdminForthResourceColumnCommon.minValue

+

AdminForthResourceColumnCommon . minValue

name​

@@ -200,7 +201,7 @@

nameInherited from​

-

AdminForthResourceColumnCommon.name

+

AdminForthResourceColumnCommon . name

primaryKey?​

@@ -210,7 +211,7 @@

primaryKey?

Inherited from​

-

AdminForthResourceColumnCommon.primaryKey

+

AdminForthResourceColumnCommon . primaryKey

required?​

@@ -220,7 +221,7 @@

required?Inherited from​

-

AdminForthResourceColumnCommon.required

+

AdminForthResourceColumnCommon . required

showIn?​

@@ -230,14 +231,14 @@

showIn?
showIn: [AdminForthResourcePages.CREATE, AdminForthResourcePages.EDIT]

Inherited from​

-

AdminForthResourceColumnCommon.showIn

+

AdminForthResourceColumnCommon . showIn

sortable?​

optional sortable: boolean

Inherited from​

-

AdminForthResourceColumnCommon.sortable

+

AdminForthResourceColumnCommon . sortable

type?​

@@ -248,7 +249,7 @@

type?​

-

AdminForthResourceColumnCommon.type

+

AdminForthResourceColumnCommon . type

validation?​

@@ -256,7 +257,7 @@

validation?

Runtime validation Regexp rules for this field.

Inherited from​

-

AdminForthResourceColumnCommon.validation

+

AdminForthResourceColumnCommon . validation

virtual?​

@@ -268,6 +269,6 @@

virtual?
<template>
 {{ getFlagEmojiFromIso(record.ipCountry) }}
</template>

<script setup>
const props = defineProps(['record']);

function getFlagEmojiFromIso(iso) {
   return iso.toUpperCase().replace(/./g, (char) => String.fromCodePoint(char.charCodeAt(0) + 127397));
}
</script>

Inherited from​

-

AdminForthResourceColumnCommon.virtual

+

AdminForthResourceColumnCommon . virtual

\ No newline at end of file diff --git a/docs/api/types/Back/interfaces/AdminForthResourceInput/index.html b/docs/api/types/Back/interfaces/AdminForthResourceInput/index.html new file mode 100644 index 000000000..ee1538761 --- /dev/null +++ b/docs/api/types/Back/interfaces/AdminForthResourceInput/index.html @@ -0,0 +1,211 @@ + + + + + +AdminForthResourceInput | Vue & Node admin panel framework + + + + + + + + + + + + + + + +

AdminForthResourceInput

+

Extends​

+ +

Properties​

+

columns​

+
+

columns: AdminForthResourceColumn[]

+
+
+

dataSource​

+
+

dataSource: string

+
+

ID of datasource which will be used to fetch data from.

+

Inherited from​

+

Omit.dataSource

+
+

dataSourceColumns?​

+
+

optional dataSourceColumns: AdminForthResourceColumn[]

+
+
+

hooks?​

+
+

optional hooks: object

+
+

Hooks allow you to change the data on different stages of resource lifecycle. +Hooks are functions which will be called on backend side (only backend side).

+

create?​

+
+

optional create: object

+
+

create.afterSave?​

+
+

optional afterSave: AfterSaveFunction | AfterSaveFunction[]

+
+

Typical use-cases:

+
    +
  • Initiate some trigger after record saved to database (e.g sync to another datasource)
    • +
+

create.beforeSave?​

+
+

optional beforeSave: BeforeSaveFunction | BeforeSaveFunction[]

+
+

Typical use-cases:

+
    +
  • Validate record before saving to database and interrupt execution if validation failed (allowedActions.create should be preferred in most cases)
    • +
  • fill-in adminUser as creator of record
    • +
  • Attach additional data to record before saving to database (mostly fillOnCreate should be used instead)
    • +
+

delete?​

+
+

optional delete: object

+
+

delete.afterSave?​

+
+

optional afterSave: BeforeSaveFunction | BeforeSaveFunction[]

+
+

Typical use-cases:

+
    +
  • Initiate some trigger after record deleted from database (e.g sync to another datasource)
    • +
+

delete.beforeSave?​

+
+

optional beforeSave: BeforeSaveFunction | BeforeSaveFunction[]

+
+

Typical use-cases:

+
    +
  • Validate that record can be deleted and interrupt execution if validation failed (allowedActions.delete should be preferred in most cases)
    • +
+

edit?​

+
+

optional edit: object

+
+

edit.afterSave?​

+
+

optional afterSave: AfterSaveFunction | AfterSaveFunction[]

+
+

Typical use-cases:

+
    +
  • Same as hooks.create.afterSave but for edit page
    • +
+

edit.beforeSave?​

+
+

optional beforeSave: BeforeSaveFunction | BeforeSaveFunction[]

+
+

Typical use-cases:

+
    +
  • Same as hooks.create.beforeSave but for edit page
    • +
+

list?​

+
+

optional list: object

+
+

list.afterDatasourceResponse?​

+
+

optional afterDatasourceResponse: AfterDataSourceResponseFunction | AfterDataSourceResponseFunction[]

+
+

Typical use-cases:

+
    +
  • Same as hooks.show.afterDatasourceResponse but applied for all records returned from database for +showing in list view, e.g. add new field to each record in list view
    • +
+

list.beforeDatasourceRequest?​

+
+

optional beforeDatasourceRequest: BeforeDataSourceRequestFunction | BeforeDataSourceRequestFunction[]

+
+

Typical use-cases:

+
    +
  • add additional filters in addition to what user selected before fetching data from database.
    • +
  • same as hooks.show.beforeDatasourceRequest
    • +
+

show?​

+
+

optional show: object

+
+

show.afterDatasourceResponse?​

+
+

optional afterDatasourceResponse: AfterDataSourceResponseFunction | AfterDataSourceResponseFunction[]

+
+

Typical use-cases:

+
    +
  • Transform value for some field for record returned from database before returning to frontend (minimize, sanitize, etc)
    • +
  • If some-why you can't use backendOnly you can cleanup sensitive fields here
    • +
  • Attach additional data to record before returning to frontend
    • +
+

show.beforeDatasourceRequest?​

+
+

optional beforeDatasourceRequest: BeforeDataSourceRequestFunction | BeforeDataSourceRequestFunction[]

+
+

Typical use-cases:

+
    +
  • request additional data from database before returning to frontend for soft-join
    • +
+
+

label?​

+
+

optional label: string

+
+

Label for resource which will be displayed in the admin panel. +By default it equals to table name in database.

+

Inherited from​

+

Omit.label

+
+

options?​

+
+

optional options: ResourceOptionsInput

+
+
+

plugins?​

+
+

optional plugins: IAdminForthPlugin[]

+
+

Array of plugins which will be used to modify resource configuration.

+
+

recordLabel()?​

+
+

optional recordLabel: (item) => string

+
+

Hook which allow you to modify record label

+

Example:

+
recordLabel: (record) => `${record.name} - ${record.id}`,
+

Parameters​

+
ParameterType
itemany
+

Returns​

+

string

+

Inherited from​

+

Omit.recordLabel

+
+

resourceId?​

+
+

optional resourceId: string

+
+

Unique identifier of resource. By default it equals to table name in database. +If you wish you can explicitly set it to any string. +We added to support cases when 2 datasources have tables with the same name.

+

Inherited from​

+

Omit.resourceId

+
+

table​

+
+

table: string

+
+

Table name in database which will be used to fetch data from. Might be case sensitive.

+

Inherited from​

+

Omit.table

+ + \ No newline at end of file diff --git a/docs/api/types/Back/interfaces/IAdminForth/index.html b/docs/api/types/Back/interfaces/IAdminForth/index.html index f84c59448..225b826e1 100644 --- a/docs/api/types/Back/interfaces/IAdminForth/index.html +++ b/docs/api/types/Back/interfaces/IAdminForth/index.html @@ -15,11 +15,11 @@ - - + + -

IAdminForth

+

IAdminForth

Properties​

activatedPlugins​

@@ -31,11 +31,6 @@

authIAdminForthAuth

-

baseUrlSlashed​

-
-

baseUrlSlashed: string

-
-

codeInjector​

codeInjector: ICodeInjector

@@ -167,6 +162,6 @@

Returnserror?​

optional error: string

-
+
\ No newline at end of file diff --git a/docs/api/types/Back/interfaces/IAdminForthAuth/index.html b/docs/api/types/Back/interfaces/IAdminForthAuth/index.html index dcd726ecb..68ebba55b 100644 --- a/docs/api/types/Back/interfaces/IAdminForthAuth/index.html +++ b/docs/api/types/Back/interfaces/IAdminForthAuth/index.html @@ -15,11 +15,11 @@ - - + + -

IAdminForthAuth

+

IAdminForthAuth

Methods​

issueJWT()​

diff --git a/docs/api/types/Back/interfaces/IAdminForthDataSourceConnector/index.html b/docs/api/types/Back/interfaces/IAdminForthDataSourceConnector/index.html index 4830fc28c..c1952fc53 100644 --- a/docs/api/types/Back/interfaces/IAdminForthDataSourceConnector/index.html +++ b/docs/api/types/Back/interfaces/IAdminForthDataSourceConnector/index.html @@ -15,11 +15,11 @@ - - + + -

IAdminForthDataSourceConnector

+

IAdminForthDataSourceConnector

Extended by​

Used to transform record after fetching from database. -According to AdminForth convention, if AdminForthResourceColumn.type is set to AdminForthDataTypes.DATETIME then it should be transformed to ISO string.

+According to AdminForth convention, if AdminForthResourceColumn.type is set to AdminForthDataTypes.DATETIME then it should be transformed to ISO string.

Parameters​

ParameterTypeDescription
fieldAdminForthResourceColumn
valueany

Returns​

@@ -109,7 +109,7 @@

AdminForthResourceColumn.allowMinMaxQuery set to true.

+Called only for columns which have AdminForthResourceColumn.allowMinMaxQuery set to true.

Internally should call IAdminForthDataSourceConnector.getFieldValue for both min and max values.

Parameters​

ParameterType
__namedParametersobject
__namedParameters.columnsAdminForthResourceColumn[]
__namedParameters.resourceAdminForthResource
@@ -144,7 +144,7 @@

u

updateRecordOriginalValues(__namedParameters): Promise<void>

Update record in database. newValues might have not all fields in record, but only changed ones. -recordId is value of field which is marked as AdminForthResourceColumn.primaryKey

+recordId is value of field which is marked as AdminForthResourceColumn.primaryKey

Parameters​

ParameterType
__namedParametersobject
__namedParameters.newValuesany
__namedParameters.recordIdstring
__namedParameters.resourceAdminForthResource

Returns​

diff --git a/docs/api/types/Back/interfaces/IAdminForthDataSourceConnectorBase/index.html b/docs/api/types/Back/interfaces/IAdminForthDataSourceConnectorBase/index.html index 910e46e5d..10a5df9ec 100644 --- a/docs/api/types/Back/interfaces/IAdminForthDataSourceConnectorBase/index.html +++ b/docs/api/types/Back/interfaces/IAdminForthDataSourceConnectorBase/index.html @@ -15,11 +15,11 @@ - - + + -

IAdminForthDataSourceConnectorBase

+

IAdminForthDataSourceConnectorBase

Interface that exposes methods to interact with AdminForth in standard way

Extends​