Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Larkinabout committed Sep 2, 2022
1 parent 9cf6a3f commit 78fbfdb
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,22 @@ Set the default background color of the inner circle. Default is #b0000066.

# Advanced Options
More options can be set using an optional array parameter: `ChallengeTracker.open(successes failures, {options})` where options is a comma-separated list of any of the following parameters in the format `option: value`:

### **backgroundImage**
Set the background/unset image of the challenge tracker

Example `backgroundImage: 'https://.../images/vintage-clock-face.webp'`

### **closeFunction**
Execute a function when a Challenge Tracker is closed.

Example `closeFunction: () => { ui.notifications.info('Goodbye!') }`

### **foregroundImage**
Set the foreground/set image of the challenge tracker

Example `backgroundImage: 'https://.../images/vintage-clock-face.webp'`

### **frameColor**
Set the hex color of the frame. The 'Frame Color' module setting will be ignored.

Expand Down

0 comments on commit 78fbfdb

Please sign in to comment.