Skip to content

Add ability to display event descriptions#274

Open
jkirkwood wants to merge 2 commits intoalexpfau:devfrom
jkirkwood:feat/show-description
Open

Add ability to display event descriptions#274
jkirkwood wants to merge 2 commits intoalexpfau:devfrom
jkirkwood:feat/show-description

Conversation

@jkirkwood
Copy link

@jkirkwood jkirkwood commented Aug 15, 2025

Description

Adds a global and entity-level show_description option that allows event descriptions to be displayed. It pretty much a copy of show_location. The option defaults to false to avoid any breaking changes.

I made sure that long descriptions wrap nicely. I'll leave the suggestion in the issue to limit the description length as a future improvement.

Related Issue

This PR is related to #159

How Has This Been Tested

I tested this change in my local Home Assistant instance. I tested the all new global and entity-level settings in both the code and visual editors.

Calendar View:

image

Visual Editor:

image image

Types of changes

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 🌎 Translation (addition or update for a language)
  • ⚙️ Tech (code style improvement, performance improvement or dependencies update)
  • 📚 Documentation (fix or addition to documentation)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • I have linted and formatted my code (npm run lint and npm run format)
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have tested the change in my local Home Assistant instance.
  • I have followed the translation guidelines if I'm adding or updating a translation.

@sevorl
Copy link
Contributor

sevorl commented Aug 27, 2025

@jkirkwood: Thanks for adding this feature. This is what stopped me from using calendar-card-pro so far.
I'd be happy to help testing this if needed - would you provide the .js file? (I don't know how I would build this myself)

I would also like to contribute the german translation
de.json

@jkirkwood
Copy link
Author

Hey @sevorl, more testing definitely wouldn't hurt! I just followed these steps to generate the js file, but I threw it into this Gist as well.

Appreciate the German translation.

@sevorl
Copy link
Contributor

sevorl commented Aug 29, 2025

Thank you for the .js file @jkirkwood !
I started testing, and it works well so far.
So far my, only comments would be regarding the icon and icon positioning. (Which I could also customize to my personal preference later)

@sevorl
Copy link
Contributor

sevorl commented Oct 27, 2025

@jkirkwood :
I tested the descption for months now, and it works.
I also found some time to work on the icon alignment, so the icon position can be adjusted - similar to the position of the date.

There is now an option for the event icon alignment in the configuration.

May I open a pull request for this for your repository?

@borgqueenx
Copy link

@jkirkwood you mention that this fixes #159 but that request is for clicking a event to get the popup with more information? Its also where you can find the delete button for a event.

It seems the functionality added here is only showing description in the actual agenda.

@sevorl
Copy link
Contributor

sevorl commented Oct 31, 2025

@borgqueenx , that is correct. This adds a description field, but not a pop up

@jkirkwood
Copy link
Author

@borgqueenx good catch, let me update from "fixes" to "related to"

@jkirkwood
Copy link
Author

May I open a pull request for this for your repository?

@sevorl sorry for missing this earlier. Feel free to open a PR.

@sevorl
Copy link
Contributor

sevorl commented Dec 18, 2025

Hi @alexpfau , is there any chance this might get added to the regular release any time soon?

@alexpfau
Copy link
Owner

@sevorl, I am super busy at the moment and didn't get to invest any time in this project for a while. I will try to test the PRs and release a new version in the next couple weeks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants