Skip to content

Commit 9c46600

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

409 files changed

Lines changed: 3846 additions & 2386 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/widgets/countdown-widget.md

Lines changed: 34 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -151,67 +151,46 @@ Use the following options when editing the widget:
151151
152152
<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">
153153

154-
<br/>
155-
<div id="note"></div>
156-
157-
> [!NOTE]
158-
>
159-
> * `col` parameter works **only for Medium and Large** widgets.
160-
>
161-
> * **Medium widget** shows top **4** events.
162-
> * **Large widget** shows top **10** events.
163-
> * If no `col` is used, widget defaults to **list view**:
164-
>
165-
> * **Medium:** top **3** events.
166-
> * **Large:** top **7** events.
167-
> * In **small** widgets:
168-
>
169-
> * Type any name from your Google Sheet (e.g., `mom`, `dad`) to show that person's event.
170-
>
171-
> * If the emoji is 🎂, it will automatically append `'s Birthday`.
172-
> * If it's 🥂, it appends `'s Anniversary`.
173-
> * *It only supports these two emojis, but you can always add more to your liking by updating the `titleSuffixes` array.*
174-
> * You can also use numeric indexes (e.g., `1`, `2`) to select an upcoming event by position.
175-
> * Default is the **most upcoming event**.
176-
> * Using `age` shows the years passed since the event date — useful for birthdays or anniversaries.
177-
>
178-
> * If today is the event date, countdown is hidden and only age is shown.
179-
>
180-
> * **Pagination (`pg`)**:
181-
> * Use `pg1`, `pg2`, `pg3`, etc., to display **multiple pages** of events.
182-
>
183-
> * In **list view** (default):
184-
> * **Medium widget**: each page displays **3 events**.
185-
> * **Large widget**: each page displays **7 events**.
186-
> * In **grid view** (`col`):
187-
>
188-
> * **Medium widget**: each page displays **4 events**.
189-
> * **Large widget**: each page displays **10 events**.
190-
>
191-
> * Example:
192-
> * `pg2`: shows the second page of events.
193-
> * `col,pg3`: shows the third page of events in grid view.
194-
>
195-
> * **Offline Fallback & Regular Sync**:
196-
>
197-
> * Events are automatically cached locally in the `.cache` folder.
198-
> * Widget gracefully **falls back to cached data** when offline.
199-
> * Data automatically updates daily at **2:00 AM**.
200154

201155

202-
## 📷 Screenshots
203156

204-
<!--
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:
166+
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.
205174

206-
| ![](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/src/countdown/countdown_s.png) | ![](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/src/countdown/countdown_age_s.PNG) | ![](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/src/countdown//countdown_bday_s.PNG) |
207-
|:--:|:--:|:--:|
208-
| Countdown | Age Display | On Birthday |
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.
209186

210-
| ![](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/src/countdown/countdown_m.PNG) | ![](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/src/countdown//countdown_col_m.PNG) | ![](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/src/countdown//countdown_l.PNG) |
211-
|:--:|:--:|:--:|
212-
| Medium Widget | Color View | Large View |
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**.
213191

214-
-->
192+
193+
## 📷 Screenshots
215194

216195
> _Small Widgets_
217196

0 commit comments

Comments
 (0)