discourse/plugins/discourse-calendar
Joffrey JAFFEUX da02ab094b
Some checks are pending
Licenses / run (push) Waiting to run
Linting / run (push) Waiting to run
Publish Assets / publish-assets (push) Waiting to run
Tests / core backend (push) Waiting to run
Tests / plugins backend (push) Waiting to run
Tests / core frontend (Chrome) (push) Waiting to run
Tests / plugins frontend (push) Waiting to run
Tests / themes frontend (push) Waiting to run
Tests / core system (push) Waiting to run
Tests / plugins system (push) Waiting to run
Tests / themes system (push) Waiting to run
Tests / core frontend (Firefox ESR) (push) Waiting to run
Tests / core frontend (Firefox Evergreen) (push) Waiting to run
Tests / chat system (push) Waiting to run
Tests / merge (push) Blocked by required conditions
FIX: do not hide time when overflowing in month view (#35016)
2025-09-27 00:17:44 +02:00
..
app DEV: Fix random typos (#34987) 2025-09-26 09:52:28 +08:00
assets FIX: do not hide time when overflowing in month view (#35016) 2025-09-27 00:17:44 +02:00
config Update translations (#34976) 2025-09-25 16:05:27 +02:00
db/migrate PERF: correctly index event dates (#34877) 2025-09-19 17:41:57 +02:00
jobs DEV: rename topic_id to timerable_id for BaseTimer (#34667) 2025-09-17 13:19:17 +08:00
lib PERF: correctly index event dates (#34877) 2025-09-19 17:41:57 +02:00
spec DEV: Fix PostDestroyer deprecations in specs (#34986) 2025-09-26 09:53:17 +08:00
test/javascripts UX: Use admin table classes for Calendar Holidays list (#34942) 2025-09-24 17:13:50 +10:00
vendor/holidays CHORE: Import holiday definition updates. (#34835) 2025-09-17 16:07:06 +10:00
.prettierignore
plugin.rb DEV: Clean up requires (#34946) 2025-09-24 12:00:22 +02:00
README.md

Discourse Calendar

Adds the ability to create a dynamic calendar in the first post of a topic.

Topic discussing the plugin itself can be found here: https://meta.discourse.org/t/discourse-calendar/97376

Customization

Events

  • discourse_post_event_event_will_start this DiscourseEvent will be triggered one hour before an event starts
  • discourse_post_event_event_started this DiscourseEvent will be triggered when an event starts
  • discourse_post_event_event_ended this DiscourseEvent will be triggered when an event ends

Custom Fields

Custom fields can be set in plugin settings. Once added a new form will appear on event UI. These custom fields are available when a plugin event is triggered.

Holidays

See an incorrect or missing holiday? Familiarize yourself with the holiday definition Syntax. Then make your updates in the vendor/holiday/definitions directory.

Generate updated holidays as follows.

cd vendor/holidays

# Generate holiday definitions
rake generate:definitions

Install the plugin and switch to the discourse root(not the plugin directory).

# Collect all holiday regions into assets/javascripts/lib/regions.js
bin/rails javascript:update_constants

Interactions with Other Plugins

You can use an element of this plugin with the Right Sidebar Blocks component. You'll want to ensure the desired route is enabled via the events calendar categories setting. In Right Sidebar Block's settings, the block name will be upcoming-events-list, and the params use this syntax, for example MMMM D, YYYY.