@directus/app 9.20.4 → 9.21.0

package/dist/assets/eiffel.d9fec659.js

@@ -0,0 +1 @@
+import{y as x}from"./index.312f2c91.entry.js";function v(f,l){for(var i=0;i<l.length;i++){const o=l[i];if(typeof o!="string"&&!Array.isArray(o)){for(const u in o)if(u!=="default"&&!(u in f)){const a=Object.getOwnPropertyDescriptor(o,u);a&&Object.defineProperty(f,u,a.get?a:{enumerable:!0,get:()=>o[u]})}}}return Object.freeze(Object.defineProperty(f,Symbol.toStringTag,{value:"Module"}))}var p={exports:{}};(function(f,l){(function(i){i(x.exports)})(function(i){i.defineMode("eiffel",function(){function o(e){for(var r={},t=0,n=e.length;t<n;++t)r[e[t]]=!0;return r}var u=o(["note","across","when","variant","until","unique","undefine","then","strip","select","retry","rescue","require","rename","reference","redefine","prefix","once","old","obsolete","loop","local","like","is","inspect","infix","include","if","frozen","from","external","export","ensure","end","elseif","else","do","creation","create","check","alias","agent","separate","invariant","inherit","indexing","feature","expanded","deferred","class","Void","True","Result","Precursor","False","Current","create","attached","detachable","as","and","implies","not","or"]),a=o([":=","and then","and","or","<<",">>"]);function d(e,r,t){return t.tokenize.push(e),e(r,t)}function b(e,r){if(e.eatSpace())return null;var t=e.next();return t=='"'||t=="'"?d(g(t,"string"),e,r):t=="-"&&e.eat("-")?(e.skipToEnd(),"comment"):t==":"&&e.eat("=")?"operator":/[0-9]/.test(t)?(e.eatWhile(/[xXbBCc0-9\.]/),e.eat(/[\?\!]/),"ident"):/[a-zA-Z_0-9]/.test(t)?(e.eatWhile(/[a-zA-Z_0-9]/),e.eat(/[\?\!]/),"ident"):/[=+\-\/*^%<>~]/.test(t)?(e.eatWhile(/[=+\-\/*^%<>~]/),"operator"):null}function g(e,r,t){return function(n,h){for(var c=!1,s;(s=n.next())!=null;){if(s==e&&(t||!c)){h.tokenize.pop();break}c=!c&&s=="%"}return r}}return{startState:function(){return{tokenize:[b]}},token:function(e,r){var t=r.tokenize[r.tokenize.length-1](e,r);if(t=="ident"){var n=e.current();t=u.propertyIsEnumerable(e.current())?"keyword":a.propertyIsEnumerable(e.current())?"operator":/^[A-Z][A-Z_0-9]*$/g.test(n)?"tag":/^0[bB][0-1]+$/g.test(n)||/^0[cC][0-7]+$/g.test(n)||/^0[xX][a-fA-F0-9]+$/g.test(n)||/^([0-9]+\.[0-9]*)|([0-9]*\.[0-9]+)$/g.test(n)||/^[0-9]+$/g.test(n)?"number":"variable"}return t},lineComment:"--"}}),i.defineMIME("text/x-eiffel","eiffel")})})();const y=p.exports,z=v({__proto__:null,default:y},[p.exports]);export{z as e};

package/dist/assets/elm.c3ce2b54.js

@@ -0,0 +1 @@
+import{y as _}from"./index.312f2c91.entry.js";function O(p,h){for(var f=0;f<h.length;f++){const r=h[f];if(typeof r!="string"&&!Array.isArray(r)){for(const a in r)if(a!=="default"&&!(a in p)){const o=Object.getOwnPropertyDescriptor(r,a);o&&Object.defineProperty(p,a,o.get?o:{enumerable:!0,get:()=>r[a]})}}}return Object.freeze(Object.defineProperty(p,Symbol.toStringTag,{value:"Module"}))}var g={exports:{}};(function(p,h){(function(f){f(_.exports)})(function(f){f.defineMode("elm",function(){function r(t,n,e){return n(e),e(t,n)}var a=/[a-z]/,o=/[A-Z]/,u=/[a-zA-Z0-9_]/,m=/[0-9]/,x=/[0-9A-Fa-f]/,v=/[-&*+.\\/<>=?^|:]/,w=/[(),[\]{}]/,y=/[ \v\f]/;function i(){return function(t,n){if(t.eatWhile(y))return null;var e=t.next();if(w.test(e))return e==="{"&&t.eat("-")?r(t,n,d(1)):e==="["&&t.match("glsl|")?r(t,n,W):"builtin";if(e==="'")return r(t,n,k);if(e==='"')return t.eat('"')?t.eat('"')?r(t,n,E):"string":r(t,n,b);if(o.test(e))return t.eatWhile(u),"variable-2";if(a.test(e)){var l=t.pos===1;return t.eatWhile(u),l?"def":"variable"}if(m.test(e)){if(e==="0"){if(t.eat(/[xX]/))return t.eatWhile(x),"number"}else t.eatWhile(m);return t.eat(".")&&t.eatWhile(m),t.eat(/[eE]/)&&(t.eat(/[-+]/),t.eatWhile(m)),"number"}return v.test(e)?e==="-"&&t.eat("-")?(t.skipToEnd(),"comment"):(t.eatWhile(v),"keyword"):e==="_"?"keyword":"error"}}function d(t){return t==0?i():function(n,e){for(;!n.eol();){var l=n.next();if(l=="{"&&n.eat("-"))++t;else if(l=="-"&&n.eat("}")&&(--t,t===0))return e(i()),"comment"}return e(d(t)),"comment"}}function E(t,n){for(;!t.eol();){var e=t.next();if(e==='"'&&t.eat('"')&&t.eat('"'))return n(i()),"string"}return"string"}function b(t,n){for(;t.skipTo('\\"');)t.next(),t.next();return t.skipTo('"')?(t.next(),n(i()),"string"):(t.skipToEnd(),n(i()),"error")}function k(t,n){for(;t.skipTo("\\'");)t.next(),t.next();return t.skipTo("'")?(t.next(),n(i()),"string"):(t.skipToEnd(),n(i()),"error")}function W(t,n){for(;!t.eol();){var e=t.next();if(e==="|"&&t.eat("]"))return n(i()),"string"}return"string"}var R={case:1,of:1,as:1,if:1,then:1,else:1,let:1,in:1,type:1,alias:1,module:1,where:1,import:1,exposing:1,port:1};return{startState:function(){return{f:i()}},copyState:function(t){return{f:t.f}},token:function(t,n){var e=n.f(t,function(T){n.f=T}),l=t.current();return R.hasOwnProperty(l)?"keyword":e}}}),f.defineMIME("text/x-elm","elm")})})();const A=g.exports,j=O({__proto__:null,default:A},[g.exports]);export{j as e};

package/dist/assets/{email-templates.5e1b5472.js → email-templates.ed708d89.js}

@@ -1,2 +1,2 @@
-import{a as l,o as r,b as i,w as n,l as e,E as t}from"./runtime-core.esm-bundler.fe249c5c.js";const m=e("div",{class:"markdown-body"},[e("blockquote",null,[e("p",null,"Templates can be used to add custom templates for your emails, or to override the system emails used for things like resetting a password or inviting a user.")]),e("h2",{id:"1.-create-a-template-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#1.-create-a-template-file"},"#"),t(" 1. Create a template file")]),e("p",null,[t("Custom email templates are stored in the "),e("code",null,"templates"),t(" folder in your extensions folder. Every template is a "),e("a",{href:"https://liquidjs.com",target:"_blank",rel:"noopener noreferrer"},[e("code",null,"liquid")]),t(" file that can render whatever you want!")]),e("pre",null,[e("code",null,`/extensions/templates/<template-name>.liquid
+import{a as l,o as r,e as i,y as n,u as e,q as t}from"./runtime-core.esm-bundler.22ec0346.js";const m=e("div",{class:"markdown-body"},[e("blockquote",null,[e("p",null,"Templates can be used to add custom templates for your emails, or to override the system emails used for things like resetting a password or inviting a user.")]),e("h2",{id:"1.-create-a-template-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#1.-create-a-template-file"},"#"),t(" 1. Create a template file")]),e("p",null,[t("Custom email templates are stored in the "),e("code",null,"templates"),t(" folder in your extensions folder. Every template is a "),e("a",{href:"https://liquidjs.com",target:"_blank",rel:"noopener noreferrer"},[e("code",null,"liquid")]),t(" file that can render whatever you want!")]),e("pre",null,[e("code",null,`/extensions/templates/<template-name>.liquid
 `)]),e("p",null,[t("To replace a system template with your own, simply name it "),e("code",null,"password-reset"),t(" or "),e("code",null,"user-invitation"),t(" for the password reset or user invite emails respectively.")]),e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Variables"),e("p",null,[t("When overriding the default email templates, make sure to include the "),e("code",null,"url"),t(" variable somewhere. A password reset email wouldn\u2019t be that useful without the link to go reset your password!")])])],-1),h="Email Templates",f=!0,w="A guide on how to build custom Email Templates in Directus.",_="1 min read",v={__name:"email-templates",setup(d,{expose:o}){const a={title:"Email Templates",modularExtension:!0,description:"A guide on how to build custom Email Templates in Directus.",readTime:"1 min read"};return o({frontmatter:a}),(u,c)=>{const s=l("docs-wrapper");return r(),i(s,{frontmatter:a},{default:n(()=>[m]),_:1})}}};export{v as default,w as description,f as modularExtension,_ as readTime,h as title};

package/dist/assets/{endpoints.44874916.js → endpoints.10a1484a.js}

@@ -1,4 +1,4 @@
-import{a,o,b as r,w as i,l as s,E as e}from"./runtime-core.esm-bundler.fe249c5c.js";const c=s("div",{class:"markdown-body"},[s("blockquote",null,[s("p",null,"Custom API Endpoints register new API routes which can be used to infinitely extend the core functionality of the platform.")]),s("h2",{id:"extension-entrypoint",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#extension-entrypoint"},"#"),e(" Extension Entrypoint")]),s("p",null,[e("The entrypoint of your endpoint is the "),s("code",null,"index"),e(" file inside the "),s("code",null,"src/"),e(" folder of your extension package. It exports a register function to register one or more custom routes. Each route of your endpoint will be a sub-route of "),s("code",null,"/<extension-name>"),e(".")]),s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Extension Name"),s("p",null,"The extension name is usually the name of the folder where you put your extension when deploying it.")]),s("p",null,"Example of an entrypoint:"),s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"export"),e(),s("span",{class:"hljs-keyword"},"default"),e(` (router) => {
+import{a,o,e as r,y as i,u as s,q as e}from"./runtime-core.esm-bundler.22ec0346.js";const c=s("div",{class:"markdown-body"},[s("blockquote",null,[s("p",null,"Custom API Endpoints register new API routes which can be used to infinitely extend the core functionality of the platform.")]),s("h2",{id:"extension-entrypoint",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#extension-entrypoint"},"#"),e(" Extension Entrypoint")]),s("p",null,[e("The entrypoint of your endpoint is the "),s("code",null,"index"),e(" file inside the "),s("code",null,"src/"),e(" folder of your extension package. It exports a register function to register one or more custom routes. Each route of your endpoint will be a sub-route of "),s("code",null,"/<extension-name>"),e(".")]),s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Extension Name"),s("p",null,"The extension name is usually the name of the folder where you put your extension when deploying it.")]),s("p",null,"Example of an entrypoint:"),s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"export"),e(),s("span",{class:"hljs-keyword"},"default"),e(` (router) => {
 	router.`),s("span",{class:"hljs-title function_"},"get"),e("("),s("span",{class:"hljs-string"},"'/'"),e(", "),s("span",{class:"hljs-function"},[e("("),s("span",{class:"hljs-params"},"req, res"),e(") =>")]),e(" res."),s("span",{class:"hljs-title function_"},"send"),e("("),s("span",{class:"hljs-string"},"'Hello, World!'"),e(`));
 };
 `)])]),s("p",null,"Alternatively, you can export a configuration object to be able to customize the root route:"),s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"export"),e(),s("span",{class:"hljs-keyword"},"default"),e(` {

package/dist/assets/erlang.d00fab30.js

@@ -0,0 +1 @@
+import{y as X}from"./index.312f2c91.entry.js";function Y(g,h){for(var a=0;a<h.length;a++){const _=h[a];if(typeof _!="string"&&!Array.isArray(_)){for(const p in _)if(p!=="default"&&!(p in g)){const s=Object.getOwnPropertyDescriptor(_,p);s&&Object.defineProperty(g,p,s.get?s:{enumerable:!0,get:()=>_[p]})}}}return Object.freeze(Object.defineProperty(g,Symbol.toStringTag,{value:"Module"}))}var A={exports:{}};(function(g,h){(function(a){a(X.exports)})(function(a){a.defineMIME("text/x-erlang","erlang"),a.defineMode("erlang",function(_){var p=["-type","-spec","-export_type","-opaque"],s=["after","begin","catch","case","cond","end","fun","if","let","of","query","receive","try","when"],m=/[\->,;]/,R=["->",";",","],U=["and","andalso","band","bnot","bor","bsl","bsr","bxor","div","not","or","orelse","rem","xor"],j=/[\+\-\*\/<>=\|:!]/,O=["=","+","-","*","/",">",">=","<","=<","=:=","==","=/=","/=","||","<-","!"],Z=/[<\(\[\{]/,y=["<<","(","[","{"],q=/[>\)\]\}]/,x=["}","]",")",">>"],$=["is_atom","is_binary","is_bitstring","is_boolean","is_float","is_function","is_integer","is_list","is_number","is_pid","is_port","is_record","is_reference","is_tuple","atom","binary","bitstring","boolean","function","integer","list","number","pid","port","record","reference","tuple"],I=["abs","adler32","adler32_combine","alive","apply","atom_to_binary","atom_to_list","binary_to_atom","binary_to_existing_atom","binary_to_list","binary_to_term","bit_size","bitstring_to_list","byte_size","check_process_code","contact_binary","crc32","crc32_combine","date","decode_packet","delete_module","disconnect_node","element","erase","exit","float","float_to_list","garbage_collect","get","get_keys","group_leader","halt","hd","integer_to_list","internal_bif","iolist_size","iolist_to_binary","is_alive","is_atom","is_binary","is_bitstring","is_boolean","is_float","is_function","is_integer","is_list","is_number","is_pid","is_port","is_process_alive","is_record","is_reference","is_tuple","length","link","list_to_atom","list_to_binary","list_to_bitstring","list_to_existing_atom","list_to_float","list_to_integer","list_to_pid","list_to_tuple","load_module","make_ref","module_loaded","monitor_node","node","node_link","node_unlink","nodes","notalive","now","open_port","pid_to_list","port_close","port_command","port_connect","port_control","pre_loaded","process_flag","process_info","processes","purge_module","put","register","registered","round","self","setelement","size","spawn","spawn_link","spawn_monitor","spawn_opt","split_binary","statistics","term_to_binary","time","throw","tl","trunc","tuple_size","tuple_to_list","unlink","unregister","whereis"],v=/[\w@Ø-ÞÀ-Öß-öø-ÿ]/,Q=/[0-7]{1,3}|[bdefnrstv\\"']|\^[a-zA-Z]|x[0-9a-zA-Z]{2}|x{[0-9a-zA-Z]+}/;function D(e,n){if(n.in_string)return n.in_string=!z(e),o(n,e,"string");if(n.in_atom)return n.in_atom=!E(e),o(n,e,"atom");if(e.eatSpace())return o(n,e,"whitespace");if(!b(n)&&e.match(/-\s*[a-zß-öø-ÿ][\wØ-ÞÀ-Öß-öø-ÿ]*/))return u(e.current(),p)?o(n,e,"type"):o(n,e,"attribute");var r=e.next();if(r=="%")return e.skipToEnd(),o(n,e,"comment");if(r==":")return o(n,e,"colon");if(r=="?")return e.eatSpace(),e.eatWhile(v),o(n,e,"macro");if(r=="#")return e.eatSpace(),e.eatWhile(v),o(n,e,"record");if(r=="$")return e.next()=="\\"&&!e.match(Q)?o(n,e,"error"):o(n,e,"number");if(r==".")return o(n,e,"dot");if(r=="'"){if(!(n.in_atom=!E(e))){if(e.match(/\s*\/\s*[0-9]/,!1))return e.match(/\s*\/\s*[0-9]/,!0),o(n,e,"fun");if(e.match(/\s*\(/,!1)||e.match(/\s*:/,!1))return o(n,e,"function")}return o(n,e,"atom")}if(r=='"')return n.in_string=!z(e),o(n,e,"string");if(/[A-Z_Ø-ÞÀ-Ö]/.test(r))return e.eatWhile(v),o(n,e,"variable");if(/[a-z_ß-öø-ÿ]/.test(r)){if(e.eatWhile(v),e.match(/\s*\/\s*[0-9]/,!1))return e.match(/\s*\/\s*[0-9]/,!0),o(n,e,"fun");var t=e.current();return u(t,s)?o(n,e,"keyword"):u(t,U)?o(n,e,"operator"):e.match(/\s*\(/,!1)?u(t,I)&&(b(n).token!=":"||b(n,2).token=="erlang")?o(n,e,"builtin"):u(t,$)?o(n,e,"guard"):o(n,e,"function"):N(e)==":"?t=="erlang"?o(n,e,"builtin"):o(n,e,"function"):u(t,["true","false"])?o(n,e,"boolean"):o(n,e,"atom")}var c=/[0-9]/,i=/[0-9a-zA-Z]/;return c.test(r)?(e.eatWhile(c),e.eat("#")?e.eatWhile(i)||e.backUp(1):e.eat(".")&&(e.eatWhile(c)?e.eat(/[eE]/)&&(e.eat(/[-+]/)?e.eatWhile(c)||e.backUp(2):e.eatWhile(c)||e.backUp(1)):e.backUp(1)),o(n,e,"number")):S(e,Z,y)?o(n,e,"open_paren"):S(e,q,x)?o(n,e,"close_paren"):W(e,m,R)?o(n,e,"separator"):W(e,j,O)?o(n,e,"operator"):o(n,e,null)}function S(e,n,r){if(e.current().length==1&&n.test(e.current())){for(e.backUp(1);n.test(e.peek());)if(e.next(),u(e.current(),r))return!0;e.backUp(e.current().length-1)}return!1}function W(e,n,r){if(e.current().length==1&&n.test(e.current())){for(;n.test(e.peek());)e.next();for(;0<e.current().length;){if(u(e.current(),r))return!0;e.backUp(1)}e.next()}return!1}function z(e){return T(e,'"',"\\")}function E(e){return T(e,"'","\\")}function T(e,n,r){for(;!e.eol();){var t=e.next();if(t==n)return!0;t==r&&e.next()}return!1}function N(e){var n=e.match(/^\s*([^\s%])/,!1);return n?n[1]:""}function u(e,n){return-1<n.indexOf(e)}function o(e,n,r){switch(G(e,B(r,n)),r){case"atom":return"atom";case"attribute":return"attribute";case"boolean":return"atom";case"builtin":return"builtin";case"close_paren":return null;case"colon":return null;case"comment":return"comment";case"dot":return null;case"error":return"error";case"fun":return"meta";case"function":return"tag";case"guard":return"property";case"keyword":return"keyword";case"macro":return"variable-2";case"number":return"number";case"open_paren":return null;case"operator":return"operator";case"record":return"bracket";case"separator":return null;case"string":return"string";case"type":return"def";case"variable":return"variable";default:return null}}function P(e,n,r,t){return{token:e,column:n,indent:r,type:t}}function B(e,n){return P(n.current(),n.column(),n.indentation(),e)}function F(e){return P(e,0,0,e)}function b(e,n){var r=e.tokenStack.length,t=n||1;return r<t?!1:e.tokenStack[r-t]}function G(e,n){n.type=="comment"||n.type=="whitespace"||(e.tokenStack=H(e.tokenStack,n),e.tokenStack=J(e.tokenStack))}function H(e,n){var r=e.length-1;return 0<r&&e[r].type==="record"&&n.type==="dot"?e.pop():(0<r&&e[r].type==="group"&&e.pop(),e.push(n)),e}function J(e){if(!e.length)return e;var n=e.length-1;if(e[n].type==="dot")return[];if(n>1&&e[n].type==="fun"&&e[n-1].token==="fun")return e.slice(0,n-1);switch(e[n].token){case"}":return f(e,{g:["{"]});case"]":return f(e,{i:["["]});case")":return f(e,{i:["("]});case">>":return f(e,{i:["<<"]});case"end":return f(e,{i:["begin","case","fun","if","receive","try"]});case",":return f(e,{e:["begin","try","when","->",",","(","[","{","<<"]});case"->":return f(e,{r:["when"],m:["try","if","case","receive"]});case";":return f(e,{E:["case","fun","if","receive","try","when"]});case"catch":return f(e,{e:["try"]});case"of":return f(e,{e:["case"]});case"after":return f(e,{e:["receive","try"]});default:return e}}function f(e,n){for(var r in n)for(var t=e.length-1,c=n[r],i=t-1;-1<i;i--)if(u(e[i].token,c)){var l=e.slice(0,i);switch(r){case"m":return l.concat(e[i]).concat(e[t]);case"r":return l.concat(e[t]);case"i":return l;case"g":return l.concat(F("group"));case"E":return l.concat(e[i]);case"e":return l.concat(e[i])}}return r=="E"?[]:e}function K(e,n){var r,t=_.indentUnit,c=L(n),i=b(e,1),l=b(e,2);return e.in_string||e.in_atom?a.Pass:l?i.token=="when"?i.column+t:c==="when"&&l.type==="function"?l.indent+t:c==="("&&i.token==="fun"?i.column+3:c==="catch"&&(r=w(e,["try"]))?r.column:u(c,["end","after","of"])?(r=w(e,["begin","case","fun","if","receive","try"]),r?r.column:a.Pass):u(c,x)?(r=w(e,y),r?r.column:a.Pass):u(i.token,[",","|","||"])||u(c,[",","|","||"])?(r=M(e),r?r.column+r.token.length:t):i.token=="->"?u(l.token,["receive","case","if","try"])?l.column+t+t:l.column+t:u(i.token,y)?i.column+i.token.length:(r=V(e),d(r)?r.column+t:0):0}function L(e){var n=e.match(/,|[a-z]+|\}|\]|\)|>>|\|+|\(/);return d(n)&&n.index===0?n[0]:""}function M(e){var n=e.tokenStack.slice(0,-1),r=k(n,"type",["open_paren"]);return d(n[r])?n[r]:!1}function V(e){var n=e.tokenStack,r=k(n,"type",["open_paren","separator","keyword"]),t=k(n,"type",["operator"]);return d(r)&&d(t)&&r<t?n[r+1]:d(r)?n[r]:!1}function w(e,n){var r=e.tokenStack,t=k(r,"token",n);return d(r[t])?r[t]:!1}function k(e,n,r){for(var t=e.length-1;-1<t;t--)if(u(e[t][n],r))return t;return!1}function d(e){return e!==!1&&e!=null}return{startState:function(){return{tokenStack:[],in_string:!1,in_atom:!1}},token:function(e,n){return D(e,n)},indent:function(e,n){return K(e,n)},lineComment:"%"}})})})();const C=A.exports,ne=Y({__proto__:null,default:C},[A.exports]);export{ne as e};

package/dist/assets/{extensions.9790f6ff.js → extensions.d542042f.js}

@@ -1,4 +1,4 @@
-import{a as t,o as l,b as c,w as o,l as e,E as s,e as d}from"./runtime-core.esm-bundler.fe249c5c.js";const h={class:"markdown-body"},p=e("hr",null,null,-1),_=e("h2",{id:"list-extensions",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#list-extensions"},"#"),s(" List Extensions")],-1),u=e("p",null,"List the available extensions in the project. The types of extensions that you can list are interfaces, displays, layouts, modules.",-1),x=e("h3",{id:"query-parameters",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#query-parameters"},"#"),s(" Query Parameters")],-1),m=e("p",null,"This endpoint doesn\u2019t currently support any query parameters.",-1),f=e("h3",{id:"returns",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#returns"},"#"),s(" Returns")],-1),y=e("p",null,"An array of interface extension keys.",-1),g=e("h3",{id:"rest-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api"},"#"),s(" REST API")],-1),E=e("pre",null,[e("code",null,`GET /extensions/:type
+import{a as t,o as l,e as c,y as o,u as e,q as s,z as d}from"./runtime-core.esm-bundler.22ec0346.js";const h={class:"markdown-body"},p=e("hr",null,null,-1),_=e("h2",{id:"list-extensions",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#list-extensions"},"#"),s(" List Extensions")],-1),u=e("p",null,"List the available extensions in the project. The types of extensions that you can list are interfaces, displays, layouts, modules.",-1),x=e("h3",{id:"query-parameters",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#query-parameters"},"#"),s(" Query Parameters")],-1),m=e("p",null,"This endpoint doesn\u2019t currently support any query parameters.",-1),f=e("h3",{id:"returns",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#returns"},"#"),s(" Returns")],-1),y=e("p",null,"An array of interface extension keys.",-1),g=e("h3",{id:"rest-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rest-api"},"#"),s(" REST API")],-1),E=e("pre",null,[e("code",null,`GET /extensions/:type
 `)],-1),b=e("h5",{id:"example",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#example"},"#"),s(" Example")],-1),T=e("pre",null,[e("code",null,`GET /extensions/interfaces
 `)],-1),q=e("h3",{id:"graphql",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#graphql"},"#"),s(" GraphQL")],-1),k=e("pre",null,[e("code",null,`POST /graphql/system
 `)],-1),w=e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {

package/dist/assets/factor.a6dddf2c.js

@@ -0,0 +1 @@
+import{y as x}from"./index.312f2c91.entry.js";import{s as a}from"./simple.1606e663.js";function k(n,o){for(var e=0;e<o.length;e++){const t=o[e];if(typeof t!="string"&&!Array.isArray(t)){for(const r in t)if(r!=="default"&&!(r in n)){const s=Object.getOwnPropertyDescriptor(t,r);s&&Object.defineProperty(n,r,s.get?s:{enumerable:!0,get:()=>t[r]})}}}return Object.freeze(Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}))}var g={exports:{}};(function(n,o){(function(e){e(x.exports,a.exports)})(function(e){e.defineSimpleMode("factor",{start:[{regex:/#?!.*/,token:"comment"},{regex:/"""/,token:"string",next:"string3"},{regex:/(STRING:)(\s)/,token:["keyword",null],next:"string2"},{regex:/\S*?"/,token:"string",next:"string"},{regex:/(?:0x[\d,a-f]+)|(?:0o[0-7]+)|(?:0b[0,1]+)|(?:\-?\d+.?\d*)(?=\s)/,token:"number"},{regex:/((?:GENERIC)|\:?\:)(\s+)(\S+)(\s+)(\()/,token:["keyword",null,"def",null,"bracket"],next:"stack"},{regex:/(M\:)(\s+)(\S+)(\s+)(\S+)/,token:["keyword",null,"def",null,"tag"]},{regex:/USING\:/,token:"keyword",next:"vocabulary"},{regex:/(USE\:|IN\:)(\s+)(\S+)(?=\s|$)/,token:["keyword",null,"tag"]},{regex:/(\S+\:)(\s+)(\S+)(?=\s|$)/,token:["keyword",null,"def"]},{regex:/(?:;|\\|t|f|if|loop|while|until|do|PRIVATE>|<PRIVATE|\.|\S*\[|\]|\S*\{|\})(?=\s|$)/,token:"keyword"},{regex:/\S+[\)>\.\*\?]+(?=\s|$)/,token:"builtin"},{regex:/[\)><]+\S+(?=\s|$)/,token:"builtin"},{regex:/(?:[\+\-\=\/\*<>])(?=\s|$)/,token:"keyword"},{regex:/\S+/,token:"variable"},{regex:/\s+|./,token:null}],vocabulary:[{regex:/;/,token:"keyword",next:"start"},{regex:/\S+/,token:"tag"},{regex:/\s+|./,token:null}],string:[{regex:/(?:[^\\]|\\.)*?"/,token:"string",next:"start"},{regex:/.*/,token:"string"}],string2:[{regex:/^;/,token:"keyword",next:"start"},{regex:/.*/,token:"string"}],string3:[{regex:/(?:[^\\]|\\.)*?"""/,token:"string",next:"start"},{regex:/.*/,token:"string"}],stack:[{regex:/\)/,token:"bracket",next:"start"},{regex:/--/,token:"bracket"},{regex:/\S+/,token:"meta"},{regex:/\s+|./,token:null}],meta:{dontIndentStates:["start","vocabulary","string","string3","stack"],lineComment:["!","#!"]}}),e.defineMIME("text/x-factor","factor")})})();const i=g.exports,f=k({__proto__:null,default:i},[g.exports]);export{f};

package/dist/assets/{faq.0fd5ca6e.js → faq.8904941c.js}

@@ -1,2 +1,2 @@
-import{a as r,o as n,b as i,w as c,l as e,E as s}from"./runtime-core.esm-bundler.fe249c5c.js";const l=e("div",{class:"markdown-body"},[e("blockquote"),e("h2",{id:"is-it-possible-to-update-the-admin-user-password-via-cli%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#is-it-possible-to-update-the-admin-user-password-via-cli%3F"},"#"),s(" Is it possible to update the admin user password via CLI?")]),e("p",null,"You can do this with the following command:"),e("pre",null,[e("code",{class:"language-sh"},[s("npx directus "),e("span",{class:"hljs-built_in"},"users"),s(` passwd --email admin@example.com --password newpasswordhere
-`)])]),e("h2",{id:"why-isn%E2%80%99t-directus-properly-saving-chinese-characters-or-emoji%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#why-isn%E2%80%99t-directus-properly-saving-chinese-characters-or-emoji%3F"},"#"),s(" Why isn\u2019t Directus properly saving Chinese characters or emoji?")]),e("p",null,[s("Please ensure that the encoding for your database, tables, and fields are set to "),e("code",null,"utf8mb4"),s(".")])],-1),m="Frequently Asked Questions",w=!1,f={__name:"faq",setup(d,{expose:t}){const a={title:"Frequently Asked Questions",modularExtension:!1};return t({frontmatter:a}),(p,u)=>{const o=r("docs-wrapper");return n(),i(o,{frontmatter:a},{default:c(()=>[l]),_:1})}}};export{f as default,w as modularExtension,m as title};
+import{a as r,o as n,e as i,y as c,u as e,q as s}from"./runtime-core.esm-bundler.22ec0346.js";const l=e("div",{class:"markdown-body"},[e("blockquote"),e("h2",{id:"is-it-possible-to-update-the-admin-user-password-via-cli%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#is-it-possible-to-update-the-admin-user-password-via-cli%3F"},"#"),s(" Is it possible to update the admin user password via CLI?")]),e("p",null,"You can do this with the following command:"),e("pre",null,[e("code",{class:"language-sh"},[s("npx directus "),e("span",{class:"hljs-built_in"},"users"),s(` passwd --email admin@example.com --password newpasswordhere
+`)])]),e("h2",{id:"why-isn%E2%80%99t-directus-properly-saving-chinese-characters-or-emoji%3F",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#why-isn%E2%80%99t-directus-properly-saving-chinese-characters-or-emoji%3F"},"#"),s(" Why isn\u2019t Directus properly saving Chinese characters or emoji?")]),e("p",null,[s("Please ensure that the encoding for your database, tables, and fields are set to "),e("code",null,"utf8mb4"),s(".")])],-1),m="Frequently Asked Questions",f=!1,w={__name:"faq",setup(d,{expose:t}){const a={title:"Frequently Asked Questions",modularExtension:!1};return t({frontmatter:a}),(p,u)=>{const o=r("docs-wrapper");return n(),i(o,{frontmatter:a},{default:c(()=>[l]),_:1})}}};export{w as default,f as modularExtension,m as title};

package/dist/assets/fcl.0c78a020.js

@@ -0,0 +1 @@
+import{y as _}from"./index.312f2c91.entry.js";function g(c,a){for(var o=0;o<a.length;o++){const i=a[o];if(typeof i!="string"&&!Array.isArray(i)){for(const u in i)if(u!=="default"&&!(u in c)){const f=Object.getOwnPropertyDescriptor(i,u);f&&Object.defineProperty(c,u,f.get?f:{enumerable:!0,get:()=>i[u]})}}}return Object.freeze(Object.defineProperty(c,Symbol.toStringTag,{value:"Module"}))}var y={exports:{}};(function(c,a){(function(o){o(_.exports)})(function(o){o.defineMode("fcl",function(i){var u=i.indentUnit,f={term:!0,method:!0,accu:!0,rule:!0,then:!0,is:!0,and:!0,or:!0,if:!0,default:!0},b={var_input:!0,var_output:!0,fuzzify:!0,defuzzify:!0,function_block:!0,ruleblock:!0},d={end_ruleblock:!0,end_defuzzify:!0,end_function_block:!0,end_fuzzify:!0,end_var:!0},k={true:!0,false:!0,nan:!0,real:!0,min:!0,max:!0,cog:!0,cogs:!0},s=/[+\-*&^%:=<>!|\/]/;function p(e,n){var t=e.next();if(/[\d\.]/.test(t))return t=="."?e.match(/^[0-9]+([eE][\-+]?[0-9]+)?/):t=="0"?e.match(/^[xX][0-9a-fA-F]+/)||e.match(/^0[0-7]+/):e.match(/^[0-9]*\.?[0-9]*([eE][\-+]?[0-9]+)?/),"number";if(t=="/"||t=="("){if(e.eat("*"))return n.tokenize=x,x(e,n);if(e.eat("/"))return e.skipToEnd(),"comment"}if(s.test(t))return e.eatWhile(s),"operator";e.eatWhile(/[\w\$_\xa1-\uffff]/);var r=e.current().toLowerCase();return f.propertyIsEnumerable(r)||b.propertyIsEnumerable(r)||d.propertyIsEnumerable(r)?"keyword":k.propertyIsEnumerable(r)?"atom":"variable"}function x(e,n){for(var t=!1,r;r=e.next();){if((r=="/"||r==")")&&t){n.tokenize=p;break}t=r=="*"}return"comment"}function m(e,n,t,r,l){this.indented=e,this.column=n,this.type=t,this.align=r,this.prev=l}function v(e,n,t){return e.context=new m(e.indented,n,t,null,e.context)}function h(e){if(!!e.context.prev){var n=e.context.type;return n=="end_block"&&(e.indented=e.context.indented),e.context=e.context.prev}}return{startState:function(e){return{tokenize:null,context:new m((e||0)-u,0,"top",!1),indented:0,startOfLine:!0}},token:function(e,n){var t=n.context;if(e.sol()&&(t.align==null&&(t.align=!1),n.indented=e.indentation(),n.startOfLine=!0),e.eatSpace())return null;var r=(n.tokenize||p)(e,n);if(r=="comment")return r;t.align==null&&(t.align=!0);var l=e.current().toLowerCase();return b.propertyIsEnumerable(l)?v(n,e.column(),"end_block"):d.propertyIsEnumerable(l)&&h(n),n.startOfLine=!1,r},indent:function(e,n){if(e.tokenize!=p&&e.tokenize!=null)return 0;var t=e.context,r=d.propertyIsEnumerable(n);return t.align?t.column+(r?0:1):t.indented+(r?0:u)},electricChars:"ryk",fold:"brace",blockCommentStart:"(*",blockCommentEnd:"*)",lineComment:"//"}}),o.defineMIME("text/x-fcl","fcl")})})();const z=y.exports,C=g({__proto__:null,default:z},[y.exports]);export{C as f};

package/dist/assets/{field-types.e5bd5900.js → field-types.e3e041fc.js}

@@ -1 +1 @@
-import{a as l,o as n,b as d,w as r,l as e,E as a}from"./runtime-core.esm-bundler.fe249c5c.js";const o=e("div",{class:"markdown-body"},[e("h2",{id:"field-types",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#field-types"},"#"),a(" Field Types")]),e("h3",{id:"standard-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#standard-fields"},"#"),a(" Standard Fields")]),e("h3",{id:"presentation-and-aliases",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#presentation-and-aliases"},"#"),a(" Presentation and Aliases")]),e("h3",{id:"field-groups",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#field-groups"},"#"),a(" Field Groups")]),e("h3",{id:"single-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#single-file"},"#"),a(" Single File")]),e("h3",{id:"multiple-files",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#multiple-files"},"#"),a(" Multiple Files")]),e("h3",{id:"relationship-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#relationship-fields"},"#"),a(" Relationship Fields")]),e("h3",{id:"translation-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#translation-fields"},"#"),a(" Translation Fields")])],-1),u="null",x=!1,_={__name:"field-types",setup(h,{expose:i}){const s={title:"null",modularExtension:!1};return i({frontmatter:s}),(c,f)=>{const t=l("docs-wrapper");return n(),d(t,{frontmatter:s},{default:r(()=>[o]),_:1})}}};export{_ as default,x as modularExtension,u as title};
+import{a as l,o as n,e as d,y as r,u as e,q as a}from"./runtime-core.esm-bundler.22ec0346.js";const o=e("div",{class:"markdown-body"},[e("h2",{id:"field-types",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#field-types"},"#"),a(" Field Types")]),e("h3",{id:"standard-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#standard-fields"},"#"),a(" Standard Fields")]),e("h3",{id:"presentation-and-aliases",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#presentation-and-aliases"},"#"),a(" Presentation and Aliases")]),e("h3",{id:"field-groups",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#field-groups"},"#"),a(" Field Groups")]),e("h3",{id:"single-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#single-file"},"#"),a(" Single File")]),e("h3",{id:"multiple-files",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#multiple-files"},"#"),a(" Multiple Files")]),e("h3",{id:"relationship-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#relationship-fields"},"#"),a(" Relationship Fields")]),e("h3",{id:"translation-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#translation-fields"},"#"),a(" Translation Fields")])],-1),u="null",x=!1,_={__name:"field-types",setup(h,{expose:i}){const s={title:"null",modularExtension:!1};return i({frontmatter:s}),(c,f)=>{const t=l("docs-wrapper");return n(),d(t,{frontmatter:s},{default:r(()=>[o]),_:1})}}};export{_ as default,x as modularExtension,u as title};

package/dist/assets/{field.b9b55fc2.js → field.64c29e0b.js}

@@ -1 +1 @@
-import{a as n,o as r,b as d,w as o,l as e,E as l,e as u}from"./runtime-core.esm-bundler.fe249c5c.js";const c={class:"markdown-body"},p=e("blockquote",null,[e("p",null,"Description of a Field.")],-1),f=e("li",null,[e("strong",null,"Required"),l(" \u2014 Toggles if a value for the Field is required. "),e("ul",null,[e("li",null,[l("Empty strings ("),e("code",null,"''"),l(") and "),e("code",null,"NULL"),l(" are "),e("strong",null,"not"),l(" accepted as a valid value")]),e("li",null,[e("code",null,"0"),l(" and "),e("code",null,"false"),l(" are accepted as a valid value")]),e("li",null,"Default values are accepted as a valid value"),e("li",null,"Permission Presets are accepted as a valid value")])],-1),_=e("li",null,[e("strong",null,"Readonly"),l(" \u2014 (App Only) Sets the field to be disabled.")],-1),m=e("li",null,[e("strong",null,"Hidden"),l(" \u2014 (App Only) Hides the field in the App form. "),e("ul",null,[e("li",null,"The field is still available in filters and Layout options.")])],-1),h=e("li",null,[e("strong",null,"Note"),l(" \u2014 (App Only) Displayed below the field in the App form, providing a helpful comment for App users. This note supports markdown.")],-1),g=e("strong",null,"Field Name Translations",-1),w="Field",x=!1,A={__name:"field",setup(y,{expose:a}){const t={title:"Field",modularExtension:!1};return a({frontmatter:t}),(v,b)=>{const s=n("router-link"),i=n("docs-wrapper");return r(),d(i,{frontmatter:t},{default:o(()=>[e("div",c,[p,e("ul",null,[f,_,m,h,e("li",null,[g,l(" \u2014 (App Only) While the field key can not be changed (as of now), this option allows translating the field name into different languages. By default, the platform uses the "),u(s,{to:"/docs/getting-started/glossary#title-formatter"},{default:o(()=>[l("Title Formatter")]),_:1}),l(" to display field keys as human readable names, but you can also use translations to explicitly rename more technical column keys.")])])])]),_:1})}}};export{A as default,x as modularExtension,w as title};
+import{a as n,o as r,e as d,y as o,u as e,q as l,z as u}from"./runtime-core.esm-bundler.22ec0346.js";const c={class:"markdown-body"},p=e("blockquote",null,[e("p",null,"Description of a Field.")],-1),f=e("li",null,[e("strong",null,"Required"),l(" \u2014 Toggles if a value for the Field is required. "),e("ul",null,[e("li",null,[l("Empty strings ("),e("code",null,"''"),l(") and "),e("code",null,"NULL"),l(" are "),e("strong",null,"not"),l(" accepted as a valid value")]),e("li",null,[e("code",null,"0"),l(" and "),e("code",null,"false"),l(" are accepted as a valid value")]),e("li",null,"Default values are accepted as a valid value"),e("li",null,"Permission Presets are accepted as a valid value")])],-1),_=e("li",null,[e("strong",null,"Readonly"),l(" \u2014 (App Only) Sets the field to be disabled.")],-1),m=e("li",null,[e("strong",null,"Hidden"),l(" \u2014 (App Only) Hides the field in the App form. "),e("ul",null,[e("li",null,"The field is still available in filters and Layout options.")])],-1),h=e("li",null,[e("strong",null,"Note"),l(" \u2014 (App Only) Displayed below the field in the App form, providing a helpful comment for App users. This note supports markdown.")],-1),y=e("strong",null,"Field Name Translations",-1),w="Field",x=!1,A={__name:"field",setup(g,{expose:a}){const t={title:"Field",modularExtension:!1};return a({frontmatter:t}),(v,k)=>{const s=n("router-link"),i=n("docs-wrapper");return r(),d(i,{frontmatter:t},{default:o(()=>[e("div",c,[p,e("ul",null,[f,_,m,h,e("li",null,[y,l(" \u2014 (App Only) While the field key can not be changed (as of now), this option allows translating the field name into different languages. By default, the platform uses the "),u(s,{to:"/docs/getting-started/glossary#title-formatter"},{default:o(()=>[l("Title Formatter")]),_:1}),l(" to display field keys as human readable names, but you can also use translations to explicitly rename more technical column keys.")])])])]),_:1})}}};export{A as default,x as modularExtension,w as title};

package/dist/assets/{fields.fc8af154.js → fields.1597bfad.js}

@@ -1 +1 @@
-import{a as s,o as r,b as c,w as l,l as e,E as i,e as o}from"./runtime-core.esm-bundler.fe249c5c.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,[i("Fields are database columns. Fields also enable you to manage the backend logic "),e("em",null,"(such as conditional display logic, input verification rules, etc.)"),i(" and frontend design used to display its data "),e("em",null,"(e.g., whether data will display in a table or on a map)"),i(".")])],-1),f=e("h2",{id:"overview",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#overview"},"#"),i(" Overview")],-1),p=e("video",{title:"Fields Overview",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/data-model-20220805/fields-20220805A.mp4",type:"video/mp4"})],-1),g=e("p",null,[i("To access a collection\u2019s fields, navigate to "),e("strong",null,"Settings > Data Model > [Collection]"),i(". From here, you can click a field to access its "),e("strong",null,"Configuration Drawer"),i(" and make advanced configurations. You also have the following controls for each field.")],-1),m=e("strong",null,"Fields and Layout",-1),_=e("strong",null,"Field Context Menu",-1),v=e("strong",null,"Field Configuration Drawer",-1),y=e("p",null,[e("strong",null,[i("Field Context Menu "),e("span",{mi:"",icon:""},"more_vert")]),i(" \u2014 Contains the following controls:")],-1),w=e("ul",null,[e("li",null,[e("a",{href:"#configure-a-field"},[e("span",{mi:"",icon:""},"edit"),i(" Edit Field")]),i(" \u2014 Opens the "),e("strong",null,"Field Configuration Drawer"),i(".")]),e("li",null,[e("a",{href:"#duplicate-a-field"},[e("span",{mi:"",icon:""},"content_copy"),i(" Duplicate Field")]),i(" \u2014 Duplicates a field along with all of its configuration options.")]),e("li",null,[e("a",{href:"#toggle-field-visibility-for-admins"},[e("span",{mi:"",icon:""},"visibility_off"),i(" Hide Field on Detail")]),i(" \u2014 Toggle field visibility on the Item Detail Page for Admin Users.")]),e("li",null,[e("a",{href:"#adjust-field-width"},"Width"),i(" \u2014 Fields have three different width options: "),e("ul",null,[e("li",null,[e("span",{mi:"",icon:""},"border_vertical"),i(" Half Width \u2014 The field input is shown at half the form width.")]),e("li",null,[e("span",{mi:"",icon:""},"border_right"),i(" Full Width \u2014 The default. The field input is shown at the full form width.")]),e("li",null,[e("span",{mi:"",icon:""},"aspect_ratio"),i(" Fill Width \u2014 The field input is shown filling the full width of the page area.")])])])],-1),b=e("p",null,[e("strong",null,"The Field Configuration Drawer"),i(" \u2014 Provides all "),e("a",{href:"#configure-a-field"},"field configuration"),i(" options.")],-1),C=e("h2",{id:"create-a-field-(standard)",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-field-(standard)"},"#"),i(" Create a Field (Standard)")],-1),F=e("video",{title:"Create a Field (Standard)",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/create-a-field-20220805A.mp4",type:"video/mp4"})],-1),D=e("p",null,[i("To make field configuration as intuitive and easy as possible, a template wizard is provided so that you can create fields pre-configured for common use-cases. When you create a field this way, you will still have full power to "),e("a",{href:"#configure-a-field"},"configure the field"),i(" as desired.")],-1),k=e("ol",null,[e("li",null,[i("Navigate to "),e("strong",null,"Settings > Data Model > [Collection]"),i(".")]),e("li",null,[i("Under "),e("strong",null,"Fields & Layout"),i(", click the "),e("strong",null,"Create Field"),i(" button."),e("br"),i(" A side drawer will open, with various pre-configured Interfaces to choose from.")]),e("li",null,"Click to select the desired field and a basic configuration menu will open."),e("li",null,[i("Add a "),e("strong",null,"Field Key"),i(", "),e("em",null,"which is also used as the default field name"),i("."),e("br"),i(" Optional: Configure the other field details as desired."),e("br"),i(" Optional: Click "),e("a",{href:"#create-a-field-advanced"},"Continue in Advanced Field Creation Mode"),i(".")]),e("li",null,[i("When you are ready, click "),e("strong",null,"Save"),i(" to confirm.")])],-1),T=e("h2",{id:"create-a-field-(advanced)",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-field-(advanced)"},"#"),i(" Create a Field (Advanced)")],-1),A=e("video",{title:"Create a Field (Advanced)",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/create-a-field-advanced-20220805A.mp4",type:"video/mp4"})],-1),x=e("p",null,[i("This field creation method opens the "),e("strong",null,"Field Configuration Drawer"),i(" so you can customize every field detail from the start. To create a field in advanced mode, follow these steps.")],-1),S=e("ol",null,[e("li",null,[i("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]"),i(".")]),e("li",null,[i("Under "),e("strong",null,"Fields & Layout"),i(", click the "),e("strong",null,"Create Field in Advanced Mode"),i(" button."),e("br"),i(" A dropdown menu will appear with various field types to choose from.")]),e("li",null,[i("Click to choose the field type and the "),e("strong",null,"Field Configuration Drawer"),i(" will open.")]),e("li",null,"Configure your field as desired."),e("li",null,[i("Click "),e("span",{mi:"",btn:""},"check"),i(" to confirm.")])],-1),N=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Database Columns"),e("p",null,"Remember, a field is a database column. Therefore, you can create a column directly in the database and it will automatically appear within Directus. You can then enhance the experience further by configuring it as desired.")],-1),W=e("h2",{id:"configure-a-field",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#configure-a-field"},"#"),i(" Configure a Field")],-1),M=e("video",{title:"Configure a Field",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/configure-a-field-20220805A.mp4",type:"video/mp4"})],-1),j=e("p",null,[i("Fields are configured in the "),e("strong",null,"Field Configuration Drawer"),i(", which is composed of eight sections. These provide extensive customization options, from the database column\u2019s details, to how it is displayed and interacted with, and even custom input validation and conditional display logic. To configure a field, follow these steps.")],-1),I=e("li",null,[i("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]"),i(".")],-1),P=e("li",null,[i("Under "),e("strong",null,"Fields & Layout"),i(", click the field you want to update."),e("br"),i(" The "),e("strong",null,"Field Configuration Drawer"),i(" will open.")],-1),L=e("li",null,[e("strong",null,"Schema"),i(" \u2014 Defines the database column schema for the field.")],-1),O=e("li",null,[e("strong",null,"Relationship"),i(" \u2014 Controls "),e("em",null,"and only appears when configuring relational"),i(" field details.")],-1),V=e("li",null,[e("strong",null,"Translations"),i(" \u2014 Controls "),e("em",null,"and only appears when configuring translation"),i(" field details.")],-1),H=e("strong",null,"Field",-1),E=e("li",null,[e("strong",null,"Interface"),i(" \u2014 Configures how you interact with the field\u2019s values.")],-1),U=e("li",null,[e("strong",null,"Display"),i(" \u2014 Configures how field values are displayed in the Data Studio.")],-1),z=e("li",null,[e("strong",null,"Validation"),i(" \u2014 Creates a filter to determine valid user input.")],-1),B=e("li",null,[e("strong",null,"Conditions"),i(" \u2014 Alters the current field\u2019s setup based on the values of other fields.")],-1),R=e("li",null,[i("Click "),e("span",{mi:"",btn:""},"check"),i(" to confirm.")],-1),G=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Fields in System Collections"),e("p",null,"While all out-of-the-box fields within system collections are locked from configuration or deletion, you are able to create new fields within system collections.")],-1),K=e("h2",{id:"duplicate-a-field",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#duplicate-a-field"},"#"),i(" Duplicate a Field")],-1),Y=e("video",{title:"Duplicate a Field",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/duplicate-a-field-20220805A.mp4",type:"video/mp4"})],-1),q=e("p",null,"To duplicate a field, follow these steps.",-1),J=e("ol",null,[e("li",null,[i("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]"),i(".")]),e("li",null,[i("Click the "),e("span",{mi:"",icon:""},"more_vert"),i(" icon for the field you want to duplicate.")]),e("li",null,[i("Click the "),e("span",{mi:"",icon:""},"content_copy"),i(),e("strong",null,"Duplicate Field"),i(" option.")]),e("li",null,"Choose the collection you\u2019d like to create the field in and set the Field Name.")],-1),Q=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Relational and Primary Key Fields"),e("p",null,"Currently, it is not possible to duplicate relational fields or a collection\u2019s primary key.")],-1),X=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Duplicates Configurations Only"),e("p",null,"When you duplicate a field, all of its configuration settings will be copied as well. However, values stored within that field will not be copied.")],-1),Z=e("h2",{id:"toggle-field-visibility-(for-admins)",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#toggle-field-visibility-(for-admins)"},"#"),i(" Toggle Field Visibility (for Admins)")],-1),$=e("video",{title:"Toggle Field Visibility (for Admins)",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/toggle-field-visibility-20220805A.mp4",type:"video/mp4"})],-1),ee=e("em",null,"non-admin",-1),ie=e("h2",{id:"adjust-field-width",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#adjust-field-width"},"#"),i(" Adjust Field Width")],-1),le=e("video",{title:"Group and Sort Field",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/adjust-field-width-20220805A.mp4",type:"video/mp4"})],-1),te=e("strong",null,"Fields and Layout",-1),oe=e("ol",null,[e("li",null,[i("Click "),e("span",{mi:"",icon:""},"more_vert"),i(" to open the field\u2019s context menu.")]),e("li",null,[i("Choose one of the following: "),e("ul",null,[e("li",null,[e("span",{mi:"",icon:""},"border_vertical"),i(),e("strong",null,"Half Width"),i(" \u2014 The field is shown at half the form width.")]),e("li",null,[e("span",{mi:"",icon:""},"border_right"),i(),e("strong",null,"Full Width"),i(" \u2014 The default. The field is shown at the full form width.")]),e("li",null,[e("span",{mi:"",icon:""},"aspect_ratio"),i(),e("strong",null,"Fill Width"),i(" \u2014 The field is shown filling the full width of the page area.")])])])],-1),ne=e("h2",{id:"manually-sort-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#manually-sort-fields"},"#"),i(" Manually Sort Fields")],-1),se=e("video",{title:"Group and Sort Field",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/manually-sort-fields-20220805A.mp4",type:"video/mp4"})],-1),ae=e("strong",null,"Fields and Layout",-1),de=e("span",{mi:"",icon:""},"drag_indicator",-1),re=e("h2",{id:"delete-a-field",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-a-field"},"#"),i(" Delete a Field")],-1),ce=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/delete-a-field-20220805A.mp4",type:"video/mp4"})],-1),ue=e("p",null,"To permanently delete a field and all its stored values, follow these steps.",-1),he=e("ol",null,[e("li",null,[i("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]"),i(".")]),e("li",null,[i("Click the "),e("span",{mi:"",icon:""},"more_vert"),i(" icon for the field you want to delete.")]),e("li",null,[i("Click the "),e("span",{mi:"",icon:"",dngr:""},"delete"),i(),e("strong",null,"Delete Field"),i(" option.")]),e("li",null,[i("Confirm this decision by clicking "),e("strong",null,"Delete"),i(" in the dialog.")])],-1),fe=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"This action is permanent and cannot be undone. Please proceed with caution.")],-1),ve="Fields",ye=!1,we={__name:"fields",setup(pe,{expose:a}){const n={title:"Fields",modularExtension:!1};return a({frontmatter:n}),(ge,me)=>{const t=s("router-link"),d=s("docs-wrapper");return r(),c(d,{frontmatter:n},{default:l(()=>[e("div",u,[h,f,p,g,e("p",null,[m,i(" \u2014 Create, view, and configure a collection\u2019s fields as well as adjust how they are displayed and ordered on the "),o(t,{to:"/docs/app/content/collections#item-page"},{default:l(()=>[i("Item Details Page")]),_:1}),i(". This section also provides access to the "),_,i(" and "),v,i(", described below.")]),y,w,b,C,F,D,k,T,A,x,S,N,W,M,j,e("ol",null,[I,P,e("li",null,[i("Navigate to one of these sections and configure the field as desired: "),e("ul",null,[L,O,V,e("li",null,[H,i(" \u2014 Sets details for the field input, which is displayed on the "),o(t,{to:"/docs/app/content/items"},{default:l(()=>[i("item page")]),_:1}),i(".")]),E,U,z,B])]),R]),G,K,Y,q,J,Q,X,Z,$,e("p",null,[i("For users with any "),ee,i(" role, a field\u2019s visibility can be adjusted via "),o(t,{to:"/docs/configuration/users-roles-permissions.md"},{default:l(()=>[i("access permissions")]),_:1}),i(". However, you may want to hide certain fields for admins as well. This is handy if the field is distracting or has no need to be seen on the item details page.")]),ie,le,e("p",null,[i("Adjusting the field width in "),te,i(" will change field width on the "),o(t,{to:"/docs/app/content#item-page"},{default:l(()=>[i("Item Detail Page")]),_:1}),i(". To adjust field width, follow these steps.")]),oe,ne,se,e("p",null,[i("Adjusting the field order in "),ae,i(" will change its order on the "),o(t,{to:"/docs/app/content/collections#item-page"},{default:l(()=>[i("Item Page")]),_:1}),i(". To manually sort fields, click "),de,i(" to drag and drop the field as desired.")]),re,ce,ue,he,fe])]),_:1})}}};export{we as default,ye as modularExtension,ve as title};
+import{a as s,o as r,e as c,y as l,u as e,q as i,z as o}from"./runtime-core.esm-bundler.22ec0346.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,[i("Fields are database columns. Fields also enable you to manage the backend logic "),e("em",null,"(such as conditional display logic, input verification rules, etc.)"),i(" and frontend design used to display its data "),e("em",null,"(e.g., whether data will display in a table or on a map)"),i(".")])],-1),f=e("h2",{id:"overview",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#overview"},"#"),i(" Overview")],-1),p=e("video",{title:"Fields Overview",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/data-model-20220805/fields-20220805A.mp4",type:"video/mp4"})],-1),g=e("p",null,[i("To access a collection\u2019s fields, navigate to "),e("strong",null,"Settings > Data Model > [Collection]"),i(". From here, you can click a field to access its "),e("strong",null,"Configuration Drawer"),i(" and make advanced configurations. You also have the following controls for each field.")],-1),m=e("strong",null,"Fields and Layout",-1),_=e("strong",null,"Field Context Menu",-1),v=e("strong",null,"Field Configuration Drawer",-1),y=e("p",null,[e("strong",null,[i("Field Context Menu "),e("span",{mi:"",icon:""},"more_vert")]),i(" \u2014 Contains the following controls:")],-1),w=e("ul",null,[e("li",null,[e("a",{href:"#configure-a-field"},[e("span",{mi:"",icon:""},"edit"),i(" Edit Field")]),i(" \u2014 Opens the "),e("strong",null,"Field Configuration Drawer"),i(".")]),e("li",null,[e("a",{href:"#duplicate-a-field"},[e("span",{mi:"",icon:""},"content_copy"),i(" Duplicate Field")]),i(" \u2014 Duplicates a field along with all of its configuration options.")]),e("li",null,[e("a",{href:"#toggle-field-visibility-for-admins"},[e("span",{mi:"",icon:""},"visibility_off"),i(" Hide Field on Detail")]),i(" \u2014 Toggle field visibility on the Item Detail Page for Admin Users.")]),e("li",null,[e("a",{href:"#adjust-field-width"},"Width"),i(" \u2014 Fields have three different width options: "),e("ul",null,[e("li",null,[e("span",{mi:"",icon:""},"border_vertical"),i(" Half Width \u2014 The field input is shown at half the form width.")]),e("li",null,[e("span",{mi:"",icon:""},"border_right"),i(" Full Width \u2014 The default. The field input is shown at the full form width.")]),e("li",null,[e("span",{mi:"",icon:""},"aspect_ratio"),i(" Fill Width \u2014 The field input is shown filling the full width of the page area.")])])])],-1),b=e("p",null,[e("strong",null,"The Field Configuration Drawer"),i(" \u2014 Provides all "),e("a",{href:"#configure-a-field"},"field configuration"),i(" options.")],-1),C=e("h2",{id:"create-a-field-(standard)",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-field-(standard)"},"#"),i(" Create a Field (Standard)")],-1),F=e("video",{title:"Create a Field (Standard)",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/create-a-field-20220805A.mp4",type:"video/mp4"})],-1),D=e("p",null,[i("To make field configuration as intuitive and easy as possible, a template wizard is provided so that you can create fields pre-configured for common use-cases. When you create a field this way, you will still have full power to "),e("a",{href:"#configure-a-field"},"configure the field"),i(" as desired.")],-1),k=e("ol",null,[e("li",null,[i("Navigate to "),e("strong",null,"Settings > Data Model > [Collection]"),i(".")]),e("li",null,[i("Under "),e("strong",null,"Fields & Layout"),i(", click the "),e("strong",null,"Create Field"),i(" button."),e("br"),i(" A side drawer will open, with various pre-configured Interfaces to choose from.")]),e("li",null,"Click to select the desired field and a basic configuration menu will open."),e("li",null,[i("Add a "),e("strong",null,"Field Key"),i(", "),e("em",null,"which is also used as the default field name"),i("."),e("br"),i(" Optional: Configure the other field details as desired."),e("br"),i(" Optional: Click "),e("a",{href:"#create-a-field-advanced"},"Continue in Advanced Field Creation Mode"),i(".")]),e("li",null,[i("When you are ready, click "),e("strong",null,"Save"),i(" to confirm.")])],-1),T=e("h2",{id:"create-a-field-(advanced)",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-field-(advanced)"},"#"),i(" Create a Field (Advanced)")],-1),A=e("video",{title:"Create a Field (Advanced)",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/create-a-field-advanced-20220805A.mp4",type:"video/mp4"})],-1),x=e("p",null,[i("This field creation method opens the "),e("strong",null,"Field Configuration Drawer"),i(" so you can customize every field detail from the start. To create a field in advanced mode, follow these steps.")],-1),S=e("ol",null,[e("li",null,[i("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]"),i(".")]),e("li",null,[i("Under "),e("strong",null,"Fields & Layout"),i(", click the "),e("strong",null,"Create Field in Advanced Mode"),i(" button."),e("br"),i(" A dropdown menu will appear with various field types to choose from.")]),e("li",null,[i("Click to choose the field type and the "),e("strong",null,"Field Configuration Drawer"),i(" will open.")]),e("li",null,"Configure your field as desired."),e("li",null,[i("Click "),e("span",{mi:"",btn:""},"check"),i(" to confirm.")])],-1),N=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Database Columns"),e("p",null,"Remember, a field is a database column. Therefore, you can create a column directly in the database and it will automatically appear within Directus. You can then enhance the experience further by configuring it as desired.")],-1),W=e("h2",{id:"configure-a-field",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#configure-a-field"},"#"),i(" Configure a Field")],-1),M=e("video",{title:"Configure a Field",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/configure-a-field-20220805A.mp4",type:"video/mp4"})],-1),j=e("p",null,[i("Fields are configured in the "),e("strong",null,"Field Configuration Drawer"),i(", which is composed of eight sections. These provide extensive customization options, from the database column\u2019s details, to how it is displayed and interacted with, and even custom input validation and conditional display logic. To configure a field, follow these steps.")],-1),I=e("li",null,[i("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]"),i(".")],-1),P=e("li",null,[i("Under "),e("strong",null,"Fields & Layout"),i(", click the field you want to update."),e("br"),i(" The "),e("strong",null,"Field Configuration Drawer"),i(" will open.")],-1),L=e("li",null,[e("strong",null,"Schema"),i(" \u2014 Defines the database column schema for the field.")],-1),O=e("li",null,[e("strong",null,"Relationship"),i(" \u2014 Controls "),e("em",null,"and only appears when configuring relational"),i(" field details.")],-1),V=e("li",null,[e("strong",null,"Translations"),i(" \u2014 Controls "),e("em",null,"and only appears when configuring translation"),i(" field details.")],-1),H=e("strong",null,"Field",-1),z=e("li",null,[e("strong",null,"Interface"),i(" \u2014 Configures how you interact with the field\u2019s values.")],-1),U=e("li",null,[e("strong",null,"Display"),i(" \u2014 Configures how field values are displayed in the Data Studio.")],-1),B=e("li",null,[e("strong",null,"Validation"),i(" \u2014 Creates a filter to determine valid user input.")],-1),E=e("li",null,[e("strong",null,"Conditions"),i(" \u2014 Alters the current field\u2019s setup based on the values of other fields.")],-1),R=e("li",null,[i("Click "),e("span",{mi:"",btn:""},"check"),i(" to confirm.")],-1),q=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Fields in System Collections"),e("p",null,"While all out-of-the-box fields within system collections are locked from configuration or deletion, you are able to create new fields within system collections.")],-1),G=e("h2",{id:"duplicate-a-field",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#duplicate-a-field"},"#"),i(" Duplicate a Field")],-1),K=e("video",{title:"Duplicate a Field",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/duplicate-a-field-20220805A.mp4",type:"video/mp4"})],-1),Y=e("p",null,"To duplicate a field, follow these steps.",-1),J=e("ol",null,[e("li",null,[i("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]"),i(".")]),e("li",null,[i("Click the "),e("span",{mi:"",icon:""},"more_vert"),i(" icon for the field you want to duplicate.")]),e("li",null,[i("Click the "),e("span",{mi:"",icon:""},"content_copy"),i(),e("strong",null,"Duplicate Field"),i(" option.")]),e("li",null,"Choose the collection you\u2019d like to create the field in and set the Field Name.")],-1),Q=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Relational and Primary Key Fields"),e("p",null,"Currently, it is not possible to duplicate relational fields or a collection\u2019s primary key.")],-1),X=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Duplicates Configurations Only"),e("p",null,"When you duplicate a field, all of its configuration settings will be copied as well. However, values stored within that field will not be copied.")],-1),Z=e("h2",{id:"toggle-field-visibility-(for-admins)",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#toggle-field-visibility-(for-admins)"},"#"),i(" Toggle Field Visibility (for Admins)")],-1),$=e("video",{title:"Toggle Field Visibility (for Admins)",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/toggle-field-visibility-20220805A.mp4",type:"video/mp4"})],-1),ee=e("em",null,"non-admin",-1),ie=e("h2",{id:"adjust-field-width",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#adjust-field-width"},"#"),i(" Adjust Field Width")],-1),le=e("video",{title:"Group and Sort Field",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/adjust-field-width-20220805A.mp4",type:"video/mp4"})],-1),te=e("strong",null,"Fields and Layout",-1),oe=e("ol",null,[e("li",null,[i("Click "),e("span",{mi:"",icon:""},"more_vert"),i(" to open the field\u2019s context menu.")]),e("li",null,[i("Choose one of the following: "),e("ul",null,[e("li",null,[e("span",{mi:"",icon:""},"border_vertical"),i(),e("strong",null,"Half Width"),i(" \u2014 The field is shown at half the form width.")]),e("li",null,[e("span",{mi:"",icon:""},"border_right"),i(),e("strong",null,"Full Width"),i(" \u2014 The default. The field is shown at the full form width.")]),e("li",null,[e("span",{mi:"",icon:""},"aspect_ratio"),i(),e("strong",null,"Fill Width"),i(" \u2014 The field is shown filling the full width of the page area.")])])])],-1),ne=e("h2",{id:"manually-sort-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#manually-sort-fields"},"#"),i(" Manually Sort Fields")],-1),se=e("video",{title:"Group and Sort Field",autoplay:"",muted:"",loop:"",controls:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/manually-sort-fields-20220805A.mp4",type:"video/mp4"})],-1),ae=e("strong",null,"Fields and Layout",-1),de=e("span",{mi:"",icon:""},"drag_indicator",-1),re=e("h2",{id:"delete-a-field",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-a-field"},"#"),i(" Delete a Field")],-1),ce=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/fields/fields-20220805/delete-a-field-20220805A.mp4",type:"video/mp4"})],-1),ue=e("p",null,"To permanently delete a field and all its stored values, follow these steps.",-1),he=e("ol",null,[e("li",null,[i("Navigate to "),e("strong",null,"Settings > Data Model > [Collection Name]"),i(".")]),e("li",null,[i("Click the "),e("span",{mi:"",icon:""},"more_vert"),i(" icon for the field you want to delete.")]),e("li",null,[i("Click the "),e("span",{mi:"",icon:"",dngr:""},"delete"),i(),e("strong",null,"Delete Field"),i(" option.")]),e("li",null,[i("Confirm this decision by clicking "),e("strong",null,"Delete"),i(" in the dialog.")])],-1),fe=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"This action is permanent and cannot be undone. Please proceed with caution.")],-1),ve="Fields",ye=!1,we={__name:"fields",setup(pe,{expose:a}){const n={title:"Fields",modularExtension:!1};return a({frontmatter:n}),(ge,me)=>{const t=s("router-link"),d=s("docs-wrapper");return r(),c(d,{frontmatter:n},{default:l(()=>[e("div",u,[h,f,p,g,e("p",null,[m,i(" \u2014 Create, view, and configure a collection\u2019s fields as well as adjust how they are displayed and ordered on the "),o(t,{to:"/docs/app/content/collections#item-page"},{default:l(()=>[i("Item Details Page")]),_:1}),i(". This section also provides access to the "),_,i(" and "),v,i(", described below.")]),y,w,b,C,F,D,k,T,A,x,S,N,W,M,j,e("ol",null,[I,P,e("li",null,[i("Navigate to one of these sections and configure the field as desired: "),e("ul",null,[L,O,V,e("li",null,[H,i(" \u2014 Sets details for the field input, which is displayed on the "),o(t,{to:"/docs/app/content/items"},{default:l(()=>[i("item page")]),_:1}),i(".")]),z,U,B,E])]),R]),q,G,K,Y,J,Q,X,Z,$,e("p",null,[i("For users with any "),ee,i(" role, a field\u2019s visibility can be adjusted via "),o(t,{to:"/docs/configuration/users-roles-permissions.md"},{default:l(()=>[i("access permissions")]),_:1}),i(". However, you may want to hide certain fields for admins as well. This is handy if the field is distracting or has no need to be seen on the item details page.")]),ie,le,e("p",null,[i("Adjusting the field width in "),te,i(" will change field width on the "),o(t,{to:"/docs/app/content#item-page"},{default:l(()=>[i("Item Detail Page")]),_:1}),i(". To adjust field width, follow these steps.")]),oe,ne,se,e("p",null,[i("Adjusting the field order in "),ae,i(" will change its order on the "),o(t,{to:"/docs/app/content/collections#item-page"},{default:l(()=>[i("Item Page")]),_:1}),i(". To manually sort fields, click "),de,i(" to drag and drop the field as desired.")]),re,ce,ue,he,fe])]),_:1})}}};export{we as default,ye as modularExtension,ve as title};

package/dist/assets/{fields.7df6f624.js → fields.c76c2d8b.js}

@@ -1,4 +1,4 @@
-import{a,o as r,b as h,w as t,l as s,E as e,e as i}from"./runtime-core.esm-bundler.fe249c5c.js";const d={class:"markdown-body"},p=s("hr",null,null,-1),u=s("h2",{id:"the-field-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-field-object"},"#"),e(" The Field Object")],-1),_=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" Name of the collection the field resides in.")],-1),f=s("p",null,[s("code",null,"field"),e(),s("strong",null,"string"),s("br"),e(" The identifier of the field. This matches the table column name.")],-1),j=s("code",null,"type",-1),g=s("strong",null,"string",-1),m=s("br",null,null,-1),y=s("h4",{id:"meta",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#meta"},"#"),e(" Meta")],-1),b=s("p",null,"Directus metadata, primarily used in the Admin App. Meta is optional.",-1),x=s("p",null,[s("code",null,"id"),e(),s("strong",null,"integer"),s("br"),e(" Primary key of the metadata row in "),s("code",null,"directus_fields"),e(".")],-1),q=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" The name of the collection this field resides in.")],-1),T=s("p",null,[s("code",null,"field"),e(),s("strong",null,"string"),s("br"),e(" Identifier of the field. Matches the column name in the database.")],-1),w=s("p",null,[s("code",null,"special"),e(),s("strong",null,"string"),s("br"),e(" Any special transform flags that apply to this field.")],-1),k=s("p",null,[s("code",null,"interface"),e(),s("strong",null,"string"),s("br"),e(" The interface used for this field.")],-1),v=s("p",null,[s("code",null,"options"),e(),s("strong",null,"object"),s("br"),e(" The interface options configured for this field. The structure is based on the interface used.")],-1),A=s("p",null,[s("code",null,"display"),e(),s("strong",null,"string"),s("br"),e(" The display used for this field.")],-1),E=s("p",null,[s("code",null,"display_options"),e(),s("strong",null,"string"),s("br"),e(" The configured options for the used display.")],-1),S=s("p",null,[s("code",null,"readonly"),e(),s("strong",null,"boolean"),s("br"),e(" If the field is considered readonly in the Admin App.")],-1),P=s("p",null,[s("code",null,"hidden"),e(),s("strong",null,"boolean"),s("br"),e(" If the field is hidden from the edit page in the Admin App.")],-1),R=s("p",null,[s("code",null,"sort"),e(),s("strong",null,"integer"),s("br"),e(" Where this field is shown on the edit page in the Admin App.")],-1),Q=s("p",null,[s("code",null,"width"),e(),s("strong",null,"string"),s("br"),e(" How wide the interface is rendered on the edit page in the Admin App. One of "),s("code",null,"half"),e(", "),s("code",null,"half-left"),e(", "),s("code",null,"half-right"),e(", "),s("code",null,"half-space"),e(", "),s("code",null,"full"),e(", "),s("code",null,"fill"),e(".")],-1),I=s("p",null,[s("code",null,"translations"),e(),s("strong",null,"array"),s("br"),e(" How this field\u2019s name is displayed in the different languages in the Admin App.")],-1),L=s("p",null,[s("code",null,"note"),e(),s("strong",null,"string"),s("br"),e(" Short description displayed in the Admin App.")],-1),F=s("h4",{id:"schema",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#schema"},"#"),e(" Schema")],-1),G=s("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers. Note: schema is optional. If a field exist in directus_fields, but not in the database, it\u2019s an alias commonly used for relational (O2M) or presentation purposes in the Admin App.",-1),C=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Identifier of the field. Matches the column name in the database.")],-1),O=s("p",null,[s("code",null,"table"),e(),s("strong",null,"string"),s("br"),e(" Name of the table the column resides in.")],-1),D=s("p",null,[s("code",null,"data_type"),e(),s("strong",null,"string"),s("br"),e(" The datatype as used in the database. Note: this value is database vendor specific.")],-1),H=s("p",null,[s("code",null,"default_value"),e(),s("strong",null,"any"),s("br"),e(" The configured default value for the column.")],-1),M=s("p",null,[s("code",null,"max_length"),e(),s("strong",null,"integer"),s("br"),e(" Configured length for varchar type columns.")],-1),B=s("p",null,[s("code",null,"numeric_precision"),e(),s("strong",null,"integer"),s("br"),e(" Precision for integer/float/decimal type fields.")],-1),N=s("p",null,[s("code",null,"numeric_scale"),e(),s("strong",null,"integer"),s("br"),e(" Scale for integer/float/decimal type fields.")],-1),W=s("p",null,[s("code",null,"is_nullable"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not the column is nullable. This is what is used as the \u201Crequired\u201D state in Directus.")],-1),U=s("p",null,[s("code",null,"is_primary_key"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not the field is the primary key of the table.")],-1),V=s("p",null,[s("code",null,"foreign_key_column"),e(),s("strong",null,"string"),s("br"),e(" If the current column has a foreign key constraint, this points to the related column.")],-1),z=s("p",null,[s("code",null,"foreign_key_table"),e(),s("strong",null,"string"),s("br"),e(" If the current column has a foreign key constraint, this points to the related table.")],-1),J=s("p",null,[s("code",null,"comment"),e(),s("strong",null,"string"),s("br"),e(" Comment as stored in the database.")],-1),K=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+import{a,o as r,e as h,y as t,u as s,q as e,z as i}from"./runtime-core.esm-bundler.22ec0346.js";const d={class:"markdown-body"},p=s("hr",null,null,-1),u=s("h2",{id:"the-field-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-field-object"},"#"),e(" The Field Object")],-1),_=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" Name of the collection the field resides in.")],-1),f=s("p",null,[s("code",null,"field"),e(),s("strong",null,"string"),s("br"),e(" The identifier of the field. This matches the table column name.")],-1),j=s("code",null,"type",-1),g=s("strong",null,"string",-1),m=s("br",null,null,-1),y=s("h4",{id:"meta",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#meta"},"#"),e(" Meta")],-1),b=s("p",null,"Directus metadata, primarily used in the Admin App. Meta is optional.",-1),x=s("p",null,[s("code",null,"id"),e(),s("strong",null,"integer"),s("br"),e(" Primary key of the metadata row in "),s("code",null,"directus_fields"),e(".")],-1),q=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" The name of the collection this field resides in.")],-1),T=s("p",null,[s("code",null,"field"),e(),s("strong",null,"string"),s("br"),e(" Identifier of the field. Matches the column name in the database.")],-1),w=s("p",null,[s("code",null,"special"),e(),s("strong",null,"string"),s("br"),e(" Any special transform flags that apply to this field.")],-1),k=s("p",null,[s("code",null,"interface"),e(),s("strong",null,"string"),s("br"),e(" The interface used for this field.")],-1),v=s("p",null,[s("code",null,"options"),e(),s("strong",null,"object"),s("br"),e(" The interface options configured for this field. The structure is based on the interface used.")],-1),A=s("p",null,[s("code",null,"display"),e(),s("strong",null,"string"),s("br"),e(" The display used for this field.")],-1),E=s("p",null,[s("code",null,"display_options"),e(),s("strong",null,"string"),s("br"),e(" The configured options for the used display.")],-1),S=s("p",null,[s("code",null,"readonly"),e(),s("strong",null,"boolean"),s("br"),e(" If the field is considered readonly in the Admin App.")],-1),P=s("p",null,[s("code",null,"hidden"),e(),s("strong",null,"boolean"),s("br"),e(" If the field is hidden from the edit page in the Admin App.")],-1),R=s("p",null,[s("code",null,"sort"),e(),s("strong",null,"integer"),s("br"),e(" Where this field is shown on the edit page in the Admin App.")],-1),Q=s("p",null,[s("code",null,"width"),e(),s("strong",null,"string"),s("br"),e(" How wide the interface is rendered on the edit page in the Admin App. One of "),s("code",null,"half"),e(", "),s("code",null,"half-left"),e(", "),s("code",null,"half-right"),e(", "),s("code",null,"half-space"),e(", "),s("code",null,"full"),e(", "),s("code",null,"fill"),e(".")],-1),I=s("p",null,[s("code",null,"translations"),e(),s("strong",null,"array"),s("br"),e(" How this field\u2019s name is displayed in the different languages in the Admin App.")],-1),L=s("p",null,[s("code",null,"note"),e(),s("strong",null,"string"),s("br"),e(" Short description displayed in the Admin App.")],-1),F=s("h4",{id:"schema",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#schema"},"#"),e(" Schema")],-1),G=s("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers. Note: schema is optional. If a field exist in directus_fields, but not in the database, it\u2019s an alias commonly used for relational (O2M) or presentation purposes in the Admin App.",-1),C=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Identifier of the field. Matches the column name in the database.")],-1),O=s("p",null,[s("code",null,"table"),e(),s("strong",null,"string"),s("br"),e(" Name of the table the column resides in.")],-1),D=s("p",null,[s("code",null,"data_type"),e(),s("strong",null,"string"),s("br"),e(" The datatype as used in the database. Note: this value is database vendor specific.")],-1),H=s("p",null,[s("code",null,"default_value"),e(),s("strong",null,"any"),s("br"),e(" The configured default value for the column.")],-1),M=s("p",null,[s("code",null,"max_length"),e(),s("strong",null,"integer"),s("br"),e(" Configured length for varchar type columns.")],-1),B=s("p",null,[s("code",null,"numeric_precision"),e(),s("strong",null,"integer"),s("br"),e(" Precision for integer/float/decimal type fields.")],-1),N=s("p",null,[s("code",null,"numeric_scale"),e(),s("strong",null,"integer"),s("br"),e(" Scale for integer/float/decimal type fields.")],-1),W=s("p",null,[s("code",null,"is_nullable"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not the column is nullable. This is what is used as the \u201Crequired\u201D state in Directus.")],-1),U=s("p",null,[s("code",null,"is_primary_key"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not the field is the primary key of the table.")],-1),V=s("p",null,[s("code",null,"foreign_key_column"),e(),s("strong",null,"string"),s("br"),e(" If the current column has a foreign key constraint, this points to the related column.")],-1),z=s("p",null,[s("code",null,"foreign_key_table"),e(),s("strong",null,"string"),s("br"),e(" If the current column has a foreign key constraint, this points to the related table.")],-1),J=s("p",null,[s("code",null,"comment"),e(),s("strong",null,"string"),s("br"),e(" Comment as stored in the database.")],-1),K=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
 	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),e(`
 	`),s("span",{class:"hljs-attr"},'"field"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),e(`
 	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"integer"'),s("span",{class:"hljs-punctuation"},","),e(`

package/dist/assets/{file-library.7a11d866.js → file-library.8fb3da43.js}

@@ -1 +1 @@
-import{a as n,o as d,b as c,w as t,l as e,E as l,e as o}from"./runtime-core.esm-bundler.fe249c5c.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,"The File Library Module aggregates all files within the Directus Project into one consolidated library. It is a full-featured Digital Asset Management (DAM) system for storing, organizing, browsing, and transforming your various files and assets.")],-1),p=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-library-20220307A.webp",alt:"File Library"})],-1),f={class:"warning hint"},m=e("div",{class:"hint-title"},"More Documents on Folder and File Management",-1),g=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),l(" How it Works")],-1),_={class:"tip hint"},y=e("div",{class:"hint-title"},"Required Knowledge",-1),b=e("a",{href:"#folders"},"Folder",-1),F=e("a",{href:"#files"},"Files",-1),v=e("em",null,"not just images",-1),w=e("a",{href:"#folders"},"File Listing Page",-1),k=e("video",{title:"How the File Library Works",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/how-it-works-20220305A.mp4",type:"video/mp4"}),e("p",null,[l(" Your browser is not displaying the video for some reason. Here's a "),e("a",{href:""},"link to the video"),l(" instead. ")])],-1),A=e("ol",null,[e("li",null,[l("Select a Folder. There are two options: "),e("ul",null,[e("li",null,"Choose desired Folder from the Navigation Bar."),e("li",null,[l("Click "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" in the Page Header, name your folder, and click "),e("strong",null,"\u201CSave\u201D"),l(".")])])]),e("li",null,[l("Click "),e("span",{mi:"",btn:""},"add"),l(" in the Page Header. A popover will appear.")]),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])]),e("li",null,"Optional: Click the File Display to open the File Details Page and fill in information as desired.")],-1),C=e("h2",{id:"files",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#files"},"#"),l(" Files")],-1),T=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/files-20220305A.webp",alt:"Files"})],-1),D=e("h3",{id:"action-buttons",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#action-buttons"},"#"),l(" Action Buttons")],-1),L=e("p",null,"Notice the following Buttons in the Header:",-1),P=e("ul",null,[e("li",null,[e("span",{mi:"",btn:""},"check"),l(" \u2013 Saves any edits made to the file.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"tune"),l(" \u2013 Please see "),e("a",{href:"#edit-an-image"},"Edit an Image"),l(" to learn more.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"save_alt"),l(" \u2013 Downloads the file to your current device.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"drive_file_move"),l(" \u2013 Moves selected File(s) to another Folder.")]),e("li",null,[e("span",{mi:"",btn:"",dngr:""},"delete"),l(" \u2013 Permanently removes the File and its metadata. This action is permanent and cannot be undone.")])],-1),I=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Deleting Files Linked to Items"),e("p",null,[l("By default, Directus will not allow you to delete a File until you remove it from any and all related Items. However, this behavior can be reconfigured so that Files automatically update when the image is deleted by setting the relational constraint of your File Field to "),e("code",null,"SET NULL"),l(" or "),e("code",null,"CASCADE"),l(" when the File is deleted.")])],-1),x=e("h3",{id:"file-details",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#file-details"},"#"),l(" File Details")],-1),M=e("p",null,[l("The Files Collection comes pre-configured with the following Fields out of the box. New Fields can be created and customized as needed in "),e("strong",null,"Settings > Data Model"),l(". However the pre-configured Fields cannot be changed or deleted.")],-1),S=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-details-20220305A.webp",alt:"File Details"})],-1),E=e("ul",null,[e("li",null,[e("strong",null,"Preview"),l(" \u2013 A preview of the image or file.")]),e("li",null,[e("strong",null,"Title"),l(" \u2013 A title for the File.")]),e("li",null,[e("strong",null,"Description"),l(" \u2013 A description of the File.")]),e("li",null,[e("strong",null,"Tags"),l(" \u2013 Keywords used for search-ability.")]),e("li",null,[e("strong",null,"Location"),l(" \u2013 An optional location "),e("em",null,"(e.g. where a photo was taken)"),l(".")]),e("li",null,[e("strong",null,"Storage"),l(" \u2013 Which storage adapter is used to store the file asset.")]),e("li",null,[e("strong",null,"Filename (Disk)"),l(" \u2013 LOCKED. This is the actual name of the file in storage.")]),e("li",null,[e("strong",null,"Filename (Download)"),l(" \u2013 Allows you to set the name of the file when it is downloaded.")])],-1),U=e("h3",{id:"file-sidebar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#file-sidebar"},"#"),l(" File Sidebar")],-1),H=e("p",null,"The file sidebar also includes the following details, which are not editable and serve as metadata.",-1),B=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-sidebar-20220305A.webp",alt:"File Sidebar"})],-1),N=e("ul",null,[e("li",null,[e("strong",null,"Type"),l(" \u2013 The MIME type of the file, displayed in the App as a formatted media type.")]),e("li",null,[e("strong",null,"Dimensions"),l(" \u2013 "),e("em",null,"Images only"),l(". The width and height of the image in pixels.")]),e("li",null,[e("strong",null,"Size"),l(" \u2013 The file-size the asset takes up in the storage adapter.")]),e("li",null,[e("strong",null,"Created"),l(" \u2013 The timestamp of when the file was uploaded to the Project.")]),e("li",null,[e("strong",null,"Owner"),l(" \u2013 The User that uploaded the file to the Project.")]),e("li",null,[e("strong",null,"Modified"),l(" \u2013 The timestamp of when the file was last modified.")]),e("li",null,[e("strong",null,"Edited By"),l(" \u2013 The User that modified the File.")]),e("li",null,[e("strong",null,"Folder"),l(" \u2013 The current parent folder that contains the File.")]),e("li",null,[e("strong",null,"Metadata"),l(" \u2013 Metadata JSON dump of the File\u2019s EXIF, IPTC, and ICC information.")])],-1),R=e("h2",{id:"edit-an-image",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#edit-an-image"},"#"),l(" Edit an Image")],-1),W=e("p",null,"Rotate, crop, flip, or adjust aspect ratios of an image.",-1),j=e("video",{alt:"Edit an Image",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220516A/edit-an-image-20220516A.mp4",type:"video/mp4"})],-1),z=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click a file to open its detail page.")]),e("li",null,[l("Click the "),e("span",{mi:"",btn:"",sec:""},"tune"),l(" button in the top right to open the image editor.")]),e("li",null,[l("Make your changes and click "),e("span",{mi:"",btn:""},"check"),l(" in the top right to save the updates.")])],-1),O=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"Edits overwrite the original file on disk. This can\u2019t be reversed.")],-1),K=e("h2",{id:"upload-a-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#upload-a-file"},"#"),l(" Upload a File")],-1),V=e("a",{href:"#how-it-works"},"How it Works",-1),Y=e("h2",{id:"replace-a-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#replace-a-file"},"#"),l(" Replace a File")],-1),q=e("p",null,"When a file is replaced, its existing info and all relationships are kept.",-1),J=e("video",{alt:"Replace a File",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220608A/replace-a-file-20220608A.mp4",type:"video/mp4"})],-1),X=e("ol",null,[e("li",null,"Click the Image Preview on the File Detail page. A popup will appear."),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])])],-1),G=e("h2",{id:"folders",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#folders"},"#"),l(" Folders")],-1),Q=e("p",null,"Folders provide the organization system for Files.",-1),Z=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/folders-20220305A.webp",alt:"Folders"})],-1),$=e("h2",{id:"create-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-folder"},"#"),l(" Create a Folder")],-1),ee=e("video",{alt:"Create a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/create-a-folder-20220305A.mp4",type:"video/mp4"})],-1),le=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click on the "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" button located in the Header.")]),e("li",null,"Fill in a Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),te=e("h2",{id:"rename-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rename-a-folder"},"#"),l(" Rename a Folder")],-1),ie=e("video",{alt:"Renaming a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/rename-a-folder-20220215A.mp4",type:"video/mp4"})],-1),oe=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to rename and select \u201CRename Folder\u201D.")]),e("li",null,"Update the Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),ae=e("h2",{id:"move-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#move-a-folder"},"#"),l(" Move a Folder")],-1),ne=e("video",{alt:"Moving a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/move-a-folder20220305A.mp4",type:"video/mp4"})],-1),se=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the folder you wish to move and select "),e("strong",null,"\u201CMove to Folder\u201D"),l(". A popup will appear.")]),e("li",null,"Select a Folder to serve as the new Parent Folder."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),re=e("h2",{id:"delete-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-a-folder"},"#"),l(" Delete a Folder")],-1),de=e("video",{alt:"Deleting a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/delete-a-folder-20220215A.mp4",type:"video/mp4"})],-1),ce=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to delete and select "),e("strong",null,"\u201CDelete Folder\u201D"),l(".")]),e("li",null,[l("Click "),e("strong",null,"\u201CDelete\u201D"),l(".")])],-1),he=e("div",{class:"tip hint"},[e("p",null,"When you delete a Folder, any nested Files and Folders will be moved one level up.")],-1),ue=e("h2",{id:"more-help",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#more-help"},"#"),l(" More Help")],-1),pe=e("p",null,[l("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),ye="File Library",be=!1,Fe="The File Library Module aggregates all files within the Directus Project into one consolidated library.",ve="7 min read",we={__name:"file-library",setup(fe,{expose:s}){const a={title:"File Library",modularExtension:!1,description:"The File Library Module aggregates all files within the Directus Project into one consolidated library.",readTime:"7 min read"};return s({frontmatter:a}),(me,ge)=>{const i=n("router-link"),r=n("docs-wrapper");return d(),c(r,{frontmatter:a},{default:t(()=>[e("div",h,[u,p,e("div",f,[m,e("p",null,[l("This is a non-technical, no-code guide to the File Library Module. Please note there is documentation on programmatic "),o(i,{to:"/docs/reference/system/folders"},{default:t(()=>[l("Folder")]),_:1}),l(" and "),o(i,{to:"/docs/reference/files"},{default:t(()=>[l("File")]),_:1}),l(" management via the API.")])]),g,e("div",_,[y,e("p",null,[l("Familiarity with the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(" will be helpful but not necessary.")])]),e("p",null,[l("The File Library acts as one big "),b,l(" to store all uploaded "),F,l(". Sub-folders can be created within the File Library to help Files stay organized. Folders and File information are stored in regular Collections, which means "),o(i,{to:"/docs/configuration/users-roles-permissions.md"},{default:t(()=>[l("User and Role access permissions")]),_:1}),l(" are fully configurable and granular on both Folders and Files. Multiple files can be uploaded at once through the app and also programmatically via the API. Any type of file can be uploaded, "),v,l(". When a Folder is selected from the Navigation Bar, the "),w,l(" is presented. This page has all the same features and functionalities as the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(".")]),k,A,C,e("p",null,[l("When a file is clicked in the File Listing Page, the File Details Page appears. This is a custom form for viewing assets and embeds, with core Fields included out-of-the-box (see below), and the ability for Administrators to add additional custom Fields. This page has the same features and functionality as the "),o(i,{to:"/docs/getting-started/glossary#items"},{default:t(()=>[l("Item Page")]),_:1}),l(".")]),T,D,L,P,I,x,M,S,E,U,H,B,N,R,W,j,z,O,K,e("p",null,[l("We covered the File Library\u2019s three upload methods in "),V,l(". Keep in mind that files can also be added through different Interfaces as well. For example, Users can upload an Avatar image when they fill in their User Details. Similarly, Items with an Image Field will have a file upload Interface on the Item Detail page. Files can also be "),o(i,{to:"/docs/reference/files"},{default:t(()=>[l("uploaded programmatically via the API")]),_:1}),l(".")]),Y,q,J,X,G,Q,Z,e("p",null,[l("They can be named, renamed, and nested as sub-folders anywhere in the Folder hierarchy. Once a Folder is selected from the Navigation Bar, File Listing Page opens. The File Listing Page displays all Files within a Folder. It also enables all other features and functionalities from the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(" such as batch editing, batch deleting, sorting, filtering, searching, etc. Folders can also be managed "),o(i,{to:"/docs/reference/system/folders"},{default:t(()=>[l("programmatically via the API")]),_:1}),l(".")]),$,ee,le,te,ie,oe,ae,ne,se,re,de,ce,he,ue,pe])]),_:1})}}};export{we as default,Fe as description,be as modularExtension,ve as readTime,ye as title};
+import{a as n,o as d,e as c,y as t,u as e,q as l,z as o}from"./runtime-core.esm-bundler.22ec0346.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,"The File Library Module aggregates all files within the Directus Project into one consolidated library. It is a full-featured Digital Asset Management (DAM) system for storing, organizing, browsing, and transforming your various files and assets.")],-1),p=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-library-20220307A.webp",alt:"File Library"})],-1),f={class:"warning hint"},m=e("div",{class:"hint-title"},"More Documents on Folder and File Management",-1),g=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),l(" How it Works")],-1),_={class:"tip hint"},y=e("div",{class:"hint-title"},"Required Knowledge",-1),b=e("a",{href:"#folders"},"Folder",-1),F=e("a",{href:"#files"},"Files",-1),v=e("em",null,"not just images",-1),w=e("a",{href:"#folders"},"File Listing Page",-1),k=e("video",{title:"How the File Library Works",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/how-it-works-20220305A.mp4",type:"video/mp4"}),e("p",null,[l(" Your browser is not displaying the video for some reason. Here's a "),e("a",{href:""},"link to the video"),l(" instead. ")])],-1),A=e("ol",null,[e("li",null,[l("Select a Folder. There are two options: "),e("ul",null,[e("li",null,"Choose desired Folder from the Navigation Bar."),e("li",null,[l("Click "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" in the Page Header, name your folder, and click "),e("strong",null,"\u201CSave\u201D"),l(".")])])]),e("li",null,[l("Click "),e("span",{mi:"",btn:""},"add"),l(" in the Page Header. A popover will appear.")]),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])]),e("li",null,"Optional: Click the File Display to open the File Details Page and fill in information as desired.")],-1),C=e("h2",{id:"files",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#files"},"#"),l(" Files")],-1),T=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/files-20220305A.webp",alt:"Files"})],-1),D=e("h3",{id:"action-buttons",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#action-buttons"},"#"),l(" Action Buttons")],-1),L=e("p",null,"Notice the following Buttons in the Header:",-1),P=e("ul",null,[e("li",null,[e("span",{mi:"",btn:""},"check"),l(" \u2013 Saves any edits made to the file.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"tune"),l(" \u2013 Please see "),e("a",{href:"#edit-an-image"},"Edit an Image"),l(" to learn more.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"save_alt"),l(" \u2013 Downloads the file to your current device.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"drive_file_move"),l(" \u2013 Moves selected File(s) to another Folder.")]),e("li",null,[e("span",{mi:"",btn:"",dngr:""},"delete"),l(" \u2013 Permanently removes the File and its metadata. This action is permanent and cannot be undone.")])],-1),I=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Deleting Files Linked to Items"),e("p",null,[l("By default, Directus will not allow you to delete a File until you remove it from any and all related Items. However, this behavior can be reconfigured so that Files automatically update when the image is deleted by setting the relational constraint of your File Field to "),e("code",null,"SET NULL"),l(" or "),e("code",null,"CASCADE"),l(" when the File is deleted.")])],-1),x=e("h3",{id:"file-details",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#file-details"},"#"),l(" File Details")],-1),M=e("p",null,[l("The Files Collection comes pre-configured with the following Fields out of the box. New Fields can be created and customized as needed in "),e("strong",null,"Settings > Data Model"),l(". However the pre-configured Fields cannot be changed or deleted.")],-1),S=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-details-20220305A.webp",alt:"File Details"})],-1),E=e("ul",null,[e("li",null,[e("strong",null,"Preview"),l(" \u2013 A preview of the image or file.")]),e("li",null,[e("strong",null,"Title"),l(" \u2013 A title for the File.")]),e("li",null,[e("strong",null,"Description"),l(" \u2013 A description of the File.")]),e("li",null,[e("strong",null,"Tags"),l(" \u2013 Keywords used for search-ability.")]),e("li",null,[e("strong",null,"Location"),l(" \u2013 An optional location "),e("em",null,"(e.g. where a photo was taken)"),l(".")]),e("li",null,[e("strong",null,"Storage"),l(" \u2013 Which storage adapter is used to store the file asset.")]),e("li",null,[e("strong",null,"Filename (Disk)"),l(" \u2013 LOCKED. This is the actual name of the file in storage.")]),e("li",null,[e("strong",null,"Filename (Download)"),l(" \u2013 Allows you to set the name of the file when it is downloaded.")])],-1),U=e("h3",{id:"file-sidebar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#file-sidebar"},"#"),l(" File Sidebar")],-1),H=e("p",null,"The file sidebar also includes the following details, which are not editable and serve as metadata.",-1),B=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-sidebar-20220305A.webp",alt:"File Sidebar"})],-1),N=e("ul",null,[e("li",null,[e("strong",null,"Type"),l(" \u2013 The MIME type of the file, displayed in the App as a formatted media type.")]),e("li",null,[e("strong",null,"Dimensions"),l(" \u2013 "),e("em",null,"Images only"),l(". The width and height of the image in pixels.")]),e("li",null,[e("strong",null,"Size"),l(" \u2013 The file-size the asset takes up in the storage adapter.")]),e("li",null,[e("strong",null,"Created"),l(" \u2013 The timestamp of when the file was uploaded to the Project.")]),e("li",null,[e("strong",null,"Owner"),l(" \u2013 The User that uploaded the file to the Project.")]),e("li",null,[e("strong",null,"Modified"),l(" \u2013 The timestamp of when the file was last modified.")]),e("li",null,[e("strong",null,"Edited By"),l(" \u2013 The User that modified the File.")]),e("li",null,[e("strong",null,"Folder"),l(" \u2013 The current parent folder that contains the File.")]),e("li",null,[e("strong",null,"Metadata"),l(" \u2013 Metadata JSON dump of the File\u2019s EXIF, IPTC, and ICC information.")])],-1),R=e("h2",{id:"edit-an-image",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#edit-an-image"},"#"),l(" Edit an Image")],-1),W=e("p",null,"Rotate, crop, flip, or adjust aspect ratios of an image.",-1),j=e("video",{alt:"Edit an Image",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220516A/edit-an-image-20220516A.mp4",type:"video/mp4"})],-1),z=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click a file to open its detail page.")]),e("li",null,[l("Click the "),e("span",{mi:"",btn:"",sec:""},"tune"),l(" button in the top right to open the image editor.")]),e("li",null,[l("Make your changes and click "),e("span",{mi:"",btn:""},"check"),l(" in the top right to save the updates.")])],-1),O=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"Edits overwrite the original file on disk. This can\u2019t be reversed.")],-1),K=e("h2",{id:"upload-a-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#upload-a-file"},"#"),l(" Upload a File")],-1),q=e("a",{href:"#how-it-works"},"How it Works",-1),V=e("h2",{id:"replace-a-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#replace-a-file"},"#"),l(" Replace a File")],-1),Y=e("p",null,"When a file is replaced, its existing info and all relationships are kept.",-1),J=e("video",{alt:"Replace a File",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220608A/replace-a-file-20220608A.mp4",type:"video/mp4"})],-1),X=e("ol",null,[e("li",null,"Click the Image Preview on the File Detail page. A popup will appear."),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])])],-1),G=e("h2",{id:"folders",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#folders"},"#"),l(" Folders")],-1),Q=e("p",null,"Folders provide the organization system for Files.",-1),Z=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/folders-20220305A.webp",alt:"Folders"})],-1),$=e("h2",{id:"create-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-folder"},"#"),l(" Create a Folder")],-1),ee=e("video",{alt:"Create a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/create-a-folder-20220305A.mp4",type:"video/mp4"})],-1),le=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click on the "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" button located in the Header.")]),e("li",null,"Fill in a Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),te=e("h2",{id:"rename-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rename-a-folder"},"#"),l(" Rename a Folder")],-1),ie=e("video",{alt:"Renaming a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/rename-a-folder-20220215A.mp4",type:"video/mp4"})],-1),oe=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to rename and select \u201CRename Folder\u201D.")]),e("li",null,"Update the Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),ae=e("h2",{id:"move-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#move-a-folder"},"#"),l(" Move a Folder")],-1),ne=e("video",{alt:"Moving a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/move-a-folder20220305A.mp4",type:"video/mp4"})],-1),se=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the folder you wish to move and select "),e("strong",null,"\u201CMove to Folder\u201D"),l(". A popup will appear.")]),e("li",null,"Select a Folder to serve as the new Parent Folder."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),re=e("h2",{id:"delete-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-a-folder"},"#"),l(" Delete a Folder")],-1),de=e("video",{alt:"Deleting a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/delete-a-folder-20220215A.mp4",type:"video/mp4"})],-1),ce=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to delete and select "),e("strong",null,"\u201CDelete Folder\u201D"),l(".")]),e("li",null,[l("Click "),e("strong",null,"\u201CDelete\u201D"),l(".")])],-1),he=e("div",{class:"tip hint"},[e("p",null,"When you delete a Folder, any nested Files and Folders will be moved one level up.")],-1),ue=e("h2",{id:"more-help",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#more-help"},"#"),l(" More Help")],-1),pe=e("p",null,[l("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),ye="File Library",be=!1,Fe="The File Library Module aggregates all files within the Directus Project into one consolidated library.",ve="7 min read",we={__name:"file-library",setup(fe,{expose:s}){const a={title:"File Library",modularExtension:!1,description:"The File Library Module aggregates all files within the Directus Project into one consolidated library.",readTime:"7 min read"};return s({frontmatter:a}),(me,ge)=>{const i=n("router-link"),r=n("docs-wrapper");return d(),c(r,{frontmatter:a},{default:t(()=>[e("div",h,[u,p,e("div",f,[m,e("p",null,[l("This is a non-technical, no-code guide to the File Library Module. Please note there is documentation on programmatic "),o(i,{to:"/docs/reference/system/folders"},{default:t(()=>[l("Folder")]),_:1}),l(" and "),o(i,{to:"/docs/reference/files"},{default:t(()=>[l("File")]),_:1}),l(" management via the API.")])]),g,e("div",_,[y,e("p",null,[l("Familiarity with the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(" will be helpful but not necessary.")])]),e("p",null,[l("The File Library acts as one big "),b,l(" to store all uploaded "),F,l(". Sub-folders can be created within the File Library to help Files stay organized. Folders and File information are stored in regular Collections, which means "),o(i,{to:"/docs/configuration/users-roles-permissions.md"},{default:t(()=>[l("User and Role access permissions")]),_:1}),l(" are fully configurable and granular on both Folders and Files. Multiple files can be uploaded at once through the app and also programmatically via the API. Any type of file can be uploaded, "),v,l(". When a Folder is selected from the Navigation Bar, the "),w,l(" is presented. This page has all the same features and functionalities as the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(".")]),k,A,C,e("p",null,[l("When a file is clicked in the File Listing Page, the File Details Page appears. This is a custom form for viewing assets and embeds, with core Fields included out-of-the-box (see below), and the ability for Administrators to add additional custom Fields. This page has the same features and functionality as the "),o(i,{to:"/docs/getting-started/glossary#items"},{default:t(()=>[l("Item Page")]),_:1}),l(".")]),T,D,L,P,I,x,M,S,E,U,H,B,N,R,W,j,z,O,K,e("p",null,[l("We covered the File Library\u2019s three upload methods in "),q,l(". Keep in mind that files can also be added through different Interfaces as well. For example, Users can upload an Avatar image when they fill in their User Details. Similarly, Items with an Image Field will have a file upload Interface on the Item Detail page. Files can also be "),o(i,{to:"/docs/reference/files"},{default:t(()=>[l("uploaded programmatically via the API")]),_:1}),l(".")]),V,Y,J,X,G,Q,Z,e("p",null,[l("They can be named, renamed, and nested as sub-folders anywhere in the Folder hierarchy. Once a Folder is selected from the Navigation Bar, File Listing Page opens. The File Listing Page displays all Files within a Folder. It also enables all other features and functionalities from the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(" such as batch editing, batch deleting, sorting, filtering, searching, etc. Folders can also be managed "),o(i,{to:"/docs/reference/system/folders"},{default:t(()=>[l("programmatically via the API")]),_:1}),l(".")]),$,ee,le,te,ie,oe,ae,ne,se,re,de,ce,he,ue,pe])]),_:1})}}};export{we as default,Fe as description,be as modularExtension,ve as readTime,ye as title};

package/dist/assets/{files.84b41f2f.js → files.d8e3acf4.js}

@@ -1,4 +1,4 @@
-import{a as o,o as c,b as h,w as a,l as s,E as e,e as n}from"./runtime-core.esm-bundler.fe249c5c.js";const d={class:"markdown-body"},u=s("blockquote",null,[s("p",null,[e("Every file managed by the platform is uploaded to the configured storage adapter, and its associated metadata is tracked within the "),s("code",null,"directus_files"),e(" system collection. Any requested file transformations are handled on the fly, and are only saved to storage.")])],-1),p=s("hr",null,null,-1),_=s("h2",{id:"accessing-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#accessing-a-file"},"#"),e(" Accessing a File")],-1),f=s("p",null,"The location of your actual file originals is based on the project\u2019s configuration, but you can consistently access them via the API using the following URL.",-1),m=s("pre",null,[s("code",{class:"language-txt"},`example.com/assets/<file-id>
+import{a as o,o as c,e as h,y as a,u as s,q as e,z as n}from"./runtime-core.esm-bundler.22ec0346.js";const d={class:"markdown-body"},u=s("blockquote",null,[s("p",null,[e("Every file managed by the platform is uploaded to the configured storage adapter, and its associated metadata is tracked within the "),s("code",null,"directus_files"),e(" system collection. Any requested file transformations are handled on the fly, and are only saved to storage.")])],-1),p=s("hr",null,null,-1),_=s("h2",{id:"accessing-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#accessing-a-file"},"#"),e(" Accessing a File")],-1),f=s("p",null,"The location of your actual file originals is based on the project\u2019s configuration, but you can consistently access them via the API using the following URL.",-1),m=s("pre",null,[s("code",{class:"language-txt"},`example.com/assets/<file-id>
 example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4
 `)],-1),g=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"SEO"),s("p",null,"You can provide an optional filename after the UUID to optimize for SEO, for example:"),s("pre",null,[s("code",{class:"language-txt"},`example.com/assets/<file-id>/<filename>
 example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4/directus-logo.png
@@ -69,7 +69,7 @@ SEARCH /files
 		filename_disk
 	}
 }
-`)])],-1),Ns=s("h2",{id:"upload-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#upload-a-file"},"#"),e(" Upload a File")],-1),Zs=s("p",null,"Upload/create a new file.",-1),Hs=s("p",null,[e("To upload a file, use "),s("code",null,"multipart/form-data"),e(" as the encoding type, instead of JSON.")],-1),Ws=s("p",null,[e("The file contents has to be provided in a part called "),s("code",null,"file"),e(". All other properties of "),s("a",{href:"#the-file-object"},"the file object"),e(" can be provided as parts as well, except "),s("code",null,"filename_disk"),e(" and "),s("code",null,"filename_download"),e(".")],-1),Ks=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Order Matters"),s("p",null,[e("Make sure to define the non-file properties "),s("em",null,"first"),e(". This ensures that the file metadata is associated with the correct file.")])],-1),Js=s("p",null,"You can upload multiple files at a time by repeating the payload with different contents, for example:",-1),Vs=s("pre",null,[s("code",null,`--__X_BOUNDARY__
+`)])],-1),Ns=s("h2",{id:"upload-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#upload-a-file"},"#"),e(" Upload a File")],-1),Zs=s("p",null,"Upload/create a new file.",-1),Hs=s("p",null,[e("To upload a file, use "),s("code",null,"multipart/form-data"),e(" as the encoding type. The file contents has to be provided in a part called "),s("code",null,"file"),e(". All other properties of "),s("a",{href:"#the-file-object"},"the file object"),e(" can be provided as parts as well, except "),s("code",null,"filename_disk"),e(" and "),s("code",null,"filename_download"),e(".")],-1),Ws=s("p",null,[e("Alternatively, you can use "),s("code",null,"application/json"),e(" with JSON request body to associate metadata to a file that already exists in the storage. The "),s("code",null,"type"),e(" property will be required to specify the mimetype of that file.")],-1),Ks=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Order Matters"),s("p",null,[e("Make sure to define the non-file properties "),s("em",null,"first"),e(". This ensures that the file metadata is associated with the correct file.")])],-1),Js=s("p",null,"You can upload multiple files at a time by repeating the payload with different contents, for example:",-1),Vs=s("pre",null,[s("code",null,`--__X_BOUNDARY__
 Content-Disposition: form-data; name="title"
 
 Example

package/dist/assets/{filter-rules.099e9689.js → filter-rules.edb18765.js}

@@ -1,4 +1,4 @@
-import{a as l,o as c,b as i,w as a,l as t,E as n,e as r}from"./runtime-core.esm-bundler.fe249c5c.js";const p={class:"markdown-body"},h=t("blockquote",null,[t("p",null,[n("Permissions, validation, and the API\u2019s "),t("code",null,"filter"),n(" parameter all rely on a specific JSON structure to define their rules. This page describes the syntax for creating flat, relational, or complex filter rules.")])],-1),d=t("h2",{id:"syntax",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#syntax"},"#"),n(" Syntax")],-1),j=t("ul",null,[t("li",null,[t("strong",null,"Field"),n(" \u2014 Any valid root field, "),t("a",{href:"#relational"},"relational field"),n(", or "),t("a",{href:"#logical-operators"},"logical operator")]),t("li",null,[t("strong",null,"Operator"),n(" \u2014 Any valid "),t("a",{href:"#filter-operators"},"filter operator")]),t("li",null,[t("strong",null,"Value"),n(" \u2014 Any valid static value, or "),t("a",{href:"#dynamic-variables"},"dynamic variable")])],-1),_=t("pre",null,[t("code",null,`{
+import{a as l,o as c,e as i,y as a,u as t,q as n,z as r}from"./runtime-core.esm-bundler.22ec0346.js";const p={class:"markdown-body"},h=t("blockquote",null,[t("p",null,[n("Permissions, validation, and the API\u2019s "),t("code",null,"filter"),n(" parameter all rely on a specific JSON structure to define their rules. This page describes the syntax for creating flat, relational, or complex filter rules.")])],-1),d=t("h2",{id:"syntax",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#syntax"},"#"),n(" Syntax")],-1),j=t("ul",null,[t("li",null,[t("strong",null,"Field"),n(" \u2014 Any valid root field, "),t("a",{href:"#relational"},"relational field"),n(", or "),t("a",{href:"#logical-operators"},"logical operator")]),t("li",null,[t("strong",null,"Operator"),n(" \u2014 Any valid "),t("a",{href:"#filter-operators"},"filter operator")]),t("li",null,[t("strong",null,"Value"),n(" \u2014 Any valid static value, or "),t("a",{href:"#dynamic-variables"},"dynamic variable")])],-1),_=t("pre",null,[t("code",null,`{
 	<field>: {
 		<operator>: <value>
 	}
@@ -25,7 +25,7 @@ import{a as l,o as c,b as i,w as a,l as t,E as n,e as r}from"./runtime-core.esm-
 		`),t("span",{class:"hljs-punctuation"},"}"),n(`
 	`),t("span",{class:"hljs-punctuation"},"}"),n(`
 `),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),N=t("p",null,[n("When using M2M relationships, a junction table will be created and the filter applies to the junction table itself. For example, if you have a "),t("code",null,"books"),n(" collection, with a M2M relationship to authors of each book, the junction collection will probably be named "),t("code",null,"books_authors"),n(" and have 3 fields : "),t("code",null,"id"),n(", "),t("code",null,"books_id"),n(" and "),t("code",null,"authors_id"),n(". To filter specific books depending on their authors you must go through the junction table and the "),t("code",null,"authors_id"),n(" field :")],-1),O=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
+`)])],-1),N=t("p",null,[n("When using M2M relationships, a junction table will be created and the filter applies to the junction table itself. For example, if you have a "),t("code",null,"books"),n(" collection, with a M2M relationship to authors of each book, the junction collection will probably be named "),t("code",null,"books_authors"),n(" and have 3 fields : "),t("code",null,"id"),n(", "),t("code",null,"books_id"),n(" and "),t("code",null,"authors_id"),n(". To filter specific books depending on their authors you must go through the junction table and the "),t("code",null,"authors_id"),n(" field :")],-1),q=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
 	`),t("span",{class:"hljs-attr"},'"authors"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
 		`),t("span",{class:"hljs-attr"},'"authors_id"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
 			`),t("span",{class:"hljs-attr"},'"name"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
@@ -34,7 +34,7 @@ import{a as l,o as c,b as i,w as a,l as t,E as n,e as r}from"./runtime-core.esm-
 		`),t("span",{class:"hljs-punctuation"},"}"),n(`
 	`),t("span",{class:"hljs-punctuation"},"}"),n(`
 `),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),q=t("h2",{id:"logical-operators",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#logical-operators"},"#"),n(" Logical Operators")],-1),D=t("p",null,[n("You can nest or group multiple rules using the "),t("code",null,"_and"),n(" or "),t("code",null,"_or"),n(" logical operators. Each logical operator holds an array of Filter Rules, allowing for more complex filtering. Also note in the example that Logical Operators can be sub-nested into Logical Operators. However, they cannot be sub-nested into Filter Rules.")],-1),k=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
+`)])],-1),O=t("h2",{id:"logical-operators",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#logical-operators"},"#"),n(" Logical Operators")],-1),D=t("p",null,[n("You can nest or group multiple rules using the "),t("code",null,"_and"),n(" or "),t("code",null,"_or"),n(" logical operators. Each logical operator holds an array of Filter Rules, allowing for more complex filtering. Also note in the example that Logical Operators can be sub-nested into Logical Operators. However, they cannot be sub-nested into Filter Rules.")],-1),k=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
 	`),t("span",{class:"hljs-attr"},'"_or"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"["),n(`
 		`),t("span",{class:"hljs-punctuation"},"{"),n(`
 			`),t("span",{class:"hljs-attr"},'"_and"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"["),n(`
@@ -82,4 +82,4 @@ import{a as l,o as c,b as i,w as a,l as t,E as n,e as r}from"./runtime-core.esm-
 		`),t("span",{class:"hljs-punctuation"},"}"),n(`
 	`),t("span",{class:"hljs-punctuation"},"}"),n(`
 `),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),L=t("p",null,"will fetch all parent items that don\u2019t have the category \u201CRecipe\u201D",-1),V=t("h2",{id:"dynamic-variables",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#dynamic-variables"},"#"),n(" Dynamic Variables")],-1),M=t("p",null,[n("In addition to static values, you can also filter against "),t("em",null,"dynamic"),n(" values using the following variables.")],-1),W=t("ul",null,[t("li",null,[t("code",null,"$CURRENT_USER"),n(" \u2014 The primary key of the currently authenticated user")]),t("li",null,[t("code",null,"$CURRENT_ROLE"),n(" \u2014 The primary key of the role for the currently authenticated user")]),t("li",null,[t("code",null,"$NOW"),n(" \u2014 The current timestamp")]),t("li",null,[t("code",null,"$NOW(<adjustment>)"),n(" - The current timestamp plus/minus a given distance, for example "),t("code",null,"$NOW(-1 year)"),n(", "),t("code",null,"$NOW(+2 hours)")])],-1),A={class:"tip hint"},G=t("div",{class:"hint-title"},"Functions",-1),P=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Nested User / Role variables in Permissions"),t("p",null,[n("When configuring permissions, "),t("code",null,"$CURRENT_USER"),n(" and "),t("code",null,"$CURRENT_ROLE"),n(" allow you to specify any (nested) field under the current user/role as well as the root ID. For example: "),t("code",null,"$CURRENT_ROLE.name"),n(" or "),t("code",null,"$CURRENT_USER.avatar.filesize"),n(". This includes custom fields that were added to the directus_users/directus_roles tables.")]),t("p",null,"Note: This feature is only available for permissions, validation, and presets. Regular filters and conditional fields currently only support the root ID.")],-1),Z="Filter Rules",z=!1,H="REST and GraphQL API documentation for filter rules in Directus.",K="5 min read",X={__name:"filter-rules",setup(B,{expose:e}){const s={title:"Filter Rules",modularExtension:!1,description:"REST and GraphQL API documentation for filter rules in Directus.",readTime:"5 min read"};return e({frontmatter:s}),(Y,J)=>{const u=l("router-link"),o=l("docs-wrapper");return c(),i(o,{frontmatter:s},{default:a(()=>[t("div",p,[h,d,j,_,f,m,g,b,y,v,R,w,x,E,T,I,N,O,q,D,k,U,F,S,$,C,L,V,M,W,t("div",A,[G,t("p",null,[n("You can also use "),r(u,{to:"/docs/reference/query#functions"},{default:a(()=>[n("Function Parameters")]),_:1}),n(" when building Filters.")])]),P])]),_:1})}}};export{X as default,H as description,z as modularExtension,K as readTime,Z as title};
+`)])],-1),L=t("p",null,"will fetch all parent items that don\u2019t have the category \u201CRecipe\u201D",-1),V=t("h2",{id:"dynamic-variables",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#dynamic-variables"},"#"),n(" Dynamic Variables")],-1),M=t("p",null,[n("In addition to static values, you can also filter against "),t("em",null,"dynamic"),n(" values using the following variables.")],-1),W=t("ul",null,[t("li",null,[t("code",null,"$CURRENT_USER"),n(" \u2014 The primary key of the currently authenticated user")]),t("li",null,[t("code",null,"$CURRENT_ROLE"),n(" \u2014 The primary key of the role for the currently authenticated user")]),t("li",null,[t("code",null,"$NOW"),n(" \u2014 The current timestamp")]),t("li",null,[t("code",null,"$NOW(<adjustment>)"),n(" - The current timestamp plus/minus a given distance, for example "),t("code",null,"$NOW(-1 year)"),n(", "),t("code",null,"$NOW(+2 hours)")])],-1),A={class:"tip hint"},G=t("div",{class:"hint-title"},"Functions",-1),P=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Nested User / Role variables in Permissions"),t("p",null,[n("When configuring permissions, "),t("code",null,"$CURRENT_USER"),n(" and "),t("code",null,"$CURRENT_ROLE"),n(" allow you to specify any (nested) field under the current user/role as well as the root ID. For example: "),t("code",null,"$CURRENT_ROLE.name"),n(" or "),t("code",null,"$CURRENT_USER.avatar.filesize"),n(". This includes custom fields that were added to the directus_users/directus_roles tables.")]),t("p",null,"Note: This feature is only available for permissions, validation, and presets. Regular filters and conditional fields currently only support the root ID.")],-1),Q="Filter Rules",Z=!1,H="REST and GraphQL API documentation for filter rules in Directus.",K="5 min read",X={__name:"filter-rules",setup(B,{expose:e}){const s={title:"Filter Rules",modularExtension:!1,description:"REST and GraphQL API documentation for filter rules in Directus.",readTime:"5 min read"};return e({frontmatter:s}),(Y,z)=>{const u=l("router-link"),o=l("docs-wrapper");return c(),i(o,{frontmatter:s},{default:a(()=>[t("div",p,[h,d,j,_,f,m,g,b,y,v,R,w,x,E,T,I,N,q,O,D,k,U,F,S,$,C,L,V,M,W,t("div",A,[G,t("p",null,[n("You can also use "),r(u,{to:"/docs/reference/query#functions"},{default:a(()=>[n("Function Parameters")]),_:1}),n(" when building Filters.")])]),P])]),_:1})}}};export{X as default,H as description,Z as modularExtension,K as readTime,Q as title};

package/dist/assets/{filters.98d31bd5.js → filters.26e88a50.js}

@@ -1 +1 @@
-import{a as n,o as d,b as c,w as o,l as e,E as t,e as i}from"./runtime-core.esm-bundler.fe249c5c.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"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.")],-1),p=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filters-20220303A.webp",alt:"Filters"})],-1),f={class:"warning hint"},m=e("div",{class:"hint-title"},"There Are Two Filters Documents",-1),_=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),t(" How it Works")],-1),g={class:"tip hint"},y=e("div",{class:"hint-title"},"Assumed Knowledge",-1),b=e("strong",null,"Field",-1),w=e("strong",null,"Value",-1),F=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/how-filters-work-20220303A.mp4",type:"video/mp4"})],-1),v=e("ol",{start:"2"},[e("li",null,[t("Click "),e("span",{mi:"",icon:""},"filter_list"),t(" or "),e("strong",null,"\u201CAdd Filter\u201D"),t(".")]),e("li",null,"Select the Field to filter by."),e("li",null,"Select the Operator as desired."),e("li",null,"Define the Value to filter for.")],-1),C=e("p",null,[t("From here, you can set multiple Filters at once, filter by "),e("a",{href:"#filtering-by-related-collections"},"Fields in related Collections"),t(", set Values with "),e("a",{href:"#dynamic-variables"},"Dynamic Variables"),t(", as well as apply "),e("a",{href:"#and-or-groups"},"AND/OR Groups"),t(".")],-1),A={class:"tip hint"},k=e("div",{class:"hint-title"},"Operators",-1),x=e("a",{href:"#unfilterable-fields"},"Unfilterable Fields",-1),R=e("h2",{id:"and%2For-groups",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#and%2For-groups"},"#"),t(" AND/OR Groups")],-1),O=e("p",null,[e("code",null,"AND"),t(" Groups give the option to filter for Items that meet "),e("em",null,"all of several criteria"),t(". On the other hand, "),e("code",null,"OR"),t(" Groups filter for Items that meet "),e("em",null,"any one of several criteria"),t(".")],-1),I=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/and-or-groups-20220303A.webp",alt:"AND/OR Groups"})],-1),D=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click \u201CAnd/OR Group\u201D at the very top of the dropdown menu."),e("li",null,[t("Click the AND/OR text to toggle: "),e("ul",null,[e("li",null,[e("code",null,"AND"),t(" \u2013 Selects Items that meet every single criteria.")]),e("li",null,[e("code",null,"OR"),t(" \u2013 Selects Items that meet one of several criteria.")])])]),e("li",null,"Click \u201CAdd Filter\u201D again."),e("li",null,"Configure the Field, Operator, and Value as desired."),e("li",null,[t("Click and hold "),e("span",{mi:"",icon:""},"drag_indicator"),t(" to drag a Filter and nest it under an AND/OR Group.")])],-1),N=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Why do we need AND Groups?"),e("p",null,[t("Filters actually default to "),e("code",null,"AND"),t(" Group behavior automatically. However, when Filters are nested inside of an OR Group, they of course switch to "),e("code",null,"OR"),t(" Group behavior. So an AND Group is necessary in cases where you want to meet multiple conditions inside of OR Groups.")])],-1),G=e("h2",{id:"dynamic-variables",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#dynamic-variables"},"#"),t(" Dynamic Variables")],-1),T=e("p",null,"The following video shows how to filter for Blog posts written within the past 60 days.",-1),U=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/dynamic-variables-20220307A.mp4",type:"video/mp4"})],-1),E=e("code",null,"$CURRENT_USER",-1),V=e("code",null,"$CURRENT_ROLE",-1),H=e("code",null,"$NOW",-1),S=e("code",null,"$NOW(<adjustment>)",-1),W=e("h2",{id:"filtering-by-related-collections",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#filtering-by-related-collections"},"#"),t(" Filtering by Related Collections")],-1),B=e("p",null,[t("You may need to run filters on one Collection "),e("em",null,"based on information in another related Collection"),t(". Here are a few examples of when that might happen:")],-1),$=e("ul",null,[e("li",null,[t("Book authors that also wrote screenplays (filters "),e("code",null,"authors"),t(", uses "),e("code",null,"screenplays"),t(").")]),e("li",null,[t("Products with a 5 star customer review (filters "),e("code",null,"products"),t(", uses "),e("code",null,"reviews"),t(").")]),e("li",null,[t("Accounts with active user login within the last 12 months (filters "),e("code",null,"accounts"),t(", uses "),e("code",null,"logins"),t(").")])],-1),j=e("p",null,[t("This can span across any number of relationally linked Collections. For example, you could filter for customers that bought rock songs, where the "),e("code",null,"customers"),t(" and "),e("code",null,"genres"),t(" Collections are linked by "),e("code",null,"customers"),t(" -> "),e("code",null,"invoices"),t(" -> "),e("code",null,"invoice-items"),t(" -> "),e("code",null,"tracks"),t(" -> "),e("code",null,"genres"),t(".")],-1),z=e("span",{mi:"",icon:""},"chevron_right",-1),P=e("p",null,"Here are step-by-step instructions on how to filter by Fields in other Collections:",-1),q=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filtering-by-related-collections-20220303A.mp4",type:"video/mp4"})],-1),L=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click the desired relational Field. This will pop down and display the related Collection Fields."),e("li",null,"Select a Field from this related Collection."),e("li",null,"Set the Operator and Value as desired.")],-1),Y=e("h2",{id:"unfilterable-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#unfilterable-fields"},"#"),t(" Unfilterable Fields")],-1),K=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/unfilterable-fields-20220303A.webp",alt:"Unfilterable Fields"})],-1),M=e("p",null,[t("Not all Fields can be filtered. As seen above in "),e("a",{href:"#filtering-by-related-collections"},"Filtering by Related Collections"),t(", Alias Fields cannot be filtered; they instead provide a dropdown menu to access Fields from a related Collection. Additionally, the \u201CPresentation\u201D and \u201CGroup\u201D Fields cannot be filtered at all and will not appear as an option in Filters.")],-1),J=e("h2",{id:"extensibility-options",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#extensibility-options"},"#"),t(" Extensibility Options")],-1),Q=e("p",null,"Directus Core is completely open-source, modular and extensible. Extensions allow you to expand or modify any part of Directus to fit your needs. Here are some great resources to get started down that track.",-1),X=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Accelerated Development"),e("p",null,[t("Working on an enterprise project and looking to outsource or financially sponsor the development of a Shares extension? Contact "),e("a",{href:"https://directus.io/contact",target:"_blank",rel:"noopener noreferrer"},"our team")])],-1),Z=e("h2",{id:"more-help",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#more-help"},"#"),t(" More Help")],-1),ee=e("p",null,[t("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),se="Filters",ne=!1,re="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.",ae="5 min read",de={__name:"filters",setup(te,{expose:r}){const s={title:"Filters",modularExtension:!1,description:"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.",readTime:"5 min read"};return r({frontmatter:s}),(oe,le)=>{const l=n("router-link"),a=n("docs-wrapper");return d(),c(a,{frontmatter:s},{default:o(()=>[e("div",u,[h,p,e("div",f,[m,e("p",null,[t("This page is a non-technical guide to using Filters. For more technical info, see "),i(l,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter-Rules")]),_:1}),t(".")])]),_,e("div",g,[y,e("p",null,[t("Filters are intuitive to use, but get quite nuanced as complexity increases. In order to use Filters effectively, you will need to understand the Field "),e("em",null,[t("(aka "),i(l,{to:"/docs/configuration/data-model"},{default:o(()=>[t("data model")]),_:1}),t(")")]),t(" being filtered as well as any relevant "),i(l,{to:"/docs/configuration/users-roles-permissions.md"},{default:o(()=>[t("Users, Roles and Permissions")]),_:1}),t(".")])]),e("p",null,[t("A basic filter is composed of 3 parts: A "),b,t(" from the Collection being Filtered, a logical "),i(l,{to:"/docs/reference/filter-rules#filter-operators"},{default:o(()=>[t("Operator")]),_:1}),t(", and some specified "),w,t(" to filter for within each Item\u2019s Field.")]),F,v,C,e("div",A,[k,e("p",null,[t("The Field type will determine the kinds of Operators that can be used on it. In fact, some Fields cannot be filtered at all (read more in "),x,t("). Once a Field is selected, the permitted operators will automatically display. An exhaustive list of Operators and what they do can be found in the more technical "),i(l,{to:"/docs/reference/filter-rules#filter-operators"},{default:o(()=>[t("Filter Rules")]),_:1}),t(" document.")])]),R,O,I,D,N,G,T,U,e("p",null,[t("The following Dynamic Variables are built into Directus to make Filtering easier: "),E,t(", "),V,t(", "),H,t(" and "),S,t(". For more information, please see the Dynamic Variables section in "),i(l,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter Rules")]),_:1}),t(".")]),W,B,$,j,e("p",null,[t("You will notice a "),z,t(" icon beside relational Fields. When you click on any "),i(l,{to:"/docs/getting-started/glossary#alias"},{default:o(()=>[t("Alias")]),_:1}),t(" Field, all the Fields for that associated Collection pop down. If you select one of these Fields, you can run Filters on the current Collection by Field values in a related Collection.")]),P,q,L,Y,K,M,J,Q,e("ul",null,[e("li",null,[i(l,{to:"/docs/extensions/introduction"},{default:o(()=>[t("Extensions > Introduction")]),_:1})]),e("li",null,[i(l,{to:"/docs/extensions/creating-extensions"},{default:o(()=>[t("Extensions > Creating Extensions")]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/introduction"},{default:o(()=>[t("Contributing > Introduction")]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/codebase-overview"},{default:o(()=>[t("Contributing > Codebase Overview")]),_:1})])]),X,Z,ee])]),_:1})}}};export{de as default,re as description,ne as modularExtension,ae as readTime,se as title};
+import{a as n,o as d,e as c,y as o,u as e,q as t,z as i}from"./runtime-core.esm-bundler.22ec0346.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"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.")],-1),p=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filters-20220303A.webp",alt:"Filters"})],-1),f={class:"warning hint"},m=e("div",{class:"hint-title"},"There Are Two Filters Documents",-1),_=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),t(" How it Works")],-1),y={class:"tip hint"},g=e("div",{class:"hint-title"},"Assumed Knowledge",-1),b=e("strong",null,"Field",-1),w=e("strong",null,"Value",-1),F=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/how-filters-work-20220303A.mp4",type:"video/mp4"})],-1),v=e("ol",{start:"2"},[e("li",null,[t("Click "),e("span",{mi:"",icon:""},"filter_list"),t(" or "),e("strong",null,"\u201CAdd Filter\u201D"),t(".")]),e("li",null,"Select the Field to filter by."),e("li",null,"Select the Operator as desired."),e("li",null,"Define the Value to filter for.")],-1),C=e("p",null,[t("From here, you can set multiple Filters at once, filter by "),e("a",{href:"#filtering-by-related-collections"},"Fields in related Collections"),t(", set Values with "),e("a",{href:"#dynamic-variables"},"Dynamic Variables"),t(", as well as apply "),e("a",{href:"#and-or-groups"},"AND/OR Groups"),t(".")],-1),A={class:"tip hint"},k=e("div",{class:"hint-title"},"Operators",-1),x=e("a",{href:"#unfilterable-fields"},"Unfilterable Fields",-1),R=e("h2",{id:"and%2For-groups",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#and%2For-groups"},"#"),t(" AND/OR Groups")],-1),O=e("p",null,[e("code",null,"AND"),t(" Groups give the option to filter for Items that meet "),e("em",null,"all of several criteria"),t(". On the other hand, "),e("code",null,"OR"),t(" Groups filter for Items that meet "),e("em",null,"any one of several criteria"),t(".")],-1),I=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/and-or-groups-20220303A.webp",alt:"AND/OR Groups"})],-1),D=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click \u201CAnd/OR Group\u201D at the very top of the dropdown menu."),e("li",null,[t("Click the AND/OR text to toggle: "),e("ul",null,[e("li",null,[e("code",null,"AND"),t(" \u2013 Selects Items that meet every single criteria.")]),e("li",null,[e("code",null,"OR"),t(" \u2013 Selects Items that meet one of several criteria.")])])]),e("li",null,"Click \u201CAdd Filter\u201D again."),e("li",null,"Configure the Field, Operator, and Value as desired."),e("li",null,[t("Click and hold "),e("span",{mi:"",icon:""},"drag_indicator"),t(" to drag a Filter and nest it under an AND/OR Group.")])],-1),N=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Why do we need AND Groups?"),e("p",null,[t("Filters actually default to "),e("code",null,"AND"),t(" Group behavior automatically. However, when Filters are nested inside of an OR Group, they of course switch to "),e("code",null,"OR"),t(" Group behavior. So an AND Group is necessary in cases where you want to meet multiple conditions inside of OR Groups.")])],-1),G=e("h2",{id:"dynamic-variables",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#dynamic-variables"},"#"),t(" Dynamic Variables")],-1),T=e("p",null,"The following video shows how to filter for Blog posts written within the past 60 days.",-1),U=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/dynamic-variables-20220307A.mp4",type:"video/mp4"})],-1),V=e("code",null,"$CURRENT_USER",-1),E=e("code",null,"$CURRENT_ROLE",-1),H=e("code",null,"$NOW",-1),S=e("code",null,"$NOW(<adjustment>)",-1),W=e("h2",{id:"filtering-by-related-collections",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#filtering-by-related-collections"},"#"),t(" Filtering by Related Collections")],-1),B=e("p",null,[t("You may need to run filters on one Collection "),e("em",null,"based on information in another related Collection"),t(". Here are a few examples of when that might happen:")],-1),z=e("ul",null,[e("li",null,[t("Book authors that also wrote screenplays (filters "),e("code",null,"authors"),t(", uses "),e("code",null,"screenplays"),t(").")]),e("li",null,[t("Products with a 5 star customer review (filters "),e("code",null,"products"),t(", uses "),e("code",null,"reviews"),t(").")]),e("li",null,[t("Accounts with active user login within the last 12 months (filters "),e("code",null,"accounts"),t(", uses "),e("code",null,"logins"),t(").")])],-1),$=e("p",null,[t("This can span across any number of relationally linked Collections. For example, you could filter for customers that bought rock songs, where the "),e("code",null,"customers"),t(" and "),e("code",null,"genres"),t(" Collections are linked by "),e("code",null,"customers"),t(" -> "),e("code",null,"invoices"),t(" -> "),e("code",null,"invoice-items"),t(" -> "),e("code",null,"tracks"),t(" -> "),e("code",null,"genres"),t(".")],-1),j=e("span",{mi:"",icon:""},"chevron_right",-1),q=e("p",null,"Here are step-by-step instructions on how to filter by Fields in other Collections:",-1),P=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filtering-by-related-collections-20220303A.mp4",type:"video/mp4"})],-1),L=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click the desired relational Field. This will pop down and display the related Collection Fields."),e("li",null,"Select a Field from this related Collection."),e("li",null,"Set the Operator and Value as desired.")],-1),Y=e("h2",{id:"unfilterable-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#unfilterable-fields"},"#"),t(" Unfilterable Fields")],-1),K=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/unfilterable-fields-20220303A.webp",alt:"Unfilterable Fields"})],-1),M=e("p",null,[t("Not all Fields can be filtered. As seen above in "),e("a",{href:"#filtering-by-related-collections"},"Filtering by Related Collections"),t(", Alias Fields cannot be filtered; they instead provide a dropdown menu to access Fields from a related Collection. Additionally, the \u201CPresentation\u201D and \u201CGroup\u201D Fields cannot be filtered at all and will not appear as an option in Filters.")],-1),J=e("h2",{id:"extensibility-options",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#extensibility-options"},"#"),t(" Extensibility Options")],-1),Q=e("p",null,"Directus Core is completely open-source, modular and extensible. Extensions allow you to expand or modify any part of Directus to fit your needs. Here are some great resources to get started down that track.",-1),X=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Accelerated Development"),e("p",null,[t("Working on an enterprise project and looking to outsource or financially sponsor the development of a Shares extension? Contact "),e("a",{href:"https://directus.io/contact",target:"_blank",rel:"noopener noreferrer"},"our team")])],-1),Z=e("h2",{id:"more-help",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#more-help"},"#"),t(" More Help")],-1),ee=e("p",null,[t("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),se="Filters",ne=!1,re="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.",ae="5 min read",de={__name:"filters",setup(te,{expose:r}){const s={title:"Filters",modularExtension:!1,description:"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.",readTime:"5 min read"};return r({frontmatter:s}),(oe,le)=>{const l=n("router-link"),a=n("docs-wrapper");return d(),c(a,{frontmatter:s},{default:o(()=>[e("div",u,[h,p,e("div",f,[m,e("p",null,[t("This page is a non-technical guide to using Filters. For more technical info, see "),i(l,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter-Rules")]),_:1}),t(".")])]),_,e("div",y,[g,e("p",null,[t("Filters are intuitive to use, but get quite nuanced as complexity increases. In order to use Filters effectively, you will need to understand the Field "),e("em",null,[t("(aka "),i(l,{to:"/docs/configuration/data-model"},{default:o(()=>[t("data model")]),_:1}),t(")")]),t(" being filtered as well as any relevant "),i(l,{to:"/docs/configuration/users-roles-permissions.md"},{default:o(()=>[t("Users, Roles and Permissions")]),_:1}),t(".")])]),e("p",null,[t("A basic filter is composed of 3 parts: A "),b,t(" from the Collection being Filtered, a logical "),i(l,{to:"/docs/reference/filter-rules#filter-operators"},{default:o(()=>[t("Operator")]),_:1}),t(", and some specified "),w,t(" to filter for within each Item\u2019s Field.")]),F,v,C,e("div",A,[k,e("p",null,[t("The Field type will determine the kinds of Operators that can be used on it. In fact, some Fields cannot be filtered at all (read more in "),x,t("). Once a Field is selected, the permitted operators will automatically display. An exhaustive list of Operators and what they do can be found in the more technical "),i(l,{to:"/docs/reference/filter-rules#filter-operators"},{default:o(()=>[t("Filter Rules")]),_:1}),t(" document.")])]),R,O,I,D,N,G,T,U,e("p",null,[t("The following Dynamic Variables are built into Directus to make Filtering easier: "),V,t(", "),E,t(", "),H,t(" and "),S,t(". For more information, please see the Dynamic Variables section in "),i(l,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter Rules")]),_:1}),t(".")]),W,B,z,$,e("p",null,[t("You will notice a "),j,t(" icon beside relational Fields. When you click on any "),i(l,{to:"/docs/getting-started/glossary#alias"},{default:o(()=>[t("Alias")]),_:1}),t(" Field, all the Fields for that associated Collection pop down. If you select one of these Fields, you can run Filters on the current Collection by Field values in a related Collection.")]),q,P,L,Y,K,M,J,Q,e("ul",null,[e("li",null,[i(l,{to:"/docs/extensions/introduction"},{default:o(()=>[t("Extensions > Introduction")]),_:1})]),e("li",null,[i(l,{to:"/docs/extensions/creating-extensions"},{default:o(()=>[t("Extensions > Creating Extensions")]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/introduction"},{default:o(()=>[t("Contributing > Introduction")]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/codebase-overview"},{default:o(()=>[t("Contributing > Codebase Overview")]),_:1})])]),X,Z,ee])]),_:1})}}};export{de as default,re as description,ne as modularExtension,ae as readTime,se as title};