Files
directus/docs/concepts/displays.md
Rijk van Zanten 817ccf3620 Overhaul docs (#3951)
* Add Quickstart Guide

* Update installation

* Remove unused files

* Update support/backing

* Tweaks in concepts

* Setup file structure for API reference 2.0

* Setup page layout for reference

* Add clean-urls plugin

* getting started updates

* Finish authentication rest

* getting started updates

* Render stylus in 2 spaces

* Various

* Various

* Finish activity docs

* Add collections reference

* Add extension reference

* concepts updates

* Fields/tweaks

* Add files doc

* Add revisions

* concepts docs

* More api reference

* Finish rest api reference (finally)

* initial concepts

* More things

* Add assets api ref

* Move sections from file to assets

* Add environment variables

* contributing docs

* Add field transforms page

* Left align table headers

* concept links

* Add API config

* Fix mobile nav

* Add migrating a project

* doc link fixes

Co-authored-by: Ben Haynes <ben@rngr.org>
2021-02-05 18:51:54 -05:00

1.2 KiB

Displays

Displays are the smaller, read-only counterpart to Interfaces, defining how a field's data will be displayed inline throughout the App.

For example, you may have a "Status" field that uses a Dropdown Interface on the Item Detail page, and a smaller Badge Display when the field is referenced throughout the rest of the App. Directus includes many Displays out-of-the-box, below are the some key examples:

  • Raw — The exact value, straight from the API
  • Formatted Value — Provides options for string formatting
  • Boolean — Customizable True/False icons
  • Color — A color swatch preview
  • DateTime — Formatted or relative datetimes
  • Image — Thumbnail previews
  • Labels — Small, custom colored badges
  • Rating — Customizable stars
  • Related Values — Displays relational display titles
  • User — Avatar and name of a system user

In addition to the included core displays, custom displays allow for creating new and/or proprietary ways to view or represent field data. For example, you could create progress indicators, tooltips for relational data, specific formatting styles, or anything else.

Relevant Guides