You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
36 lines
1.9 KiB
36 lines
1.9 KiB
---
|
|
title: Guides & Tutorials
|
|
description: Learn how to create and customize widgets in Homepage. Explore translations, widget components, widget metadata, proxy handlers, and making API calls.
|
|
icon: fontawesome/solid/graduation-cap
|
|
---
|
|
|
|
Widgets are a core component of Homepage. They are used to display information about your system, services, and environment.
|
|
|
|
## Overview
|
|
|
|
If you are new to Homepage widgets, and are looking to create a new widget, please follow along with the guide here: [Widget Tutorial](tutorial.md).
|
|
|
|
### Translations
|
|
|
|
All text and numerical content in widgets should be translated and localized. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage).
|
|
|
|
The Homepage community prides itself on being multilingual, and we strongly encourage you to add translations for your widgets.
|
|
|
|
If you are looking to learn more about translations, please refer to the guide here: [Translations Guide](translations.md).
|
|
|
|
### Widget Component
|
|
|
|
The widget component is the core of the widget. It is responsible for [fetching data from the API](api.md) and rendering the widget UI. Homepage provides a set of hooks and utilities to help you build your widget component.
|
|
|
|
If you are looking to learn more about widget components, please refer to the guide here: [Component Guide](component.md).
|
|
|
|
### Widget Metadata
|
|
|
|
Widget metadata defines the configuration of the widget. It defines the API endpoint to fetch data from, the proxy handler to use, and any data mappings.
|
|
|
|
If you are looking to learn more about widget metadata, endpoint and data mapping, please refer to the guide here: [Metadata Guide](metadata.md).
|
|
|
|
If you are looking to learn more about proxy handlers, please refer to the guide here: [Proxies Guide](proxies.md).
|
|
|
|
If you are looking to learn more making API calls from inside your widget, please refer to the guide here: [API Guide](api.md).
|