github/directus
1
0
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-02-03 07:54:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into insights

Browse Source
This commit is contained in:
rijkvanzanten
2021-06-11 19:07:53 -04:00
parent c6b154e60d 6283b649f5
commit 69d47476d0
545 changed files with 37116 additions and 32568 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
docs/reference/api/system/users.md
View File

@@ -819,7 +819,7 @@ mutation {
---
## Enable Two-Factor Authentication
## Generate Two-Factor Authentication Secret
Generates a secret and returns the URL to be used in an authenticator app.
@@ -853,13 +853,13 @@ OTP secret to be saved in the authenticator app.
### REST API
```
POST /users/me/tfa/enable
POST /users/me/tfa/generate
```
##### Example
```json
// POST /users/me/tfa/enable
// POST /users/me/tfa/generate
{
"password": "d1r3ctu5"
}
@@ -873,7 +873,7 @@ POST /graphql/system
```graphql
type Mutation {
users_me_tfa_enable(password: String!): users_me_tfa_enable_data
users_me_tfa_generate(password: String!): users_me_tfa_generate_data
}
```
@@ -881,7 +881,7 @@ type Mutation {
```graphql
mutation {
users_me_tfa_enable(password: "d1r3ctu5") {
users_me_tfa_generate(password: "d1r3ctu5") {
secret
otpauth_url
}
@@ -893,6 +893,77 @@ mutation {
---
## Enable Two-Factor Authentication
Adds a TFA secret to the user account.
<div class="two-up">
<div class="left">
### Request Body
<div class="definitions">
`secret` **Required**\
The TFA secret from tfa/generate.
`otp` **Required**\
OTP generated with the secret, to recheck if the user has a correct TFA setup
</div>
### Returns
<div class="definitions">
Empty response.
</div>
</div>
<div class="right">
### REST API
```
POST /users/me/tfa/enable
```
##### Example
```json
// POST /users/me/tfa/enable
{
"otp": "123456",
"secret": "3CtiutsNBmY3szHE"
}
```
### GraphQL
```
POST /graphql/system
```
```graphql
type Mutation {
users_me_tfa_enable(otp: String!, secret: String!): Boolean
}
```
##### Example
```graphql
mutation {
users_me_tfa_enable(otp: "123456", secret: "3CtiutsNBmY3szHE")
}
```
</div>
</div>
---
## Disable Two-Factor Authentication
Disables two-factor authentication by removing the OTP secret from the user.

2
docs/reference/app/components/transition-bounce.md
View File

@@ -14,7 +14,7 @@ Bounces items in or out depending if the get added or removed from the view.
</template>
<script lang="ts">
import { defineComponent, ref } from '@vue/composition-api';
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup(props) {

2
docs/reference/app/components/transition-dialog.md
View File

@@ -14,7 +14,7 @@ Fades items in or out depending if the get added or removed from the view.
</template>
<script lang="ts">
import { defineComponent, ref } from '@vue/composition-api';
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup(props) {

2
docs/reference/app/components/transition-expand.md
View File

@@ -14,7 +14,7 @@ Use around a `v-if` or `v-show` component to have it expand in and out of view.
</template>
<script lang="ts">
import { defineComponent, ref } from '@vue/composition-api';
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup(props) {

56
docs/reference/app/components/v-button-group.md
View File

@@ -1,56 +0,0 @@
# Button Group
Provides the ability to make groups of buttons. Uses the v-item-group component and adds styling to the buttons. For
more information about how to use groups, look into v-item-group.
## Usage
```html
<template>
<v-button-group v-model="selection">
<v-button v-slot:default="{ active }">Click me to {{ active ? 'activate' : 'deactivate' }}</v-button>
</v-button-group>
</template>
<script lang="ts">
import { defineComponent, ref } from '@vue/composition-api';
export default defineComponent({
setup() {
const selection = ref([]);
return { selection };
},
});
</script>
```
## Reference
#### Props
| Prop | Description | Default | Type |
| ----------- | ------------------------------------------------------- | ----------- | ---------------------- |
| `mandatory` | Require an item to be selected | `false` | `Boolean` |
| `max` | Only allow a maximum of n items | `-1` | `Number` |
| `multiple` | Allow multiple items to be selected | `false` | `Boolean` |
| `value` | The v-model value. Selection of indexes / custom values | `undefined` | `(string or number)[]` |
| `rounded` | Adds rounded corners to the sides | `false` | `Boolean` |
| `tile` | Adds sharp corners to the sides | `false` | `Boolean` |
#### Slots
| Slot | Description | Data |
| --------- | ----------- | ---- |
| _default_ | | -- |
#### Events
| Event | Description | Value |
| ------- | -------------------------------- | ---------------------- |
| `input` | Used to update the v-model value | `(string or number)[]` |
#### CSS Variables
| Variable | Default |
| ------------------------------------------ | -------------------- |
| `--v-button-group-background-color-active` | `var(--primary-alt)` |

32
docs/reference/app/components/v-button.md
View File

@@ -90,19 +90,19 @@ the loading state.
#### CSS Variables
| Variable | Default |
| --------------------------------------- | ---------------------------- |
| `--v-button-width` | `auto` |
| `--v-button-height` | `44px` |
| `--v-button-color` | `var(--foreground-inverted)` |
| `--v-button-color-hover` | `var(--foreground-inverted)` |
| `--v-button-color-activated` | `var(--foreground-inverted)` |
| `--v-button-color-disabled` | `var(--foreground-subdued)` |
| `--v-button-background-color` | `var(--primary)` |
| `--v-button-background-color-hover` | `var(--primary-125)` |
| `--v-button-background-color-activated` | `var(--primary)` |
| `--v-button-background-color-disabled` | `var(--background-normal)` |
| `--v-button-font-size` | `16px` |
| `--v-button-font-weight` | `600` |
| `--v-button-line-height` | `22px` |
| `--v-button-min-width` | `140px` |
| Variable | Default |
| -------------------------------------- | ---------------------------- |
| `--v-button-width` | `auto` |
| `--v-button-height` | `44px` |
| `--v-button-color` | `var(--foreground-inverted)` |
| `--v-button-color-hover` | `var(--foreground-inverted)` |
| `--v-button-color-active` | `var(--foreground-inverted)` |
| `--v-button-color-disabled` | `var(--foreground-subdued)` |
| `--v-button-background-color` | `var(--primary)` |
| `--v-button-background-color-hover` | `var(--primary-125)` |
| `--v-button-background-color-active` | `var(--primary)` |
| `--v-button-background-color-disabled` | `var(--background-normal)` |
| `--v-button-font-size` | `16px` |
| `--v-button-font-weight` | `600` |
| `--v-button-line-height` | `22px` |
| `--v-button-min-width` | `140px` |

4
docs/reference/app/components/v-checkbox.md
View File

@@ -64,11 +64,11 @@ Keep in mind to pass the `value` prop with a unique value when using arrays in `
## Indeterminate
The indeterminate state can be set with the `indeterminate` prop. We recommend using the `.sync` modifier with the
The indeterminate state can be set with the `indeterminate` prop. We recommend using the `v-model` directive with the
indeterminate prop, so the checkbox can set change it too:
```html
<v-checkbox :indeterminate.sync="indeterminate">
<v-checkbox v-model:indeterminate="indeterminate">
<script>
export default {
data() {

12
docs/reference/app/components/v-detail.md
View File

@@ -12,12 +12,12 @@ Use the detail component to hide not so important information or elements.
#### Props
| Prop | Description | Default | Type |
| ------------ | ----------------------- | ------------------ | --------- |
| `active` | Used with `v-model` | `undefined` | `Boolean` |
| `label` | Label of detail | `i18n.t('toggle')` | `String` |
| `start-open` | Have it open by default | `false` | `Boolean` |
| `disabled` | Disable any interaction | `false` | `Boolean` |
| Prop | Description | Default | Type |
| ------------ | ----------------------- | ------------------------- | --------- |
| `active` | Used with `v-model` | `undefined` | `Boolean` |
| `label` | Label of detail | `i18n.global.t('toggle')` | `String` |
| `start-open` | Have it open by default | `false` | `Boolean` |
| `disabled` | Disable any interaction | `false` | `Boolean` |
#### Events

16
docs/reference/app/components/v-drawer.md
View File

@@ -13,14 +13,14 @@ relational or nested data.
#### Props
| Prop | Description | Default | Type |
| --------------- | ------------------------------------------------------ | ------------------- | --------- |
| `title`\* | The title of the drawer | | `String` |
| `subtitle` | The subtitle of the drawer | `null` | `String` |
| `active` | Can be used with `v-model` to open or close the drawer | `undefined` | `Boolean` |
| `persistent` | Disallow closing the drawer by clicking out of it | `false` | `Boolean` |
| `icon` | An icon for the drawer | `'box'` | `String` |
| `sidebar-label` | A label for the sidebar | `i18n.t('sidebar')` | `String` |
| Prop | Description | Default | Type |
| --------------- | ------------------------------------------------------ | -------------------------- | --------- |
| `title`\* | The title of the drawer | | `String` |
| `subtitle` | The subtitle of the drawer | `null` | `String` |
| `active` | Can be used with `v-model` to open or close the drawer | `undefined` | `Boolean` |
| `persistent` | Disallow closing the drawer by clicking out of it | `false` | `Boolean` |
| `icon` | An icon for the drawer | `'box'` | `String` |
| `sidebar-label` | A label for the sidebar | `i18n.global.t('sidebar')` | `String` |
#### Events

16
docs/reference/app/components/v-fancy-select.md
View File

@@ -33,14 +33,14 @@ representation.
## FancySelectItem
| Prop | Description | Type |
| ------------- | ------------------------------------------ | ---------------------------------------- |
| `icon` | Which icon to display | `string` |
| `value` | Which value the item represents | `string or number` |
| `text` | The displayed text | `undefined or string or TranslateResult` |
| `description` | Optional description to display | `undefined or string or TranslateResult` |
| `divider` | If set to true, display an divider instead | `undefined or boolean` |
| `iconRight` | Display an optional icon to the right | `undefined or string` |
| Prop | Description | Type |
| ------------- | ------------------------------------------ | ---------------------- |
| `icon` | Which icon to display | `string` |
| `value` | Which value the item represents | `string or number` |
| `text` | The displayed text | `undefined or string` |
| `description` | Optional description to display | `undefined or string` |
| `divider` | If set to true, display an divider instead | `undefined or boolean` |
| `iconRight` | Display an optional icon to the right | `undefined or string` |
## Reference

10
docs/reference/app/components/v-form.md
View File

@@ -5,7 +5,7 @@ Renders a form using interfaces based on the passed collection name.
```html
<v-form
collection="articles"
:edits.sync="{}"
v-model="{}"
:initial-values="{
title: 'Hello World'
}"
@@ -21,7 +21,7 @@ Renders a form using interfaces based on the passed collection name.
| `collection` | The collection of which you want to render the fields | `undefined` | `String` |
| `fields` | Array of fields to render. This can be used instead of the collection prop | `undefined` | `Field[]` |
| `initial-values` | Object of the starting values of the fields | `null` | `FieldValues` |
| `edits` | The edits that were made after the form was rendered. Being used in `v-model` | `null` | `FieldValues` |
| `model-value` | The edits that were made after the form was rendered. Being used in `v-model` | `null` | `FieldValues` |
| `loading` | Display the form in a loading state. Prevents the ctx menus from being used and renders skeleton loaders for the fields | `false` | `Boolean` |
| `batch-mode` | If enabled, allows to select multiple entries | `false` | `Boolean` |
| `primary-key` | The primary key of the given collection | `null` | `[String, Number]` |
@@ -36,6 +36,6 @@ n/a
#### Events
| Event | Description | Value |
| ------- | ------------------------ | ----- |
| `input` | Edits have been updated. | |
| Event | Description | Value |
| -------------------- | ------------------------ | ----- |
| `update:model-value` | Edits have been updated. | |

4
docs/reference/app/components/v-item-group.md
View File

@@ -18,7 +18,7 @@ elements like a list of cards, or a button group.
</template>
<script lang="ts">
import { defineComponent, ref } from '@vue/composition-api';
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
@@ -103,7 +103,7 @@ useful when you're working with a predefined list of items:
</template>
<script lang="ts">
import { defineComponent, ref } from '@vue/composition-api';
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {

2
docs/reference/app/components/v-menu.md
View File

@@ -4,7 +4,7 @@ Renders a dropdown menu. Can be attached to an activator element or free floatin
**NOTE**
Due to the fact that a menu is rendered through a portal, dialogs don't work great when rendered from within a menu.
Due to the fact that a menu is rendered through a teleport, dialogs don't work great when rendered from within a menu.
## Reference

70
docs/reference/app/components/v-table.md
View File

@@ -50,7 +50,7 @@ in the header item for this column sent to `headers`.
```html
<v-table :headers="headers" :items="items">
<template #header.name="{ header }">
<template #[`header.name`]="{ header }">
<v-button>{{ header.text }}</v-button>
</template>
</v-table>
@@ -65,7 +65,7 @@ header item for this column sent to `headers`.
```html
<v-table :headers="headers" :items="items">
<template #item.name="{ item }">
<template #[`item.name`]="{ item }">
<v-button>{{ item.name }}</v-button>
</template>
</v-table>
@@ -76,15 +76,15 @@ In this slot, you have access to the `item` through the scoped slot binding.
## Resizable rows
Adding the `show-resize` prop allows the user to resize the columns at will. You can keep your headers updated by using
the `.sync` modifier or listening to the `update:headers` event:
the `v-model` directive or listening to the `update:headers` event:
```html
<template>
<v-table :headers.sync="headers" :items="[]" show-resize>
<v-table v-model:headers="headers" :items="[]" show-resize>
</template>
<script>
import { defineComponent, ref } from '@vue/composition-api';
import { defineComponent, ref } from 'vue';
import { HeaderRaw } from '@/components/v-table/types';
export default defineComponent({
@@ -112,39 +112,39 @@ export default defineComponent({
#### Props
| Prop | Description | Default | Type |
| -------------------- | ---------------------------------------------------------------------------------------------- | -------------------- | ------------- |
| `headers`\* | What columns to show in the table. Supports the `.sync` modifier | | `HeaderRaw[]` |
| `items`\* | The individual items to render as rows | | `Item[]` |
| `disabled` | Disable edits to items in the form (drag/select) | `false` | `Boolean` |
| `fixed-header` | Make the header fixed | `false` | `Boolean` |
| `inline` | Display the table inline with other text | `false` | `Boolean` |
| `item-key` | Primary key of the item. Used for keys / selections | `'id'` | `String` |
| `loading-text` | What text to show when table is loading with no items | `i18n.t('loading')` | `String` |
| `loading` | Show progress indicator | `false` | `Boolean` |
| `manual-sort-key` | What field to use for manual sorting | `null` | `String` |
| `must-sort` | Requires the sort to be on a particular column | `false` | `Boolean` |
| `no-items-text` | What text to show when table doesn't contain any rows | `i18n.t('no_items')` | `String` |
| `row-height` | Height of the individual rows in px | `48` | `Number` |
| `selection-use-keys` | What field to use for selection | `false` | `Boolean` |
| `selection` | What items are selected. Can be used with `v-model` as well | `() => []` | `any` |
| `server-sort` | Handle sorting on the parent level. | `false` | `Boolean` |
| `show-manual-sort` | Show manual sort drag handles | `false` | `Boolean` |
| `show-resize` | Show resize handlers | `false` | `Boolean` |
| `show-select` | Show checkboxes | `false` | `Boolean` |
| `sort` | What column / order to sort by. Supports the `.sync` modifier. `{ by: string, desc: boolean }` | `null` | `Sort` |
| Prop | Description | Default | Type |
| -------------------- | ------------------------------------------------------------------------------------------------- | --------------------------- | ------------- |
| `headers`\* | What columns to show in the table. Supports the `v-model` directive | | `HeaderRaw[]` |
| `items`\* | The individual items to render as rows | | `Item[]` |
| `disabled` | Disable edits to items in the form (drag/select) | `false` | `Boolean` |
| `fixed-header` | Make the header fixed | `false` | `Boolean` |
| `inline` | Display the table inline with other text | `false` | `Boolean` |
| `item-key` | Primary key of the item. Used for keys / selections | `'id'` | `String` |
| `loading-text` | What text to show when table is loading with no items | `i18n.global.t('loading')` | `String` |
| `loading` | Show progress indicator | `false` | `Boolean` |
| `manual-sort-key` | What field to use for manual sorting | `null` | `String` |
| `must-sort` | Requires the sort to be on a particular column | `false` | `Boolean` |
| `no-items-text` | What text to show when table doesn't contain any rows | `i18n.global.t('no_items')` | `String` |
| `row-height` | Height of the individual rows in px | `48` | `Number` |
| `selection-use-keys` | What field to use for selection | `false` | `Boolean` |
| `selection` | What items are selected. Can be used with `v-model` as well | `() => []` | `any` |
| `server-sort` | Handle sorting on the parent level. | `false` | `Boolean` |
| `show-manual-sort` | Show manual sort drag handles | `false` | `Boolean` |
| `show-resize` | Show resize handlers | `false` | `Boolean` |
| `show-select` | Show checkboxes | `false` | `Boolean` |
| `sort` | What column / order to sort by. Supports the `v-model` directive. `{ by: string, desc: boolean }` | `null` | `Sort` |
#### Events
| Event | Description | Value |
| ---------------- | ------------------------------------------------- | ------------------------------- |
| `update:sort` | `.sync` event for `sort` prop | `{ by: string, desc: boolean }` |
| `click:row` | When a row has been clicked | |
| `update:items` | When changes to the items where made | |
| `manual-sort` | When a user manually sorts the items | |
| `update:headers` | `.sync` event for `headers` prop or `HeaderRaw[]` | |
| `item-selected` | Emitted when an item is selected or deselected | `{ item: any, value: boolean }` |
| `select` | Emitted when selected items change | `any[]` |
| Event | Description | Value |
| ---------------- | --------------------------------------------------- | ------------------------------- |
| `update:sort` | `v-model` event for `sort` prop | `{ by: string, desc: boolean }` |
| `click:row` | When a row has been clicked | |
| `update:items` | When changes to the items where made | |
| `manual-sort` | When a user manually sorts the items | |
| `update:headers` | `v-model` event for `headers` prop or `HeaderRaw[]` | |
| `item-selected` | Emitted when an item is selected or deselected | `{ item: any, value: boolean }` |
| `select` | Emitted when selected items change | `any[]` |
#### Slots

25
docs/reference/environment-variables.md
View File

@@ -310,14 +310,15 @@ Based on the `EMAIL_TRANSPORT` used, you must also provide the following configu
### SMTP (`smtp`)
| Variable | Description | Default Value |
| --------------------- | ---------------- | ------------- |
| `EMAIL_SMTP_HOST` | SMTP Host | -- |
| `EMAIL_SMTP_PORT` | SMTP Port | -- |
| `EMAIL_SMTP_USER` | SMTP User | -- |
| `EMAIL_SMTP_PASSWORD` | SMTP Password | -- |
| `EMAIL_SMTP_POOL` | Use SMTP pooling | -- |
| `EMAIL_SMTP_SECURE` | Enable TLS | -- |
| Variable | Description | Default Value |
| ----------------------- | ---------------- | ------------- |
| `EMAIL_SMTP_HOST` | SMTP Host | -- |
| `EMAIL_SMTP_PORT` | SMTP Port | -- |
| `EMAIL_SMTP_USER` | SMTP User | -- |
| `EMAIL_SMTP_PASSWORD` | SMTP Password | -- |
| `EMAIL_SMTP_POOL` | Use SMTP pooling | -- |
| `EMAIL_SMTP_SECURE` | Enable TLS | -- |
| `EMAIL_SMTP_IGNORE_TLS` | Ignore TLS | -- |
### Mailgun (`mailgun`)
@@ -386,3 +387,11 @@ to use for the given value by prefixing the value with `{type}:`. The following
| `number` | `number:3306` | `3306` |
| `regex` | `regex:/\.example\.com$/` | `/\.example\.com$/` |
| `array` | `array:https://example.com,https://example2.com` | `["https://example.com","https://example2.com"]` |
## File Based Environment Variables (Docker Secrets)
Any of the environment variable values can be imported from a file, by appending `_FILE` to the environment variable
name. For example: `DB_PASSWORD_FILE="/run/secrets/db_password"`.
This is especially useful when used in conjunction with Docker Secrets, so you can keep sensitive data out of your
compose files.