{"id":13683644,"url":"https://github.com/tvjsx/tvjs-overlays","last_synced_at":"2025-04-09T23:22:20.196Z","repository":{"id":39174031,"uuid":"251059839","full_name":"tvjsx/tvjs-overlays","owner":"tvjsx","description":"💴  Collection of overlays made by the TradingVueJs community","archived":false,"fork":false,"pushed_at":"2023-01-07T04:37:12.000Z","size":3275,"stargazers_count":104,"open_issues_count":22,"forks_count":59,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-02T22:08:44.219Z","etag":null,"topics":["ez","good","indicators","money","trading","trading-algorithms","trading-platform","trading-strategies","trading-systems","tradingview","tvjs-overlays","vue","vuejs"],"latest_commit_sha":null,"homepage":"https://github.com/tvjsx/trading-vue-js","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tvjsx.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-29T15:03:57.000Z","updated_at":"2025-02-24T20:59:42.000Z","dependencies_parsed_at":"2023-02-06T12:01:06.220Z","dependency_job_id":null,"html_url":"https://github.com/tvjsx/tvjs-overlays","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tvjsx%2Ftvjs-overlays","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tvjsx%2Ftvjs-overlays/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tvjsx%2Ftvjs-overlays/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tvjsx%2Ftvjs-overlays/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tvjsx","download_url":"https://codeload.github.com/tvjsx/tvjs-overlays/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248126561,"owners_count":21051963,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["ez","good","indicators","money","trading","trading-algorithms","trading-platform","trading-strategies","trading-systems","tradingview","tvjs-overlays","vue","vuejs"],"created_at":"2024-08-02T13:02:20.376Z","updated_at":"2025-04-09T23:22:20.164Z","avatar_url":"https://github.com/tvjsx.png","language":"Vue","funding_links":[],"categories":["Vue"],"sub_categories":[],"readme":"\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg width=\"318\" heigth=\"256\" src=\"assets/README-e6a22b27.png\" alt=\"trading-vue logo\"\u003e\n\u003c/div\u003e\n\n# TVJS Overlay Pack ![npm](https://img.shields.io/npm/v/tvjs-overlays.svg?color=brightgreen\u0026label=version) ![license](https://img.shields.io/badge/license-MIT-blue.svg) ![GRUGLIKE](https://img.shields.io/badge/GRUG-LIKE-yellow.svg) ![build](https://img.shields.io/badge/build-passing-brightgreen.svg) ![size](https://img.shields.io/github/size/tvjsx/tvjs-overlays/dist/tvjs-overlays.min.js.svg)\n\n**TVJS Overlays** is a collection of overlays made by the [TradingVue.js](https://github.com/tvjsx/trading-vue-js) community.\n\n## List\n\n| Name | Author | Type | Description | Version |\n|---|---|---|---|---|\n| [ALMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/ALMA) | StdSquad | OV+Script | Arnaud Legoux Moving Average | 1.0.0 |\n| [ATR](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/ATR) | StdSquad | OV+Script | Average True Range | 1.0.0 |\n| [ATRp](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/ATRp) | StdSquad | OV+Script | Average True Range, % | 1.0.0 |\n| [Area51](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Area51) | 👽 | OV | Gradient area chart | 1.0.0 |\n| [BB](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/BB) | StdSquad | OV+Script | Bollinger Bands | 1.0.0 |\n| [BBW](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/BBW) | StdSquad | OV+Script | Bollinger Bands Width | 1.0.0 |\n| [CCI](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/CCI) | StdSquad | OV+Script | Commodity Channel Index | 1.0.0 |\n| [CMO](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/CMO) | StdSquad | OV+Script | Chande Momentum Oscillator | 1.0.0 |\n| [COG](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/COG) | StdSquad | OV+Script | Center of Gravity | 1.0.0 |\n| [DHistogram](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/DHistogram) | Acid3croco | OV | Double Histogram Plot | 1.0.0 |\n| [DMI](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/DMI) | StdSquad | OV+Script | Directional Movement Index | 1.0.0 |\n| [EMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/EMA) | StdSquad | OV+Script | Exponential Moving Average | 1.0.0 |\n| [HMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/HMA) | StdSquad | OV+Script | Hull Moving Average | 1.0.0 |\n| [Histogram](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Histogram) | StdSquad | OV | Histogram plot | 1.0.0 |\n| [Ichi](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Ichi) | C451 | OV+Script | Ichimoku Cloud based on scripts | 1.0.0 |\n| [Ichimoku](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Ichimoku) | Sudeep Batra | OV |  | 1.0.0 |\n| [KC](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/KC) | StdSquad | OV+Script | Keltner Channels | 1.0.0 |\n| [KCW](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/KCW) | StdSquad | OV+Script | Keltner Channels Width | 1.0.0 |\n| [LongShortTrades](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/LongShortTrades) | Sudeep Batra | OV |  | 1.0.1 |\n| [MACD](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/MACD) | StdSquad | OV+Script | Moving Average Convergence/Divergence | 1.0.2 |\n| [MFI](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/MFI) | StdSquad | OV+Script | Money Flow Index | 1.0.0 |\n| [MOM](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/MOM) | StdSquad | OV+Script | Momentum | 1.0.0 |\n| [Markers](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Markers) | C451 | OV | Interactive markers | 1.0.1 |\n| [PlotCross](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/PlotCross) | StdSquad | OV | Plot line with crosses | 1.0.0 |\n| [ROC](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/ROC) | StdSquad | OV+Script | Rate of Change | 1.0.0 |\n| [RSI](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/RSI) | StdSquad | OV+Script | Relative Strength Index | 1.0.0 |\n| [Ribbon](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Ribbon) | StdSquad | OV+Script | Moving Average Ribbon | 1.0.0 |\n| [SAR](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/SAR) | StdSquad | OV+Script | Parabolic SAR | 1.0.0 |\n| [SMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/SMA) | StdSquad | OV+Script | Simple Moving Average | 1.0.0 |\n| [SWMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/SWMA) | StdSquad | OV+Script | Symmetrically Weighted Moving Average | 1.0.0 |\n| [Stoch](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/Stoch) | StdSquad | OV+Script | Stochastic | 1.0.0 |\n| [TSI](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/TSI) | StdSquad | OV+Script | True Strength Index | 1.0.0 |\n| [TradesPlus](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/TradesPlus) | C451 | OV | Trades overlay with stops | 1.0.1 |\n| [VWMA](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/VWMA) | StdSquad | OV+Script | Volume Weighted Moving Average | 1.0.0 |\n| [WilliamsR](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/WilliamsR) | StdSquad | OV+Script | Williams %R | 1.0.0 |\n| [XOhlcBars](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/XOhlcBars) | X | OV | Bar Chart | 1.3.0 |\n\n## Install\n\n**NPM**\n```\nnpm i tvjs-overlays\n```\n**In browser**\n\n```\n\u003cscript src=\"tvjs-overlays.min.js\"\u003e\u003c/script\u003e\n```\n\n## How to use\n\n**NPM**\n\n```html\n\u003ctemplate\u003e\n\u003ctrading-vue :data=\"data\" :overlays=\"overlays\"/\u003e\n\u003c/template\u003e\n\u003cscript\u003e\n\nimport TradingVue from 'trading-vue-js'\nimport Overlays from 'tvjs-overlays'\n\nexport default {\n    name: 'app',\n    components: { TradingVue },\n    data() {\n        return {\n            overlays: Object.values(Overlays),\n            data: new DataCube(...)\n        }\n    }\n}\n\n\u003c/script\u003e\n\n```\n\n**In browser**\n\n```html\n\u003cdiv id=\"app\"\u003e\n\u003ctrading-vue :data=\"data\" :overlays=\"overlays\"/\u003e\n\u003c/div\u003e\n\u003cscript\u003e\napp = new Vue({\n    el: '#app',\n    data: {\n        overlays: Object.values(TvjsOverlays),\n        data: new TradingVueJs.DataCube(...)\n    }\n})\n\u003c/script\u003e\n```\n\n## Adding new overlay\n\n1. Create a folder in `src/overlays` named just like your overlay: `YourOverlayName`\n2. Your main code must be in `YourOverlayName.vue`, but you can use .js and .json imports\n3. Add your data sample `data.json`\n4. Make sure that the following conditions are met:\n```\n    * folder name === .vue file name === overlay name\n    * required functions: draw, use_for\n    * use_for includes the name\n    * use_for.length === 1\n    * name is unique (format: CapitalizedWords, Numbers_123)\n    * required meta: author, version\n    * data.json \u003c 1MB\n```\n\n5. `npm run check` to check that everything is OK\n6. `npm run compile` to build the development index\n7. `npm run dev` to test your overlays\n8. Add a short README.md ([example](https://github.com/tvjsx/tvjs-overlays/tree/master/src/overlays/TestOverlay1))\n9. Submit a PR request to this repo\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftvjsx%2Ftvjs-overlays","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftvjsx%2Ftvjs-overlays","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftvjsx%2Ftvjs-overlays/lists"}