Skip to content

#177 - Rename Entry.customProperties to extendedProps in JSON #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

eberleant
Copy link

Sorry if I should have asked first whether there's a reason for naming it customProperties, but it seemed like a quick thing and no harm done if the PR is rejected. All this does is rename customProperties to extendedProps, which is what FC expects for non-standard fields (https://fullcalendar.io/docs/event-object).

I ran into a similar issue to what was mentioned in #177 where I wasn't able to order calendar entries by a custom property, even though FC docs say it is possible (https://fullcalendar.io/docs/eventOrder):

This setting accepts a few different arguments:

  • a name of an Event Object property, like "title". This can be the name of a non-standard field.

It might be because the custom property is getting nested an extra level (extendedProps -> customProperties -> property). FC is probably moving customProperties into the extendedProps hash:

Any non-standard properites are moved into the extendedProps hash during event parsing.

If this isn't acceptable, I may have time to modify this to enable setting an eventOrder function (which was also mentioned on #177 as a possible solution), but this seemed like the easiest solution.

@aetasoul aetasoul requested a review from stefanuebe December 24, 2024 13:26
@stefanuebe
Copy link
Owner

stefanuebe commented Jan 28, 2025

Sorry for the late reply. Your change is currently not "enough". I know, that the extendedProps exist on the client. There was once a reason to change it to customProperties for the server-client-communication (don't ask me for details, I do not know anymore :) ).

The thing is, that our client expects a "extendedProps.customProperties" to be there (check the full-calendar.ts). So simply renaming the json mapping will not be enough and most likely break things. Also since there might be other projects relying on the "customProperties" name, I will not rename it in a minor or bugfix patch.

Please feel free to create an issue for this rename and we can have a deeper look into it with the next major version.

@stefanuebe stefanuebe closed this Jan 28, 2025
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.

2 participants