Widgets

Widgets make your Control Panel a more friendly and useful entry point.


The dashboard of the Control Panel may contain any number of widgets. A widget can contain anything you can think of. From a list of recent entries to a randomized inspiration quote.

Statamic comes bundled with a handful of widgets, however you may also create your own or use ones created by others.

Configuration

Widgets can be added to the dashboard by modifying the widgets array in site/settings/cp.yaml.

Each item in the array should specify the widget as the type, plus any widget-specific configuration values. You can find what values are available on each widget’s page below.

You may use the same widget multiple times, configured in different ways.

widgets:
  -
    type: collection
    collection: blog
    limit: 5
    width: half   # Can be 'half' or 'full'. Defaults to 'half'.
  -
    type: collection
    collection: things
    limit: 3

Permissions

Each widget may be restricted depending on certain permissions.

widgets:
  -
    type: collection
    collection: blog
    limit: 5
    permissions:
      - collections:blog:edit

Available Widgets

Widget Description
collection Display a listing of entries from a collection.
form Display a listing of form submissions.
template Display anything you want using a standard Antlers template from your theme.
updater Display whether any Statamic updates are available and give the option to update.