Skip to content

sdetweil/birthdaylist

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

install

cd ~/MagicMirror/modules
git clone https://github.com/sdetweil/birthdaylist
cd birthdaylist
npm install

reads from bdl.csv in the module data folder, sample provided

2 columns

birthday , name
07/21/76 , Fred

birthday can be any form of mm/dd/yyyy or yyyy/mm/dd
using any separator
(all the same format)

u can set colors in CSS.
sample provided in bdl.css

config params, and defaults

{ 
        module: "birthdaylist",
        position:'top_left',
        config: {
		dimmEntries: false,  // true: dims entries and the associated
				     //       symbol when the date has expired.
			             // false: dont display entries and the associated
				     //        symbol when the date has expired.
		initialLoadDelay: 0, // How many seconds to wait on a fresh start up.
				     // This is to prevent collision with all other modules also
				     // loading all at the same time. This only happens once,
				     // when the mirror first starts up.
		updateDelay: 5,      // How many seconds after midnight before a refresh
				     // This is to prevent collision with other
				     // modules refreshing at the same time.
		currentMonthOnly: true,  // will show birthdays for the current month only if true
		maxEntries: 0,	     // maximum entries to show, default is all
		dateFormat: '',	     // date format for birthday (default is none), could be 'Do' for 'Sep 12th'
		ageFormat:'',	     // some format string for the persons age, '[ n ]'  n will be replace by age value
		withMonth: false     // then true, add the month display as part of the date field, 
				     // using the same orientation and separator as the input csv data
		debug:false
                }
}

if no birthdays are found to display a message will be shown

no birthdays in range to display

About

display birthdays for the month from csv

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published