{"id":17717397,"url":"https://github.com/achaak/circle-bar","last_synced_at":"2025-07-19T08:11:06.466Z","repository":{"id":113798143,"uuid":"192333005","full_name":"Achaak/circle-bar","owner":"Achaak","description":"This is a module to simply add a circle bar to your site.","archived":false,"fork":false,"pushed_at":"2019-06-24T15:45:54.000Z","size":37,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-03-05T19:57:08.910Z","etag":null,"topics":["circle-bars","component","js","js-component","progress-bar"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/Achaak.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-17T11:23:40.000Z","updated_at":"2021-09-29T05:31:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"1eb62000-05dd-4e8d-a8b7-d5ac73837089","html_url":"https://github.com/Achaak/circle-bar","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Achaak%2Fcircle-bar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Achaak%2Fcircle-bar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Achaak%2Fcircle-bar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Achaak%2Fcircle-bar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Achaak","download_url":"https://codeload.github.com/Achaak/circle-bar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246465282,"owners_count":20781928,"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":["circle-bars","component","js","js-component","progress-bar"],"created_at":"2024-10-25T14:20:27.541Z","updated_at":"2025-03-31T12:21:38.148Z","avatar_url":"https://github.com/Achaak.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# circle-bar\nThis is a module to simply add a circle bar to your site.\n\n\u003cimg src=\"pictures/circle-bar-preview.png\" alt=\"circle bar preview\"/\u003e\n\n\n## Requirement :\n* JQuery\n\n## Install :\nLoad the required files.\nInside the page's head tag include the circle bar's CSS file.\n``` html\n\u003clink rel=\"stylesheet\" href=\"/your-path/circle-bar.css\"\u003e\n```\n\nAnd in the page's footer, include the required javascript files.\n``` html\n\u003cscript src=\"/your-path/circle-bar.js\"\u003e\u003c/script\u003e\n```\n\n## Initialize :\nFor initialize the circle bar, insert this example snippet and update this with your parameters.\nExemple: \n``` js\n$(document).ready(function() {\n    circleBar().init(\n        \"#circle-bar\", \n        {\n            text: \"Insert your text\",\n            lineColor: \"#1d8eff\",\n            lineBgColor: \"rgb(150, 203, 255)\",\n            backgroundColor: \"white\",\n            lineWidth: \"15\",\n            lineWidthHover: \"7\",\n            bgLineWidth: \"10\",\n            bgLineWidthHover: \"4\",\n            lineDuration: \"200ms\",\n            lineDelay: \"100ms\",\n            diameter: \"300\",\n            viewPourcentage: true,\n            textCSS: {\n                \"color\": \"#a0a0a0\",\n                \"font-weight\": \"bold\",\n                \"font-family\": \"Verdana, Arial, Helvetica, sans-serif\",\n                \"font-size\": \"1rem\"\n            },\n            textHoverCSS: {\n                \"font-size\": \"1.5rem\",\n                \"color\": \"#1d8eff\"\n            },\n            pourcentageCSS: {\n                \"color\": \"#a0a0a0\",\n                \"font-weight\": \"bold\",\n                \"font-family\": \"Verdana, Arial, Helvetica, sans-serif\",\n                \"text-transform\": \"uppercase\",\n                \"font-size\": \"1rem\"\n            },\n            pourcentageHoverCSS: {\n                \"font-size\": \"1.5rem\",\n                \"color\": \"#1d8eff\"\n            }\n        },\n        50\n    );\n});\n```\n\n\n## Options :\n```\ntext: [string],\nlineColor: \u003crgb()\u003e | \u003crgba()\u003e | \u003chsl()\u003e | \u003chsla()\u003e | \u003chex-color\u003e | \u003cnamed-color\u003e | currentcolor | \u003cdeprecated-system-color\u003e,\nlineBgColor: \u003crgb()\u003e | \u003crgba()\u003e | \u003chsl()\u003e | \u003chsla()\u003e | \u003chex-color\u003e | \u003cnamed-color\u003e | currentcolor | \u003cdeprecated-system-color\u003e,\nbackgroundColor: \u003crgb()\u003e | \u003crgba()\u003e | \u003chsl()\u003e | \u003chsla()\u003e | \u003chex-color\u003e | \u003cnamed-color\u003e | currentcolor | \u003cdeprecated-system-color\u003e,\nlineWidth: [number],\nlineWidthHover: [number],\nbgLineWidth: [number],\nbgLineWidthHover: [number],\nlineDuration: [duration],\nlineDelay: [duration],\ndiameter: [number],\nviewPourcentage: [boolean],\ntextCSS: {\n/*\n    Example :\n    \"color\": \"#a0a0a0\",\n    \"font-weight\": \"bold\",\n    \"font-family\": \"Verdana, Arial, Helvetica, sans-serif\",\n    \"font-size\": \"1rem\"\n*/\n},\ntextHoverCSS: {\n/*\n    Example :\n    \"font-size\": \"1.5rem\",\n    \"color\": \"#1d8eff\"\n*/\n},\npourcentageCSS: {\n/*\n    Example :\n    \"color\": \"#a0a0a0\",\n    \"font-weight\": \"bold\",\n    \"font-family\": \"Verdana, Arial, Helvetica, sans-serif\",\n    \"text-transform\": \"uppercase\",\n    \"font-size\": \"1rem\"\n*/\n},\npourcentageHoverCSS: {\n/*\n    Example :\n    \"font-size\": \"1.5rem\",\n    \"color\": \"#1d8eff\"\n*/\n}\n```\n\n## Fonctions :\n- [circleBar().init](#init)\n- [circleBar().getValue](#getValue)\n- [circleBar().getOpts](#getOpts)\n- [circleBar().setText](#setText)\n- [circleBar().setValue](#setValue)\n- [circleBar().setLineColor](#setLineColor)\n- [circleBar().setLineBgColor](#setLineBgColor)\n- [circleBar().setBgColor](#setBgColor)\n- [circleBar().setLineWidth](#setLineWidth)\n- [circleBar().setBgLineWidth](#setBgLineWidth)\n- [circleBar().setLineDuration](#setLineDuration)\n- [circleBar().setLineDelay](#setLineDelay)\n- [circleBar().setLineWidthHover](#setLineWidthHover)\n- [circleBar().setbgLineWidthHover](#setbgLineWidthHover)\n- [circleBar().setLineTransitionHover](#setLineTransitionHover)\n- [circleBar().viewPourcentage](#viewPourcentage)\n- [circleBar().setTextCSS](#setTextCSS)\n- [circleBar().setTextHoverCSS](#setTextHoverCSS)\n- [circleBar().setPourcentageCSS](#setPourcentageCSS)\n- [circleBar().setPourcentageHoverCSS](#setPourcentageHoverCSS)\n\n__circleBar().init__ \u003ca name=\"init\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to create the circle bar\n *\n * @param {string} _elem Class or id of the slider\n * @param {Array} _opts List of options\n * @param {number} _value Value of the circle bar\n */\ncircleBar.createCircleBar(elem, opts, value);\n```\n\n__circleBar().getValue__ \u003ca name=\"getValue\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to get the value of the circle bar\n */\ncircleBar.getValue();\n```\n\n__circleBar().getOpts__ \u003ca name=\"getOpts\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to get the options of the circle bar\n */\ncircleBar.getOpts();\n```\n\n__circleBar().setText__ \u003ca name=\"setText\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set text\n *\n * @param {string} _text Text to insert\n */\ncircleBar.setText(text);\n```\n\n__circleBar().setValue__ \u003ca name=\"setValue\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set a value\n *\n * @param {number} _val Value of the circle bar\n */\ncircleBar.setValue(value);\n```\n\n__circleBar().setLineColor__ \u003ca name=\"setLineColor\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the color of the line of the circle bar\n * \n * @param {string} _lineColor \u003crgb()\u003e | \u003crgba()\u003e | \u003chsl()\u003e | \u003chsla()\u003e | \u003chex-color\u003e | \u003cnamed-color\u003e | currentcolor | \u003cdeprecated-system-color\u003e\n */\ncircleBar.setLineColor(lineColor);\n```\n\n__circleBar().setLineBgColor__ \u003ca name=\"setLineBgColor\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the background color of the line of the circle bar\n *\n * @param {string} _lineBgColor \u003crgb()\u003e | \u003crgba()\u003e | \u003chsl()\u003e | \u003chsla()\u003e | \u003chex-color\u003e | \u003cnamed-color\u003e | currentcolor | \u003cdeprecated-system-color\u003e\n */\ncircleBar.setLineBgColor(lineBgColor);\n```\n\n__circleBar().setBgColor__ \u003ca name=\"setBgColor\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the background color of the circle bar\n *\n * @param {string} _bgColor \u003crgb()\u003e | \u003crgba()\u003e | \u003chsl()\u003e | \u003chsla()\u003e | \u003chex-color\u003e | \u003cnamed-color\u003e | currentcolor | \u003cdeprecated-system-color\u003e\n */\ncircleBar.setBgColor(bgColor);\n```\n\n__circleBar().setLineWidth__ \u003ca name=\"setLineWidth\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the line width\n *\n * @param {number} _lineWidth Width of the line\n */\ncircleBar.setLineWidth(lineWidth);\n```\n\n__circleBar().setBgLineWidth__ \u003ca name=\"setBgLineWidth\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the background line width\n *\n * @param {number} _bgLineWidth Width of the background line\n */\ncircleBar.setBgLineWidth(bgLineWidth);\n```\n\n__circleBar().setLineDuration__ \u003ca name=\"setLineDuration\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the line duration of the circle bar transition\n *\n * @param {string} _lineDuration Duration of the transition\n */\ncircleBar.setLineDuration(lineDuration);\n```\n\n__circleBar().setLineDelay__ \u003ca name=\"setLineDelay\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the line delay of the circle bar transition\n *\n * @param {string} _lineDelay Delay of the transition\n */\ncircleBar.setLineDelay(lineDelay);\n```\n\n__circleBar().setLineWidthHover__ \u003ca name=\"setLineWidthHover\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the line hover width\n *\n * @param {number} _lineWidthHover Width of the line hover\n */\ncircleBar.setLineWidthHover(lineWidthHover);\n```\n\n__circleBar().setbgLineWidthHover__ \u003ca name=\"setbgLineWidthHover\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the background line hover width\n *\n * @param {number} _bgLineWidthHover Width of the background line hover\n */\ncircleBar.setbgLineWidthHover(bgLineWidthHover);\n```\n\n__circleBar().setLineTransitionHover__ \u003ca name=\"setLineTransitionHover\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the line transition hover of the circle bar transition\n *\n * @param {string} _lineTransitionHover Duration of the transition\n */\ncircleBar.setLineTransitionHover(lineTransitionHover);\n```\n\n__circleBar().viewPourcentage__ \u003ca name=\"viewPourcentage\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to view the pourcentage of the circle bar\n *\n * @param {boolean} _bool True for view pourcentage if not false\n */\ncircleBar.viewPourcentage(bool);\n```\n\n__circleBar().setTextCSS__ \u003ca name=\"setTextCSS\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the CSS of the text\n *\n * @param {Array} _css Array of CSS\n */\ncircleBar.setTextCSS(css);\n```\n\n__circleBar().setTextHoverCSS__ \u003ca name=\"setTextHoverCSS\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the hover CSS of the text\n *\n * @param {Array} _css Array of CSS\n */\ncircleBar.setTextHoverCSS(css);\n```\n\n__circleBar().setPourcentageCSS__ \u003ca name=\"setPourcentageCSS\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the CSS of the pourcentage\n *\n * @param {Array} _css Array of CSS\n */\ncircleBar.setPourcentageCSS(css);\n```\n\n__circleBar().setPourcentageHoverCSS__ \u003ca name=\"setPourcentageHoverCSS\"\u003e\u003c/a\u003e\n``` js\n/**\n * Used to set the hover CSS of the pourcentage\n *\n * @param {Array} _css Array of CSS\n */\ncircleBar.setPourcentageHoverCSS(css);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fachaak%2Fcircle-bar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fachaak%2Fcircle-bar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fachaak%2Fcircle-bar/lists"}