Coder Social home page Coder Social logo

uphy / obsidian-reminder Goto Github PK

View Code? Open in Web Editor NEW
410.0 5.0 29.0 3.25 MB

Reminder plugin for Obsidian

Home Page: https://uphy.github.io/obsidian-reminder/

License: MIT License

TypeScript 90.61% JavaScript 1.84% Svelte 6.52% Shell 1.04%
obsidian-plugin

obsidian-reminder's Introduction

Obsidian Reminder Plugin

Reminder plugin for Obsidian. This plugin adds feature to manage markdown TODOs with reminder.

Features

Set Reminders

You can set reminders for TODO list items with the following format.

- [ ] This is a sample task with reminder (@2021-08-14)
- [ ] Also you can specify time (@2021-08-14 09:37)
- [x] You will not be notified about the reminders you have already checked. (@2021-08-14)

List Reminders

You can view the list of reminders contained in all files.

If you click the reminder list item, the source markdown file will be appeared.

Reminder Notification

Reminder will be notified on Obsidian when the time comes.

If you click Mark as Done, your check list item will be checked. Alternatively, you can postpone the reminder by selecting Remind Me Later.

Interoperability with other plugins

In addition to original format @YYYY-MM-DD, this plugin also supports following plugin formats.

Guide

https://uphy.github.io/obsidian-reminder/

FAQ

  • Notification in mobile (Android/iOS)
    • System notification in mobile device is not available because Obsidian doesn't provide the feature.

Support

Buy Me A Coffee

obsidian-reminder's People

Contributors

github-actions[bot] avatar iamrecursion avatar samuellawrentz avatar uphy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

obsidian-reminder's Issues

[Feature]: Recurring reminders

Goal or desired outcome of this feature

Ability to schedule repeated and recurring tasks and reminders.

Thank you for your work, I have just started using your plugin and it's useful!

Describe the feature

It would be useful to schedule recurring reminders for regular tasks.
Examples

The syntax used for cron schedule expressions could be used for scheduling exactly to one's needs.

I could see history being generated below each item, based on if the item was completed that time or not, but that might not be super useful for everyone, for example:

  • Workout (@daily)
    • 3.1.2022 - Done
    • 4.1.2022 - Missed
    • 5.1.2022 - Done

(Each check-in workout would generate a new line and then reset back to an unchecked state)

Screenshots, mockups, or videos

No response

[Feature]: execute commands when completing reminders

Goal or desired outcome of this feature

I want to be able to set and execute commands from command palette automatically after completing reminder.

Describe the feature

The plugin buttons have the functionality to execute commands, so I was thinking maybe a collaboration to support inline button with the reminder. After that the reminder plugin will recognize the button and execute it right after completing the reminder.

Or maybe another plugin that can execute commands, or maybe execute directly without relying on another plugin if it's no too complicated.
I'm sorry, but I'm not knowledgeable about the "how".

Screenshots, mockups, or videos

A video of my previous example

test.mov

[Feature]: support auto wrap

Goal or desired outcome of this feature

see the picture

Describe the feature

see the picture

Screenshots, mockups, or videos

image

[Bug]: Calendar popup does not trigger

Describe the bug

The Calendar popup trigger is set to (@ but it does not trigger the popup.

01fd_.mp4

Expected Behavior

Calendar picker to pop up

Steps to reproduce

Type (@

Operating system

Windows

[Feature]: E-mail notification

Goal or desired outcome of this feature

there is a plan pushing messages for a e-mail notifiction?

Describe the feature

there is a plan pushing messages for a e-mail notifiction?

Screenshots, mockups, or videos

No response

Support automatically adding customized timestamp after completing tasks

Similar to what is used for scheduling tasks, it would be great if timestamp can also be added automatically when completing tasks managed by this plugin. The format can be something like the following:
Support customizing data and time into ISO format · Issue #8 · uphy/obsidian-reminder

Supporting adding task completing timestamp would also help integrating with Obsidian Tasks, which can filter tasks based on task completion date:
schemar/obsidian-tasks: Task management for the Obsidian knowledge base.

[Feature]: Don't bring obsidian to foreground when completing/postponing from notification

Goal or desired outcome of this feature

The problem is that obsidian is in focus every time I complete/postpone a reminder from notification on macOS.

Describe the feature

It would be better if when I complete/postpone a reminder, obsidian wouldn't be called up to the foreground.

Screenshots, mockups, or videos

current problem

Screen.Recording.2022-01-19.at.3.32.20.PM.mov

demo of solution

Screen.Recording.2022-01-19.at.3.34.50.PM.mov

[Feature]: recurrent reminder

Goal or desired outcome of this feature

would be nice to have additional option for recurrent reminders
which adds desired period to current due date and keep unchecked state on click

Describe the feature

something like (inspired by extended todotxt):
(@2021-08-14 09:37 rec:3day) - recurrent reminder every 3rd day, similar for Nweek, Nmonth, Nyear
on checkbox click : re-set date (@2021-08-17 09:37 rec:3day)

Screenshots, mockups, or videos

No response

[Bug]: Reminder not set after creating

Describe the bug

I tried to add a reminder by selecting the date on the pop up calendar modal. But upon clicking on it, the window closes immediately, and the reminder wasn't added.

This is what I see afterward:
image

What should I do?

Expected Behavior

A reminder should be added with the due date being displayed beside the task.

Steps to reproduce

  1. Type (@ , a calender pop up modal will appear.
  2. Nothing happens after selecting on the due date.

Operating system

Windows

Support customizing data and time into ISO format

I see that data and time format customization is on the road map. Just want to provide some input regarding this.

It would be great to support ISO 8601 format YYYY-MM[-DDTHH:mm:ss.nnn+ZZ]. An example of this would be 2021-04-18T04:19:35.000. This format is also used by another powerful plugin Dataview:
Data Annotation - Dataview

Therefore, supporting this would provide better integration among plugins.

[Bug]: Pop-up of calendar date picker goes underneath other panes, should be above

Describe the bug

I have my todo list set in the left sidebar as a page that's always open - using the calendar date picker when the line is close to the next pane (my central one) results in the pop-up being half underneath the next pane, making it impossible to select a date.

Expected Behavior

Calendar date picker should be displayed above any other pane.

Steps to reproduce

Create a note, put it on the left sidebar (not just on left side of the current note, but in the side-bar you can collapse), write some text to get close to the edge of the main pane, hit (@ to summon the calendar date picker, notice its underneath the main pane.

Operating system

Windows

No time, no reminder

Goal or desired outcome of this feature

I'd like to have an option to turn off notification for tasks without time. I have tried to leave the time of reminder blank in settings, but this app refused to accept it.

Describe the feature

Just a button to turn off notification for task without a specific time

Screenshots, mockups, or videos

No response

[Bug]: Calendar is not setting the date inline

Describe the bug

The calendar is popping out correctly but it doesn't write the date inline when is selected:
image

image

The workaround is type the date manually but is not desired.

This doesn't happen in a new vault but after uninstall and clear the folder in the .obsidian path, it's not working either, and seems like more people is affected (at least 1 more reported this in the Obsidian's Discord).

Expected Behavior

Pick a date and automatically set inline.

Steps to reproduce

Just type the calendar trigger and select a date.

Operating system

Windows

Reminder list: Last digit of date / time in a new row

Hello,

the reminder list shows the last digit of the date or time from a reminder in a new row, like in the picture below. I've tried different themes and a fresh vault, but same results unfortunately.

I'm currently using:

  • Windows 10
  • Obsidian v0.12.14

If I should provide further information, I'd be glad to help out.

Unbenannt

Page based reminders

Hi, nice plugin.

I had a feature request - for the reminders dialog to be opened when a certain page was opened. These could be specified in the same format as the date reminders i.e. (@[[Page linked to reminder]]). This could be in addition to a reminder being linked to a date or time.

[Bug]: Calendar pop-up does not work on mobile devices

Describe the bug

The calendar popup does not work on Android, even if I set the trigger text to something simple.

Expected Behavior

Setting trigger text such as xxxxx works on Obsidian desktop but not Android.

Steps to reproduce

On Android:
Configure Reminder to work with Tasks
Set trigger text to xxxxx
Create a reminder and enter xxxxx

Operating system

Android

Support locating desired tasks based on tag

Supporting locating desired tasks based on tag, in addition to the format (@2021-08-14 09:37), would help better manage tasks from the tag pane and have a consistent tag definition for other tasks that do not have such tags. For instance, this plugin may look for tasks defined in the format of - [ ] Task #Task 📅 2021-08-27T09:37.

Moreover, supporting this would help better integrating with Obsidian Tasks, which uses a global filter/tag for locating tasks managed by it.
schemar/obsidian-tasks: Task management for the Obsidian knowledge base.

[Feature]: Time format in reminder list view

Goal or desired outcome of this feature

(1) 02:00 or 20:00 time display is not user friendly in Reminder Pane, and
(2) please allow for NOT showing the Time in Reminder Pane

Describe the feature

Have options in the Plugin>Settings to accomplish (1) and (2) above.

Screenshots, mockups, or videos

No response

[Feature]: Support for Live Preview Mode

Goal or desired outcome of this feature

Supporting Obsidian's Live Preview Mode which was publicly released in v0.13.11.

Describe the feature

Currently the following features are not available with Live Preview Mode

  • Calendar popup ((@ trigger, popup command) (#42)
  • Jump to the reminder location (after the jump, selection is incorrect)

If anyone finds any other problems, please comment to this issue.

Screenshots, mockups, or videos

No response

Progress

  • Calendar modal in live preview mode (workaround)
  • Calendar popup
  • Jump to the reminder location

Wrong label in settings?

The settings page says in the label for Reminder Time: "Time when the reminder which has time part will show". Shouldn't that say "Time when a reminder with no time part will show" or "Time to show reminders without time specification"?

[Bug]: [windows] No menu displayed if system notif is enabled

Describe the bug

The menu to choose to link, mute, mark as done, doesn't appear if I enable the system notification.

Expected Behavior

When I click on the menu, the menu must appear.

Steps to reproduce

  • Enable system notification
  • Click on overdue reminder

Operating system

Windows

[Feature]: Non-strict date format

Goal or desired outcome of this feature

Supports non-strict(partial) date formats.

Describe the feature

This plugin supports to change reminder time format such as YYYY-MM-DD[T]HH:mm:ss:SSS.
Currently, time format is strict.

OK: 2021-11-03T19:48:10:123
NG: 2021-11-03T19:48 -> not parsed

This is a feature request to support such non-strict format.

This feature is suggested in the following issue:
#8 (comment)

Screenshots, mockups, or videos

No response

[Feature]: support locales datetime

Goal or desired outcome of this feature

my daily note format is 'YYMMDD~ddd', now 'ddd' is just English, i hope to support other language. Such as Chinese.

Describe the feature

support locales datetime

Screenshots, mockups, or videos

No response

when using the 'Tasks' plugin - when a task is overdue and the 'reminder' is triggered, ignoring or snoozing partially completes the task. Marking as done does not complete the action for tasks created via "Tasks"

Expected Behavior

  1. a new task is created, via the task modal:
    image

NB: todays date is the 2021-09-07

When the notification pops up, and is ignored, the task should remain as excepted, eg:
image

  1. when 'Mark as Done' is selected, [x] should appear with the green tick and today's date

Current Behavior

  1. The green tick with today's date appears, yet, the box isn't ticked, but the task modal says done w/ today's date.

image

image

  1. the [ ] remains, yet the green tick and today's date appears.

Steps to Reproduce

Context (Environment)

  • Obsidian version: 0.12.15
  • Tasks version: 1.3
  • Reminder version: 1.0.7
  • I have tried it with all other plugins disabled and the error still occurs

Unable to create reminders with date within [[link]]

Thank you for this plugin— its incredibly useful. I tend to use dates within [[]] links wherever possible in order to ensure that tasks can also be back-linked to the right day. Is there a way to change settings in order to support this?

[Feature]: Reminders outside of tasks

Goal or desired outcome of this feature

I'd like to use the reminder feature without using checklists.

Describe the feature

All the current features without the checklist requirement.

Screenshots, mockups, or videos

No response

bring obsidian to the front at the time of the reminder

I am leaving obsidian open and hidden most of the time, so it would be nice if you could bring the obsidian window to the front when the reminder is fired. I don't know if it's easier, but I believe this is an alternative to the system notification support, no ?

[Feature]: Link with Space Repetition plugin

Goal or desired outcome of this feature

The spaced repetition plug-in add a date in Yaml with sr-due.
The reminder plug-in car read this date to add it to reminder too.

Describe the feature

The reminder plug-in could read the sr-due as a @date and add the note to the other reminder.
Alternatively it can be could to configure some metadata to be read by the plugin. For exemple, I could add thesr-due and the todo frontmatter to be read as reminder.

Screenshots, mockups, or videos

No response

[Bug]: Calendar popup broken with Experimental Live Preview

Describe the bug

I'm not sure if it's even possible to show the calendar popup with new live preview editor but I noticed that the calendar popup doesn't trigger when live preview is enabled. It does work as expected after disabling live preview.

Expected Behavior

The calendar popup should display

Steps to reproduce

Enable live preview from the Editor options (catalyst required)
image

Type the calendar popup trigger, ex: (@

Operating system

macOS

[Feature]: Exclude folder

Goal or desired outcome of this feature

Doesn't have notification at all for file in specific folder (as templater folder for example)

Why ? Because I create a custom reminder in a template, and each day, this template is overdue.… Not very practical!

Describe the feature

The file in the folder specified doesn't must appear in the reminder menu and be reminded.

Screenshots, mockups, or videos

No response

customizable "remind me later"

It would be nice if we could add more options (1 min, 10 min...) in the settings of the plugin or if we could just write the next time in this panel, thank you.
image

Notification on top of Obsidian doesn't snooze despite clicking snooze

As a user
and a task reminder pops up
and the user is viewing obsidian
When the user closes the popup
OR
When the user selects a time value (eg 15mins)
And the window disappears
THEN within 10seconds to 30seconds, the same popup appears addressing the same task and the same note (as per file address).

--
if silencing/snoozing is reattempted, the popup keeps appearing; my solution was to disable the plugin.

[Bug]: time in repeating tasks follows postpone rather than original time

Describe the bug

I'm using the task plugin with the reminder plugin. I have a repeating reminder (every day at 22:09, for example). Say i postpone it for 1 minute. After completion, the new task include 22:10 rather than 22:09.

test.mov

Expected Behavior

The newly created task should have the original time rather than the postponed time.

Steps to reproduce

Create a repeating task with reminder then postpone it, then complete it. The new task will include the postponed time rather than the original time.

Operating system

macOS

[Bug]: when completing repeating task, the reminder date doesn't change

Describe the bug

I'm using the task plugin with the reminder plugin, I created a repeating task with a reminder. Sometimes I want to complete the task before the reminder triggers, but the reminder date doesn't change to the next recurrence. The recurrence only change when I complete it from notification or obsidian pop up

test.mov

Expected Behavior

The reminder date should change to the next recurrence.

Steps to reproduce

Create a repeating task with a reminder, then complete it before the reminder triggers.

Operating system

macOS

[Bug]: Show Reminder

Describe the bug

Show reminder feature works on the Obsidian desktop. However, it does not work on the mobile (android version).

Expected Behavior

Open up the reminder panel

Steps to reproduce

  • call the show reminder from obsidian command palette.

Operating system

Android

[Bug]: Using Kanban format as primary format doesn't recognised dates linked to daily notes

Describe the bug

I have configured Reminders to use the Kanban date format as the primary format. This correctly constructs dates with either the @{} or @[[]] format based on the setting in the Kanban config which controls linking to daily notes. If I set the option in the Kanban config to link to daily notes and create a new date using the Reminder calendar popup then it correctly creates the date in the appropriate format but does not recognise it as a reminder.

Expected Behavior

It should recognised dates in Kanban format linked to daily notes as valid reminders.

Steps to reproduce

Configure Reminders to use the Kanban daily note format. Configure Kanban to link to daily notes. Create a new reminder date on a todo. It will create the date in the Kanban format @[[]] but will not recognise it as a reminder.

Operating system

Linux

mobile reminder

Hi again, can you add support for mobile reminders ? I tried setting a reminder in android but nothing showed up except for the in-app reminder.

  • Obsidian was allowed to display notifications
  • The plugin's setting for "system notification" was enabled

support for obsidian-tasks recurring date

When enabling "reminder plugin format" in the settings and completing a recurring task created by the "obsidian-tasks" via the reminder, the task plugin doesn't create a new task with the new recurring date.

make it play nice with the natural language dates plugin

This plugin https://github.com/argenos/nldates-obsidian have the trigger "@" by default so when I write "(@" (without disabling "nldates") then select a date, it removes the "@" so it doesn't recognize the task until I re-add the "@".

Fortunately, I can change the trigger for "nldates". But for a beginner, it would be nice if he knew this conflict beforehand, maybe add it in the description of this plugin.

Also, the ability to change this plugin trigger would be nice.
Thank you.

Reminder not showing up

image
tired to set reminders and list the reminder as give in the readme. seems not working

image

did I missed anything !?

Thanks for developing this plugin :)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.