Birthday Reminder

1 📖 Birthday Reminder

English | 中文文档

An Obsidian plugin designed to help you easily manage important birthday information for friends, family, colleagues, and clients. The plugin supports Gregorian/Lunar calendar conversion, zodiac and Chinese animal sign display, intelligent calendar view, and automatically adapts to sidebar and main window layouts.

Whether you use Obsidian for personal life management or as a CRM tool for client relationships, this plugin makes birthday reminders elegant and efficient.

(Preview below)

This plugin is fully AI-generated, so please bear with me if there are any issues.

---

2 ✨ Features

2.1 🎯 Core Features

Feature	Description
Configurable Birthday Property	✨ Customize frontmatter property name – supports any naming like birthday, date_of_birth, DOB, etc.
Intelligent Birthday Calculation	Automatically calculates next birthday date and days remaining, accurately determines if this year's birthday has passed
Automatic Age Calculation	Automatically calculates upcoming age based on birth date
Lunar Calendar Conversion	Uses solarlunar for precise Gregorian to Lunar conversion, supports leap months
Zodiac & Animal Signs	Automatically displays zodiac sign and Chinese animal sign, adding cultural interest
Folder Filtering	Scan specific folders to avoid scanning entire vault

2.2 📊 Statistics

• Statistics Cards: Total count, today's birthdays, birthdays within 7 days, birthdays within 30 days at a glance
• Auto-grouping: Automatically categorized into today, next 7 days, next 30 days, and later birthdays
• Sorted Display: Automatically sorted by remaining days, upcoming birthdays appear first

2.3 📅 Calendar View

• Monthly Calendar: Displays all birthdays in calendar format, birthday dates highlighted
• Month Navigation: Supports previous/next month switching, one-click return to today
• Birthday Preview: Shows names of people with birthdays directly on calendar cells
• Click to Open: Click any birthday card or calendar cell to jump directly to the corresponding note

2.4 🎨 Interface Adaptation

• Responsive Layout: Automatically detects window width – compact mode in sidebar, full mode in main window
• Multiple Color Schemes: 5 built-in color schemes (Default, Warm Orange, Cool Blue, Nature Green, Elegant Purple)
• Dark/Light Theme: Perfectly adapts to Obsidian's dark and light themes

2.5 🌐 Multi-language Support

• Chinese/English: Interface language switching to meet different user needs
• Full Localization: All interface text fully translated for consistent experience

2.6 ⚙️ Highly Configurable

Setting	Description
Birthday Property Name	✨ Customize frontmatter property name, default birthday, supports date_of_birth, DOB, etc.
Target Folder	Specify folder path to scan
Visible Months	Number of months to display in calendar view (1-6 months)
Color Scheme	5 theme colors to choose from
Show Lunar Calendar	Toggle lunar date display
Show Zodiac & Animal	Toggle zodiac and animal sign display
Show Calendar View	Toggle monthly calendar display
Show Statistics	Toggle statistics cards display at top
Highlight Today's Birthdays	Toggle special highlighting for today's birthdays
Language	Chinese/English switching

3 🌟 Highlights

3.1 Configurable Birthday Property

No longer limited to the birthday property name! You can use any property name you prefer:

Option 1: Use default property

birthday: 1990-05-20

Option 2: Customize to date_of_birth

date_of_birth: 1990-05-20

Option 3: Customize to DOB

DOB: 1990-05-20

Simply configure the corresponding property name in plugin settings, and it will be automatically recognized!

3.2 One Field, All Features

Just add the birthday property to your note's frontmatter, and all features work automatically.

3.3 Perfect Sidebar & Main Window Adaptation

• Drag to sidebar → Automatically switches to compact mode, saving space
• Drag to main window → Automatically switches to full mode, displaying more information

3.4 Precise Lunar Conversion

Uses the professional solarlunar library, supporting precise lunar conversion for years 1900-2100, correctly handling leap months.

3.5 Elegant Calendar View

• Automatically fills previous/next month dates at month boundaries
• Cross-month dates displayed semi-transparently
• Today's date highlighted with special border
• Birthday cells support hover tooltips

3.6 One-Click Note Navigation

Click any birthday card or birthday name in the calendar to immediately open the corresponding note – no manual searching required.

3.7 Performance Optimized

• Uses ResizeObserver to monitor window changes for real-time layout adjustment
• Birthday data indexed by month, O(1) complexity for calendar rendering
• Automatically refreshes data every hour

---

4 📸 Interface Preview

4.1 Main Window Mode (Full Layout)

4.2 Sidebar Mode (Compact Layout)

4.3 Plugin Settings

---

5 🚀 Quick Start

5.1 Installation

The plugin is not yet available in the Obsidian community plugin store. You can install it using one of the following methods:

5.1.1 Method 1: Install via BRAT (Recommended)

1. Make sure you have the BRAT plugin installed and enabled.
2. Open Settings → BRAT (under Community Plugins).
3. Click the Add Beta Plugin button.
4. In the dialog that appears, enter the following repository address:
   https://github.com/ichris007/Obsidian-Birthday-Reminder
5. (Optional) Enter a name, e.g., Birthday Reminder.
6. Click Add Plugin. BRAT will automatically download and install it.
7. Once installed, go to Settings → Community Plugins, find Birthday Reminder, and enable it.

5.1.2 Method 2: Manual Installation

1. Download the latest release (main.js, manifest.json, styles.css) from the Releases page.
2. Extract the files into your Obsidian vault’s plugins folder:
   .obsidian/plugins/birthday-reminder/
3. Restart Obsidian.
4. Go to Settings → Community Plugins, find Birthday Reminder, and enable it.

5.2 Configuration Steps

1. After enabling the plugin, click the "Settings" icon next to it
2. Set Birthday Property Name (optional): If you use a custom property name like date_of_birth, enter it here
3. Set Target Folder: Specify the folder containing person notes (e.g., 07Relations/)
4. Adjust other options as needed (color scheme, display settings, etc.)
5. Add birthday property to notes in the target folder:

For example:

birthday: 1990-05-20

5.3 Usage

• Click the cake icon 🎂 in the left sidebar to open the birthday reminder panel
• Or use the Command Palette (Ctrl/Cmd + P) and type "Birthday Reminder"

---

6 📝 Changelog

6.1 v1.1.0 (2026-03-21)

• ✨ New Features

  • Full English interface support with localized animal signs, zodiac signs, lunar dates, and age units
  • Dynamic interface text based on language settings

• 🐛 Bug Fixes

  • Fixed issue where animal signs and zodiac signs displayed in Chinese even in English mode
  • Fixed age unit showing "岁" (Chinese) instead of "years old" in English mode

• 📝 Other

  • Improved multi-language localization support

6.2 v1.0.0 (2026-03-21)

• ✨ Initial Release
• 🎯 Configurable Birthday Property: Support custom frontmatter property names (birthday, date_of_birth, DOB, etc.)
• 🎯 Intelligent birthday calculation and age calculation
• 🌙 Lunar calendar conversion (using solarlunar library)
• 🐉 Zodiac and animal sign display
• 📅 Calendar view with month navigation
• 🎨 5 color schemes
• 🌐 Chinese/English bilingual support
• 📱 Responsive layout, automatically adapts to sidebar/main window
• ⚙️ Rich configuration options

---

7 🙏 Acknowledgments

• solarlunar- Lunar calendar calculation library
• Obsidian - Excellent note-taking software

---

8 📄 License

MIT License

---

9 🔗 Links

• GitHub Repository
• Issue Tracker

---

10 💡 FAQ

10.1 Q: I use the date_of_birth property. Can it be supported?

A: Yes! Simply change the "Birthday Property Name" in plugin settings to date_of_birth.

10.2 Q: Can multiple different property names be supported simultaneously?

A: Currently only one property name is supported, but you can choose the one you use most frequently and unify other notes accordingly.

10.3 Q: Is the lunar date accurate?

A: The plugin uses the professional solarlunar library, supporting precise lunar conversion for years 1900-2100, including leap month handling.

10.4 Q: Does the layout automatically switch between sidebar and main window?

A: Yes! The plugin automatically detects window width – switches to compact mode when width is less than 450px, and full mode when width is 450px or greater.