Skip to content

Added the custom list widget #1871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 19, 2025

Conversation

alayham
Copy link
Contributor

@alayham alayham commented Jul 18, 2025

alayham Medium alayham /feature/custom-list-widget → Lissy93/dashy Commits: 1 | Files Changed: 3 | Additions: 256 Label Powered by Pull Request Badge

Category: Feature

Overview
Added a new widget to display custom schema-compliant JSON in lists. The schema is included in the documentation, along with an example.
The JSON input for this list includes a date, and the widget can be configured to highlight list items that are newer than a certain number of days in the past.
The list format is very similar to other list widgets like the Proxmox widget and the public holidays widget.

Why
Widgets are rendered on every page load. It is more efficient to cache the widget data when the widget does not require real time updates on every page load, and this can be done using a script, a cron job, or a data pipeline.

Screenshot
image

Testing
The above screenshot was generated from the following configuration

      - type: custom-list
        options:
          url: /json-data/github-releases.json
          title: 'Github Releases'
          daysForNew: 5

The input json is:

[
    {
        "link": {
            "text": "jellyfin/jellyfin",
            "url": "https://github.com/jellyfin/jellyfin/releases/tag/v10.10.7",
            "title": ""
        },
        "value": {
            "text": "v10.10.7",
            "title": "2025-04-05"
        },
        "date": "2025-04-05T19:14:59Z"
    },
    {
        "link": {
            "text": "jellyfin/jellyfin-web",
            "url": "https://github.com/jellyfin/jellyfin-web/releases/tag/v10.10.7",
            "title": ""
        },
        "value": {
            "text": "v10.10.7",
            "title": "2025-04-05"
        },
        "date": "2025-04-05T19:15:00Z"
    },
    {
        "link": {
            "text": "lissy93/dashy",
            "url": "https://github.com/Lissy93/dashy/releases/tag/3.1.1",
            "title": ""
        },
        "value": {
            "text": "3.1.1",
            "title": "2024-05-30"
        },
        "date": "2024-05-30T17:20:53Z"
    },
    {
        "link": {
            "text": "VSCodium/vscodium",
            "url": "https://github.com/VSCodium/vscodium/releases/tag/1.102.14746",
            "title": ""
        },
        "value": {
            "text": "1.102.14746",
            "title": "2025-07-16"
        },
        "date": "2025-07-16T18:27:49Z"
    }
]

To test the widget, put this json data in a file inside the user-data directory, and point the widget to it.

Code Quality Checklist

  • All changes are backwards compatible
  • All lint checks and tests are passing
  • There are no (new) build warnings or errors
  • (If a new config option is added) Attribute is outlined in the schema and documented
  • (If a new dependency is added) Package is essential, and has been checked out for security or performance
  • (If significant change) Bumps version in package.json

@alayham alayham requested a review from Lissy93 as a code owner July 18, 2025 23:03
Copy link

netlify bot commented Jul 18, 2025

Deploy Preview for dashy-dev ready!

Name Link
🔨 Latest commit 9ee4d24
🔍 Latest deploy log https://app.netlify.com/projects/dashy-dev/deploys/687ad2dfb4b8260008cd4bdb
😎 Deploy Preview https://deploy-preview-1871--dashy-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Owner

@Lissy93 Lissy93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@Lissy93 Lissy93 merged commit b7d40c5 into Lissy93:master Jul 19, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants