Default Calendar Sources for renderCalendar + Cache Bugfix (Breaking Option)#456
Open
jarekbird wants to merge 6 commits intoobsidian-community:mainfrom
Open
Conversation
jarekbird
changed the title
jarekbird
commented
May 24, 2023
| ``` | ||
| ```` | ||
|
|
||
| Unfortunately, there's a bug on first render and you need to interact with the calendar by changing the week or view before it renders properly. |
Author
There was a problem hiding this comment.
If the cache had not been initialized, then the bug mentioned above would occur. This PR fixes this problem by conditionally initializing the cache as part of the renderCalendar() function.
This solution required setting the renderCalendar() function to be an async function because the cache initialization is async, which changes the public API. :/ Docs are updated to reflect this. This is a breaking change.
jarekbird
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In trying to simply render the default calendar based on the global settings, I found it to be a bit difficult to do.
This PR simplifies the process by having the renderCalendar function default the events to all events from the event sources set in the global settings. I've also added this case as one of the basic examples in the documentation
Additionally, I was able to tackle the bug mentioned in the advanced docs, but my solution was a breaking change because the public API is modified. See comment below for details.
I was able to find a solution that is not a full breaking change. I think this PR might be slightly cleaner, but it is a breaking change. See this alternative PR for the non breaking change option: #456