@directus/app 9.22.1 → 9.22.3

package/dist/assets/coffeescript-9720271f.js

@@ -0,0 +1 @@
+import{z as $}from"./index.522e44ef.entry.js";function N(v,k){for(var c=0;c<k.length;c++){const u=k[c];if(typeof u!="string"&&!Array.isArray(u)){for(const p in u)if(p!=="default"&&!(p in v)){const l=Object.getOwnPropertyDescriptor(u,p);l&&Object.defineProperty(v,p,l.get?l:{enumerable:!0,get:()=>u[p]})}}}return Object.freeze(Object.defineProperty(v,Symbol.toStringTag,{value:"Module"}))}var w={};(function(v,k){(function(c){c($)})(function(c){c.defineMode("coffeescript",function(u,p){var l="error";function h(e){return new RegExp("^(("+e.join(")|(")+"))\\b")}var z=/^(?:->|=>|\+[+=]?|-[\-=]?|\*[\*=]?|\/[\/=]?|[=!]=|<[><]?=?|>>?=?|%=?|&=?|\|=?|\^=?|\~|!|\?|(or|and|\|\||&&|\?)=)/,A=/^(?:[()\[\]{},:`=;]|\.\.?\.?)/,x=/^[_A-Za-z$][_A-Za-z$0-9]*/,E=/^@[_A-Za-z$][_A-Za-z$0-9]*/,O=h(["and","or","not","is","isnt","in","instanceof","typeof"]),g=["for","while","loop","if","unless","else","switch","try","catch","finally","class"],_=["break","by","continue","debugger","delete","do","in","of","new","return","then","this","@","throw","when","until","extends"],s=h(g.concat(_));g=h(g);var S=/^('{3}|\"{3}|['\"])/,P=/^(\/{3}|\/)/,j=["Infinity","NaN","undefined","null","true","false","on","off","yes","no"],M=h(j);function d(e,n){if(e.sol()){n.scope.align===null&&(n.scope.align=!1);var i=n.scope.offset;if(e.eatSpace()){var f=e.indentation();return f>i&&n.scope.type=="coffee"?"indent":f<i?"dedent":null}else i>0&&a(e,n)}if(e.eatSpace())return null;var r=e.peek();if(e.match("####"))return e.skipToEnd(),"comment";if(e.match("###"))return n.tokenize=R,n.tokenize(e,n);if(r==="#")return e.skipToEnd(),"comment";if(e.match(/^-?[0-9\.]/,!1)){var t=!1;if(e.match(/^-?\d*\.\d+(e[\+\-]?\d+)?/i)&&(t=!0),e.match(/^-?\d+\.\d*/)&&(t=!0),e.match(/^-?\.\d+/)&&(t=!0),t)return e.peek()=="."&&e.backUp(1),"number";var o=!1;if(e.match(/^-?0x[0-9a-f]+/i)&&(o=!0),e.match(/^-?[1-9]\d*(e[\+\-]?\d+)?/)&&(o=!0),e.match(/^-?0(?![\dx])/i)&&(o=!0),o)return"number"}if(e.match(S))return n.tokenize=b(e.current(),!1,"string"),n.tokenize(e,n);if(e.match(P)){if(e.current()!="/"||e.match(/^.*\//,!1))return n.tokenize=b(e.current(),!0,"string-2"),n.tokenize(e,n);e.backUp(1)}return e.match(z)||e.match(O)?"operator":e.match(A)?"punctuation":e.match(M)?"atom":e.match(E)||n.prop&&e.match(x)?"property":e.match(s)?"keyword":e.match(x)?"variable":(e.next(),l)}function b(e,n,i){return function(f,r){for(;!f.eol();)if(f.eatWhile(/[^'"\/\\]/),f.eat("\\")){if(f.next(),n&&f.eol())return i}else{if(f.match(e))return r.tokenize=d,i;f.eat(/['"\/]/)}return n&&(p.singleLineStringErrors?i=l:r.tokenize=d),i}}function R(e,n){for(;!e.eol();){if(e.eatWhile(/[^#]/),e.match("###")){n.tokenize=d;break}e.eatWhile("#")}return"comment"}function y(e,n,i){i=i||"coffee";for(var f=0,r=!1,t=null,o=n.scope;o;o=o.prev)if(o.type==="coffee"||o.type=="}"){f=o.offset+u.indentUnit;break}i!=="coffee"?(r=null,t=e.column()+e.current().length):n.scope.align&&(n.scope.align=!1),n.scope={offset:f,type:i,prev:n.scope,align:r,alignOffset:t}}function a(e,n){if(n.scope.prev)if(n.scope.type==="coffee"){for(var i=e.indentation(),f=!1,r=n.scope;r;r=r.prev)if(i===r.offset){f=!0;break}if(!f)return!0;for(;n.scope.prev&&n.scope.offset!==i;)n.scope=n.scope.prev;return!1}else return n.scope=n.scope.prev,!1}function I(e,n){var i=n.tokenize(e,n),f=e.current();f==="return"&&(n.dedent=!0),((f==="->"||f==="=>")&&e.eol()||i==="indent")&&y(e,n);var r="[({".indexOf(f);if(r!==-1&&y(e,n,"])}".slice(r,r+1)),g.exec(f)&&y(e,n),f=="then"&&a(e,n),i==="dedent"&&a(e,n))return l;if(r="])}".indexOf(f),r!==-1){for(;n.scope.type=="coffee"&&n.scope.prev;)n.scope=n.scope.prev;n.scope.type==f&&(n.scope=n.scope.prev)}return n.dedent&&e.eol()&&(n.scope.type=="coffee"&&n.scope.prev&&(n.scope=n.scope.prev),n.dedent=!1),i}var Z={startState:function(e){return{tokenize:d,scope:{offset:e||0,type:"coffee",prev:null,align:!1},prop:!1,dedent:0}},token:function(e,n){var i=n.scope.align===null&&n.scope;i&&e.sol()&&(i.align=!1);var f=I(e,n);return f&&f!="comment"&&(i&&(i.align=!0),n.prop=f=="punctuation"&&e.current()=="."),f},indent:function(e,n){if(e.tokenize!=d)return 0;var i=e.scope,f=n&&"])}".indexOf(n.charAt(0))>-1;if(f)for(;i.type=="coffee"&&i.prev;)i=i.prev;var r=f&&i.type===n.charAt(0);return i.align?i.alignOffset-(r?1:0):(r?i.prev:i).offset},lineComment:"#",fold:"indent"};return Z}),c.defineMIME("application/vnd.coffeescript","coffeescript"),c.defineMIME("text/x-coffeescript","coffeescript"),c.defineMIME("text/coffeescript","coffeescript")})})();const U=N({__proto__:null,default:w},[w]);export{w as a,U as c};

package/dist/assets/collections-20d2d5bb.js

@@ -0,0 +1,106 @@
+import{a as o,o as h,e as p,y as t,u as s,q as n,z as l}from"./runtime-core.esm-bundler-753bcc58.js";const r={class:"markdown-body"},u=s("hr",null,null,-1),d=s("h2",{id:"the-collection-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-collection-object"},"#"),n(" The Collection Object")],-1),_=s("p",null,[s("code",null,"collection"),n(),s("strong",null,"string"),s("br"),n(" Name of the collection. This matches the table name in the database.")],-1),j=s("h4",{id:"meta",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#meta"},"#"),n(" Meta")],-1),m=s("p",null,"Directus metadata, primarily used in the Admin App.",-1),g=s("p",null,[s("code",null,"collection"),n(),s("strong",null,"string"),s("br"),n(" Name of the collection. This matches the table name in the database.")],-1),b=s("p",null,[s("code",null,"icon"),n(),s("strong",null,"string"),s("br"),n(" Icon displayed in the Admin App when working with this collection.")],-1),f=s("p",null,[s("code",null,"note"),n(),s("strong",null,"string"),s("br"),n(" Short description displayed in the Admin App.")],-1),y=s("p",null,[s("code",null,"display_template"),n(),s("strong",null,"string"),s("br"),n(" How items in this collection should be displayed when viewed relationally in the Admin App.")],-1),x=s("p",null,[s("code",null,"hidden"),n(),s("strong",null,"boolean"),s("br"),n(" Whether or not this collection is hidden in the Admin App.")],-1),q=s("p",null,[s("code",null,"singleton"),n(),s("strong",null,"boolean"),s("br"),n(" Whether or not this collection is treated as a singleton.")],-1),v=s("p",null,[s("code",null,"translations"),n(),s("strong",null,"array"),s("br"),n(" How this collection’s name is displayed in the different languages in the Admin App.")],-1),w=s("p",null,[s("code",null,"archive_field"),n(),s("strong",null,"string"),s("br"),n(" What field in the collection holds the archived state.")],-1),T=s("p",null,[s("code",null,"archive_value"),n(),s("strong",null,"string"),s("br"),n(" What value the archive field should be set to when archiving an item.")],-1),A=s("p",null,[s("code",null,"unarchive_value"),n(),s("strong",null,"string"),s("br"),n(" What value the archive field should be set to when unarchiving an item.")],-1),k=s("p",null,[s("code",null,"archive_app_filter"),n(),s("strong",null,"boolean"),s("br"),n(" Whether or not the Admin App should allow the user to view archived items.")],-1),E=s("p",null,[s("code",null,"sort_field"),n(),s("strong",null,"boolean"),s("br"),n(" What field holds the sort value on the collection. The Admin App uses this to allow drag-and-drop manual sorting.")],-1),S=s("code",null,"accountability",-1),C=s("strong",null,"string",-1),P=s("br",null,null,-1),R=s("code",null,"all",-1),L=s("code",null,"activity",-1),Q=s("code",null,"item_duplication_fields",-1),W=s("strong",null,"array",-1),G=s("br",null,null,-1),O=s("code",null,"group",-1),D=s("strong",null,"string",-1),B=s("br",null,null,-1),I=s("code",null,"sort",-1),H=s("strong",null,"number",-1),N=s("br",null,null,-1),M=s("p",null,[s("code",null,"collapse"),n(),s("strong",null,"string"),s("br"),n(" What is the default behavior of this collection or “folder” collection when it has nested collections. One of "),s("code",null,"open"),n(", "),s("code",null,"closed"),n(", "),s("code",null,"locked"),n(".")],-1),U=s("h4",{id:"schema",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#schema"},"#"),n(" Schema")],-1),V=s("p",null,"“Raw” database information. Based on the database vendor used, different information might be returned. The following are available for all drivers.",-1),Y=s("p",null,[s("code",null,"name"),n(),s("strong",null,"string"),s("br"),n(" The table name.")],-1),z=s("p",null,[s("code",null,"comment"),n(),s("strong",null,"string"),s("br"),n(" The table comment.")],-1),F={class:"tip hint"},J=s("code",null,"null",-1),K=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"article"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"note"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Blog posts"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"display_template"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"{{ title }}"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"hidden"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"singleton"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"translations"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),n(`
+			`),s("span",{class:"hljs-punctuation"},"{"),n(`
+				`),s("span",{class:"hljs-attr"},'"language"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"en-US"'),s("span",{class:"hljs-punctuation"},","),n(`
+				`),s("span",{class:"hljs-attr"},'"translation"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Articles"'),n(`
+			`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),n(`
+			`),s("span",{class:"hljs-punctuation"},"{"),n(`
+				`),s("span",{class:"hljs-attr"},'"language"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"nl-NL"'),s("span",{class:"hljs-punctuation"},","),n(`
+				`),s("span",{class:"hljs-attr"},'"translation"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Artikelen"'),n(`
+			`),s("span",{class:"hljs-punctuation"},"}"),n(`
+		`),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"archive_field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"status"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"archive_value"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"archived"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"unarchive_value"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"draft"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"archive_app_filter"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"sort_field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"sort"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"item_duplication_fields"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"sort"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"1"),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"schema"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"pages"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"comment"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),X=s("hr",null,null,-1),Z=s("h2",{id:"list-collections",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-collections"},"#"),n(" List Collections")],-1),$=s("p",null,"List the available collections.",-1),ss=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),n(" Query Parameters")],-1),ns=s("p",null,"This endpoint doesn’t currently support any query parameters.",-1),ts=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),n(" Returns")],-1),as=s("p",null,[n("An array of "),s("a",{href:"#the-collection-object"},"collection objects"),n(".")],-1),ls=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),n(" REST API")],-1),es=s("pre",null,[s("code",null,`GET /collections
+SEARCH /collections
+`)],-1),os=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),n(" GraphQL")],-1),cs=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),is=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-symbol"},"collections"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),n("directus_collections"),s("span",{class:"hljs-punctuation"},"]"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),hs=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),n(" Example")],-1),ps=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	collections `),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-punctuation"},"..."),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),rs=s("hr",null,null,-1),us=s("h2",{id:"retrieve-a-collection",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-a-collection"},"#"),n(" Retrieve a Collection")],-1),ds=s("p",null,"Retrieve a single collection by table name.",-1),_s=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),n(" Query Parameters")],-1),js=s("p",null,"This endpoint doesn’t currently support any query parameters.",-1),ms=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),n(" Returns")],-1),gs=s("p",null,[n("A "),s("a",{href:"#the-collection-object"},"collection object"),n(".")],-1),bs=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),n(" REST API")],-1),fs=s("pre",null,[s("code",null,`GET /collections/:collection
+`)],-1),ys=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),n(" Example")],-1),xs=s("pre",null,[s("code",null,`GET /collections/articles
+`)],-1),qs=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),n(" GraphQL")],-1),vs=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),ws=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	collections_by_name`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"name"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` directus_collections
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Ts=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),n(" Example")],-1),As=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	collections_by_name`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"name"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-punctuation"},"..."),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),ks=s("hr",null,null,-1),Es=s("h2",{id:"create-a-collection",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-a-collection"},"#"),n(" Create a Collection")],-1),Ss=s("p",null,"Create a new Collection. This will create a new table in the database as well.",-1),Cs=s("h3",{id:"query-parameters-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),n(" Query Parameters")],-1),Ps=s("p",null,"This endpoint doesn’t currently support any query parameters.",-1),Rs=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),n(" Request Body")],-1),Ls=s("p",null,[n("The "),s("code",null,"collection"),n(" property is required, all other properties of the "),s("a",{href:"#the-collection-object"},"collection object"),n(" are optional.")],-1),Qs=s("code",null,"fields",-1),Ws=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),n(" Returns")],-1),Gs=s("p",null,[n("The "),s("a",{href:"#the-collection-object"},"collection object"),n(" for the collection created in this request.")],-1),Os={class:"tip hint"},Ds=s("code",null,"schema: {}",-1),Bs=s("code",null,"schema: null",-1),Is=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),n(" REST API")],-1),Hs=s("pre",null,[s("code",null,`POST /collections
+`)],-1),Ns=s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),n(" Example")],-1),Ms=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /collections"),n(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"testimonials"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"format_quote"'),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Us=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),n(" GraphQL")],-1),Vs=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Ys=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	create_collections_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(" directus_collections"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` directus_collections
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),zs=s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),n(" Example")],-1),Fs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	create_collections_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"testimonials"'),n(`,
+		`),s("span",{class:"hljs-symbol"},"meta"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+			`),s("span",{class:"hljs-symbol"},"icon"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"format_quote"'),n(`
+		`),s("span",{class:"hljs-punctuation"},"}"),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-punctuation"},"..."),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Js=s("hr",null,null,-1),Ks=s("h2",{id:"update-a-collection",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-collection"},"#"),n(" Update a Collection")],-1),Xs=s("p",null,"Update the metadata for an existing collection.",-1),Zs=s("h3",{id:"query-parameters-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),n(" Query Parameters")],-1),$s=s("p",null,"This endpoint doesn’t currently support any query parameters.",-1),sn=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),n(" Request Body")],-1),nn=s("p",null,[n("You can only update the "),s("code",null,"meta"),n(" values of the "),s("a",{href:"#the-collection-object"},"collection object"),n(". Updating the collection name is not supported at this time.")],-1),tn=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),n(" Returns")],-1),an=s("p",null,[n("The "),s("a",{href:"#the-collection-object"},"collection object"),n(" for the updated collection in this request.")],-1),ln=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),n(" REST API")],-1),en=s("pre",null,[s("code",null,`PATCH /collections/:collection
+`)],-1),on=s("h5",{id:"example-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-5"},"#"),n(" Example")],-1),cn=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /collections/testimonials"),n(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"note"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Short quotes from happy customers."'),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),hn=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),n(" GraphQL")],-1),pn=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),rn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	update_collections_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),n(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(" update_directus_collections_input"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` directus_collections
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),un=s("h5",{id:"example-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-6"},"#"),n(" Example")],-1),dn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	update_collections_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"testimonials"'),n(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"meta"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"note"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Short quotes from happy customers."'),n(),s("span",{class:"hljs-punctuation"},"}"),n(),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),_n=s("hr",null,null,-1),jn=s("h2",{id:"delete-a-collection",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-a-collection"},"#"),n(" Delete a Collection")],-1),mn=s("p",null,"Delete a collection.",-1),gn=s("div",{class:"danger hint"},[s("div",{class:"hint-title"},"Destructive"),s("p",null,"Be aware, this will delete the table from the database, including all items in it. This action can’t be undone.")],-1),bn=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),n(" REST API")],-1),fn=s("pre",null,[s("code",null,`DELETE /collections/:collection
+`)],-1),yn=s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),n(" Example")],-1),xn=s("pre",null,[s("code",null,`DELETE /collections/articles
+`)],-1),qn=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),n(" GraphQL")],-1),vn=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),wn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	delete_collections_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` delete_collection
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Tn=s("h5",{id:"example-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-8"},"#"),n(" Example")],-1),An=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	delete_collections_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),kn=s("hr",null,null,-1),Rn="Collections",Ln=!1,Qn='REST and GraphQL API documentation on the "Collections" collection in Directus.',Wn="5 min read",Gn="page-reference",On={__name:"collections",setup(En,{expose:c}){const e={title:"Collections",modularExtension:!1,description:'REST and GraphQL API documentation on the "Collections" collection in Directus.',readTime:"5 min read",pageClass:"page-reference"};return c({frontmatter:e}),(Sn,Cn)=>{const a=o("router-link"),i=o("docs-wrapper");return h(),p(i,{frontmatter:e},{default:t(()=>[s("div",r,[s("blockquote",null,[s("p",null,[n("Collections are the individual collections of items, similar to tables in a database. Changes to collections will alter the schema of the database. "),l(a,{to:"/docs/getting-started/glossary#collections"},{default:t(()=>[n("Learn more about Collections")]),_:1}),n(".")])]),u,d,_,j,m,g,b,f,y,x,q,v,w,T,A,k,E,s("p",null,[S,n(),C,P,n(" What data is tracked. One of "),R,n(", "),L,n(". See "),l(a,{to:"/docs/configuration/data-model#accountability"},{default:t(()=>[n("Accountability")]),_:1}),n(" for more information.")]),s("p",null,[Q,n(),W,G,n(" What fields are duplicated during “Save as copy” action of an item in this collection. See "),l(a,{to:"/docs/configuration/data-model#duplication"},{default:t(()=>[n("Duplication")]),_:1}),n(" for more information.")]),s("p",null,[O,n(),D,B,n(" The name of the parent collection. This is used in "),l(a,{to:"/docs/configuration/data-model#sorting-grouping"},{default:t(()=>[n("grouping/nesting of collections")]),_:1}),n(".")]),s("p",null,[I,n(),H,N,n(" What sort order of the collection relative to other collections of the same level. This is used in "),l(a,{to:"/docs/configuration/data-model#sorting-grouping"},{default:t(()=>[n("sorting of collections")]),_:1}),n(".")]),M,U,V,Y,z,s("div",F,[s("p",null,[l(a,{to:"/docs/configuration/data-model#sorting-grouping"},{default:t(()=>[n("“folder” collections do not hold any data")]),_:1}),n(", hence their schema would be "),J,n(".")])]),K,X,Z,$,ss,ns,ts,as,ls,es,s("p",null,[l(a,{to:"/docs/reference/introduction#search-http-method"},{default:t(()=>[n("Learn more about SEARCH ->")]),_:1})]),os,cs,is,hs,ps,rs,us,ds,_s,js,ms,gs,bs,fs,ys,xs,qs,vs,ws,Ts,As,ks,Es,Ss,Cs,Ps,Rs,Ls,s("p",null,[n("You are able to provide an array of "),Qs,n(" to be created during the creation of the collection. See the "),l(a,{to:"/docs/reference/system/fields#the-fields-object"},{default:t(()=>[n("fields object")]),_:1}),n(" for more information on what properties are available in a field.")]),Ws,Gs,s("div",Os,[s("p",null,[n("Make sure to pass an empty object for schema ("),Ds,n(") when creating collections. Alternatively, you can omit it entirely or use "),Bs,n(" to create "),l(a,{to:"/docs/configuration/data-model#sorting-grouping"},{default:t(()=>[n("“folder” collections")]),_:1}),n(".")])]),Is,Hs,Ns,Ms,Us,Vs,Ys,zs,Fs,Js,Ks,Xs,Zs,$s,sn,nn,tn,an,ln,en,on,cn,hn,pn,rn,un,dn,_n,jn,mn,gn,bn,fn,yn,xn,qn,vn,wn,Tn,An,kn])]),_:1})}}};export{On as default,Qn as description,Ln as modularExtension,Gn as pageClass,Wn as readTime,Rn as title};

package/dist/assets/collections-9763e362.js

@@ -0,0 +1,2 @@
+import{a as n,o as d,e as r,y as o,u as e,q as t,z as i}from"./runtime-core.esm-bundler-753bcc58.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,"The Collection Page displays all Items within a Collection and comes with highly configurable Layouts for browsing, visualizing, and managing these Items.")],-1),p={class:"tip hint"},m=e("div",{class:"hint-title"},"Before You Begin",-1),g=e("h2",{id:"toggle-hidden-collections",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#toggle-hidden-collections"},"#"),t(" Toggle Hidden Collections")],-1),_=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Toggle Hidden Collections"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220816/toggle-hidden-collections-20220816A.mp4",type:"video/mp4"})],-1),y=e("ol",null,[e("li",null,"Navigate to the Content Module."),e("li",null,"Right-click in the Navigation Bar."),e("li",null,[t("Click "),e("strong",null,"Show/Hide Hidden Collections"),t(" to toggle visibility.")])],-1),f={class:"tip hint"},v=e("em",null,"visually cleanup",-1),b=e("h2",{id:"adjust-page-layout",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#adjust-page-layout"},"#"),t(" Adjust Page Layout")],-1),w=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Layouts"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/adjust-page-layout-20220415A.mp4",type:"video/mp4"})],-1),I=e("h2",{id:"search-items",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#search-items"},"#"),t(" Search Items")],-1),C=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Search Items"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/search-items-20220419A.mp4",type:"video/mp4"})],-1),k=e("p",null,[t("Find all Items with one or more Fields containing your searched value, excluding any Items which have been "),e("a",{href:"#filter-items"},"filtered out"),t(". To search through a Collection’s Items, follow these steps.")],-1),T=e("ol",null,[e("li",null,"Navigate to the Content Module and select the desired Collection."),e("li",null,[t("Select "),e("span",{mi:"",icon:""},"search"),t(" in the Page Header and a search bar will appear.")]),e("li",null,"Type in the value to search for.")],-1),A=e("h2",{id:"filter-items",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#filter-items"},"#"),t(" Filter Items")],-1),x=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Filter Items"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/filter-items-2022019A.mp4",type:"video/mp4"})],-1),S=e("h2",{id:"manually-sort-items",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#manually-sort-items"},"#"),t(" Manually Sort Items")],-1),L=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Batch Edit Items"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/manually-sort-items-20220415A.mp4",type:"video/mp4"})],-1),P=e("strong",null,"“Settings > Data Model > Collection”",-1),B=e("br",null,null,-1),F=e("em",null,"(Shown in the video)",-1),N=e("li",null,"Navigate to the Content Module and select the desired Collection.",-1),M=e("li",null,[t("In the Sidebar, be sure a "),e("a",{href:"#adjust-page-layout"},"Layout"),t(" is chosen that supports manual sorting.")],-1),E=e("li",null,[t("Enable manual sorting: "),e("ul",null,[e("li",null,[t("For the Table Layout, toggle "),e("span",{mi:"",icon:""},"sort"),t(" in the configured Sort column.")])])],-1),D=e("li",null,"Drag Items by their handle into a new position.",-1),j={class:"warning hint"},q=e("div",{class:"hint-title"},"Manual Sorting Requires Configuration",-1),z={class:"tip hint"},H=e("h2",{id:"automatically-sort-items",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#automatically-sort-items"},"#"),t(" Automatically Sort Items")],-1),U=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Automatically Sort Items"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/automatically-sort-items-20220415A.mp4",type:"video/mp4"})],-1),V=e("div",{class:"tip hint"},[e("p",null,"Automatic sorting is a non-destructive action which does not change your data.")],-1),R=e("h2",{id:"view-archived-items",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#view-archived-items"},"#"),t(" View Archived Items")],-1),O=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"View Archived Items"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/view-archived-items.mp4",type:"video/mp4"})],-1),W=e("ol",null,[e("li",null,"Navigate to the Content Module and select the desired Collection."),e("li",null,[t("Click "),e("strong",null,"“Archive”"),t(" in the Sidebar.")]),e("li",null,[t("Choose the desired view: "),e("ul",null,[e("li",null,[e("strong",null,"“Show Items”")]),e("li",null,[e("strong",null,"“Show Archived Items”")]),e("li",null,[e("strong",null,"“Show Items + Archived Items”")])])])],-1),Y={class:"warning hint"},G=e("div",{class:"hint-title"},"Archiving Requires Configuration",-1),J=e("h2",{id:"create-a-bookmark",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-bookmark"},"#"),t(" Create a Bookmark")],-1),K=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Create Presets and Bookmarks"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/presets-and-bookmarks-20220415A.mp4",type:"video/mp4"})],-1),Q=e("p",null,"Save how a Collection Page looks so that you can return to the exact same view later. This includes details such as the Layout, search queries, filters, custom sort & order, etc. To create a Bookmark from the Collection Page, follow these steps.",-1),X=e("ol",null,[e("li",null,"Navigate to the desired collection."),e("li",null,[t("Click "),e("span",{mi:"",btn:"",muted:""},"bookmark_outline"),t(" in the page header.")]),e("li",null,[t("Enter a "),e("strong",null,"Name"),t(),e("em",null,"(and optionally)"),t(" an "),e("strong",null,"Icon"),t(" and "),e("strong",null,"Color"),t(".")]),e("li",null,[t("Click "),e("strong",null,"Save"),t(" to confirm.")])],-1),Z=e("p",null,"Your Bookmark will appear in the Navigation Bar, under the associated Collection Page.",-1),$={class:"tip hint"},ee=e("div",{class:"hint-title"},"Learn More",-1),te=e("h2",{id:"import-%2F-export-items",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#import-%2F-export-items"},"#"),t(" Import / Export Items")],-1),oe=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/imports-exports-20220416A.webp",alt:"Import and Export Items"})],-1),le=e("h2",{id:"batch-delete%2C-archive-or-edit-items",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#batch-delete%2C-archive-or-edit-items"},"#"),t(" Batch Delete, Archive or Edit Items")],-1),ie=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Batch Edit Items"},[e("source",{src:`https://cdn.directus.io/docs/v9/app-guide/content/content-items/content-items-20220415A/batch-edit-items-20220415A.mp4
+`,type:"video/mp4"})],-1),se=e("p",null,"It is possible to delete, archive, or edit multiple Items at once from the Collection Page. Deletion will permanently delete Items from the database, this cannot be reverted. When batch editing, the Item Page opens, allowing you to make the same edit across multiple Items. Follow these steps to batch delete, archive, or edit Items.",-1),ne=e("li",null,"Navigate to the Content Module and select the desired Collection.",-1),ae=e("br",null,null,-1),ce=e("li",null,[t("Click the Items you wish to select: "),e("ul",null,[e("li",null,[e("strong",null,"Table Layout:"),t(" Click "),e("span",{mi:"",icon:""},"check_box_outline_blank"),t(" in the left-most column.")]),e("li",null,[e("strong",null,"Card Layout:"),t(" Click "),e("span",{mi:"",icon:""},"radio_button_unchecked"),t(" in the upper left-hand corner of each Card.")])])],-1),de=e("p",null,[t("Once Items are selected, the following buttons will appear in the Page Header: "),e("span",{mi:"",btn:"",muted:""},"delete"),e("span",{mi:"",btn:"",muted:""},"archive"),t(),e("span",{mi:"",btn:"",muted:""},"edit")],-1),re=e("p",null,[e("strong",null,"Delete"),e("br"),t(" 4. Click "),e("span",{mi:"",btn:"",dngr:""},"delete"),t(" in the header and a popup will appear."),e("br"),t(" 5. Click "),e("strong",null,"“Delete”"),t(" to confirm the action.")],-1),he=e("p",null,[e("strong",null,"Archive"),e("br"),t(" 4. Click "),e("span",{mi:"",btn:"",muted:""},"archive"),t(" in the header and a popup will appear."),e("br"),t(" 5. Click "),e("strong",null,"“Delete”"),t(" to confirm the action.")],-1),ue=e("p",null,[e("strong",null,"Edit"),e("br"),t(" 4. Click "),e("span",{mi:"",btn:"",muted:""},"edit"),t(" in the header and the Item Page will open."),e("br"),t(" 5. Update Item details as desired."),e("br"),t(" 6. Click "),e("span",{mi:"",btn:""},"check"),t(" to confirm batch edits on all Items.")],-1),ye="Collection Page",fe=!1,ve="The Collection Page displays all Items within a Collection and comes with highly configurable Layouts for browsing, visualizing, and managing these Items.",be="6 min read",we={__name:"collections",setup(pe,{expose:a}){const s={title:"Collection Page",modularExtension:!1,description:"The Collection Page displays all Items within a Collection and comes with highly configurable Layouts for browsing, visualizing, and managing these Items.",readTime:"6 min read"};return a({frontmatter:s}),(me,ge)=>{const l=n("router-link"),c=n("docs-wrapper");return d(),r(c,{frontmatter:s},{default:o(()=>[e("div",h,[u,e("div",p,[m,e("p",null,[t("To use the Collection Page, you will need to know about "),i(l,{to:"/docs/getting-started/glossary#collections"},{default:o(()=>[t("Collections")]),_:1}),t(", "),i(l,{to:"/docs/getting-started/glossary#items"},{default:o(()=>[t("Items")]),_:1}),t(" and "),i(l,{to:"/docs/getting-started/glossary#fields"},{default:o(()=>[t("Fields")]),_:1}),t(".")])]),g,_,e("p",null,[t("Some projects may have dozens or even hundreds of collections, which can be overwhelming to sort through. To ease this problem, Admins can choose to "),i(l,{to:"/docs/configuration/data-model/collections.html#toggle-collection-visibility"},{default:o(()=>[t("hide collections by default")]),_:1}),t(" on the Navigation bar. Users can then show or hide hidden collections as desired. To toggle collection visibility, follow these steps.")]),y,e("div",f,[e("p",null,[t("This functionality is purely aesthetic, provided to help you "),v,t(" the Navigation Bar. For admins who’d like to block users’ access permissions, please see "),i(l,{to:"/docs/configuration/users-roles-permissions"},{default:o(()=>[t("users, roles and permissions")]),_:1}),t(".")])]),b,w,e("p",null,[t("Layouts determine how you view or interact with Items in a Collection. Whether your Collection contains blog posts, project management tasks, geo-coordinates, temporal data or beyond; Layouts present Items in a more human-friendly way. "),i(l,{to:"/docs/app/layouts"},{default:o(()=>[t("Learn More")]),_:1})]),I,C,k,T,A,x,e("p",null,[t("Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results, restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more. To Learn More, see our guide on "),i(l,{to:"/docs/app/filters"},{default:o(()=>[t("Filters")]),_:1}),t(".")]),S,L,e("p",null,[t("Drag and drop Items to custom sort them as desired. This is only possible on certain Layouts, such as the default "),i(l,{to:"/docs/app/layouts#table-layout"},{default:o(()=>[t("Table Layout")]),_:1}),t(". To sort a Collection’s Items, follow these steps.")]),e("ol",null,[e("li",null,[t("Be sure "),i(l,{to:"/docs/configuration/data-model/collections#sort-field"},{default:o(()=>[t("a sort field")]),_:1}),t(" has been configured under "),P,t("."),B,F]),N,M,E,D]),e("div",j,[q,e("p",null,[t("Only available if a "),i(l,{to:"/docs/configuration/data-model/collections#sort-field"},{default:o(()=>[t("sort field")]),_:1}),t(" has been configured.")])]),e("div",z,[e("p",null,[t("Sorting saves a value in a "),i(l,{to:"/docs/reference/query#sort"},{default:o(()=>[t("Sort Field")]),_:1}),t(". This value is used to return data in a custom order. This means that while the values in this Sort Field do get updated and modified, values in other Fields are not changed.")])]),H,U,e("p",null,[t("Sort Items alphabetically or numerically, in ascending or descending order. Sorting is not possible on certain Layouts, such as the Map Layout. Layouts that do support automatic sorting have controls in slightly different locations. To learn more, see "),i(l,{to:"/docs/app/layouts"},{default:o(()=>[t("Layouts")]),_:1}),t(".")]),V,R,O,e("p",null,[t("The no-code app allows you to hide archived Items, display them alongside other Items, or display archived Items only. To learn how to archive an Item, see our guide on the "),i(l,{to:"/docs/app/content/items#archive-an-item"},{default:o(()=>[t("Item Page")]),_:1}),t(". To change whether an archived Item is displayed, follow these steps.")]),W,e("div",Y,[G,e("p",null,[t("Only available if an "),i(l,{to:"/docs/configuration/data-model/collections#archive"},{default:o(()=>[t("Archive field")]),_:1}),t(" has been configured.")])]),J,K,Q,X,Z,e("div",$,[ee,e("p",null,[t("To learn more, see our guide on "),i(l,{to:"/docs/configuration/presets-bookmarks"},{default:o(()=>[t("Presets and Bookmarks")]),_:1}),t(".")])]),te,oe,e("p",null,[t("The Content, User Directory and File Library modules allow importing and exporting of multiple Items stored as files. This makes it quick and easy to handle tasks like uploading and downloading new customer information; pulling down sales data for transformation, reports, analysis, and beyond. To learn more, see how to "),i(l,{to:"/docs/app/import-export"},{default:o(()=>[t("Import and Export Items")]),_:1}),t(" in file format.")]),le,ie,se,e("ol",null,[ne,e("li",null,[t("Choose a "),i(l,{to:"/docs/app/layouts"},{default:o(()=>[t("Layout")]),_:1}),t(" that supports multiple Item selection from the Sidebar."),ae,t(" (e.g. The Table or Card Layout)")]),ce]),de,re,he,ue])]),_:1})}}};export{we as default,ve as description,fe as modularExtension,be as readTime,ye as title};

package/dist/assets/collections-bc19d5d3.js

@@ -0,0 +1,2 @@
+import{a as s,o as d,e as r,y as o,u as t,q as e,z as n}from"./runtime-core.esm-bundler-753bcc58.js";const u={class:"markdown-body"},h=t("blockquote",null,[t("p",null,"Collections are a set of items. This can be a 1-1 data table in SQL, a group of other collections, or a readonly view. They come with all the same power and functionality of data tables, despite the less technical name.")],-1),p=t("h2",{id:"overview",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#overview"},"#"),e(" Overview")],-1),f=t("video",{title:"Overview",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/data-model-20220805/collections-20220805A.mp4",type:"video/mp4"})],-1),_=t("h2",{id:"system-collections",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#system-collections"},"#"),e(" System Collections")],-1),m=t("video",{title:"System Collections",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/system-collections-20220805A.mp4",type:"video/mp4"})],-1),g=t("p",null,"System collections store the data and configuration details required to power your project.",-1),y=t("p",null,[e("Since system collections store information that powers your Directus project. You cannot reconfigure system collections or any of their default fields, as any reconfigurations would break your project. However, you "),t("em",null,"can"),e(" create and configure new fields on a system collection. This lets you safely customize your data model as desired.")],-1),v=t("p",null,"System collections are not displayed in the Content Module. The following table will go over the logic and functionality each system collection is responsible for, as well as where to find relevant App and API documentation.",-1),w=t("thead",null,[t("tr",null,[t("th",null,"System Collection"),t("th",null,"Purpose"),t("th",null,"APP"),t("th",null,"API")])],-1),b=t("td",null,"Activity",-1),S=t("td",null,"Tracks and stores all events within Directus, giving full accountability over everything.",-1),C=t("td",null,"Collections",-1),T=t("td",null,"Stores data table & configuration details each and every Collection.",-1),k=t("td",null,"Dashboards",-1),A=t("td",null,"Stores dashboard configuration details and all relationally linked panels.",-1),D=t("td",null,[t("strong",null,"N/A")],-1),F=t("td",null,"Fields",-1),I=t("td",null,"Stores configuration details for each field.",-1),x=t("td",null,"Files",-1),N=t("td",null,"This stores file location from asset storage as well as any data associated with that file.",-1),P=t("td",null,"Flows",-1),M=t("td",null,"Stores basic logic required for Flows, which enable event-triggered task automation.",-1),O=t("td",null,"Folders",-1),R=t("td",null,"Stores information required for Folders, which provide virtual file asset management.",-1),j=t("tr",null,[t("td",null,"Migrations"),t("td",null,"Used by our install/upgrade process to track when migration scripts for a specific release have been run."),t("td",null,"It has no relevant app functionality."),t("td",null,[t("strong",null,"N/A")])],-1),B=t("td",null,"Notifications",-1),L=t("td",null,"Stores details about in-app notifications.",-1),U=t("td",null,"Operations",-1),H=t("td",null,[e("Stores information required for Operations, which are a part of "),t("a",{href:"#flows"},"Flows"),e(".")],-1),V=t("td",null,"Panels",-1),q=t("td",null,[e("This stores information about individual analytics panels, which are displayed on "),t("a",{href:"#dashboards"},"Dashboards"),e(".")],-1),E=t("td",null,[t("strong",null,"N/A")],-1),W=t("td",null,"Permissions",-1),K=t("td",null,"This stores the access permissions configured for roles.",-1),Q=t("td",null,"Presets",-1),Y=t("td",null,"This stores details for presets and bookmarks.",-1),z=t("td",null,"Relations",-1),G=t("td",null,"This stores information about relationships between collections.",-1),J=t("td",null,"Revisions",-1),X=t("td",null,"Revisions are changes/edits made to Items. Directus keeps track of edits made, so you’re able to revert to a previous state at will.",-1),Z=t("td",null,"Roles",-1),$=t("td",null,"Stores information about each role created.",-1),tt=t("tr",null,[t("td",null,"Sessions"),t("td",null,"Stores information about each user session, for system purposes."),t("td",null,[t("strong",null,"N/A")]),t("td",null,[t("strong",null,"N/A")])],-1),et=t("td",null,"Settings",-1),ot=t("td",null,[e("Stores all configurations made within "),t("strong",null,"Settings > Project Settings"),e(".")],-1),lt=t("td",null,"Shares",-1),nt=t("td",null,"Stores all information regarding data shares.",-1),it=t("td",null,null,-1),st=t("td",null,"Users",-1),at=t("td",null,"Stores information about each user within the platform.",-1),ct=t("td",null,"Webhooks",-1),dt=t("td",null,"Stores all information about configured webhooks.",-1),rt=t("h2",{id:"create-a-collection",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#create-a-collection"},"#"),e(" Create a Collection")],-1),ut=t("video",{title:"Create a Collection",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:`https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/create-a-collection-20220805A.mp4
+`,type:"video/mp4"})],-1),ht=t("p",null,"To create a collection, follow these steps.",-1),pt=t("li",null,[e("Navigate to "),t("strong",null,"Settings > Data Model"),e(", click "),t("span",{mi:"",btn:""},"add"),e(" in the page header, and a drawer will open.")],-1),ft=t("li",null,[e("Enter a unique "),t("strong",null,"Collection Name"),e(". This cannot be modified later, but can be translated."),t("br"),e(" This is used as the data table key, API collection key, and default collection name.")],-1),_t=t("li",null,[t("strong",null,"Singleton"),e(" — Toggles whether the collection is a "),t("a",{href:"#collection-setup"},"Singleton"),e(".")],-1),mt=t("li",null,[t("strong",null,"Primary Key Field"),e(" — Sets the name of the primary key field, defaults to "),t("code",null,"id"),e(".")],-1),gt=t("strong",null,"Type",-1),yt=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"arrow_forward"),e(" to confirm.")],-1),vt=t("li",null,[e("Enable and rename the other Optional System Fields as desired: "),t("ul",null,[t("li",null,[t("strong",null,"Status"),e(" — Stores item status.")]),t("li",null,[t("strong",null,"Sort"),e(" — Adds a field which enables drag-and-drop sorting of items.")]),t("li",null,[t("strong",null,"Created On"),e(" — Logs the date an item was created.")]),t("li",null,[t("strong",null,"Created By"),e(" — Logs the user that created this item.")]),t("li",null,[t("strong",null,"Updated On"),e(" — Logs the date an item was last updated.")]),t("li",null,[t("strong",null,"Updated By"),e(" — Stores the last user to edit the file.")])])],-1),wt=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"check"),e(" to confirm and create the collection.")],-1),bt=t("div",{class:"danger hint"},[t("div",{class:"hint-title"},"Immutable Keys"),t("p",null,[e("The collection name from step two cannot be modified after collection creation. However, you can override how it is displayed with "),t("a",{href:"#collection-setup"},"Collection Naming Translations"),e(".")])],-1),St=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Composite Keys"),t("p",null,"Directus does not currently support composite keys. If your project uses composite keys, you will need to make an adjustment to the data model.")],-1),Ct=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"SQL Views"),t("p",null,"Directus does not currently support creation of virtual tables via SQL Views.")],-1),Tt=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Database Tables"),t("p",null,[e("Remember, a collection is simply a database table. Therefore, you can import or create a table directly in the database and it will automatically appear within your Directus project. The first time you manage that table, a "),t("code",null,"directus_collections"),e(" record will be created with default values.")])],-1),kt=t("h2",{id:"toggle-collection-visibility",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#toggle-collection-visibility"},"#"),e(" Toggle Collection Visibility")],-1),At=t("video",{title:"Hide a Collection",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/toggle-collection-visibility-20220805A.mp4",type:"video/mp4"})],-1),Dt=t("p",null,"To toggle whether a collection is hidden by default in the Content Module, follow these steps.",-1),Ft=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Data Model"),e(".")]),t("li",null,[e("Click "),t("span",{mi:"",icon:""},"more_vert"),e(" to open the collection’s Context Menu.")]),t("li",null,[e("Select "),t("strong",null,"View Content"),e(" or "),t("strong",null,"Make Collection Hidden"),e(" to adjust visibility as desired.")])],-1),It={class:"tip hint"},xt=t("span",{mi:"",icon:""},"visibility",-1),Nt=t("strong",null,"Show Hidden Collections",-1),Pt=t("h2",{id:"create-a-folder",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#create-a-folder"},"#"),e(" Create a Folder")],-1),Mt=t("video",{title:"Create a Folder",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/create-a-folder-20220805A.mp4",type:"video/mp4"})],-1),Ot=t("p",null,[e("Folders allow you to sub-nest and group how collections are displayed. This feature simply changes how the collections are displayed under "),t("strong",null,"Settings > Data Model"),e(" and in the Content Module. It has no impact on the data model. To create a folder, follow these steps.")],-1),Rt=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Data Model"),e(".")]),t("li",null,[e("Click "),t("span",{mi:"",btn:"",muted:""},"create_new_folder"),e(" in the page header.")]),t("li",null,"Set a folder key, which will also be used as the folder’s name."),t("li",null,"Optional: Set the folder icon, color, note and translations as desired."),t("li",null,[e("Click "),t("strong",null,"Save"),e(" to create your folder.")])],-1),jt=t("h2",{id:"toggle-folder-display",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#toggle-folder-display"},"#"),e(" Toggle Folder Display")],-1),Bt=t("video",{title:"Toggle Folder Display",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/toggle-folder-display-20220805A.mp4",type:"video/mp4"})],-1),Lt=t("p",null,"To toggle folder display, follow these steps.",-1),Ut=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Data Model"),e(".")]),t("li",null,[e("Click "),t("span",{mi:"",icon:""},"folder"),e(" on the desired collection to toggle the following displays: "),t("ul",null,[t("li",null,[t("strong",null,"Start Open")]),t("li",null,[t("strong",null,"Start Collapsed")]),t("li",null,[t("strong",null,"Always Open")])])])],-1),Ht=t("h2",{id:"sort-and-nest-collections",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#sort-and-nest-collections"},"#"),e(" Sort and Nest Collections")],-1),Vt=t("video",{title:"Configure a Collection",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/sort-and-nest-collections.mp4",type:"video/mp4"})],-1),qt=t("p",null,[e("To sort and nest collections in "),t("strong",null,"Settings > Data Model"),e(" and "),t("strong",null,"Content Module"),e(", follow these steps.")],-1),Et=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Data Model"),e(".")]),t("li",null,[e("Click and drag "),t("span",{mi:"",icon:""},"drag_handle"),e(" to position collections as desired."),t("br"),e(" To nest a collection, drag below and to the right of an intended parent folder or collection.")])],-1),Wt=t("h2",{id:"configure-a-collection",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#configure-a-collection"},"#"),e(" Configure a Collection")],-1),Kt=t("video",{title:"Configure a Collection",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/configure-a-collection-20220805A.mp4",type:"video/mp4"})],-1),Qt=t("p",null,"To configure a collection, follow these steps.",-1),Yt=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Data Model"),e(" and click the desired collection."),t("br"),e(" The collection’s configuration page will open.")]),t("li",null,[e("Make configurations as desired. Configuration options are broken into six categories. "),t("ul",null,[t("li",null,[t("a",{href:"#fields-layout"},"Fields and Layout")]),t("li",null,[t("a",{href:"#collection-setup"},"Collection Setup")]),t("li",null,[t("a",{href:"#archive"},"Archive")]),t("li",null,[t("a",{href:"#sort-field"},"Sort")]),t("li",null,[t("a",{href:"#accountability"},"Accountability")]),t("li",null,[t("a",{href:"#duplication"},"Duplication")])])]),t("li",null,[e("Click "),t("span",{mi:"",btn:""},"check"),e(" to confirm.")])],-1),zt=t("h3",{id:"fields-%26-layout",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#fields-%26-layout"},"#"),e(" Fields & Layout")],-1),Gt=t("video",{title:"Fields and Layout",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/fields-and-layout-20220805A.mp4",type:"video/mp4"})],-1),Jt=t("h3",{id:"collection-setup",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#collection-setup"},"#"),e(" Collection Setup")],-1),Xt=t("video",{title:"Collection Setup",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/collection-setup-20220805A.mp4",type:"video/mp4"})],-1),Zt=t("p",null,"These controls allow you to modify how the collection is displayed within the Content Module.",-1),$t=t("li",null,[t("strong",null,"Collection Name"),e(" — Displays the collection’s name, which cannot be modified. However, you can override the displayed name with Collection Naming Translations, shown lower on this list.")],-1),te=t("li",null,[t("strong",null,"Note"),e(" — Set a helpful note that explains the collection’s purpose.")],-1),ee=t("li",null,[t("strong",null,"Icon"),e(" — Set an icon used throughout the app when referencing this collection.")],-1),oe=t("li",null,[t("strong",null,"Color"),e(" — Set a color for the icon, shown in the Navigation Bar and its page header.")],-1),le=t("strong",null,"Display Template",-1),ne=t("li",null,[t("strong",null,"Hidden"),e(" — Toggle whether the collection should be globally hidden in the other app modules, even for admin users. You cannot hide collections for admins via permissions like other roles, so this comes in handy to tidy up the Content Module.")],-1),ie=t("strong",null,"Singleton",-1),se=t("strong",null,"Collection Naming Translations",-1),ae={class:"tip hint"},ce=t("div",{class:"hint-title"},"Collection Naming Translations",-1),de=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"What's a Singleton?"),t("p",null,[e("A collection that only contains one single item. For example, a website’s "),t("strong",null,"About Us"),e(" page.")])],-1),re=t("h3",{id:"archive",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#archive"},"#"),e(" Archive")],-1),ue=t("video",{title:"Archive",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/archive-20220805A.mp4",type:"video/mp4"})],-1),he=t("p",null,[e("Selects a field to handle archiving items. This provides a "),t("em",null,"soft-delete"),e(" functionality for items in a collection. Archived items will still exist in the collection and database, but are filtered within the Data Studio. To configure an archive field, set the following four input fields as desired.")],-1),pe=t("li",null,[t("strong",null,"Archive Field"),e(" — Selects the archive field from a dropdown menu.")],-1),fe=t("strong",null,"Archive App Filter",-1),_e=t("strong",null,"Archive Value",-1),me=t("strong",null,"Unarchive Value",-1),ge=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Automatic Setup"),t("p",null,[e("When you "),t("a",{href:"#create-a-collection"},"create a collection"),e(", you have the option to create an optional Status Field. If you choose to include this field, the collection’s archive settings will be automatically configured for you.")])],-1),ye=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Archive Field Values"),t("p",null,"The archive fields can contain any number of additional values besides the archived and unarchived values defined above.")],-1),ve=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Archived Item Management via API"),t("p",null,"Archived items are hidden in the app by default, but they are still returned normally via the API unless explicitly filtered out. This gives you the flexibility to manage archived items however you want when working with the API.")],-1),we=t("h3",{id:"sort-field",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#sort-field"},"#"),e(" Sort Field")],-1),be=t("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Batch Edit Items"},[t("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/manually-sort-items-20220415A.mp4",type:"video/mp4"})],-1),Se=t("strong",null,"Content Module > Collection Page",-1),Ce=t("code",null,"INTEGER",-1),Te=t("p",null,[t("strong",null,"Sort Field"),e(" — Select a field to custom sort and order items. Click "),t("strong",null,"Deselect"),e(" to disable.")],-1),ke=t("p",null,"To configure a sort field, follow these steps.",-1),Ae=t("code",null,"INTEGER",-1),De=t("li",null,[e("Choose a field from the dropdown under "),t("strong",null,"Settings > Data Model > [Collection] > Sort"),e(".")],-1),Fe=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"check"),e(" to confirm.")],-1),Ie={class:"tip hint"},xe=t("div",{class:"hint-title"},"Automatic Setup",-1),Ne=t("strong",null,"Sort",-1),Pe=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Interface Sorting"),t("p",null,[e("To configure manual sorting within a relational Interface (e.g., M2M, O2M, or M2A), configure as above, but also set the "),t("strong",null,"Sort Field"),e(" within the relationship section of the field’s configuration drawer.")])],-1),Me=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Configure to Hidden"),t("p",null,[e("You can also set this field to be "),t("strong",null,"Hidden"),e(" so it doesn’t show up within the Item Details Page.")])],-1),Oe=t("h3",{id:"accountability",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#accountability"},"#"),e(" Accountability")],-1),Re=t("video",{title:"Accountability",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/acountability-20220805A.mp4",type:"video/mp4"})],-1),je=t("ul",null,[t("li",null,[t("strong",null,"Activity & Revision Tracking"),e(" — The following options are supported: "),t("ul",null,[t("li",null,[t("strong",null,"Track Activity & Revisions")]),t("li",null,[t("strong",null,"Only Track Activity")]),t("li",null,[t("strong",null,"Do Not Track Anything")])])])],-1),Be={class:"tip hint"},Le=t("div",{class:"hint-title"},"Accountability vs. Telemetry",-1),Ue=t("em",null,"who does what",-1),He=t("h3",{id:"duplication",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#duplication"},"#"),e(" Duplication")],-1),Ve=t("video",{title:"Duplication",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/duplicate-20220805A.mp4",type:"video/mp4"})],-1),qe=t("p",null,[e("The "),t("strong",null,"Save as Copy"),e(" option on the Item Details Page offers a way to effectively duplicate the current item. Since there may be unique or relational data within the item, it’s important to control exactly what will be copied. Duplication lets you configure which parent & relational field values will be copied when you use "),t("strong",null,"Save as Copy"),e(" on an item.")],-1),Ee=t("ul",null,[t("li",null,[t("strong",null,"Item Duplication Fields"),e(" — Check the field(s) to copy values for when duplicating an item.")])],-1),We=t("h2",{id:"delete-a-collection",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#delete-a-collection"},"#"),e(" Delete a Collection")],-1),Ke=t("video",{title:"Delete a Collection",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/collections/collections-20220805/delete-a-collection-20220805A.mp4",type:"video/mp4"})],-1),Qe=t("p",null,"To delete a collection, follow these steps.",-1),Ye=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Data Model > [Collection Name]"),e(".")]),t("li",null,[e("Click "),t("span",{mi:"",btn:"",dngr:""},"delete"),e(" in the page header.")]),t("li",null,[e("Confirm this decision by clicking "),t("strong",null,"Delete"),e(" in the dialog.")])],-1),ze=t("div",{class:"danger hint"},[t("p",null,"This action is permanent and irreversible. Please proceed with caution.")],-1),$e="Collections",to=!1,eo={__name:"collections",setup(Ge,{expose:a}){const i={title:"Collections",modularExtension:!1};return a({frontmatter:i}),(Je,Xe)=>{const l=s("router-link"),c=s("docs-wrapper");return d(),r(c,{frontmatter:i},{default:o(()=>[t("div",u,[h,p,f,t("p",null,[e("Collections are data tables. Typically, you access items within a collection in the "),n(l,{to:"/docs/app/content"},{default:o(()=>[e("Content Module")]),_:1}),e(".")]),_,m,g,y,v,t("table",null,[w,t("tbody",null,[t("tr",null,[b,S,t("td",null,[n(l,{to:"/docs/configuration/activity-log"},{default:o(()=>[e("Activity Log")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/activity"},{default:o(()=>[e("Activity")]),_:1})])]),t("tr",null,[C,T,t("td",null,[n(l,{to:"/docs/configuration/data-model/collections"},{default:o(()=>[e("Collections")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/collections"},{default:o(()=>[e("Collections")]),_:1})])]),t("tr",null,[k,A,t("td",null,[n(l,{to:"/docs/app/insights"},{default:o(()=>[e("Insights")]),_:1})]),D]),t("tr",null,[F,I,t("td",null,[n(l,{to:"/docs/configuration/data-model/fields/"},{default:o(()=>[e("Fields")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/fields"},{default:o(()=>[e("Fields")]),_:1})])]),t("tr",null,[x,N,t("td",null,[n(l,{to:"/docs/app/file-library"},{default:o(()=>[e("File Library")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/files"},{default:o(()=>[e("Files")]),_:1})])]),t("tr",null,[P,M,t("td",null,[n(l,{to:"/docs/configuration/flows"},{default:o(()=>[e("Flows")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/flows"},{default:o(()=>[e("Flows")]),_:1})])]),t("tr",null,[O,R,t("td",null,[n(l,{to:"/docs/app/file-library#folders"},{default:o(()=>[e("Folders")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/folders"},{default:o(()=>[e("Folders")]),_:1})])]),j,t("tr",null,[B,L,t("td",null,[n(l,{to:"/docs/app/overview#_1-module-bar"},{default:o(()=>[e("Module Bar")]),_:1}),e(" and "),n(l,{to:"/docs/app/overview#_4-sidebar"},{default:o(()=>[e("Sidebar")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/notifications"},{default:o(()=>[e("Notifications")]),_:1})])]),t("tr",null,[U,H,t("td",null,[n(l,{to:"/docs/configuration/flows"},{default:o(()=>[e("Operations")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/operations.md"},{default:o(()=>[e("Operations")]),_:1})])]),t("tr",null,[V,q,t("td",null,[n(l,{to:"/docs/app/insights"},{default:o(()=>[e("Insights")]),_:1})]),E]),t("tr",null,[W,K,t("td",null,[n(l,{to:"/docs/configuration/users-roles-permissions"},{default:o(()=>[e("Users, Roles & Permissions")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/permissions"},{default:o(()=>[e("Permissions")]),_:1})])]),t("tr",null,[Q,Y,t("td",null,[n(l,{to:"/docs/configuration/presets-bookmarks"},{default:o(()=>[e("Presents & Bookmarks")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/presets"},{default:o(()=>[e("Presets")]),_:1})])]),t("tr",null,[z,G,t("td",null,[n(l,{to:"/docs/configuration/data-model/relationships"},{default:o(()=>[e("Relationships")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/relations"},{default:o(()=>[e("Relations")]),_:1})])]),t("tr",null,[J,X,t("td",null,[n(l,{to:"/docs/app/content/items#revert-an-item"},{default:o(()=>[e("Revert an Item")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/revisions"},{default:o(()=>[e("Revisions")]),_:1})])]),t("tr",null,[Z,$,t("td",null,[n(l,{to:"/docs/configuration/users-roles-permissions"},{default:o(()=>[e("Users, Roles, and Permissions")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/roles"},{default:o(()=>[e("Roles")]),_:1})])]),tt,t("tr",null,[et,ot,t("td",null,[n(l,{to:"/docs/configuration/project-settings"},{default:o(()=>[e("Project Settings")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/settings"},{default:o(()=>[e("settings")]),_:1})])]),t("tr",null,[lt,nt,t("td",null,[n(l,{to:"/docs/app/content/shares"},{default:o(()=>[e("Data Sharing")]),_:1})]),it]),t("tr",null,[st,at,t("td",null,[n(l,{to:"/docs/app/user-directory"},{default:o(()=>[e("User Directory")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/relations"},{default:o(()=>[e("Users")]),_:1})])]),t("tr",null,[ct,dt,t("td",null,[n(l,{to:"/docs/configuration/webhooks"},{default:o(()=>[e("Webhooks")]),_:1})]),t("td",null,[n(l,{to:"/docs/reference/system/relations"},{default:o(()=>[e("Webhooks")]),_:1})])])])]),rt,ut,ht,t("ol",null,[pt,ft,t("li",null,[e("Optional: Make any other configurations as desired. "),t("ul",null,[_t,mt,t("li",null,[gt,e(" — Sets the "),n(l,{to:"/docs/configuration/data-model/fields/#keys-and-ids"},{default:o(()=>[e("type of ID")]),_:1}),e(" to use for this collection.")])])]),yt,vt,wt]),bt,St,Ct,Tt,kt,At,Dt,Ft,t("div",It,[t("p",null,[e("Assuming a user has "),n(l,{to:"/docs/configuration/users-roles-permissions"},{default:o(()=>[e("access permissions")]),_:1}),e(", hidden collections can still be viewed. They must right-click on the Navigation Bar and choose "),xt,e(),Nt,e(".")])]),Pt,Mt,Ot,Rt,jt,Bt,Lt,Ut,Ht,Vt,qt,Et,Wt,Kt,Qt,Yt,zt,Gt,t("p",null,[e("This section allows you to create and configure fields, as well as configure how fields are displayed on the "),n(l,{to:"/docs/app/content/items"},{default:o(()=>[e("Item Details Page")]),_:1}),e(". To learn more, please see the documentation on "),n(l,{to:"/docs/configuration/data-model/fields/"},{default:o(()=>[e("fields")]),_:1}),e(".")]),Jt,Xt,Zt,t("ul",null,[$t,te,ee,oe,t("li",null,[le,e(" — Create a "),n(l,{to:"/docs/app/display-templates"},{default:o(()=>[e("Display Template")]),_:1}),e(" for the collection.")]),ne,t("li",null,[ie,e(" — Toggle to bypass the "),n(l,{to:"/docs/app/content/collections"},{default:o(()=>[e("Collection Page")]),_:1}),e(" and take users to the "),n(l,{to:"/docs/app/content/items"},{default:o(()=>[e("Item Details Page")]),_:1}),e(".")]),t("li",null,[se,e(" — Translate the collection name across multiple languages. When the default language is changed in "),n(l,{to:"/docs/configuration/project-settings#general"},{default:o(()=>[e("Project Settings")]),_:1}),e(" or "),n(l,{to:"/docs/app/user-directory#user-details-page"},{default:o(()=>[e("User Details Page")]),_:1}),e(", the relevant translation, if any exists, will be used throughout the app.")])]),t("div",ae,[ce,t("p",null,[e("By default, Directus uses the "),n(l,{to:"/docs/getting-started/glossary#title-formatter"},{default:o(()=>[e("Title Formatter")]),_:1}),e(" to display collection keys as human readable names, but you can also use translations to explicitly rename more technical table keys.")])]),de,re,ue,he,t("ul",null,[pe,t("li",null,[fe,e(" — Toggles whether app users can "),n(l,{to:"/docs/app/content/collections#view-archived-items"},{default:o(()=>[e("filter for archived items")]),_:1}),e(".")]),t("li",null,[_e,e(" — A value that is assigned to the field when an item is "),n(l,{to:"/docs/app/content/items#archive-an-item"},{default:o(()=>[e("archived")]),_:1}),e(".")]),t("li",null,[me,e(" — A value that is assigned to the field when an item is "),n(l,{to:"/docs/app/content/items#archive-an-item"},{default:o(()=>[e("unarchived")]),_:1}),e(".")])]),ge,ye,ve,we,be,t("p",null,[e("The sort feature enables users to "),n(l,{to:"/docs/app/content/collections#manually-sort-items"},{default:o(()=>[e("manually sort Items")]),_:1}),e(" within the Data Studio. This is typically shown on the "),Se,e(". It can also be used for sorting items within "),n(l,{to:"/docs/getting-started/glossary#junction-collections"},{default:o(()=>[e("Junction Collections")]),_:1}),e(". A standard field, configured with an "),Ce,e(" data type, is required. As shown in the video, fields which cannot serve as sort fields will be grayed out and unselectable in the Sort Field dropdown.")]),Te,ke,t("ol",null,[t("li",null,[n(l,{to:"/docs/configuration/data-model/fields/#create-a-field-standard"},{default:o(()=>[e("Create a Field")]),_:1}),e(" with an "),Ae,e(" data type.")]),De,Fe]),t("p",null,[e("Once you sort field is configured, you may want to learn how to "),n(l,{to:"/docs/app/content/collections#manually-sort-items"},{default:o(()=>[e("manually sort Items")]),_:1}),e(".")]),t("div",Ie,[xe,t("p",null,[e("When you "),n(l,{to:"/docs/configuration/data-model/collections#create-a-collection"},{default:o(()=>[e("create a Collection")]),_:1}),e(", you have the option of creating a "),Ne,e(" field. If you choose to include this field, the collection’s sort settings will automatically be configured for you.")])]),Pe,Me,Oe,Re,t("p",null,[e("By default, your Directus Project tracks all "),n(l,{to:"/docs/reference/system/activity"},{default:o(()=>[e("activity")]),_:1}),e(" and "),n(l,{to:"/docs/reference/system/revisions"},{default:o(()=>[e("revisions")]),_:1}),e(" for collections. However, you can override this and choose what data is tracked.")]),je,t("div",Be,[Le,t("p",null,[e("Accountability is a log of "),Ue,e(" in your project. It is for your team’s own use. This is different from "),n(l,{to:"/docs/self-hosted/config-options#telemetry"},{default:o(()=>[e("telemetry")]),_:1}),e(", which is configured under "),n(l,{to:"/docs/self-hosted/config-options#telemetry"},{default:o(()=>[e("environment variables")]),_:1}),e(".")])]),He,Ve,qe,Ee,We,Ke,Qe,Ye,ze])]),_:1})}}};export{eo as default,to as modularExtension,$e as title};

package/dist/assets/commonlisp-5aaf3dae.js

@@ -0,0 +1 @@
+import{z as y}from"./index.522e44ef.entry.js";function k(f,d){for(var i=0;i<d.length;i++){const l=d[i];if(typeof l!="string"&&!Array.isArray(l)){for(const c in l)if(c!=="default"&&!(c in f)){const u=Object.getOwnPropertyDescriptor(l,c);u&&Object.defineProperty(f,c,u.get?u:{enumerable:!0,get:()=>l[c]})}}}return Object.freeze(Object.defineProperty(f,Symbol.toStringTag,{value:"Module"}))}var x={};(function(f,d){(function(i){i(y)})(function(i){i.defineMode("commonlisp",function(l){var c=/^(block|let*|return-from|catch|load-time-value|setq|eval-when|locally|symbol-macrolet|flet|macrolet|tagbody|function|multiple-value-call|the|go|multiple-value-prog1|throw|if|progn|unwind-protect|labels|progv|let|quote)$/,u=/^with|^def|^do|^prog|case$|^cond$|bind$|when$|unless$/,a=/^(?:[+\-]?(?:\d+|\d*\.\d+)(?:[efd][+\-]?\d+)?|[+\-]?\d+(?:\/[+\-]?\d+)?|#b[+\-]?[01]+|#o[+\-]?[0-7]+|#x[+\-]?[\da-f]+)/,b=/[^\s'`,@()\[\]";]/,o;function p(e){for(var n;n=e.next();)if(n=="\\")e.next();else if(!b.test(n)){e.backUp(1);break}return e.current()}function s(e,n){if(e.eatSpace())return o="ws",null;if(e.match(a))return"number";var t=e.next();if(t=="\\"&&(t=e.next()),t=='"')return(n.tokenize=v)(e,n);if(t=="(")return o="open","bracket";if(t==")"||t=="]")return o="close","bracket";if(t==";")return e.skipToEnd(),o="ws","comment";if(/['`,@]/.test(t))return null;if(t=="|")return e.skipTo("|")?(e.next(),"symbol"):(e.skipToEnd(),"error");if(t=="#"){var t=e.next();return t=="("?(o="open","bracket"):/[+\-=\.']/.test(t)||/\d/.test(t)&&e.match(/^\d*#/)?null:t=="|"?(n.tokenize=m)(e,n):t==":"?(p(e),"meta"):t=="\\"?(e.next(),p(e),"string-2"):"error"}else{var r=p(e);return r=="."?null:(o="symbol",r=="nil"||r=="t"||r.charAt(0)==":"?"atom":n.lastType=="open"&&(c.test(r)||u.test(r))?"keyword":r.charAt(0)=="&"?"variable-2":"variable")}}function v(e,n){for(var t=!1,r;r=e.next();){if(r=='"'&&!t){n.tokenize=s;break}t=!t&&r=="\\"}return"string"}function m(e,n){for(var t,r;t=e.next();){if(t=="#"&&r=="|"){n.tokenize=s;break}r=t}return o="ws","comment"}return{startState:function(){return{ctx:{prev:null,start:0,indentTo:0},lastType:null,tokenize:s}},token:function(e,n){e.sol()&&typeof n.ctx.indentTo!="number"&&(n.ctx.indentTo=n.ctx.start+1),o=null;var t=n.tokenize(e,n);return o!="ws"&&(n.ctx.indentTo==null?o=="symbol"&&u.test(e.current())?n.ctx.indentTo=n.ctx.start+l.indentUnit:n.ctx.indentTo="next":n.ctx.indentTo=="next"&&(n.ctx.indentTo=e.column()),n.lastType=o),o=="open"?n.ctx={prev:n.ctx,start:e.column(),indentTo:null}:o=="close"&&(n.ctx=n.ctx.prev||n.ctx),t},indent:function(e,n){var t=e.ctx.indentTo;return typeof t=="number"?t:e.ctx.start+1},closeBrackets:{pairs:'()[]{}""'},lineComment:";;",blockCommentStart:"#|",blockCommentEnd:"|#"}}),i.defineMIME("text/x-common-lisp","commonlisp")})})();const h=k({__proto__:null,default:x},[x]);export{h as c};

package/dist/assets/conditions-533313f8.js

@@ -0,0 +1 @@
+import{a as n,o as a,e as h,y as s,u as e,q as t,z as d}from"./runtime-core.esm-bundler-753bcc58.js";const c={class:"markdown-body"},u=e("p",null,"Conditions allow you to alter the current field’s setup based on the values of other fields in the form. This allows you to show/hide the field, make it readonly, or change the interface options.",-1),f=e("p",null,[t("Each field can have one or more "),e("em",null,"rules"),t(". Each rule has the following configuration options:")],-1),_=e("li",null,[e("strong",null,"Name"),t(": The name of the rule. This is only used internally for convenience purposes")],-1),p=e("strong",null,"Rule",-1),m=e("li",null,[e("strong",null,"Readonly"),t(": Whether or not the field is readonly when the condition is matched")],-1),g=e("li",null,[e("strong",null,"Hidden"),t(": Whether or not the field is hidden when the condition is matched")],-1),y=e("li",null,[e("strong",null,"Required"),t(": Whether or not the field is required when the condition is matched")],-1),w=e("li",null,[e("strong",null,"Interface Options"),t(": Any additional configuration for the selected interface")],-1),T=e("p",null,"These changes to the field are merged onto the base configuration of the field. This means you can have the field hidden by default, and then only toggle the hidden state of the field in the condition.",-1),v=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Order Matters"),e("p",null,[t("The conditions are matched in order. The "),e("strong",null,"last"),t(" condition that matches is the one that’s used to apply the changes.")])],-1),b="Conditions",E=!1,N={__name:"conditions",setup(k,{expose:l}){const o={title:"Conditions",modularExtension:!1};return l({frontmatter:o}),(x,C)=>{const i=n("router-link"),r=n("docs-wrapper");return a(),h(r,{frontmatter:o},{default:s(()=>[e("div",c,[u,f,e("ul",null,[_,e("li",null,[p,t(": The rule that controls whether or not these conditions are applied. Rule follows the "),d(i,{to:"/docs/reference/filter-rules"},{default:s(()=>[t("Filter Rules")]),_:1}),t(" spec")]),m,g,y,w]),T,v])]),_:1})}}};export{N as default,E as modularExtension,b as title};