Skip to content

Commit aeab989

Browse files
committed
Update countdown-widget.md
1 parent 9c46600 commit aeab989

File tree

1 file changed

+10
-39
lines changed

1 file changed

+10
-39
lines changed

docs/widgets/countdown-widget.md

Lines changed: 10 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -138,57 +138,28 @@ Use the following options when editing the widget:
138138
<td>Text</td>
139139
<td>
140140
<ul>
141-
<li>For e.g., <code>age</code>, <code>2</code>, <code>john,age</code>, <code>col</code>
142-
</li>
141+
<li>For e.g., <code>age</code>, <code>2</code>, <code>john,age</code>, <code>col</code></li>
143142
<li><a href="#note">Read below</a> for more instructions</li>
144143
</ul>
145-
</ul>
146144
</td>
147145
</tr>
148146
</table>
149147

150148
> _Here's a Screenshot of widget's config panal_
151149
152-
<img height="auto" width="500px" src="https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/countdown/countdown_config_panal.PNG" alt="countdown_config_panal.png">
153-
154-
155-
156-
157-
**Widget Parameter Notes:**
158-
159-
- `col` parameter works **only for Medium and Large** widgets.
160-
- **Medium widget** shows top **4** events.
161-
- **Large widget** shows top **10** events.
162-
- If no `col` is used, widget defaults to **list view**:
163-
- **Medium:** top **3** events.
164-
- **Large:** top **7** events.
165-
- In **small** widgets:
166150

167-
- Type any name from your Google Sheet (e.g., `mom`, `dad`) to show that person's event.
168-
- If the emoji is 🎂, it will automatically append `'s Birthday`.
169-
- If it's 🥂, it appends `'s Anniversary`.
170-
- It only supports these two emojis, but you can always add more to your liking by updating the `titleSuffixes` array.
171-
- You can also use numeric indexes (e.g., `1`, `2`) to select an upcoming event by position.
172-
- Default is the **most upcoming event**.
173-
- Using `age` shows the years passed since the event date — useful for birthdays or anniversaries. If today is the event date, countdown is hidden and only age is shown.
151+
![countdown_config_panal.png](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/countdown/countdown_config_panal.PNG)
174152

175-
**Pagination (`pg`)**:
176-
- Use `pg1`, `pg2`, `pg3`, etc., to display **multiple pages** of events.
177-
- In **list view** (default):
178-
- **Medium widget**: each page displays **3 events**.
179-
- **Large widget**: each page displays **7 events**.
180-
- In **grid view** (`col`):
181-
- **Medium widget**: each page displays **4 events**.
182-
- **Large widget**: each page displays **10 events**.
183-
- Example:
184-
- `pg2`: shows the second page of events.
185-
- `col,pg3`: shows the third page of events in grid view.
186153

187-
**Offline Fallback & Regular Sync:**
188-
- Events are automatically cached locally in the `.cache` folder.
189-
- Widget gracefully **falls back to cached data** when offline.
190-
- Data automatically updates daily at **2:00 AM**.
191154

155+
<b>Widget Parameter Notes:</b>
156+
<ul><li><b>col</b> parameter works <b>only for Medium and Large</b> widgets.<ul><li><b>Medium widget</b> shows top <b>4</b> events.</li><li><b>Large widget</b> shows top <b>10</b> events.</li></ul></li><li>If no <b>col</b> is used, widget defaults to <b>list view</b>:<ul><li><b>Medium:</b> top <b>3</b> events.</li><li><b>Large:</b> top <b>7</b> events.</li></ul></li></ul>
157+
<b>In small widgets:</b>
158+
<ul><li>Type any name from your Google Sheet (e.g., <code>mom</code>, <code>dad</code>) to show that person's event.</li><li>If the emoji is 🎂, it will automatically append <code>'s Birthday</code>.</li><li>If it's 🥂, it appends <code>'s Anniversary</code>.</li><li>It only supports these two emojis, but you can always add more to your liking by updating the <code>titleSuffixes</code> array.</li><li>You can also use numeric indexes (e.g., <code>1</code>, <code>2</code>) to select an upcoming event by position.</li><li>Default is the <b>most upcoming event</b>.</li><li>Using <code>age</code> shows the years passed since the event date — useful for birthdays or anniversaries. If today is the event date, countdown is hidden and only age is shown.</li></ul>
159+
<b>Pagination (<code>pg</code>):</b>
160+
<ul><li>Use <code>pg1</code>, <code>pg2</code>, <code>pg3</code>, etc., to display <b>multiple pages</b> of events.<ul><li>In <b>list view</b> (default):<ul><li><b>Medium widget</b>: each page displays <b>3 events</b>.</li><li><b>Large widget</b>: each page displays <b>7 events</b>.</li></ul></li><li>In <b>grid view</b> (<code>col</code>):<ul><li><b>Medium widget</b>: each page displays <b>4 events</b>.</li><li><b>Large widget</b>: each page displays <b>10 events</b>.</li></ul></li><li>Example:<ul><li><code>pg2</code>: shows the second page of events.</li><li><code>col,pg3</code>: shows the third page of events in grid view.</li></ul></li></ul></li></ul>
161+
<b>Offline Fallback & Regular Sync:</b>
162+
<ul><li>Events are automatically cached locally in the <code>.cache</code> folder.</li><li>Widget gracefully <b>falls back to cached data</b> when offline.</li><li>Data automatically updates daily at <b>2:00 AM</b>.</li></ul>
192163

193164
## 📷 Screenshots
194165

0 commit comments

Comments
 (0)