716784a1c8
- Update fields translations use 'language' instead of 'locale' - Replace all translation files from locale to language - Update the docs with locale to language
9.7 KiB
App Overview
The Directus App is the presentation layer for your data, content, and assets. It uses a left-to-right visual hierarchy for organization and navigation. Below we cover the App's global elements and individual pages.
Global Elements
1. Module Bar
- Project Logo — Displays your configured project logo and project color (defaults to the Directus logo and color). If configured, clicking this component will navigate to the Project URL. During platform activity, an indeterminate progress indicator will also be shown here.
- Modules — Any available modules are listed below the project logo. These may be turned off or reordered based on your role's configuration, but by default this includes:
- Collections
- User Directory
- File Library
- Documentation
- Settings — Admin only
- Custom Modules — If configured
- Current User Menu — This component displays the authenticated user's name and avatar. Hovering over this menu exposes the Log Out button.
2. Navigation Bar
- Project Name — Shows the name of your current project (see Project Settings), as well as the quality of your project's API connection.
- Navigation — This is a dynamic navigation based on your current module. Some modules also support Presets and/or Bookmarks, which are ways to link to more specific data-sets.
3. Page
- Header — A fixed section at the top of each page, the header includes:
- Page Icon — Clicking this navigates back to the previous page
- Module Title — Clicking this navigates to the parent module/section
- Page Title — Displays the current page's title
- Action Buttons — On the right-side of the header are contextual buttons for specific page actions. Please note that some primary action buttons have a "..." icon beside them that provides additional options when clicked.
- Page Content — This displays the content of the page you navigated to.
4. Page Sidebar
- Page Components — Lists any contextual page components available. The "Info" component is available on every page, explaining the page's general purpose and relevant details. Clicking any sidebar component will accordion it open. If the App window is large enough, the sidebar will automatically open, and can be closed by clicking the "X" in the top-right.
- Notifications Tray — Fixed to the bottom of the page sidebar, this button opens a tray of recent user notifications, and provides a link to the Activity History page.
Collections
This module is the primary way for interacting with your database content. Here you can access your collections, browse their items, and navigate to individual item forms.
Collection Listing
A page that lists the collections available to the current user. This is the landing page of the module, and effectively the same as its navigation listing.
Collection Detail
Provides a configurable layout to browse or visualize items within a given collection. Like other browse pages, there are many available features, including:
Item Detail
Most layouts on the browse page support navigating to individual item detail pages, where you a presented with a customizable form for viewing/editing the item's content. Like other detail pages, there are many available features, including:
User Directory
A module includes a comprehensive listing of all system users within your project. This page has the same features and configuration as Collection Detail.
User Detail
Similar to other Item Detail pages, this page provides a custom form for viewing system users. This is also used for editing the "Profile Page" of the current user, which is accessible from the User Menu. Directus ships with a full-featured user system, with the following fields:
- First Name — The user's given name
- Last Name — The user's family name
- Email — The user's email address used for login/authenticating and email updates
- Password — The private string used for login/authenticating (stored as a secure hash)
- Avatar — An image displayed throughout the App that represents the user
- Location — Can be used for the user's city, country, office name, etc
- Title — The name of the position the user holds at their company or organization
- Description — A description or bio of the user
- Tags — A set of keywords useful when searching within the User Directory
- Timezone — (User Preference) The timezone of the user
- Language — (User Preference) The language to use for this user's App language
- Theme — (User Preference) Light, Dark, or Auto (based on the user's OS preferences)
- Two-Factor Auth — (User Preference) Enables authenticating with 2FA
- Status — (Admin Only) Determines if the user is active within the App/API
- Role — (Admin Only) The user's role determines their permissions and access
- Token — (Admin Only) A static string used for authenticating within the API
The sidebar's info component also includes the following readonly details:
- User Key — The primary key of the user
- Last Access — The timestamp of the user's last App or API action
- Last Page — The last App page accessed by the user
::: Extending Users While the fields included out-of-the-box are locked from schema changes, you can extend Directus Users to include additional proprietary fields within Settings > Data Model. :::
File Library
This module aggregates all files within the project into one consolidated library. This page has the same features and configuration as Collection Detail.
File Detail
Similar to other Item Detail pages, this page provides a custom form for viewing assets and embeds. Directus ships with a full-featured system for digital asset management, with the following fields:
- Title — Pulled from the file metadata if available, falls back to a formatted version of the filename
- Description — Pulled from the file metadata if available
- Tags — Pulled from the file metadata if available
- Location — Pulled from the file metadata if available
- Storage — The storage adapter where the asset is saved (readonly)
- Filename Disk — The actual name of the file within the storage adapter
- Filename Download — The name used when downloading the file via Content-Disposition
The sidebar's info component also includes the following readonly details:
- Type — The MIME type of the file, displayed in the App as a formatted media type
- Dimensions — (Images Only) The width and height of the image in pixels
- Size — The file-size the asset takes up within the storage adapter
- Created — The timestamp of when the file was uploaded to the project
- Owner — The Directus user that uploaded the file to the project
- Folder — The current parent folder that contains the file
- Metadata — Metadata JSON dump of the file's EXIF, IPTC, and ICC information
::: Extending Files While the fields included out-of-the-box are locked from schema changes, you can extend Directus Files to include additional proprietary fields within Settings > Data Model. :::
Documentation
This module is an internal set of guides, concepts, and reference docs for your project's specific version of Directus. It also includes a dynamic API Reference that is dynamically tailored to your custom schema. The docs are organized into four distinct sections:
- Getting Started** — Novice Oriented. For a platform intro and installation.
- Concepts** — Learning Oriented. For understanding the platfom.
- Guides** — Problem Oriented. Follow along with steps while working.
- Reference** — Information Oriented. Look up info and specs while working.
::: Updating the Docs Our docs are written in markdown (with some additional VuePress styling like this hint box), and available for editing/fixing via GitHub. :::
Actvity History
This module provides a collective timeline of all actions taken within the project. This is a great way to audit user activity or enforce accountability. This is the only system module that is not in the module bar by default — instead being located within the notifications tray of the page sidebar. This page has the same features and configuration as Collection Detail.
Activity Detail
Unlike other item detail pages, activity items are readonly (for proper accountability) and open in a modal window with the following fields:
- User — The Directus user that performed the action
- Action — The specific action taken, eg: Create, Update, Delete, Authenticate, etc
- Date — The timestamp of when the action was performed
- IP Address — The IP address of the device from which the action was performed
- User Agent — The description of the browser that was used to perform the action
- Collection — The collection affected by the action
- Item — The item (within the above Collection) affected by the action
Settings
This module is only available to users within admin roles. This is where your project is configured, and the first place to go after installation. It includes the following sections: