@directus/app 9.15.1 → 9.17.0

package/dist/assets/collections.2fa0dd8e.js

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

package/dist/assets/collections.b7aafbfb.js

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

package/dist/assets/{commonlisp.afc36432.js → commonlisp.bea6c921.js}

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

package/dist/assets/conditions.281a6ed5.js

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