@directus/app 9.22.0 → 9.22.2

package/dist/assets/fields-3074ab9b.js

@@ -0,0 +1,135 @@
+import{a as e,o as h,e as p,y as a,u as s,q as n,z as c}from"./runtime-core.esm-bundler-753bcc58.js";const u={class:"markdown-body"},r=s("hr",null,null,-1),d=s("h2",{id:"the-field-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-field-object"},"#"),n(" The Field Object")],-1),j=s("p",null,[s("code",null,"collection"),n(),s("strong",null,"string"),s("br"),n(" Name of the collection the field resides in.")],-1),_=s("p",null,[s("code",null,"field"),n(),s("strong",null,"string"),s("br"),n(" The identifier of the field. This matches the table column name.")],-1),f=s("code",null,"type",-1),m=s("strong",null,"string",-1),g=s("br",null,null,-1),b=s("h4",{id:"meta",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#meta"},"#"),n(" Meta")],-1),y=s("p",null,"Directus metadata, primarily used in the Admin App. Meta is optional.",-1),x=s("p",null,[s("code",null,"id"),n(),s("strong",null,"integer"),s("br"),n(" Primary key of the metadata row in "),s("code",null,"directus_fields"),n(".")],-1),q=s("p",null,[s("code",null,"collection"),n(),s("strong",null,"string"),s("br"),n(" The name of the collection this field resides in.")],-1),T=s("p",null,[s("code",null,"field"),n(),s("strong",null,"string"),s("br"),n(" Identifier of the field. Matches the column name in the database.")],-1),w=s("p",null,[s("code",null,"special"),n(),s("strong",null,"string"),s("br"),n(" Any special transform flags that apply to this field.")],-1),k=s("p",null,[s("code",null,"interface"),n(),s("strong",null,"string"),s("br"),n(" The interface used for this field.")],-1),v=s("p",null,[s("code",null,"options"),n(),s("strong",null,"object"),s("br"),n(" The interface options configured for this field. The structure is based on the interface used.")],-1),A=s("p",null,[s("code",null,"display"),n(),s("strong",null,"string"),s("br"),n(" The display used for this field.")],-1),E=s("p",null,[s("code",null,"display_options"),n(),s("strong",null,"string"),s("br"),n(" The configured options for the used display.")],-1),S=s("p",null,[s("code",null,"readonly"),n(),s("strong",null,"boolean"),s("br"),n(" If the field is considered readonly in the Admin App.")],-1),P=s("p",null,[s("code",null,"hidden"),n(),s("strong",null,"boolean"),s("br"),n(" If the field is hidden from the edit page in the Admin App.")],-1),R=s("p",null,[s("code",null,"sort"),n(),s("strong",null,"integer"),s("br"),n(" Where this field is shown on the edit page in the Admin App.")],-1),Q=s("p",null,[s("code",null,"width"),n(),s("strong",null,"string"),s("br"),n(" How wide the interface is rendered on the edit page in the Admin App. One of "),s("code",null,"half"),n(", "),s("code",null,"half-left"),n(", "),s("code",null,"half-right"),n(", "),s("code",null,"half-space"),n(", "),s("code",null,"full"),n(", "),s("code",null,"fill"),n(".")],-1),I=s("p",null,[s("code",null,"translations"),n(),s("strong",null,"array"),s("br"),n(" How this field’s name is displayed in the different languages in the Admin App.")],-1),L=s("p",null,[s("code",null,"note"),n(),s("strong",null,"string"),s("br"),n(" Short description displayed in the Admin App.")],-1),F=s("h4",{id:"schema",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#schema"},"#"),n(" Schema")],-1),G=s("p",null,"“Raw” 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’s an alias commonly used for relational (O2M) or presentation purposes in the Admin App.",-1),C=s("p",null,[s("code",null,"name"),n(),s("strong",null,"string"),s("br"),n(" Identifier of the field. Matches the column name in the database.")],-1),O=s("p",null,[s("code",null,"table"),n(),s("strong",null,"string"),s("br"),n(" Name of the table the column resides in.")],-1),D=s("p",null,[s("code",null,"data_type"),n(),s("strong",null,"string"),s("br"),n(" The datatype as used in the database. Note: this value is database vendor specific.")],-1),H=s("p",null,[s("code",null,"default_value"),n(),s("strong",null,"any"),s("br"),n(" The configured default value for the column.")],-1),M=s("p",null,[s("code",null,"max_length"),n(),s("strong",null,"integer"),s("br"),n(" Configured length for varchar type columns.")],-1),B=s("p",null,[s("code",null,"numeric_precision"),n(),s("strong",null,"integer"),s("br"),n(" Precision for integer/float/decimal type fields.")],-1),N=s("p",null,[s("code",null,"numeric_scale"),n(),s("strong",null,"integer"),s("br"),n(" Scale for integer/float/decimal type fields.")],-1),W=s("p",null,[s("code",null,"is_nullable"),n(),s("strong",null,"boolean"),s("br"),n(" Whether or not the column is nullable. This is what is used as the “required” state in Directus.")],-1),U=s("p",null,[s("code",null,"is_primary_key"),n(),s("strong",null,"boolean"),s("br"),n(" Whether or not the field is the primary key of the table.")],-1),V=s("p",null,[s("code",null,"foreign_key_column"),n(),s("strong",null,"string"),s("br"),n(" 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"),n(),s("strong",null,"string"),s("br"),n(" If the current column has a foreign key constraint, this points to the related table.")],-1),J=s("p",null,[s("code",null,"comment"),n(),s("strong",null,"string"),s("br"),n(" Comment as stored in the database.")],-1),K=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"integer"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"16"),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"special"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"interface"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"numeric"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"options"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"display"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"display_options"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"readonly"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"hidden"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"sort"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"1"),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"width"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"full"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"translations"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"note"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"The unique identifier of the article"'),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"schema"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"table"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"data_type"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"integer"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"default_value"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"max_length"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"numeric_precision"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"32"),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"numeric_scale"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"0"),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"is_nullable"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"is_primary_key"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"has_auto_increment"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"foreign_key_column"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"foreign_key_table"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"comment"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),X=s("hr",null,null,-1),Y=s("h2",{id:"list-all-fields",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-all-fields"},"#"),n(" List All Fields")],-1),Z=s("p",null,"List the available fields.",-1),$=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),n(" Query Parameters")],-1),ss=s("p",null,"This endpoint doesn’t currently support any query parameters.",-1),ns=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),n(" Returns")],-1),as=s("p",null,[n("An array of "),s("a",{href:"#the-field-object"},"field objects"),n(".")],-1),ls=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),n(" REST API")],-1),ts=s("pre",null,[s("code",null,`GET /fields
+`)],-1),es=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),n(" GraphQL")],-1),cs=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),os=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-symbol"},"fields"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),n("directus_fields"),s("span",{class:"hljs-punctuation"},"]"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),is=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),n(" Example")],-1),hs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	fields `),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),ps=s("hr",null,null,-1),us=s("h2",{id:"list-fields-in-collection",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-fields-in-collection"},"#"),n(" List Fields in Collection")],-1),rs=s("p",null,"List the available fields in a given collection.",-1),ds=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),n(" Query Parameters")],-1),js=s("p",null,"This endpoint doesn’t currently support any query parameters.",-1),_s=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),n(" Returns")],-1),fs=s("p",null,[n("An array of "),s("a",{href:"#the-field-object"},"field objects"),n(".")],-1),ms=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),n(" REST API")],-1),gs=s("pre",null,[s("code",null,`GET /fields/:collection
+`)],-1),bs=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),n(" Example")],-1),ys=s("pre",null,[s("code",null,`GET /fields/articles
+`)],-1),xs=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),n(" GraphQL")],-1),qs=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Ts=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	fields_in_collection`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` directus_fields
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),ws=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),n(" Example")],-1),ks=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	fields_in_collection`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),vs=s("hr",null,null,-1),As=s("h2",{id:"retrieve-a-field",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-a-field"},"#"),n(" Retrieve a Field")],-1),Es=s("p",null,"Get a single field in a given collection.",-1),Ss=s("h3",{id:"query-parameters-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),n(" Query Parameters")],-1),Ps=s("p",null,"This endpoint doesn’t currently support any query parameters.",-1),Rs=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),n(" Returns")],-1),Qs=s("p",null,[n("A "),s("a",{href:"#the-field-object"},"field object"),n(".")],-1),Is=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),n(" REST API")],-1),Ls=s("pre",null,[s("code",null,`GET /fields/:collection/:field
+`)],-1),Fs=s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),n(" Example")],-1),Gs=s("pre",null,[s("code",null,`GET /fields/articles/title
+`)],-1),Cs=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),n(" GraphQL")],-1),Os=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Ds=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	fields_by_name`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` directus_fields
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Hs=s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),n(" Example")],-1),Ms=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	fields_by_name`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"title"'),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Bs=s("hr",null,null,-1),Ns=s("h2",{id:"create-a-field",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-a-field"},"#"),n(" Create a Field")],-1),Ws=s("p",null,"Create a new field in the given collection.",-1),Us=s("h3",{id:"query-parameters-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),n(" Query Parameters")],-1),Vs=s("p",null,"This endpoint doesn’t currently support any query parameters.",-1),zs=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),n(" Request Body")],-1),Js=s("p",null,[s("code",null,"field"),n(),s("strong",null,"Required"),s("br"),n(" Field key, also used as the column name.")],-1),Ks=s("p",null,[s("code",null,"type"),n(),s("strong",null,"Required"),s("br"),n(" One of the Directus types. This in turn controls what datatype is used for the column in the database. Setting the type to "),s("code",null,"alias"),n(" prevents a column from being created in the database.")],-1),Xs=s("p",null,[s("code",null,"meta"),s("br"),n(" Any of the optional meta values in the "),s("a",{href:"#the-field-object"},"field object"),n(".")],-1),Ys=s("p",null,[s("code",null,"schema"),s("br"),n(" Any of the optional schema values in the "),s("a",{href:"#the-field-object"},"field object"),n(".")],-1),Zs=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),n(" Returns")],-1),$s=s("p",null,[n("The "),s("a",{href:"#the-field-object"},"field object"),n(" for the created field.")],-1),sn=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),n(" REST API")],-1),nn=s("pre",null,[s("code",null,`POST /fields/:collection
+`)],-1),an=s("h5",{id:"example-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-5"},"#"),n(" Example")],-1),ln=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /fields/articles"),n(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"title"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"string"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"title"'),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"schema"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"default_value"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Hello World"'),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),tn=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),n(" GraphQL")],-1),en=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),cn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	create_fields_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),n(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(" create_directus_fields_input"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` directus_fields
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),on=s("h5",{id:"example-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-6"},"#"),n(" Example")],-1),hn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	create_fields_item`),s("span",{class:"hljs-punctuation"},"("),n(`
+		`),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),n(`
+		`),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"title"'),n(", "),s("span",{class:"hljs-symbol"},"type"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"string"'),n(", "),s("span",{class:"hljs-symbol"},"meta"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"icon"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"title"'),n(),s("span",{class:"hljs-punctuation"},"}"),n(", "),s("span",{class:"hljs-symbol"},"schema"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"default_value"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Hello World"'),n(),s("span",{class:"hljs-punctuation"},"}"),n(),s("span",{class:"hljs-punctuation"},"}"),n(`
+	`),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),pn=s("hr",null,null,-1),un=s("h2",{id:"update-a-field",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-field"},"#"),n(" Update a Field")],-1),rn=s("p",null,"Updates the given field in the given collection.",-1),dn=s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),n(" Query Parameters")],-1),jn=s("p",null,"This endpoint doesn’t currently support any query parameters.",-1),_n=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),n(" Request Body")],-1),fn=s("p",null,[s("code",null,"type"),s("br"),n(" The new type for the field.")],-1),mn=s("div",{class:"warning hint"},[s("div",{class:"hint-title"},"Changing Type"),s("p",null,"Types may not be compatible, and/or data might be truncated / corrupted. Please be careful when changing types of an existing field with content.")],-1),gn=s("p",null,[s("code",null,"meta"),s("br"),n(" Any of the optional meta values in the "),s("a",{href:"#the-field-object"},"field object"),n(".")],-1),bn=s("p",null,[s("code",null,"schema"),s("br"),n(" Any of the optional schema values in the "),s("a",{href:"#the-field-object"},"field object"),n(".")],-1),yn=s("p",null,"Updating the field name is not supported at this time.",-1),xn=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),n(" Returns")],-1),qn=s("p",null,[n("The "),s("a",{href:"#the-field-object"},"field object"),n(" for the updated field.")],-1),Tn=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),n(" REST API")],-1),wn=s("pre",null,[s("code",null,`PATCH /fields/:collection/:field
+`)],-1),kn=s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),n(" Example")],-1),vn=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /fields/articles/title"),n(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"note"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Put the title here"'),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"schema"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"default_value"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Hello World!"'),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),An=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),n(" GraphQL")],-1),En=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Sn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	update_fields_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),n(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(" update_directus_fields_input"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` directus_fields
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Pn=s("h5",{id:"example-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-8"},"#"),n(" Example")],-1),Rn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	update_fields_item`),s("span",{class:"hljs-punctuation"},"("),n(`
+		`),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),n(`
+		`),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"title"'),n(`
+		`),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"meta"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"note"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Put the title here"'),n(),s("span",{class:"hljs-punctuation"},"}"),n(", "),s("span",{class:"hljs-symbol"},"schema"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"default_value"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Hello World!"'),n(),s("span",{class:"hljs-punctuation"},"}"),n(),s("span",{class:"hljs-punctuation"},"}"),n(`
+	`),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Qn=s("hr",null,null,-1),In=s("h2",{id:"delete-a-field",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-a-field"},"#"),n(" Delete a Field")],-1),Ln=s("p",null,"Deletes the given field in the given collection.",-1),Fn=s("div",{class:"danger hint"},[s("div",{class:"hint-title"},"Destructive"),s("p",null,"Be aware, this will delete the column from the database, including all data in it. This action can’t be undone.")],-1),Gn=s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),n(" REST API")],-1),Cn=s("pre",null,[s("code",null,`DELETE /fields/:collection/:field
+`)],-1),On=s("h5",{id:"example-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-9"},"#"),n(" Example")],-1),Dn=s("pre",null,[s("code",null,`DELETE /fields/articles/title
+`)],-1),Hn=s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),n(" GraphQL")],-1),Mn=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Bn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	delete_fields_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` delete_field
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Nn=s("h5",{id:"example-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-10"},"#"),n(" Example")],-1),Wn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	delete_fields_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"title"'),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Kn="Fields",Xn=!1,Yn="REST and GraphQL API documentation on the Fields collection in Directus.",Zn="7 min read",$n="page-reference",sa={__name:"fields",setup(Un,{expose:o}){const l={title:"Fields",modularExtension:!1,description:"REST and GraphQL API documentation on the Fields collection in Directus.",readTime:"7 min read",pageClass:"page-reference"};return o({frontmatter:l}),(Vn,zn)=>{const t=e("router-link"),i=e("docs-wrapper");return h(),p(i,{frontmatter:l},{default:a(()=>[s("div",u,[s("blockquote",null,[s("p",null,[n("Fields are individual pieces of content within an item. They are mapped to columns in the database. "),c(t,{to:"/docs/getting-started/glossary#fields"},{default:a(()=>[n("Learn more about Fields")]),_:1}),n(".")])]),r,d,j,_,s("p",null,[f,n(),m,g,n(" The Directus data type of the field. See "),c(t,{to:"/docs/getting-started/glossary#types"},{default:a(()=>[n("Types")]),_:1}),n(" for possible options.")]),b,y,x,q,T,w,k,v,A,E,S,P,R,Q,I,L,F,G,C,O,D,H,M,B,N,W,U,V,z,J,K,X,Y,Z,$,ss,ns,as,ls,ts,es,cs,os,is,hs,ps,us,rs,ds,js,_s,fs,ms,gs,bs,ys,xs,qs,Ts,ws,ks,vs,As,Es,Ss,Ps,Rs,Qs,Is,Ls,Fs,Gs,Cs,Os,Ds,Hs,Ms,Bs,Ns,Ws,Us,Vs,zs,Js,Ks,Xs,Ys,Zs,$s,sn,nn,an,ln,tn,en,cn,on,hn,pn,un,rn,dn,jn,_n,fn,mn,gn,bn,yn,xn,qn,Tn,wn,kn,vn,An,En,Sn,Pn,Rn,Qn,In,Ln,Fn,Gn,Cn,On,Dn,Hn,Mn,Bn,Nn,Wn])]),_:1})}}};export{sa as default,Yn as description,Xn as modularExtension,$n as pageClass,Zn as readTime,Kn as title};

package/dist/assets/fields-8d5e2b83.js

@@ -0,0 +1 @@
+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-753bcc58.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’s 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(" — 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(" — 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(" — 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(" — Toggle field visibility on the Item Detail Page for Admin Users.")]),e("li",null,[e("a",{href:"#adjust-field-width"},"Width"),i(" — Fields have three different width options: "),e("ul",null,[e("li",null,[e("span",{mi:"",icon:""},"border_vertical"),i(" Half Width — The field input is shown at half the form width.")]),e("li",null,[e("span",{mi:"",icon:""},"border_right"),i(" Full Width — The default. The field input is shown at the full form width.")]),e("li",null,[e("span",{mi:"",icon:""},"aspect_ratio"),i(" Fill Width — 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(" — 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’s 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(" — Defines the database column schema for the field.")],-1),O=e("li",null,[e("strong",null,"Relationship"),i(" — Controls "),e("em",null,"and only appears when configuring relational"),i(" field details.")],-1),V=e("li",null,[e("strong",null,"Translations"),i(" — 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(" — Configures how you interact with the field’s values.")],-1),U=e("li",null,[e("strong",null,"Display"),i(" — Configures how field values are displayed in the Data Studio.")],-1),B=e("li",null,[e("strong",null,"Validation"),i(" — Creates a filter to determine valid user input.")],-1),E=e("li",null,[e("strong",null,"Conditions"),i(" — Alters the current field’s 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’d 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’s 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’s 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(" — 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(" — 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(" — 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(" — Create, view, and configure a collection’s 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(" — 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’s 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/file-library-ecfdd625.js

@@ -0,0 +1 @@
+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-753bcc58.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,"“Save”"),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,"“Import from URL”"),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(" – Saves any edits made to the file.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"tune"),l(" – 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(" – Downloads the file to your current device.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"drive_file_move"),l(" – Moves selected File(s) to another Folder.")]),e("li",null,[e("span",{mi:"",btn:"",dngr:""},"delete"),l(" – 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(" – A preview of the image or file.")]),e("li",null,[e("strong",null,"Title"),l(" – A title for the File.")]),e("li",null,[e("strong",null,"Description"),l(" – A description of the File.")]),e("li",null,[e("strong",null,"Tags"),l(" – Keywords used for search-ability.")]),e("li",null,[e("strong",null,"Location"),l(" – An optional location "),e("em",null,"(e.g. where a photo was taken)"),l(".")]),e("li",null,[e("strong",null,"Storage"),l(" – Which storage adapter is used to store the file asset.")]),e("li",null,[e("strong",null,"Filename (Disk)"),l(" – LOCKED. This is the actual name of the file in storage.")]),e("li",null,[e("strong",null,"Filename (Download)"),l(" – 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(" – The MIME type of the file, displayed in the App as a formatted media type.")]),e("li",null,[e("strong",null,"Dimensions"),l(" – "),e("em",null,"Images only"),l(". The width and height of the image in pixels.")]),e("li",null,[e("strong",null,"Size"),l(" – The file-size the asset takes up in the storage adapter.")]),e("li",null,[e("strong",null,"Created"),l(" – The timestamp of when the file was uploaded to the Project.")]),e("li",null,[e("strong",null,"Owner"),l(" – The User that uploaded the file to the Project.")]),e("li",null,[e("strong",null,"Modified"),l(" – The timestamp of when the file was last modified.")]),e("li",null,[e("strong",null,"Edited By"),l(" – The User that modified the File.")]),e("li",null,[e("strong",null,"Folder"),l(" – The current parent folder that contains the File.")]),e("li",null,[e("strong",null,"Metadata"),l(" – Metadata JSON dump of the File’s 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’t 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,"“Import from URL”"),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,"“Save”"),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 “Rename Folder”.")]),e("li",null,"Update the Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"“Save”"),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,"“Move to Folder”"),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,"“Save”"),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,"“Delete Folder”"),l(".")]),e("li",null,[l("Click "),e("strong",null,"“Delete”"),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’s 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};