{"id":17305310,"url":"https://github.com/splittydev/hawkeye","last_synced_at":"2026-01-20T04:01:28.439Z","repository":{"id":37073726,"uuid":"409702808","full_name":"SplittyDev/hawkeye","owner":"SplittyDev","description":"A simple and extensible React Dashboard","archived":false,"fork":false,"pushed_at":"2023-01-26T20:17:45.000Z","size":1883,"stargazers_count":1,"open_issues_count":20,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-22T09:56:06.093Z","etag":null,"topics":["dashboard","hacktoberfest","widgets"],"latest_commit_sha":null,"homepage":"https://hawkeye-eta.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SplittyDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-23T18:28:51.000Z","updated_at":"2021-11-06T13:06:34.000Z","dependencies_parsed_at":"2023-02-14T23:16:19.578Z","dependency_job_id":null,"html_url":"https://github.com/SplittyDev/hawkeye","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SplittyDev/hawkeye","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplittyDev%2Fhawkeye","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplittyDev%2Fhawkeye/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplittyDev%2Fhawkeye/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplittyDev%2Fhawkeye/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SplittyDev","download_url":"https://codeload.github.com/SplittyDev/hawkeye/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplittyDev%2Fhawkeye/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28595316,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T02:08:49.799Z","status":"ssl_error","status_checked_at":"2026-01-20T02:08:44.148Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dashboard","hacktoberfest","widgets"],"created_at":"2024-10-15T11:55:18.180Z","updated_at":"2026-01-20T04:01:28.426Z","avatar_url":"https://github.com/SplittyDev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hawkeye Dashboard\n\u003e A React-based Dashboard with configurable widgets.\n\nThis is a toy project of mine and might never be finished.\n\n## Default Widgets\n\n- Random Advice\n- Inspirational Quotes\n- Kanye West Quotes\n- Quote of the Day\n- IP Address Viewer\n- Password Generator\n- Simple Crypto Price\n\n## Extending Hawkeye\n\n- Create a new widget in `src/components/widgets/`\n  - You can use the `DummyWidget.js` as a starting point\n- Export the widget as part of `ModuleList` in `src/components/widgets/index.js`\n\n## Widget Definitions\n\nA widget consists of two main parts: The component and the definition.\n\nWhile the component is responsible for handling user-interaction and rendering, the widget definition contains metadata such as a unique widget id, display name, tags (categories) and options. The options key is optional and will be used to provide a configuration modal.\n\nHere's an example of a widget definition:\n```js\nconst WidgetDefinition = {\n  id: 'some_unique_widget_id',\n  name: 'Widget Display Name',\n  tags: ['some', 'keywords'],\n  actions: {\n    [ACTION_REFRESH]: {\n      icon: FiRefreshCw, // from react-icons\n    }\n  },\n  options: {\n    isEnabled: {\n      name: 'Enabled?',\n      type: 'bool',\n      defaultValue: true\n    },\n  },\n  component: WidgetStyled,\n}\n\nexport default WidgetDefinition\n```\n\n## Widget Options\n\u003e Options are used to pass dynamic configuration to the widget.\n\n### Option Keys\n\n| Key            | Type (JS)                  | Required |\n| -------------- | -------------------------- | -------- |\n| `name`         | `string`                   | `no`     |\n| `type`         | `string`                   | `yes`    |\n| `defaultValue` | `any`                      | `no`     |\n\n### Option Types\n\n| Type       | Default Value              |\n| ---------- | -------------------------- |\n| `bool`     | `false`                    |\n| `string`   | `''`                       |\n\n## Widget Actions\n\u003e Actions are used to provide buttons in the widget header.\n\n1. You can provide actions in the `action` key of your widget definition\n2. The `useWidgetAction` hook can then be used to react to the action being fired\n\n### Example\n\n```js\nconst ACTION_REFRESH = 'refresh'\n\nconst Widget = ({ instance }) =\u003e {\n  useWidgetAction(instance, ACTION_REFRESH, () =\u003e {\n    // Do something on refresh\n  })\n\n  return (\n    \u003cdiv\u003eHello world\u003c/div\u003e\n  )\n}\n\nconst WidgetDefinition = {\n  id: 'my_widget',\n  tags: [],\n  actions: {\n    [ACTION_REFRESH]: {\n      icon: FiRefreshCw, // from react-icons\n    }\n  },\n  component: Widget,\n}\n\nexport default WidgetDefinition\n```\n\n## Widget Skeleton Loader\n\u003e Widgets can use a loading animation while fetching data.\n\n```js\nconst Widget = ({ instance }) =\u003e {\n  const setIsLoading = useSkeletonLoader(instance)\n\n  useEffect(() =\u003e {\n    setIsLoading(true)\n    // Do something expensive\n    setIsLoading(false)\n  }, [])\n\n  return (\n    \u003cdiv\u003eHello world\u003c/div\u003e\n  )\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplittydev%2Fhawkeye","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsplittydev%2Fhawkeye","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplittydev%2Fhawkeye/lists"}