Skip to content

Commit

Permalink
Add references for social & material icons (#9689)
Browse files Browse the repository at this point in the history
  • Loading branch information
@azrikahar @rijkvanzanten
azrikahar authored and rijkvanzanten committed Dec 1, 2021
1 parent f064260 commit 7ca231e
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 28 deletions.
48 changes: 24 additions & 24 deletions docs/configuration/config-options.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -559,37 +559,37 @@ These flows rely on the `PUBLIC_URL` variable for redirecting. Make sure that va

#### OAuth 2.0

| Variable | Description | Default Value |
| ------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------- |
| `AUTH_<PROVIDER>_CLIENT_ID` | OAuth identifier for the external service. | -- |
| `AUTH_<PROVIDER>_CLIENT_SECRET` | OAuth secret for the external service. | -- |
| `AUTH_<PROVIDER>_SCOPE` | A white-space separated list of privileges Directus will request. | `email` |
| `AUTH_<PROVIDER>_AUTHORIZE_URL` | The authorize page URL of the external service. | -- |
| `AUTH_<PROVIDER>_ACCESS_URL` | The token access URL of the external service. | -- |
| `AUTH_<PROVIDER>_PROFILE_URL` | The user profile information URL of the external service. | -- |
| `AUTH_<PROVIDER>_EMAIL_KEY` | OAuth profile email key used to find the email address. | `email` |
| `AUTH_<PROVIDER>_IDENTIFIER_KEY` | OAuth profile identifier key used to verify the user. Will default to `EMAIL_KEY`. | -- |
| `AUTH_<PROVIDER>_ALLOW_PUBLIC_REGISTRATION` | Automatically create accounts for authenticating users. | `false` |
| `AUTH_<PROVIDER>_DEFAULT_ROLE_ID` | The Directus role ID assigned to created users. | -- |
| `AUTH_<PROVIDER>_ICON` | SVG icon to display with the login link. | `account_circle` |
| Variable | Description | Default Value |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
| `AUTH_<PROVIDER>_CLIENT_ID` | OAuth identifier for the external service. | -- |
| `AUTH_<PROVIDER>_CLIENT_SECRET` | OAuth secret for the external service. | -- |
| `AUTH_<PROVIDER>_SCOPE` | A white-space separated list of privileges Directus will request. | `email` |
| `AUTH_<PROVIDER>_AUTHORIZE_URL` | The authorize page URL of the external service. | -- |
| `AUTH_<PROVIDER>_ACCESS_URL` | The token access URL of the external service. | -- |
| `AUTH_<PROVIDER>_PROFILE_URL` | The user profile information URL of the external service. | -- |
| `AUTH_<PROVIDER>_EMAIL_KEY` | OAuth profile email key used to find the email address. | `email` |
| `AUTH_<PROVIDER>_IDENTIFIER_KEY` | OAuth profile identifier key used to verify the user. Will default to `EMAIL_KEY`. | -- |
| `AUTH_<PROVIDER>_ALLOW_PUBLIC_REGISTRATION` | Automatically create accounts for authenticating users. | `false` |
| `AUTH_<PROVIDER>_DEFAULT_ROLE_ID` | The Directus role ID assigned to created users. | -- |
| `AUTH_<PROVIDER>_ICON` | SVG icon to display with the login link. You can choose from [Social icon or Material icon set](/getting-started/glossary/#icons). | `account_circle` |

#### OpenID

OpenID is an authentication protocol built on OAuth 2.0, and should be preferred over standard OAuth 2.0 where possible.
OpenID offers better user verification and consistent profile information, allowing for more complete user
registrations.

| Variable | Description | Default Value |
| ------------------------------------------- | ----------------------------------------------------------------- | ---------------------- |
| `AUTH_<PROVIDER>_CLIENT_ID` | OpenID identifier for the external service. | -- |
| `AUTH_<PROVIDER>_CLIENT_SECRET` | OpenID secret for the external service. | -- |
| `AUTH_<PROVIDER>_SCOPE` | A white-space separated list of privileges Directus will request. | `openid profile email` |
| `AUTH_<PROVIDER>_ISSUER_URL` | The OpenID `.well-known` Discovery Document URL. | -- |
| `AUTH_<PROVIDER>_IDENTIFIER_KEY` | OpenID profile identifier key used to verify the user. | `sub` |
| `AUTH_<PROVIDER>_ALLOW_PUBLIC_REGISTRATION` | Automatically create accounts for authenticating users. | `false` |
| `AUTH_<PROVIDER>_REQUIRE_VERIFIED_EMAIL` | Require users to have a verified email address. | `false` |
| `AUTH_<PROVIDER>_DEFAULT_ROLE_ID` | The Directus role ID assigned to created users. | -- |
| `AUTH_<PROVIDER>_ICON` | SVG icon to display with the login link. | `account_circle` |
| Variable | Description | Default Value |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------- |
| `AUTH_<PROVIDER>_CLIENT_ID` | OpenID identifier for the external service. | -- |
| `AUTH_<PROVIDER>_CLIENT_SECRET` | OpenID secret for the external service. | -- |
| `AUTH_<PROVIDER>_SCOPE` | A white-space separated list of privileges Directus will request. | `openid profile email` |
| `AUTH_<PROVIDER>_ISSUER_URL` | The OpenID `.well-known` Discovery Document URL. | -- |
| `AUTH_<PROVIDER>_IDENTIFIER_KEY` | OpenID profile identifier key used to verify the user. | `sub` |
| `AUTH_<PROVIDER>_ALLOW_PUBLIC_REGISTRATION` | Automatically create accounts for authenticating users. | `false` |
| `AUTH_<PROVIDER>_REQUIRE_VERIFIED_EMAIL` | Require users to have a verified email address. | `false` |
| `AUTH_<PROVIDER>_DEFAULT_ROLE_ID` | The Directus role ID assigned to created users. | -- |
| `AUTH_<PROVIDER>_ICON` | SVG icon to display with the login link. You can choose from [Social icon or Material icon set](/getting-started/glossary/#icons). | `account_circle` |

### LDAP (`ldap`)

Expand Down
3 changes: 2 additions & 1 deletion docs/extensions/displays.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ export default {
- `id` — The unique key for this display. It is good practice to scope proprietary displays with an author prefix.
- `name` — The human-readable name for this display.
- `description` — A short description (<80 characters) of this display shown in the App.
- `icon` — An icon name from the material icon set, or the extended list of Directus custom icons.
- `icon` — An icon name from the [material icon set](/getting-started/glossary/#material-icons), or the extended list of
Directus custom icons.
- `component` — A reference to your Vue component.
- `types` — A CSV of supported [types](/getting-started/glossary/#types).

Expand Down
3 changes: 2 additions & 1 deletion docs/extensions/interfaces.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ export default {
- `id` — The unique key for this interface. It is good practice to scope proprietary interfaces with an author prefix.
- `name` — The human-readable name for this interface.
- `description` — A short description (<80 characters) of this interface shown in the App.
- `icon` — An icon name from the material icon set, or the extended list of Directus custom icons.
- `icon` — An icon name from the [material icon set](/getting-started/glossary/#material-icons), or the extended list of
Directus custom icons.
- `component` — A reference to your Vue component.
- `types` — An array of supported [types](/getting-started/glossary/#types).
- `groups` — An array of field-groups. Accepts `standard`, `file`, `files`, `m2o`, `o2m`, `m2a`, `translations`.
Expand Down
3 changes: 2 additions & 1 deletion docs/extensions/layouts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ export default {

- `id` — The unique key for this layout. It is good practice to scope proprietary layouts with an author prefix.
- `name` — The human-readable name for this layout.
- `icon` — An icon name from the material icon set, or the extended list of Directus custom icons.
- `icon` — An icon name from the [material icon set](/getting-started/glossary/#material-icons), or the extended list of
Directus custom icons.
- `component` — A reference to your Vue component.

::: tip TypeScript
Expand Down
3 changes: 2 additions & 1 deletion docs/extensions/modules.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ export default {

- `id` — The unique key for this module. It is good practice to scope proprietary interfaces with an author prefix.
- `name` — The human-readable name for this module.
- `icon` — An icon name from the material icon set, or the extended list of Directus custom icons.
- `icon` — An icon name from the [material icon set](/getting-started/glossary/#material-icons), or the extended list of
Directus custom icons.
- `routes` — Details the routes in your module. The routes are registered as nested routes with the module's `id`
serving as the base path.

Expand Down
15 changes: 15 additions & 0 deletions docs/getting-started/glossary.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,21 @@ technically be stored as code in the database, it is far more common to manage t
The platform supports many options for uploading, storing, transforming, and retrieving different types of files, and it
an excellent Digital Asset Management system.

## Icons

### Material Icons

Full list of icons [can be found here](https://fonts.google.com/icons). Directus currently supports both filled &
outlined variants of Material icons. When you intend to use outlined variant of `account_circle`, you can use
`account_circle_outline`.

### Social Icons

They are Font Awesome 5's brands icons. Full list of icons
[can be found here](https://fontawesome.com/v5.15/icons?d=gallery&s=brands). When using them as one of the auth provider
icons, make sure to use underscores, such as `blogger_b` for
[blogger-b](https://fontawesome.com/v5.15/icons/blogger-b?style=brands) icon.

## Interfaces

Interfaces determine how you view or interact with a field. In most cases, they offer some sort of input tailored to
Expand Down

0 comments on commit 7ca231e

Please sign in to comment.