---
title: "Usage"
weight: 30
description: "Views, creation, editing, filters and shortcuts of the modern agenda."
---

# Usage

The Modern agenda module replaces the Dolibarr agenda view with a
faster, clearer page. Nothing changes for the data: events stay the ones
of the Agenda module, reminders and notifications of other modules keep
working.

## Available views

- **Month**: classic month view, all day events sit on top of each
  column.
- **Week**: the time slots of the week, your working hours emphasized.
- **Day**: a single day, in detail.
- **List**: the events of the period one under the other, no time grid.
- **Planning**: one column per user, to see at a glance who is busy and
  when (the "per user agenda" view of the classic agenda).

The view is picked in the menu at the top right of the toolbar; the last
view you used is remembered for your account.

By default the agenda takes the whole width of the screen: the Dolibarr
left menu is not shown on this page (the administrator can bring it back
on the module setup page). The three bars button, at the left of the
toolbar, shows or hides the side panel.

## Moving in time

- Arrows `<` and `>`: previous / next period.
- **Today**: back to the current day.
- The mini month of the side panel jumps to any day; its own arrows
  change the month without changing the view.
- The keyboard shortcuts `t`, `j`/`k` (or the left/right arrows) do the
  same.

## Creating an event

1. Select a range with the mouse (or tap a slot on mobile, or
   double-click a day in month view): the quick creation window opens,
   pre-filled with the range.
2. Enter the label, pick the type, adjust the dates, tick "All day"
   when needed.
3. The third party and the project are searched by name, reference or
   keyword: type at least two characters, results appear, arrows and
   Enter (or click) pick one; the retained chip is removed with a cross.
4. Choose the assigned users (you by default; on the planning view, the
   user of the column).
5. **Create** saves and displays the event. A notification lets you
   undo the creation for a few seconds.
6. **More options** carries what you already typed to the native event
   card (notes, reminders, resource, contact, etc.).

The **Create** button of the side panel opens the same window on the next
slot of the day. When the panel is hidden, the **New event** button takes
its place in the toolbar; on a phone it is the round **+** button at the
bottom right.

## Editing an event

- **Move**: drag it to its new place. A timed event dropped on a day
  becomes an all day event.
- **Resize**: drag its bottom edge.
- **Planning**: drag an event from one user column to another to
  reassign it (rights required).
- **Status**: open the event (click) and pick 0%, 50% or 100% in the
  status selector.
- **Delete**: the Delete button of the detail panel, after
  confirmation. A deletion cannot be undone.
- **Undo**: after each move or resize, the notification offers **Undo**
  for a few seconds.

If someone else modified the same event in the meantime, your change is
refused and the view refreshes: nobody silently overwrites someone
else's work.

## Event colors

The "Event color" filter picks the source of the colors:

- **Owner user**: the color of the user card (Dolibarr Color field);
  as a fallback the event type color; as a fallback a stable pastel
  palette.
- **Event type**: the color of the event type dictionary
  (Setup > dictionaries > event type); as a fallback the pastel palette.

The colors themselves are set where Dolibarr already keeps them: the
user card and the type dictionary. Holidays and birthdays have their
color on the module setup page.

## Filtering

The side panel gathers the filters:

- **Calendars**: your events, other users', holidays, birthdays,
  external calendars (iCal) and the events provided by other modules.
  Each box is remembered for your account.
- **Users**: one box per colleague, in the color of their events, with
  the Me / My team / All shortcuts. Every box checked shows everybody;
  the last checked box does not uncheck, so the agenda never goes blank
  by accident.
- **More filters**, folded by default:
  - **User group** and **event colors** (colleague or type color);
  - **Types**: one box per event type, in the color the type takes in
    the "color by type" mode, with the "hide automatic events" option;
  - **Status**: to do, in progress, done, not applicable;
  - **Third party**, **Project**, **Resource**: the same selectors as
    the native agenda.

The "Reset filters" link clears everything. Only the third party and
project filters received through a link (from a third party or project
card) are not remembered.

## Event detail

A click on an event opens its detail panel: full dates, status,
participants, third party, contact, project, linked object, location and
note. Links open the native Dolibarr cards. **Open** and **Edit** go to
the full native card, **Duplicate** creates a copy through the native
card.

Events from external sources (holidays, birthdays, iCal, other modules)
are read only: their panel offers no write action.

## Keyboard shortcuts

| Key | Action |
|-----|--------|
| `t` | Today |
| `j` or left arrow | Previous period |
| `k` or right arrow | Next period |
| `m` / `w` / `d` / `l` / `p` | Month / week / day / list / planning |
| `n` | New event |
| `f` | Show or hide filters |
| `r` | Refresh |
| `?` | Shortcut help |
| `Escape` | Close the panel or window |
| `Ctrl+Z` | Undo the last change |

## Working hours

The **Working hours / 24 h** entry of the three dots menu switches the
time grid between your working hours (set by the administrator in the
native Agenda module) and the full 0:00 to 24:00 day. Either way the day
opens on the morning.

## Reading the events

- The title comes first, in bold, the time and the third party under it;
  an event of 30 minutes or less holds on one line.
- A done event carries a check mark; past events are slightly faded.
- Automatic events (a proposal validated, an invoice sent...) show as
  outlines on a white background: they take nobody's time.
- In the month view an appointment is a colored dot, its time and its
  title; only all day events keep a filled bar.

## Dark mode

The page theme follows the Dolibarr dark mode. When the browser is set
to automatic dark, the rendering also follows the system setting.

## Mobile

On a phone, the list view is proposed by default, the side panel opens
over the agenda from the three bars button and the detail opens at the
bottom of the screen. Drag
and drop stays available through long press.

## Links from other cards

The "show the agenda of a third party" or "of a project" links open the
page with the matching filter already active for the session. Old links
to the native agenda (month, week, day, per user) keep working: they
open the equivalent view of the modern agenda.