dashy/public-ip-widget-examples.yml
Zhaoxuan Chen 295977b389 feat(widgets): add hideDetails option to public-ip widget
- Add boolean hideDetails option to hide geographical information
- When hideDetails is true, only display public IP address
- Hide ISP name, location, country flag, and map link when enabled
- Add robust error handling for missing geographical data
- Maintain full backward compatibility with existing configurations
- Update documentation with new option and usage examples

Closes #1530
2025-09-23 23:48:35 +08:00

37 lines
864 B
YAML

# Public IP Widget Configuration Examples
# Example 1: Default behavior (shows IP + geographical details)
widgets:
- type: public-ip
options:
provider: ipapi.co
# Example 2: Hide geographical details (IP only)
widgets:
- type: public-ip
options:
provider: ipapi.co
hideDetails: true
# Example 3: With custom provider and hidden details
widgets:
- type: public-ip
options:
provider: ip-api
hideDetails: true
# Example 4: Using ipgeolocation provider with API key (full details)
widgets:
- type: public-ip
options:
provider: ipgeolocation
apiKey: VUE_APP_IPGEOLOCATION_API_KEY
hideDetails: false
# Example 5: Using ip2location.io with hidden details
widgets:
- type: public-ip
options:
provider: ip2location.io
apiKey: VUE_APP_IP2LOCATION_API_KEY
hideDetails: true