@directus/app 9.0.0-rc.96 → 9.0.0-rc.97

package/dist/assets/users.3a0ace4e.js

@@ -0,0 +1,237 @@
+import{r,p as h,q as i,w as a,B as s,t as l,P as e}from"./vendor.9bb37c18.js";const d={class:"markdown-body"},u={class:"two-up"},p={class:"left"},_=e("Directus Users are the individual accounts that let you authenticate into the API and App. Each user belongs to a Role which defines its granular Permissions. "),g=e("Learn more about Users"),f=e("."),m=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-user-object"},"The User Object")]),s("li",null,[s("a",{href:"#list-users"},"List Users")]),s("li",null,[s("a",{href:"#retrieve-a-user"},"Retrieve a User")]),s("li",null,[s("a",{href:"#retrieve-the-current-user"},"Retrieve the Current User")]),s("li",null,[s("a",{href:"#create-a-user"},"Create a User")]),s("li",null,[s("a",{href:"#create-multiple-users"},"Create Multiple Users")]),s("li",null,[s("a",{href:"#update-a-user"},"Update a User")]),s("li",null,[s("a",{href:"#update-multiple-users"},"Update Multiple Users")]),s("li",null,[s("a",{href:"#delete-a-user"},"Delete a User")]),s("li",null,[s("a",{href:"#delete-multiple-users"},"Delete Multiple Users")]),s("li",null,[s("a",{href:"#invite-a-new-user"},"Invite a new User")]),s("li",null,[s("a",{href:"#accept-user-invite"},"Accept User Invite")]),s("li",null,[s("a",{href:"#generate-two-factor-authentication-secret"},"Generate Two-Factor Authentication Secret")]),s("li",null,[s("a",{href:"#enable-two-factor-authentication"},"Enable Two-Factor Authentication")]),s("li",null,[s("a",{href:"#disable-two-factor-authentication"},"Disable Two-Factor Authentication")])])])])],-1),j=s("hr",null,null,-1),y=s("h2",{id:"the-user-object"},[e("The User Object "),s("a",{class:"header-anchor",href:"#the-user-object"},"#")],-1),b={class:"two-up"},q={class:"left"},v={class:"definitions"},w=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the user.")],-1),x=s("p",null,[s("code",null,"first_name"),e(),s("strong",null,"string"),s("br"),e(" First name of the user.")],-1),T=s("p",null,[s("code",null,"last_name"),e(),s("strong",null,"string"),s("br"),e(" Last name of the user.")],-1),E=s("p",null,[s("code",null,"email"),e(),s("strong",null,"string"),s("br"),e(" Email address of the user.")],-1),R=s("p",null,[s("code",null,"password"),e(),s("strong",null,"hash"),s("br"),e(" Password of the user.")],-1),S=s("p",null,[s("code",null,"location"),e(),s("strong",null,"string"),s("br"),e(" Location of the user.")],-1),P=s("p",null,[s("code",null,"title"),e(),s("strong",null,"string"),s("br"),e(" Title of the user.")],-1),k=s("p",null,[s("code",null,"description"),e(),s("strong",null,"string"),s("br"),e(" Description of the user.")],-1),A=s("p",null,[s("code",null,"tags"),e(),s("strong",null,"csv"),s("br"),e(" Tags for the user.")],-1),U=s("code",null,"avatar",-1),O=e(),L=s("strong",null,"many-to-one",-1),I=s("br",null,null,-1),C=e(" Avatar file. Many-to-one to "),Q=e("files"),D=e("."),G=s("p",null,[s("code",null,"language"),e(),s("strong",null,"string"),s("br"),e(" Language the Admin App is rendered in. See "),s("a",{href:"https://locales.directus.io",target:"_blank",rel:"noopener noreferrer"},"our Crowdin page"),e(" for all available languages and translations.")],-1),B=s("p",null,[s("code",null,"theme"),e(),s("strong",null,"string"),s("br"),e(" One of "),s("code",null,"auto"),e(", "),s("code",null,"light"),e(", "),s("code",null,"dark"),e(".")],-1),M=s("p",null,[s("code",null,"tfa_secret"),e(),s("strong",null,"string"),s("br"),e(" When TFA is enabled, this holds the")],-1),F=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
+	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"first_name"'),e(": "),s("span",{class:"hljs-string"},'"Admin"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"last_name"'),e(": "),s("span",{class:"hljs-string"},'"User"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"admin@example.com"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"**********"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"location"'),e(": "),s("span",{class:"hljs-string"},'"New York City"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"title"'),e(": "),s("span",{class:"hljs-string"},'"CTO"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"description"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
+	`),s("span",{class:"hljs-attr"},'"tags"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
+	`),s("span",{class:"hljs-attr"},'"avatar"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
+	`),s("span",{class:"hljs-attr"},'"language"'),e(": "),s("span",{class:"hljs-string"},'"en-US"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"theme"'),e(": "),s("span",{class:"hljs-string"},'"auto"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"tfa_secret"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
+	`),s("span",{class:"hljs-attr"},'"status"'),e(": "),s("span",{class:"hljs-string"},'"active"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"token"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
+	`),s("span",{class:"hljs-attr"},'"last_access"'),e(": "),s("span",{class:"hljs-string"},'"2021-02-05T10:18:13-05:00"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"last_page"'),e(": "),s("span",{class:"hljs-string"},'"/settings/roles/653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(`
+}
+`)])])],-1),H=s("hr",null,null,-1),N=s("h2",{id:"list-users"},[e("List Users "),s("a",{class:"header-anchor",href:"#list-users"},"#")],-1),V=s("p",null,"List all users that exist in Directus.",-1),W={class:"two-up"},Y={class:"left"},z=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),J=e("Supports all "),K=e("global query parameters"),X=e("."),Z=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),$=e("An array of up to "),ss=e("limit"),es=e(),as=s("a",{href:"#the-user-object"},"user objects",-1),ts=e(". If no items are available, data will be an empty array."),ls={class:"right"},ns=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),rs=s("pre",null,[s("code",null,`GET /users
+SEARCH /users
+`)],-1),cs=e("Learn more about SEARCH ->"),os=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),hs=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),is=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	users: [directus_users]
+}
+`)])],-1),ds=s("h5",{id:"example"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),us=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	users {
+		first_name
+		last_name
+		email
+	}
+}
+`)])],-1),ps=s("hr",null,null,-1),_s=s("h2",{id:"retrieve-a-user"},[e("Retrieve a User "),s("a",{class:"header-anchor",href:"#retrieve-a-user"},"#")],-1),gs=s("p",null,"List an existing user by primary key.",-1),fs={class:"two-up"},ms={class:"left"},js=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),ys=e("Supports all "),bs=e("global query parameters"),qs=e("."),vs=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ws=s("p",null,[e("Returns the requested "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),xs=s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`GET /users/:id
+`)]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",null,`GET /users/72a1ce24-4748-47de-a05f-ce9af3033727
+`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	users_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_users
+}
+`)])]),s("h5",{id:"example-3"},[e("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	users_by_id(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(`) {
+		first_name
+		last_name
+		email
+	}
+}
+`)])])],-1),Ts=s("hr",null,null,-1),Es=s("h2",{id:"retrieve-the-current-user"},[e("Retrieve the Current User "),s("a",{class:"header-anchor",href:"#retrieve-the-current-user"},"#")],-1),Rs=s("p",null,"Retrieve the currently authenticated user.",-1),Ss={class:"two-up"},Ps={class:"left"},ks=s("h3",{id:"query-parameters-3"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),As=e("Supports all "),Us=e("global query parameters"),Os=e("."),Ls=s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Is=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the currently authenticated user.")],-1),Cs=s("div",{class:"right"},[s("h3",{id:"rest-api-3"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`GET /users/me
+`)]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
+	users_me: directus_users
+}
+`)])]),s("h5",{id:"example-4"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
+	users_me {
+		email
+	}
+}
+`)])])],-1),Qs=s("hr",null,null,-1),Ds=s("h2",{id:"create-a-user"},[e("Create a User "),s("a",{class:"header-anchor",href:"#create-a-user"},"#")],-1),Gs=s("p",null,"Create a new user",-1),Bs={class:"two-up"},Ms={class:"left"},Fs=s("h3",{id:"query-parameters-4"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Hs=e("Supports all "),Ns=e("global query parameters"),Vs=e("."),Ws=s("h3",{id:"request-body"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ys=s("p",null,[e("A partial "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),zs=s("p",null,[s("code",null,"email"),e(" and "),s("code",null,"password"),e(" are required.")],-1),Js=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),Ks=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the created user.")],-1),Xs=s("div",{class:"right"},[s("h3",{id:"rest-api-4"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`POST /users
+`)]),s("h5",{id:"example-5"},[e("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"another@example.com"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
+}
+`)])]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	create_users_item(data: create_directus_users_input!): directus_users
+}
+`)])]),s("h5",{id:"example-6"},[e("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	create_users_item(
+		data: { email: `),s("span",{class:"hljs-string"},'"another@example.com"'),e(", password: "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(` }
+	) {
+		email
+		role
+	}
+}
+`)])])],-1),Zs=s("hr",null,null,-1),$s=s("h2",{id:"create-multiple-users"},[e("Create Multiple Users "),s("a",{class:"header-anchor",href:"#create-multiple-users"},"#")],-1),se=s("p",null,"Create multiple new users",-1),ee={class:"two-up"},ae={class:"left"},te=s("h3",{id:"query-parameters-5"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),le=e("Supports all "),ne=e("global query parameters"),re=e("."),ce=s("h3",{id:"request-body-2"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),oe=s("p",null,[e("An array of partial "),s("a",{href:"#the-user-object"},"user objects"),e(".")],-1),he=s("p",null,[s("code",null,"email"),e(" and "),s("code",null,"password"),e(" are required.")],-1),ie=s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),de=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user objects"),e(" for the created users.")],-1),ue=s("div",{class:"right"},[s("h3",{id:"rest-api-5"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",null,`POST /users
+`)]),s("h5",{id:"example-7"},[e("Example "),s("a",{class:"header-anchor",href:"#example-7"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users"),e(`
+
+[
+	{
+		`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"admin@example.com"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"p455w0rd"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
+	},
+	{
+		`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"another@example.com"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`,
+		`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
+	}
+]
+`)])]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	create_users_items(data: [create_directus_users_input!]!): [directus_users]
+}
+`)])]),s("h5",{id:"example-8"},[e("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	create_users_items(
+		data: [
+			{ email: `),s("span",{class:"hljs-string"},'"admin@example.com"'),e(", password: "),s("span",{class:"hljs-string"},'"p455w0rd"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(` }
+			{ email: `),s("span",{class:"hljs-string"},'"another@example.com"'),e(", password: "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(` }
+		]
+	) {
+		email
+		role
+	}
+}
+`)])])],-1),pe=s("hr",null,null,-1),_e=s("h2",{id:"update-a-user"},[e("Update a User "),s("a",{class:"header-anchor",href:"#update-a-user"},"#")],-1),ge=s("p",null,"Update an existing user.",-1),fe={class:"two-up"},me={class:"left"},je=s("h3",{id:"query-parameters-6"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),ye=e("Supports all "),be=e("global query parameters"),qe=e("."),ve=s("h3",{id:"request-body-3"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),we=s("p",null,[e("A partial "),s("a",{href:"#the-user-object"},"user object"),e(".")],-1),xe=s("h3",{id:"returns-6"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),Te=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user object"),e(" for the updated user.")],-1),Ee=s("div",{class:"right"},[s("h3",{id:"rest-api-6"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",null,`PATCH /users/:id
+`)]),s("h5",{id:"example-9"},[e("Example "),s("a",{class:"header-anchor",href:"#example-9"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /users/72a1ce24-4748-47de-a05f-ce9af3033727"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"title"'),e(": "),s("span",{class:"hljs-string"},'"CTO"'),e(`
+}
+`)])]),s("h3",{id:"graphql-6"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	update_users_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_users_input!): directus_users
+}
+`)])]),s("h5",{id:"example-10"},[e("Example "),s("a",{class:"header-anchor",href:"#example-10"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	update_users_item(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", data: { title: "),s("span",{class:"hljs-string"},'"CTO"'),e(` }) {
+		first_name
+		last_name
+	}
+}
+`)])])],-1),Re=s("hr",null,null,-1),Se=s("h2",{id:"update-multiple-users"},[e("Update Multiple Users "),s("a",{class:"header-anchor",href:"#update-multiple-users"},"#")],-1),Pe=s("p",null,"Update multiple existing users.",-1),ke={class:"two-up"},Ae={class:"left"},Ue=s("h3",{id:"query-parameters-7"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-7"},"#")],-1),Oe=e("Supports all "),Le=e("global query parameters"),Ie=e("."),Ce=s("h3",{id:"request-body-4"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Qe=s("div",{class:"definitions"},[s("p",null,[s("code",null,"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the users you\u2019d like to update.")]),s("p",null,[s("code",null,"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-user-object"},"the user object"),e("\u2019s properties.")])],-1),De=s("h3",{id:"returns-7"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-7"},"#")],-1),Ge=s("p",null,[e("Returns the "),s("a",{href:"#the-user-object"},"user objects"),e(" for the updated users.")],-1),Be=s("div",{class:"right"},[s("h3",{id:"rest-api-7"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",null,`PATCH /users
+`)]),s("h5",{id:"example-11"},[e("Example "),s("a",{class:"header-anchor",href:"#example-11"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /users"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"keys"'),e(": ["),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", "),s("span",{class:"hljs-string"},'"9c3d75a8-7a5f-41a4-be0a-1488fd974511"'),e(`],
+	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
+		`),s("span",{class:"hljs-attr"},'"title"'),e(": "),s("span",{class:"hljs-string"},'"CTO"'),e(`
+	}
+}
+`)])]),s("h3",{id:"graphql-7"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	update_users_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_users_input!): [directus_users]
+}
+`)])]),s("h5",{id:"example-12"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	update_users_items(
+		ids: [`),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", "),s("span",{class:"hljs-string"},'"9c3d75a8-7a5f-41a4-be0a-1488fd974511"'),e(`]
+		data: { title: `),s("span",{class:"hljs-string"},'"CTO"'),e(` }
+	) {
+		first_name
+		last_name
+	}
+}
+`)])])],-1),Me=s("hr",null,null,-1),Fe=s("h2",{id:"delete-a-user"},[e("Delete a User "),s("a",{class:"header-anchor",href:"#delete-a-user"},"#")],-1),He=s("p",null,"Delete an existing user.",-1),Ne=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-8"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-8"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-8"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),s("pre",null,[s("code",null,`DELETE /users/:id
+`)]),s("h5",{id:"example-13"},[e("Example "),s("a",{class:"header-anchor",href:"#example-13"},"#")]),s("pre",null,[s("code",null,`DELETE /users/72a1ce24-4748-47de-a05f-ce9af3033727
+`)]),s("h3",{id:"graphql-8"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-8"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	delete_users_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
+}
+`)])]),s("h5",{id:"example-14"},[e("Example "),s("a",{class:"header-anchor",href:"#example-14"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	delete_users_item(id: `),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(`) {
+		id
+	}
+}
+`)])])])],-1),Ve=s("hr",null,null,-1),We=s("h2",{id:"delete-multiple-users"},[e("Delete Multiple Users "),s("a",{class:"header-anchor",href:"#delete-multiple-users"},"#")],-1),Ye=s("p",null,"Delete multiple existing users.",-1),ze=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-5"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"An array of user primary keys"),s("h3",{id:"returns-9"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-9"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-9"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-9"},"#")]),s("pre",null,[s("code",null,`DELETE /users
+`)]),s("h5",{id:"example-15"},[e("Example "),s("a",{class:"header-anchor",href:"#example-15"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// Request"),e(`
+[`),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(", "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`]
+`)])]),s("h3",{id:"graphql-9"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-9"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	delete_users_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
+}
+`)])]),s("h5",{id:"example-16"},[e("Example "),s("a",{class:"header-anchor",href:"#example-16"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	delete_users_items(ids: [`),s("span",{class:"hljs-string"},'"72a1ce24-4748-47de-a05f-ce9af3033727"'),e(", "),s("span",{class:"hljs-string"},'"9c3d75a8-7a5f-41a4-be0a-1488fd974511"'),e(`]) {
+		ids
+	}
+}
+`)])])])],-1),Je=s("hr",null,null,-1),Ke=s("h2",{id:"invite-a-new-user"},[e("Invite a new User "),s("a",{class:"header-anchor",href:"#invite-a-new-user"},"#")],-1),Xe=s("p",null,"Invite a new user by email.",-1),Ze={class:"two-up"},$e={class:"left"},sa=s("h3",{id:"request-body-6"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-6"},"#")],-1),ea={class:"definitions"},aa=s("p",null,[s("code",null,"email"),e(),s("strong",null,"Required"),s("br"),e(" User email to invite.")],-1),ta=s("p",null,[s("code",null,"role"),e(),s("strong",null,"Required"),s("br"),e(" Role of the new user.")],-1),la=s("code",null,"invite_url",-1),na=s("br",null,null,-1),ra=e(" Provide a custom invite url which the link in the email will lead to. The invite token will be passed as a parameter."),ca=s("br",null,null,-1),oa=s("strong",null,"Note",-1),ha=e(": You need to configure the "),ia=s("code",null,"USER_INVITE_URL_ALLOW_LIST",-1),da=e(" environment variable"),ua=e(" to enable this feature."),pa=s("h3",{id:"returns-10"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-10"},"#")],-1),_a=s("p",null,"Empty body.",-1),ga=s("div",{class:"right"},[s("h3",{id:"rest-api-10"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-10"},"#")]),s("pre",null,[s("code",null,`POST /users/invite
+`)]),s("h5",{id:"example-17"},[e("Example "),s("a",{class:"header-anchor",href:"#example-17"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/invite"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"email"'),e(": "),s("span",{class:"hljs-string"},'"another@example.com"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"role"'),e(": "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`
+}
+`)])]),s("h3",{id:"graphql-10"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-10"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	users_invite(email:`),s("span",{class:"hljs-type"}," String"),e("!, role:"),s("span",{class:"hljs-type"}," String"),e("!, invite_url:"),s("span",{class:"hljs-type"}," String"),e("):"),s("span",{class:"hljs-type"}," Boolean"),e(`
+}
+`)])]),s("h5",{id:"example-18"},[e("Example "),s("a",{class:"header-anchor",href:"#example-18"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	users_invite(email: `),s("span",{class:"hljs-string"},'"another@example.com"'),e(", role: "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`)
+}
+`)])])],-1),fa=s("hr",null,null,-1),ma=s("h2",{id:"accept-user-invite"},[e("Accept User Invite "),s("a",{class:"header-anchor",href:"#accept-user-invite"},"#")],-1),ja=s("p",null,[e("Accept your invite. The "),s("a",{href:"#invite-a-new-user"},"invite user endpoint"),e(" sends the email a link to the Admin App.")],-1),ya=s("p",null,"This link includes a token, which is then used to activate the invited user.",-1),ba=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-7"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-7"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"token"),e(),s("strong",null,"Required"),s("br"),e(" Accept invite token.")]),s("p",null,[s("code",null,"password"),e(),s("strong",null,"Required"),s("br"),e(" Password for the user.")])]),s("h3",{id:"returns-11"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-11"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-11"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-11"},"#")]),s("pre",null,[s("code",null,`POST /users/invite/accept
+`)]),s("h5",{id:"example-19"},[e("Example "),s("a",{class:"header-anchor",href:"#example-19"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/invite/accept"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"token"'),e(": "),s("span",{class:"hljs-string"},'"eyJh...KmUk"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`
+}
+`)])]),s("h3",{id:"graphql-11"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-11"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	users_invite_accept(token:`),s("span",{class:"hljs-type"}," String"),e("!, password:"),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
+}
+`)])]),s("h5",{id:"example-20"},[e("Example "),s("a",{class:"header-anchor",href:"#example-20"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	users_invite_accept(token: `),s("span",{class:"hljs-string"},'"eyJh...KmUk"'),e(", password: "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`)
+}
+`)])])])],-1),qa=s("hr",null,null,-1),va=s("h2",{id:"generate-two-factor-authentication-secret"},[e("Generate Two-Factor Authentication Secret "),s("a",{class:"header-anchor",href:"#generate-two-factor-authentication-secret"},"#")],-1),wa=s("p",null,"Generates a secret and returns the URL to be used in an authenticator app.",-1),xa=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-8"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-8"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"password"),e(),s("strong",null,"Required"),s("br"),e(" The user\u2019s password.")])]),s("h3",{id:"returns-12"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-12"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"secret"),e(),s("strong",null,"string"),s("br"),e(" OTP secret to be saved in the authenticator app.")]),s("p",null,[s("code",null,"otpauth_url"),e(),s("strong",null,"string"),s("br"),s("code",null,"otpauth://"),e(" formatted URL. Can be rendered as QR code and used in most authenticator apps.")])])]),s("div",{class:"right"},[s("h3",{id:"rest-api-12"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-12"},"#")]),s("pre",null,[s("code",null,`POST /users/me/tfa/generate
+`)]),s("h5",{id:"example-21"},[e("Example "),s("a",{class:"header-anchor",href:"#example-21"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/me/tfa/generate"),e(`
+{
+	`),s("span",{class:"hljs-attr"},'"password"'),e(": "),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`
+}
+`)])]),s("h3",{id:"graphql-12"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-12"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	users_me_tfa_generate(password:`),s("span",{class:"hljs-type"}," String"),e(`!): users_me_tfa_generate_data
+}
+`)])]),s("h5",{id:"example-22"},[e("Example "),s("a",{class:"header-anchor",href:"#example-22"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	users_me_tfa_generate(password: `),s("span",{class:"hljs-string"},'"d1r3ctu5"'),e(`) {
+		secret
+		otpauth_url
+	}
+}
+`)])])])],-1),Ta=s("hr",null,null,-1),Ea=s("h2",{id:"enable-two-factor-authentication"},[e("Enable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#enable-two-factor-authentication"},"#")],-1),Ra=s("p",null,"Adds a TFA secret to the user account.",-1),Sa=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-9"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-9"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"secret"),e(),s("strong",null,"Required"),s("br"),e(" The TFA secret from tfa/generate.")]),s("p",null,[s("code",null,"otp"),e(),s("strong",null,"Required"),s("br"),e(" OTP generated with the secret, to recheck if the user has a correct TFA setup")])]),s("h3",{id:"returns-13"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-13"},"#")]),s("div",{class:"definitions"},[s("p",null,"Empty response.")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-13"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-13"},"#")]),s("pre",null,[s("code",null,`POST /users/me/tfa/enable
+`)]),s("h5",{id:"example-23"},[e("Example "),s("a",{class:"header-anchor",href:"#example-23"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/me/tfa/enable"),e(`
+{
+	`),s("span",{class:"hljs-attr"},'"otp"'),e(": "),s("span",{class:"hljs-string"},'"123456"'),e(`,
+	`),s("span",{class:"hljs-attr"},'"secret"'),e(": "),s("span",{class:"hljs-string"},'"3CtiutsNBmY3szHE"'),e(`
+}
+`)])]),s("h3",{id:"graphql-13"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-13"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	users_me_tfa_enable(otp:`),s("span",{class:"hljs-type"}," String"),e("!, secret:"),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
+}
+`)])]),s("h5",{id:"example-24"},[e("Example "),s("a",{class:"header-anchor",href:"#example-24"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	users_me_tfa_enable(otp: `),s("span",{class:"hljs-string"},'"123456"'),e(", secret: "),s("span",{class:"hljs-string"},'"3CtiutsNBmY3szHE"'),e(`)
+}
+`)])])])],-1),Pa=s("hr",null,null,-1),ka=s("h2",{id:"disable-two-factor-authentication"},[e("Disable Two-Factor Authentication "),s("a",{class:"header-anchor",href:"#disable-two-factor-authentication"},"#")],-1),Aa=s("p",null,"Disables two-factor authentication by removing the OTP secret from the user.",-1),Ua=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-10"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-10"},"#")]),s("div",{class:"definitions"},[s("p",null,[s("code",null,"otp"),e(),s("strong",null,"Required"),s("br"),e(" One-time password generated by the authenticator app.")])]),s("h3",{id:"returns-14"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-14"},"#")]),s("p",null,"Empty response.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-14"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-14"},"#")]),s("pre",null,[s("code",null,`POST /users/me/tfa/disable
+`)]),s("h5",{id:"example-25"},[e("Example "),s("a",{class:"header-anchor",href:"#example-25"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /users/me/tfa/disable"),e(`
+
+{
+	`),s("span",{class:"hljs-attr"},'"otp"'),e(": "),s("span",{class:"hljs-string"},'"859014"'),e(`
+}
+`)])]),s("h3",{id:"graphql-14"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-14"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
+`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
+	users_me_tfa_disable(otp:`),s("span",{class:"hljs-type"}," String"),e("!):"),s("span",{class:"hljs-type"}," Boolean"),e(`
+}
+`)])]),s("h5",{id:"example-26"},[e("Example "),s("a",{class:"header-anchor",href:"#example-26"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
+	users_me_tfa_disable(otp: `),s("span",{class:"hljs-string"},'"591763"'),e(`)
+}
+`)])])])],-1),Qa={setup(Oa,{expose:c}){const n={title:"Users",modularExtension:!1,pageClass:"page-reference"};return c({frontmatter:n}),(La,Ia)=>{const t=r("router-link"),o=r("DocsWrapper");return h(),i(o,{frontmatter:n},{default:a(()=>[s("div",d,[s("div",u,[s("div",p,[s("blockquote",null,[s("p",null,[_,l(t,{to:"/docs/concepts/users/"},{default:a(()=>[g]),_:1}),f])])]),m]),j,y,s("div",b,[s("div",q,[s("div",v,[w,x,T,E,R,S,P,k,A,s("p",null,[U,O,L,I,C,l(t,{to:"/docs/reference/api/system/files/"},{default:a(()=>[Q]),_:1}),D]),G,B,M])]),F]),H,N,V,s("div",W,[s("div",Y,[z,s("p",null,[J,l(t,{to:"/docs/reference/api/query"},{default:a(()=>[K]),_:1}),X]),Z,s("p",null,[$,l(t,{to:"/docs/reference/api/query/#limit"},{default:a(()=>[ss]),_:1}),es,as,ts])]),s("div",ls,[ns,rs,s("p",null,[l(t,{to:"/docs/reference/api/introduction/#search-http-method"},{default:a(()=>[cs]),_:1})]),os,hs,is,ds,us])]),ps,_s,gs,s("div",fs,[s("div",ms,[js,s("p",null,[ys,l(t,{to:"/docs/reference/api/query"},{default:a(()=>[bs]),_:1}),qs]),vs,ws]),xs]),Ts,Es,Rs,s("div",Ss,[s("div",Ps,[ks,s("p",null,[As,l(t,{to:"/docs/reference/api/query"},{default:a(()=>[Us]),_:1}),Os]),Ls,Is]),Cs]),Qs,Ds,Gs,s("div",Bs,[s("div",Ms,[Fs,s("p",null,[Hs,l(t,{to:"/docs/reference/api/query"},{default:a(()=>[Ns]),_:1}),Vs]),Ws,Ys,zs,Js,Ks]),Xs]),Zs,$s,se,s("div",ee,[s("div",ae,[te,s("p",null,[le,l(t,{to:"/docs/reference/api/query"},{default:a(()=>[ne]),_:1}),re]),ce,oe,he,ie,de]),ue]),pe,_e,ge,s("div",fe,[s("div",me,[je,s("p",null,[ye,l(t,{to:"/docs/reference/api/query"},{default:a(()=>[be]),_:1}),qe]),ve,we,xe,Te]),Ee]),Re,Se,Pe,s("div",ke,[s("div",Ae,[Ue,s("p",null,[Oe,l(t,{to:"/docs/reference/api/query"},{default:a(()=>[Le]),_:1}),Ie]),Ce,Qe,De,Ge]),Be]),Me,Fe,He,Ne,Ve,We,Ye,ze,Je,Ke,Xe,s("div",Ze,[s("div",$e,[sa,s("div",ea,[aa,ta,s("p",null,[la,na,ra,ca,oa,ha,l(t,{to:"/docs/reference/environment-variables/#security"},{default:a(()=>[ia,da]),_:1}),ua])]),pa,_a]),ga]),fa,ma,ja,ya,ba,qa,va,wa,xa,Ta,Ea,Ra,Sa,Pa,ka,Aa,Ua])]),_:1})}}};export{Qa as default};

package/dist/assets/users.4e727d89.js

@@ -0,0 +1 @@
+import{r as o,p as c,q as h,w as s,B as e,t as i,P as t}from"./vendor.9bb37c18.js";const u={class:"markdown-body"},d=t("Users are the individual accounts for authenticating into the API and App. Each user belongs to a Role which defines its Permissions. "),_=t("Learn more about Users"),g=t("."),p=e("h2",{id:"creating-a-user"},[t("Creating a User "),e("a",{class:"header-anchor",href:"#creating-a-user"},"#")],-1),f=e("ol",null,[e("li",null,[t("Navigate to the "),e("strong",null,"User Library")]),e("li",null,[t("Click the "),e("strong",null,"Create User"),t(" action button in the header")]),e("li",null,[t("Enter an "),e("strong",null,"Email Address")]),e("li",null,[t("Optional: Complete the "),e("strong",null,"other user form fields")])],-1),v=e("h2",{id:"inviting-a-user"},[t("Inviting a User "),e("a",{class:"header-anchor",href:"#inviting-a-user"},"#")],-1),m=e("ol",null,[e("li",null,[t("Navigate to the "),e("strong",null,"User Library")]),e("li",null,[t("Click the "),e("strong",null,"Invite Users"),t(" button in the header")]),e("li",null,[t("Enter "),e("strong",null,"one or more email addresses"),t(", separated by new lines, in the modal")]),e("li",null,[t("Click "),e("strong",null,"Invite")])],-1),b=e("p",null,"At this point the invited user(s) will receive an email with a link to the App where they set a password and enable their account.",-1),A=e("h2",{id:"configuring-a-user"},[t("Configuring a User "),e("a",{class:"header-anchor",href:"#configuring-a-user"},"#")],-1),U=e("li",null,[t("Navigate to the "),e("strong",null,"User Library")],-1),y=e("li",null,[e("strong",null,"Click on the user"),t(" you wish to manage")],-1),k=e("strong",null,"Complete the form",-1),w=t(" of "),C=t("User Fields"),I=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"User Preferences"),e("p",null,"This section of the User Detail is only visible/editable by the current user, and admins.")],-1),P=e("h4",{id:"status"},[t("Status "),e("a",{class:"header-anchor",href:"#status"},"#")],-1),D=e("p",null,[t("The User\u2019s Status determines if an account is able to access the platform or not. Only the "),e("code",null,"active"),t(" state is able to authenticate, all others are simply descriptive inactive states.")],-1),N=e("ul",null,[e("li",null,[e("strong",null,"Draft"),t(" \u2014 An incomplete user; no App/API access")]),e("li",null,[e("strong",null,"Invited"),t(" \u2014 Has a pending invite to the project; no App/API access until accepted")]),e("li",null,[e("strong",null,"Active"),t(" \u2014 The only status that has proper access to the App and API")]),e("li",null,[e("strong",null,"Suspended"),t(" \u2014 A user that has been temporarily disabled; no App/API access")]),e("li",null,[e("strong",null,"Archived"),t(" \u2014 A soft-deleted user; no App/API access")])],-1),L=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Admin Only"),e("p",null,"Only admins can adjust this field\u2019s value.")],-1),O=e("h4",{id:"role"},[t("Role "),e("a",{class:"header-anchor",href:"#role"},"#")],-1),S=e("p",null,[t("Setting the user\u2019s role determines their access, permissions, and App presentation. You can adjust a user\u2019s role from the User Detail page, or from the "),e("em",null,"Users in Role"),t(" field within "),e("strong",null,"Settings > Roles & Permissions > [Role Name]"),t(".")],-1),T=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Admin Only"),e("p",null,"Only admins can adjust this field\u2019s value.")],-1),j=e("h4",{id:"token"},[t("Token "),e("a",{class:"header-anchor",href:"#token"},"#")],-1),x=t("A user\u2019s token is an alternate way to "),E=t("authenticate into the API"),R=t(" using a static string. When NULL, the token is disabled. When enabled, ensure that a secure string is used."),B=e("h2",{id:"archiving-a-user"},[t("Archiving a User "),e("a",{class:"header-anchor",href:"#archiving-a-user"},"#")],-1),W=e("ol",null,[e("li",null,[t("Navigate to the "),e("strong",null,"User Library")]),e("li",null,"Click the user you with to archive to go to their User Detail page"),e("li",null,[t("Click the orange "),e("strong",null,"Archive User"),t(" action button in the header")]),e("li",null,[t("Confirm this decision by clicking "),e("strong",null,"Archive"),t(" in the dialog")])],-1),V=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Disables Access"),e("p",null,[t("Archiving uses "),e("em",null,"soft-delete"),t(", therefore archived users are unable to access the App or API.")])],-1),q=e("h2",{id:"deleting-a-user"},[t("Deleting a User "),e("a",{class:"header-anchor",href:"#deleting-a-user"},"#")],-1),F=e("ol",null,[e("li",null,[t("Navigate to the "),e("strong",null,"User Library")]),e("li",null,"Select one or more users you wish to delete"),e("li",null,[t("Click the red "),e("strong",null,"Delete User"),t(" action button in the header")]),e("li",null,[t("Confirm this decision by clicking "),e("strong",null,"Delete"),t(" in the dialog")])],-1),H=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"Unlike the soft-delete of archiving, this process is a hard-delete. Therefore, this action is permanent and can not be undone. Please proceed with caution.")],-1),K={setup(Y,{expose:a}){const l={title:"Users",modularExtension:!1};return a({frontmatter:l}),(z,G)=>{const n=o("router-link"),r=o("DocsWrapper");return c(),h(r,{frontmatter:l},{default:s(()=>[e("div",u,[e("blockquote",null,[e("p",null,[d,i(n,{to:"/docs/concepts/users/"},{default:s(()=>[_]),_:1}),g])]),p,f,v,m,b,A,e("ol",null,[U,y,e("li",null,[k,w,i(n,{to:"/docs/concepts/application/#user-detail"},{default:s(()=>[C]),_:1})])]),I,P,D,N,L,O,S,T,j,e("p",null,[x,i(n,{to:"/docs/reference/api/authentication"},{default:s(()=>[E]),_:1}),R]),B,W,V,q,F,H])]),_:1})}}};export{K as default};

package/dist/assets/users.5ec636fa.js

@@ -0,0 +1 @@
+import{r as i,p as u,q as d,w as t,B as e,t as n,P as s}from"./vendor.9bb37c18.js";const c={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"Directus Users are the individual accounts that let you authenticate into the API and App. Each user belongs to a Role which defines its granular Permissions.")],-1),g=s("To use the App or API, you\u2019ll need a valid Directus User. Each user is assigned to a "),_=s("Role"),f=s(" that determines what they have access to see and do. This means that the experience of users may vary significantly depending on their role\u2019s access. For example, while some users may see "),p=e("em",null,"all",-1),m=s(" platform content, others may only see a smaller subset of Modules, Collections, or Fields."),y=e("h4",{id:"relevant-guides"},[s("Relevant Guides "),e("a",{class:"header-anchor",href:"#relevant-guides"},"#")],-1),A=s("Setting up your User Profile"),w=s("Creating a User"),T=s("Inviting a User"),U=s("Configuring a User"),v=s("Archiving a User"),b=s("Deleting a User"),D=e("h2",{id:"user-fields"},[s("User Fields "),e("a",{class:"header-anchor",href:"#user-fields"},"#")],-1),P=s("Directus ships with a basic set of user fields that are displayed on the User Detail pages. While these system fields are required/locked, you can extend the Directus Users Collection with any number of custom fields to create a fully tailored "),k=s("User Directory"),x=s(". To add fields within system collections, simply follow the normal guide for "),C=s("Creating a Field"),F=s("."),I=e("p",null,"Below are the system User fields included by default.",-1),L=e("ul",null,[e("li",null,[e("strong",null,"First Name"),s(" \u2014 The user\u2019s given name")]),e("li",null,[e("strong",null,"Last Name"),s(" \u2014 The user\u2019s family name")]),e("li",null,[e("strong",null,"Email"),s(" \u2014 The user\u2019s email address used for login/authenticating and email updates")]),e("li",null,[e("strong",null,"Password"),s(" \u2014 The private string used for login/authenticating (stored as a secure hash)")]),e("li",null,[e("strong",null,"Avatar"),s(" \u2014 An image displayed throughout the App that represents the user")]),e("li",null,[e("strong",null,"Location"),s(" \u2014 Can be used for the user\u2019s city, country, office name, etc")]),e("li",null,[e("strong",null,"Title"),s(" \u2014 The name of the position the user holds at their company or organization")]),e("li",null,[e("strong",null,"Description"),s(" \u2014 A description or bio of the user")]),e("li",null,[e("strong",null,"Tags"),s(" \u2014 A set of keywords useful when searching within the User Directory")]),e("li",null,[e("strong",null,"Language"),s(" \u2014 (User Preference) The language to use for this user\u2019s App language")]),e("li",null,[e("strong",null,"Theme"),s(" \u2014 (User Preference) Light, Dark, or Auto (based on the user\u2019s OS preferences)")]),e("li",null,[e("strong",null,"Two-Factor Auth"),s(" \u2014 (User Preference) Enables authenticating with 2FA")]),e("li",null,[e("strong",null,"Status"),s(" \u2014 (Admin Only) Determines if the user is active within the App/API")]),e("li",null,[e("strong",null,"Role"),s(" \u2014 (Admin Only) The user\u2019s role determines their permissions and access")]),e("li",null,[e("strong",null,"Token"),s(" \u2014 (Admin Only) A static string used for authenticating within the API")])],-1),B=e("p",null,"The sidebar\u2019s info component also includes the following readonly details:",-1),E=e("ul",null,[e("li",null,[e("strong",null,"User Key"),s(" \u2014 The primary key of the user")]),e("li",null,[e("strong",null,"Last Page"),s(" \u2014 The last App page accessed by the user")]),e("li",null,[e("strong",null,"Last Access"),s(" \u2014 The timestamp of the user\u2019s last App or API action")])],-1),S={setup(N,{expose:r}){const o={title:"Users",modularExtension:!1};return r({frontmatter:o}),(O,R)=>{const l=i("router-link"),a=i("DocsWrapper");return u(),d(a,{frontmatter:o},{default:t(()=>[e("div",c,[h,e("p",null,[g,n(l,{to:"/docs/concepts/roles/"},{default:t(()=>[_]),_:1}),f,p,m]),y,e("ul",null,[e("li",null,[n(l,{to:"/docs/guides/users/#setting-up-your-user-profile"},{default:t(()=>[A]),_:1})]),e("li",null,[n(l,{to:"/docs/guides/users/#creating-a-user"},{default:t(()=>[w]),_:1})]),e("li",null,[n(l,{to:"/docs/guides/users/#inviting-a-user"},{default:t(()=>[T]),_:1})]),e("li",null,[n(l,{to:"/docs/guides/users/#configuring-a-user"},{default:t(()=>[U]),_:1})]),e("li",null,[n(l,{to:"/docs/guides/users/#archiving-a-user"},{default:t(()=>[v]),_:1})]),e("li",null,[n(l,{to:"/docs/guides/users/#deleting-a-user"},{default:t(()=>[b]),_:1})])]),D,e("p",null,[P,n(l,{to:"/docs/concepts/application/#user-directory"},{default:t(()=>[k]),_:1}),x,n(l,{to:"/docs/guides/fields/#creating-a-field"},{default:t(()=>[C]),_:1}),F]),I,L,B,E])]),_:1})}}};export{S as default};

package/dist/assets/utilities.2cc2aaed.js

@@ -0,0 +1,60 @@
+import{r,p as i,q as c,w as a,B as e,t,P as s}from"./vendor.9bb37c18.js";const d={class:"markdown-body"},u=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Utilities are the various helper endpoints located within the API.")])]),e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#generate-a-hash"},"Generate a Hash")]),e("li",null,[e("a",{href:"#verify-a-hash"},"Verify a Hash")]),e("li",null,[e("a",{href:"#manually-sort-items-in-collection"},"Manually Sort Items in Collection")]),e("li",null,[e("a",{href:"#import-data-from-file"},"Import Data from File")]),e("li",null,[e("a",{href:"#clear-the-internal-cache"},"Clear the Internal Cache")])])])])])],-1),p=e("hr",null,null,-1),_=e("h2",{id:"generate-a-hash"},[s("Generate a Hash "),e("a",{class:"header-anchor",href:"#generate-a-hash"},"#")],-1),f=e("p",null,"Generate a hash for a given string.",-1),m=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"string"),s(),e("strong",null,"Required"),e("br"),s(" String to hash.")])]),e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")]),e("p",null,"Hashed string.")]),e("div",{class:"right"},[e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")]),e("pre",null,[e("code",null,`POST /utils/hash/generate
+`)]),e("h5",{id:"example"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /utils/hash/generate"),s(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"string"'),s(": "),e("span",{class:"hljs-string"},'"Hello World!"'),s(`
+}
+`)])]),e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	utils_hash_generate(string:`),e("span",{class:"hljs-type"}," String"),s("!):"),e("span",{class:"hljs-type"}," String"),s(`
+}
+`)])]),e("h5",{id:"example-2"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	utils_hash_generate(string: `),e("span",{class:"hljs-string"},'"Hello World!"'),s(`)
+}
+`)])])])],-1),g=e("hr",null,null,-1),y=e("h2",{id:"verify-a-hash"},[s("Verify a Hash "),e("a",{class:"header-anchor",href:"#verify-a-hash"},"#")],-1),q=e("p",null,"Verify a string with a hash.",-1),j=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"string"),s(),e("strong",null,"Required"),e("br"),s(" Source string.")]),e("p",null,[e("code",null,"hash"),s(),e("strong",null,"Required"),e("br"),s(" Hash you want to verify against.")])]),e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")]),e("p",null,"Boolean.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`POST /utils/hash/verify
+`)]),e("h5",{id:"example-3"},[s("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /utils/hash/verify"),s(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"string"'),s(": "),e("span",{class:"hljs-string"},'"Hello World!"'),s(`,
+	`),e("span",{class:"hljs-attr"},'"hash"'),s(": "),e("span",{class:"hljs-string"},'"$arg...fEfM"'),s(`
+}
+`)])]),e("h3",{id:"graphql-2"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	utils_hash_verify(hash:`),e("span",{class:"hljs-type"}," String"),s("!, string:"),e("span",{class:"hljs-type"}," String"),s("!):"),e("span",{class:"hljs-type"}," Boolean"),s(`
+}
+`)])])])],-1),v=e("hr",null,null,-1),b=e("h2",{id:"manually-sort-items-in-collection"},[s("Manually Sort Items in Collection "),e("a",{class:"header-anchor",href:"#manually-sort-items-in-collection"},"#")],-1),A=e("p",null,"If a collection has a sort field, this util can be used to move items in that manual order.",-1),S=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-3"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"item"),s(),e("strong",null,"Required"),e("br"),s(" Primary key of the item you\u2019re moving in the collection.")]),e("p",null,[e("code",null,"to"),s(),e("strong",null,"Required"),e("br"),s(" Primary key of the item you\u2019re moving the source item too.")])]),e("h3",{id:"returns-3"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /utils/sort/:collection
+`)]),e("h5",{id:"example-4"},[s("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /utils/sort/articles"),s(`
+
+{
+	`),e("span",{class:"hljs-attr"},'"item"'),s(": "),e("span",{class:"hljs-number"},"16"),s(`,
+	`),e("span",{class:"hljs-attr"},'"to"'),s(": "),e("span",{class:"hljs-number"},"51"),s(`
+}
+`)])]),e("h3",{id:"graphql-3"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
+`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
+	utils_sort(collection:`),e("span",{class:"hljs-type"}," String"),s("!, item:"),e("span",{class:"hljs-literal"}," ID"),s("!, to:"),e("span",{class:"hljs-literal"}," ID"),s("!):"),e("span",{class:"hljs-type"}," Boolean"),s(`
+}
+`)])]),e("h5",{id:"example-5"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	utils_sort(collection: `),e("span",{class:"hljs-string"},'"articles"'),s(", item: "),e("span",{class:"hljs-number"},"16"),s(", to: "),e("span",{class:"hljs-number"},"51"),s(`)
+}
+`)])])])],-1),x=e("hr",null,null,-1),E=e("h2",{id:"import-data-from-file"},[s("Import Data from File "),e("a",{class:"header-anchor",href:"#import-data-from-file"},"#")],-1),R=s("Import multiple records from a JSON or CSV file into a collection. Relies on a "),T=e("code",null,"multipart/form-data",-1),C=s(" encoded request, just like regular file uploads. Check "),P=s("Upload a File"),w=s(" for more information."),k=s("The import endpoint expects the file structure to match "),I=s("the export query parameter"),O=s(". For JSON, this is an array of objects, where every object is an item. For CSV, the first line has to be the columns header."),B={class:"two-up"},F={class:"left"},M=e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),D=s("Send the file in a "),H=e("code",null,"multipart/form-data",-1),G=s(" request. See "),V=s("Upload a File"),N=s(" for more information."),U=e("h3",{id:"returns-4"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),L=e("p",null,"Empty body.",-1),Q=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`POST /utils/import/:collection
+`)]),e("h5",{id:"example-6"},[s("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",null,`POST /utils/import/articles
+
+Content-Type: multipart/form-data; charset=utf-8; boundary=__X_BOUNDARY__
+Content-Length: 3442422
+
+--__X_BOUNDARY__
+Content-Disposition: form-data; name="file"; filename="articles.csv"
+Content-Type: text/csv
+
+"id","title","another","created_by"
+1,"My First Articled","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
+2,"My Second Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
+3,"My Updated Third Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
+4,"My Fourth Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
+5,"My Fifth Article","abc","506385A2-E444-4AE2-A860-F00957A62C8A"
+...
+`)]),e("h3",{id:"graphql-4"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("p",null,"n/a")],-1),W=e("hr",null,null,-1),J=e("h2",{id:"clear-the-internal-cache"},[s("Clear the Internal Cache "),e("a",{class:"header-anchor",href:"#clear-the-internal-cache"},"#")],-1),X=e("p",null,"Resets both the data and schema cache of Directus. This endpoint is only available to admin users.",-1),Y=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-5"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-5"},"#")]),e("p",null,"n/a"),e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")]),e("p",null,"Empty body")]),e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`POST /utils/cache/clear
+`)]),e("h3",{id:"graphql-5"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
+	utils_cache_clear
+}
+`)])])])],-1),ee={setup($,{expose:o}){const n={title:"Utilities",modularExtension:!1,pageClass:"page-reference"};return o({frontmatter:n}),(z,K)=>{const l=r("router-link"),h=r("DocsWrapper");return i(),c(h,{frontmatter:n},{default:a(()=>[e("div",d,[u,p,_,f,m,g,y,q,j,v,b,A,S,x,E,e("p",null,[R,T,C,t(l,{to:"/docs/reference/api/system/files/#upload-a-file"},{default:a(()=>[P]),_:1}),w]),e("p",null,[k,t(l,{to:"/docs/reference/api/query/#export"},{default:a(()=>[I]),_:1}),O]),e("div",B,[e("div",F,[M,e("p",null,[D,H,G,t(l,{to:"/docs/reference/api/system/files/#upload-a-file"},{default:a(()=>[V]),_:1}),N]),U,L]),Q]),W,J,X,Y])]),_:1})}}};export{ee as default};

package/dist/assets/v-avatar.367102a1.js

@@ -0,0 +1,10 @@
+import{r as t,p as r,q as o,w as c,B as l,P as a}from"./vendor.9bb37c18.js";const u=l("div",{class:"markdown-body"},[l("p",null,"The avatar component can be used to display a person or something similar. It will generate a grey box in which either a profile picture or an icon or text can be inserted."),l("pre",null,[l("code",{class:"language-html"},[l("span",{class:"hljs-tag"},[a("<"),l("span",{class:"hljs-name"},"v-avatar"),a(">")]),a("RVZ"),l("span",{class:"hljs-tag"},[a("</"),l("span",{class:"hljs-name"},"v-avatar"),a(">")]),a(`
+
+`),l("span",{class:"hljs-tag"},[a("<"),l("span",{class:"hljs-name"},"v-avatar"),a(">")]),a(`
+	`),l("span",{class:"hljs-tag"},[a("<"),l("span",{class:"hljs-name"},"img"),a(),l("span",{class:"hljs-attr"},"src"),a("="),l("span",{class:"hljs-string"},'"..."'),a(" />")]),a(`
+`),l("span",{class:"hljs-tag"},[a("</"),l("span",{class:"hljs-name"},"v-avatar"),a(">")]),a(`
+
+`),l("span",{class:"hljs-tag"},[a("<"),l("span",{class:"hljs-name"},"v-avatar"),a(">")]),a(`
+	`),l("span",{class:"hljs-tag"},[a("<"),l("span",{class:"hljs-name"},"v-icon"),a(),l("span",{class:"hljs-attr"},"name"),a("="),l("span",{class:"hljs-string"},'"person"'),a(" />")]),a(`
+`),l("span",{class:"hljs-tag"},[a("</"),l("span",{class:"hljs-name"},"v-avatar"),a(">")]),a(`
+`)])]),l("h2",{id:"reference"},[a("Reference "),l("a",{class:"header-anchor",href:"#reference"},"#")]),l("h4",{id:"props"},[a("Props "),l("a",{class:"header-anchor",href:"#props"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Prop"),l("th",null,"Description"),l("th",null,"Default"),l("th",null,"Type")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"size")]),l("td",null,"Size in px"),l("td",null,[l("code",null,"null")]),l("td",null,[l("code",null,"Number")])]),l("tr",null,[l("td",null,[l("code",null,"tile")]),l("td",null,"Render as a tile (square)"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])])])]),l("h4",{id:"slots"},[a("Slots "),l("a",{class:"header-anchor",href:"#slots"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Slot"),l("th",null,"Description"),l("th",null,"Data")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("em",null,"default")]),l("td",null,"Default slot to display your elements inside the avatar"),l("td",null,"\u2013")])])]),l("h4",{id:"events"},[a("Events "),l("a",{class:"header-anchor",href:"#events"},"#")]),l("p",null,"n/a"),l("h4",{id:"css-variables"},[a("CSS Variables "),l("a",{class:"header-anchor",href:"#css-variables"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Default")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"--v-avatar-color")]),l("td",null,[l("code",null,"var(--background-normal)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-avatar-size")]),l("td",null,[l("code",null,"48px")])])])])],-1),v={setup(h,{expose:n}){const s={title:"Avatar",modularExtension:!1};return n({frontmatter:s}),(d,p)=>{const e=t("DocsWrapper");return r(),o(e,{frontmatter:s},{default:c(()=>[u]),_:1})}}};export{v as default};

package/dist/assets/v-badge.db55f316.js

@@ -0,0 +1,5 @@
+import{r as s,p as o,q as d,w as u,B as l,P as n}from"./vendor.9bb37c18.js";const c=l("div",{class:"markdown-body"},[l("p",null,"Display a small dot in the corner of the component."),l("pre",null,[l("code",{class:"language-html"},[l("span",{class:"hljs-tag"},[n("<"),l("span",{class:"hljs-name"},"v-badge"),n(),l("span",{class:"hljs-attr"},"value"),n("="),l("span",{class:"hljs-string"},'"2"'),n(">")]),l("span",{class:"hljs-tag"},[n("<"),l("span",{class:"hljs-name"},"v-icon"),n(">")]),n("ABC"),l("span",{class:"hljs-tag"},[n("</"),l("span",{class:"hljs-name"},"v-icon"),n(">")]),l("span",{class:"hljs-tag"},[n("</"),l("span",{class:"hljs-name"},"v-badge"),n(">")]),n(`
+`)])]),l("h2",{id:"colors"},[n("Colors "),l("a",{class:"header-anchor",href:"#colors"},"#")]),l("p",null,[n("You can set the color, background color and border color with the "),l("code",null,"--v-badge-color"),n(", "),l("code",null,"--v-badge-background-color"),n(" and "),l("code",null,"--v-badge-border-color"),n(" css vars respectively:")]),l("pre",null,[l("code",{class:"language-html"},[l("span",{class:"hljs-tag"},[n("<"),l("span",{class:"hljs-name"},"v-badge"),n(),l("span",{class:"hljs-attr"},"value"),n("="),l("span",{class:"hljs-string"},'"11"'),n(),l("span",{class:"hljs-attr"},"style"),n("="),l("span",{class:"hljs-string"},'"--v-badge-color: var(--red-500);"'),n(">")]),n(`
+	`),l("span",{class:"hljs-tag"},[n("<"),l("span",{class:"hljs-name"},"v-icon"),n(">")]),n("ABC"),l("span",{class:"hljs-tag"},[n("</"),l("span",{class:"hljs-name"},"v-icon"),n(">")]),n(`
+`),l("span",{class:"hljs-tag"},[n("</"),l("span",{class:"hljs-name"},"v-badge"),n(">")]),n(`
+`)])]),l("h2",{id:"reference"},[n("Reference "),l("a",{class:"header-anchor",href:"#reference"},"#")]),l("h4",{id:"props"},[n("Props "),l("a",{class:"header-anchor",href:"#props"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Prop"),l("th",null,"Description"),l("th",null,"Default"),l("th",null,"Type")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"value")]),l("td",null,"The value that will be displayed inside the badge Only 2 characters allowed)"),l("td",null,[l("code",null,"null")]),l("td",null,[l("code",null,"[String, Number]")])]),l("tr",null,[l("td",null,[l("code",null,"dot")]),l("td",null,"Only will show a small dot without any content"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"bordered")]),l("td",null,"Shows a border around the badge"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"left")]),l("td",null,"Aligns the badge on the left side"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"bottom")]),l("td",null,"Aligns the badge on the bottom side"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"icon")]),l("td",null,"Shows an icon instead of text"),l("td",null,[l("code",null,"null")]),l("td",null,[l("code",null,"String")])]),l("tr",null,[l("td",null,[l("code",null,"disabled")]),l("td",null,"Don\u2019t render the badge"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])])])]),l("h4",{id:"css-variables"},[n("CSS Variables "),l("a",{class:"header-anchor",href:"#css-variables"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Default")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"--v-badge-color")]),l("td",null,[l("code",null,"var(--white)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-badge-background-color")]),l("td",null,[l("code",null,"var(--danger)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-badge-border-color")]),l("td",null,[l("code",null,"var(--background-page)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-badge-offset-x")]),l("td",null,[l("code",null,"0px")])]),l("tr",null,[l("td",null,[l("code",null,"--v-badge-offset-y")]),l("td",null,[l("code",null,"0px")])]),l("tr",null,[l("td",null,[l("code",null,"--v-badge-size")]),l("td",null,[l("code",null,"16px")])])])]),l("h4",{id:"slots"},[n("Slots "),l("a",{class:"header-anchor",href:"#slots"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Slot"),l("th",null,"Description"),l("th",null,"Data")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("em",null,"default")]),l("td"),l("td")])])])],-1),b={setup(r,{expose:a}){const e={title:"Badge",modularExtension:!1};return a({frontmatter:e}),(h,p)=>{const t=s("DocsWrapper");return o(),d(t,{frontmatter:e},{default:u(()=>[c]),_:1})}}};export{b as default};

package/dist/assets/v-breadcrumb.14cc3d02.js

@@ -0,0 +1,2 @@
+import{r as a,p as u,q as o,w as d,B as l,P as e}from"./vendor.9bb37c18.js";const s=l("div",{class:"markdown-body"},[l("p",null,[e("A breadcrumb can help you display on what site you are currently on by displaying a structure like "),l("code",null,"my / custom / page"),e(".")]),l("pre",null,[l("code",{class:"language-html"},[l("span",{class:"hljs-tag"},[e("<"),l("span",{class:"hljs-name"},"v-breadcrumb"),e(),l("span",{class:"hljs-attr"},":items"),e("="),l("span",{class:"hljs-string"},`"[{name: 'Collections', to: '/collections'}]"`),e(" />")]),e(`
+`)])]),l("h2",{id:"breadcrumb-item"},[e("Breadcrumb Item "),l("a",{class:"header-anchor",href:"#breadcrumb-item"},"#")]),l("p",null,"An item for the items prop has these 4 options:"),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Prop"),l("th",null,"Description")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"to")]),l("td",null,"The reroute link")]),l("tr",null,[l("td",null,[l("code",null,"name")]),l("td",null,"The name which will be displayed")]),l("tr",null,[l("td",null,[l("code",null,"icon")]),l("td",null,"Displays an icon with the given name in front of the name")]),l("tr",null,[l("td",null,[l("code",null,"disabled")]),l("td",null,"If the router link should be clickable")])])]),l("h2",{id:"reference"},[e("Reference "),l("a",{class:"header-anchor",href:"#reference"},"#")]),l("h4",{id:"props"},[e("Props "),l("a",{class:"header-anchor",href:"#props"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Prop"),l("th",null,"Description"),l("th",null,"Default"),l("th",null,"Type")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"items")]),l("td",null,"An array of objects which information about each section"),l("td",null,[l("code",null,"() => []")]),l("td",null,[l("code",null,"Breadcrumb[]")])])])]),l("h4",{id:"css-variables"},[e("CSS Variables "),l("a",{class:"header-anchor",href:"#css-variables"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Default")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"--v-breadcrumb-color")]),l("td",null,[l("code",null,"var(--foreground-subdued)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-breadcrumb-color-hover")]),l("td",null,[l("code",null,"var(--foreground-normal)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-breadcrumb-color-disabled")]),l("td",null,[l("code",null,"var(--foreground-subdued)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-breadcrumb-divider-color")]),l("td",null,[l("code",null,"var(--foreground-subdued)")])])])])],-1),p={setup(c,{expose:r}){const n={title:"Breadcrumb",modularExtension:!1};return r({frontmatter:n}),(i,h)=>{const t=a("DocsWrapper");return u(),o(t,{frontmatter:n},{default:d(()=>[s]),_:1})}}};export{p as default};

package/dist/assets/v-button.db5add93.js

@@ -0,0 +1,15 @@
+import{r as o,p as d,q as a,w as s,B as l,P as n}from"./vendor.9bb37c18.js";const r=l("div",{class:"markdown-body"},[l("p",null,"A simple button component to make your life interactive!"),l("pre",null,[l("code",{class:"language-html"},[l("span",{class:"hljs-tag"},[n("<"),l("span",{class:"hljs-name"},"v-button"),n(">")]),n("Click me!"),l("span",{class:"hljs-tag"},[n("</"),l("span",{class:"hljs-name"},"v-button"),n(">")]),n(`
+`)])]),l("h2",{id:"sizes"},[n("Sizes "),l("a",{class:"header-anchor",href:"#sizes"},"#")]),l("p",null,"The button component supports the following sizes through the use of props:"),l("ul",null,[l("li",null,"x-small"),l("li",null,"small"),l("li",null,"(default)"),l("li",null,"large"),l("li",null,"x-large")]),l("h2",{id:"colors"},[n("Colors "),l("a",{class:"header-anchor",href:"#colors"},"#")]),l("p",null,[n("You can set the color, background color, hover color, and background hover color with the "),l("code",null,"--v-button-color"),n(", "),l("code",null,"--v-button-background-color"),n(", "),l("code",null,"--v-button-color-hover"),n(", and "),l("code",null,"--v-button-background-color-hover"),n(" css variables respectively:")]),l("pre",null,[l("code",{class:"language-html"},[l("span",{class:"hljs-tag"},[n("<"),l("span",{class:"hljs-name"},"v-button"),n(">")]),n("Click me"),l("span",{class:"hljs-tag"},[n("</"),l("span",{class:"hljs-name"},"v-button"),n(">")]),n(`
+
+`),l("span",{class:"hljs-tag"},[n("<"),l("span",{class:"hljs-name"},"style"),n(">")]),l("span",{class:"css"},[n(`
+	`),l("span",{class:"hljs-selector-class"},".v-button"),n(` {
+		--v-`),l("span",{class:"hljs-selector-tag"},"button"),n("-"),l("span",{class:"hljs-attribute"},"color"),n(": "),l("span",{class:"hljs-built_in"},"var"),n(`(--red);
+		--v-`),l("span",{class:"hljs-selector-tag"},"button"),n("-"),l("span",{class:"hljs-attribute"},"background-color"),n(": "),l("span",{class:"hljs-built_in"},"var"),n("(--red-"),l("span",{class:"hljs-number"},"50"),n(`);
+		--v-`),l("span",{class:"hljs-selector-tag"},"button"),n("-"),l("span",{class:"hljs-attribute"},"color"),n("-hover: "),l("span",{class:"hljs-built_in"},"var"),n(`(--white);
+		--v-`),l("span",{class:"hljs-selector-tag"},"button"),n("-"),l("span",{class:"hljs-attribute"},"background-color"),n("-hover: "),l("span",{class:"hljs-built_in"},"var"),n(`(--red);
+	}
+`)]),l("span",{class:"hljs-tag"},[n("</"),l("span",{class:"hljs-name"},"style"),n(">")]),n(`
+`)])]),l("h2",{id:"loading"},[n("Loading "),l("a",{class:"header-anchor",href:"#loading"},"#")]),l("p",null,[n("The button has a loading state that can be enabled with the "),l("code",null,"loading"),n(" prop. By default, the button will render a "),l("code",null,"v-spinner"),n(". You can override what\u2019s being shown during the loading state by using the "),l("code",null,"#loading"),n(" slot:")]),l("pre",null,[l("code",{class:"language-html"},[l("span",{class:"hljs-tag"},[n("<"),l("span",{class:"hljs-name"},"v-button"),n(">")]),n(`
+	`),l("span",{class:"hljs-tag"},[n("<"),l("span",{class:"hljs-name"},"template"),n(" #"),l("span",{class:"hljs-attr"},"loading"),n(">")]),n("... Almost done ..."),l("span",{class:"hljs-tag"},[n("</"),l("span",{class:"hljs-name"},"template"),n(">")]),n(`
+`),l("span",{class:"hljs-tag"},[n("</"),l("span",{class:"hljs-name"},"v-button"),n(">")]),n(`
+`)])]),l("p",null,[n("The loading slot is rendered "),l("em",null,"on top"),n(" of the content that was there before. Make sure that your loading content doesn\u2019t exceed the size of the default state content. This restriction is put in place to prevent jumps when going from and to the loading state.")]),l("h2",{id:"reference"},[n("Reference "),l("a",{class:"header-anchor",href:"#reference"},"#")]),l("h4",{id:"props"},[n("Props "),l("a",{class:"header-anchor",href:"#props"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Prop"),l("th",null,"Description"),l("th",null,"Default"),l("th",null,"Type")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"icon")]),l("td",null,"Remove padding / min-width. Meant to be used with just an icon as content"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"outlined")]),l("td",null,"No background"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"rounded")]),l("td",null,"Enable rounded corners"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"type")]),l("td",null,[n("HTML "),l("code",null,"type"),n(" attribute")]),l("td",null,[l("code",null,"'button'")]),l("td",null,[l("code",null,"String")])]),l("tr",null,[l("td",null,[l("code",null,"disabled")]),l("td",null,"Disabled state"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"loading")]),l("td",null,"Loading state"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"to")]),l("td",null,"Render as vue router-link"),l("td",null,[l("code",null,"null")]),l("td",null,[l("code",null,"string or Location")])]),l("tr",null,[l("td",null,[l("code",null,"href")]),l("td",null,"Render as anchor"),l("td",null,[l("code",null,"null")]),l("td",null,[l("code",null,"String")])]),l("tr",null,[l("td",null,[l("code",null,"align")]),l("td",null,"Align content in button. One of `left"),l("td",null,[l("code",null,"'center'")]),l("td",null,[l("code",null,"String")])]),l("tr",null,[l("td",null,[l("code",null,"dashed")]),l("td",null,[n("Render the border dashed. Meant to be used with "),l("code",null,"outlined"),n(".")]),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"tile")]),l("td",null,"Render without border radius"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"download")]),l("td",null,[n("Add the "),l("code",null,"download"),n(" attribute (used in combo with "),l("code",null,"href"),n(")")]),l("td",null,[l("code",null,"null")]),l("td",null,[l("code",null,"String")])]),l("tr",null,[l("td",null,[l("code",null,"full-width")]),l("td"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"exact")]),l("td"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"secondary")]),l("td"),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"Boolean")])]),l("tr",null,[l("td",null,[l("code",null,"value")]),l("td"),l("td",null,[l("code",null,"null")]),l("td",null,[l("code",null,"[Number, String]")])])])]),l("h4",{id:"slots"},[n("Slots "),l("a",{class:"header-anchor",href:"#slots"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Slot"),l("th",null,"Description"),l("th",null,"Data")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("em",null,"default")]),l("td",null,"Button content"),l("td")]),l("tr",null,[l("td",null,[l("code",null,"loading")]),l("td",null,"Content that\u2019s rendered during loading state"),l("td")]),l("tr",null,[l("td",null,[l("code",null,"prepend-outer")]),l("td",null,"Content that\u2019s rendered before the button"),l("td")]),l("tr",null,[l("td",null,[l("code",null,"append-outer")]),l("td",null,"Content that\u2019s rendered after the button"),l("td")])])]),l("h4",{id:"events"},[n("Events "),l("a",{class:"header-anchor",href:"#events"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Event"),l("th",null,"Description"),l("th",null,"Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"click")]),l("td",null,"User clicks on button"),l("td",null,[l("code",null,"MouseEvent")])])])]),l("h4",{id:"css-variables"},[n("CSS Variables "),l("a",{class:"header-anchor",href:"#css-variables"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Default")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"--v-button-width")]),l("td",null,[l("code",null,"auto")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-height")]),l("td",null,[l("code",null,"44px")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-color")]),l("td",null,[l("code",null,"var(--foreground-inverted)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-color-hover")]),l("td",null,[l("code",null,"var(--foreground-inverted)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-color-active")]),l("td",null,[l("code",null,"var(--foreground-inverted)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-color-disabled")]),l("td",null,[l("code",null,"var(--foreground-subdued)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-background-color")]),l("td",null,[l("code",null,"var(--primary)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-background-color-hover")]),l("td",null,[l("code",null,"var(--primary-125)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-background-color-active")]),l("td",null,[l("code",null,"var(--primary)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-background-color-disabled")]),l("td",null,[l("code",null,"var(--background-normal)")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-font-size")]),l("td",null,[l("code",null,"16px")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-font-weight")]),l("td",null,[l("code",null,"600")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-line-height")]),l("td",null,[l("code",null,"22px")])]),l("tr",null,[l("td",null,[l("code",null,"--v-button-min-width")]),l("td",null,[l("code",null,"140px")])])])])],-1),b={setup(c,{expose:e}){const t={title:"Button",modularExtension:!1};return e({frontmatter:t}),(h,i)=>{const u=o("DocsWrapper");return d(),a(u,{frontmatter:t},{default:s(()=>[r]),_:1})}}};export{b as default};

package/dist/assets/v-card-actions.53ff7c23.js

@@ -0,0 +1,8 @@
+import{r as e,p as c,q as o,w as r,B as s,P as a}from"./vendor.9bb37c18.js";const h=s("div",{class:"markdown-body"},[s("p",null,[a("This component is used to add actions like "),s("code",null,"cancel"),a(" or "),s("code",null,"save"),a(" to an existing "),s("code",null,"v-card"),a(".")]),s("pre",null,[s("code",{class:"language-html"},[s("span",{class:"hljs-tag"},[a("<"),s("span",{class:"hljs-name"},"v-card"),a(">")]),a(`
+	Would you like to save the changes?
+	`),s("span",{class:"hljs-tag"},[a("<"),s("span",{class:"hljs-name"},"v-card-actions"),a(">")]),a(`
+		`),s("span",{class:"hljs-tag"},[a("<"),s("span",{class:"hljs-name"},"v-button"),a(">")]),a("Cancel"),s("span",{class:"hljs-tag"},[a("</"),s("span",{class:"hljs-name"},"v-button"),a(">")]),a(`
+		`),s("span",{class:"hljs-tag"},[a("<"),s("span",{class:"hljs-name"},"v-button"),a(">")]),a("Save"),s("span",{class:"hljs-tag"},[a("</"),s("span",{class:"hljs-name"},"v-button"),a(">")]),a(`
+	`),s("span",{class:"hljs-tag"},[a("</"),s("span",{class:"hljs-name"},"v-card-actions"),a(">")]),a(`
+`),s("span",{class:"hljs-tag"},[a("</"),s("span",{class:"hljs-name"},"v-card"),a(">")]),a(`
+`)])]),s("h2",{id:"reference"},[a("Reference "),s("a",{class:"header-anchor",href:"#reference"},"#")]),s("h4",{id:"slots"},[a("Slots "),s("a",{class:"header-anchor",href:"#slots"},"#")]),s("table",null,[s("thead",null,[s("tr",null,[s("th",null,"Slot"),s("th",null,"Description"),s("th",null,"Data")])]),s("tbody",null,[s("tr",null,[s("td",null,[s("em",null,"default")]),s("td",null,"Where all the actions will go"),s("td")])])])],-1),m={setup(d,{expose:n}){const l={title:"Card Actions",modularExtension:!1};return n({frontmatter:l}),(p,u)=>{const t=e("DocsWrapper");return c(),o(t,{frontmatter:l},{default:r(()=>[h]),_:1})}}};export{m as default};

package/dist/assets/v-card-subtitle.d548ebd7.js

@@ -0,0 +1,4 @@
+import{r as n,p as r,q as c,w as o,B as s,P as e}from"./vendor.9bb37c18.js";const d=s("div",{class:"markdown-body"},[s("p",null,[e("This component is used to give a "),s("code",null,"v-card"),e(" an already stylized subtitle.")]),s("pre",null,[s("code",{class:"language-html"},[s("span",{class:"hljs-tag"},[e("<"),s("span",{class:"hljs-name"},"v-card"),e(">")]),e(`
+	`),s("span",{class:"hljs-tag"},[e("<"),s("span",{class:"hljs-name"},"v-card-subtitle"),e(">")]),e("A less important subtitle"),s("span",{class:"hljs-tag"},[e("</"),s("span",{class:"hljs-name"},"v-card-subtitle"),e(">")]),e(`
+`),s("span",{class:"hljs-tag"},[e("</"),s("span",{class:"hljs-name"},"v-card"),e(">")]),e(`
+`)])]),s("h2",{id:"reference"},[e("Reference "),s("a",{class:"header-anchor",href:"#reference"},"#")]),s("h4",{id:"slots"},[e("Slots "),s("a",{class:"header-anchor",href:"#slots"},"#")]),s("table",null,[s("thead",null,[s("tr",null,[s("th",null,"Slot"),s("th",null,"Description"),s("th",null,"Data")])]),s("tbody",null,[s("tr",null,[s("td",null,[s("em",null,"default")]),s("td",null,"Where the subtitle will go"),s("td")])])])],-1),m={setup(u,{expose:a}){const l={title:"Card Subtitle",modularExtension:!1};return a({frontmatter:l}),(h,p)=>{const t=n("DocsWrapper");return r(),c(t,{frontmatter:l},{default:o(()=>[d]),_:1})}}};export{m as default};

package/dist/assets/v-card-text.ccfd80ea.js

@@ -0,0 +1,4 @@
+import{r as n,p as r,q as c,w as o,B as a,P as e}from"./vendor.9bb37c18.js";const d=a("div",{class:"markdown-body"},[a("p",null,[e("This component is used to give a "),a("code",null,"v-card"),e(" an already stylized text.")]),a("pre",null,[a("code",{class:"language-html"},[a("span",{class:"hljs-tag"},[e("<"),a("span",{class:"hljs-name"},"v-card"),e(">")]),e(`
+	`),a("span",{class:"hljs-tag"},[e("<"),a("span",{class:"hljs-name"},"v-card-text"),e(">")]),e("This card can do nothing!"),a("span",{class:"hljs-tag"},[e("</"),a("span",{class:"hljs-name"},"v-card-text"),e(">")]),e(`
+`),a("span",{class:"hljs-tag"},[e("</"),a("span",{class:"hljs-name"},"v-card"),e(">")]),e(`
+`)])]),a("h2",{id:"reference"},[e("Reference "),a("a",{class:"header-anchor",href:"#reference"},"#")]),a("h4",{id:"slots"},[e("Slots "),a("a",{class:"header-anchor",href:"#slots"},"#")]),a("table",null,[a("thead",null,[a("tr",null,[a("th",null,"Slot"),a("th",null,"Description"),a("th",null,"Data")])]),a("tbody",null,[a("tr",null,[a("td",null,[a("em",null,"default")]),a("td",null,"Where your text will go"),a("td")])])])],-1),m={setup(h,{expose:l}){const s={title:"Card Text",modularExtension:!1};return l({frontmatter:s}),(p,u)=>{const t=n("DocsWrapper");return r(),c(t,{frontmatter:s},{default:o(()=>[d]),_:1})}}};export{m as default};