https://github.com/openbb-finance/widgets-library
OpenBB Terminal Pro widgets library
https://github.com/openbb-finance/widgets-library
Last synced: 3 months ago
JSON representation
OpenBB Terminal Pro widgets library
- Host: GitHub
- URL: https://github.com/openbb-finance/widgets-library
- Owner: OpenBB-finance
- Created: 2023-11-21T00:00:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-13T16:11:47.000Z (8 months ago)
- Last Synced: 2025-06-03T21:04:29.861Z (4 months ago)
- Size: 11.1 MB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: news/company_news.png
Awesome Lists containing this project
README
# Widgets Library
Update :
We just need to populate the imgUrl in the new widgets.json now as we read from [here](https://pro.openbb.co/assets/data/widgets.json) - The images can go in any of the folders above
Deprecated :
This repository contains the widget images that are going to be part of the Terminal Pro widget library documentation [here](https://docs.openbb.co/pro/widgets-library).
The [latest widgets.json file](https://github.com/OpenBB-finance/terminalpro/blob/colinsmh/src/lib/widgets.json) on the Terminal Pro should be copy-pasted to the root of this repo.
This is what will be used to get the `category`, `widgetId`, `name`, `description`, and `source`.
The widgets.json file will have the following format:
```json
"market_overview": {
"searchCategory": "general-information",
"name": "Market Indices",
"description": "Show market overview (SP500, Nasdaq, Gold, ...)",
"category": "equity",
"widgetType": "individual",
"widgetId": "market_overview",
"gridData": {
"w": 40,
"h": 2,
"minW": 20
},
"source": [
"fmp"
]
},
"equity_select": {
"searchCategory": "price",
"name": "Ticker Information",
"description": "Ticker Information",
"category": "equity",
"widgetType": "individual",
"widgetId": "equity_select",
"gridData": {
"w": 20,
"h": 2
},
"source": [
"fmp"
]
},
```
An image needs to be created in this repository with the following format: {category}/{widgetId}.png.
This is what will be used to generate the docs images.