{"id":13821972,"url":"https://github.com/joeycozza/marquee-ora","last_synced_at":"2026-02-04T05:48:07.228Z","repository":{"id":30495736,"uuid":"124945789","full_name":"joeycozza/marquee-ora","owner":"joeycozza","description":"A tool to create an ora compatible spinner object that behaves like a scrolling marquee","archived":false,"fork":false,"pushed_at":"2023-03-04T02:36:05.000Z","size":1367,"stargazers_count":80,"open_issues_count":2,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-05-14T07:59:01.044Z","etag":null,"topics":["cli","marquee","ora","scrolling"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/joeycozza.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-03-12T20:14:16.000Z","updated_at":"2024-12-05T16:11:28.000Z","dependencies_parsed_at":"2023-01-14T17:04:59.172Z","dependency_job_id":"0e0f4124-b1b4-4b84-a90a-a125a7eb9f15","html_url":"https://github.com/joeycozza/marquee-ora","commit_stats":{"total_commits":26,"total_committers":2,"mean_commits":13.0,"dds":"0.038461538461538436","last_synced_commit":"eb8bf07e035719a1f86be0b7da51f68d64311052"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeycozza%2Fmarquee-ora","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeycozza%2Fmarquee-ora/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeycozza%2Fmarquee-ora/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeycozza%2Fmarquee-ora/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joeycozza","download_url":"https://codeload.github.com/joeycozza/marquee-ora/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254556633,"owners_count":22090971,"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":["cli","marquee","ora","scrolling"],"created_at":"2024-08-04T08:01:36.445Z","updated_at":"2026-02-04T05:48:07.163Z","avatar_url":"https://github.com/joeycozza.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/joeycozza/marquee-ora.svg?branch=master)](https://travis-ci.org/joeycozza/marquee-ora)\n[![Maintainability](https://api.codeclimate.com/v1/badges/192675607b7e88b61e65/maintainability)](https://codeclimate.com/github/joeycozza/marquee-ora/maintainability)\n\n# marquee-ora\nA tool to create an ora compatible spinner object that behaves like a scrolling marquee\n\n## Install\n`npm install --save marquee-ora`\n\n## Usage\nThis module is to be used in conjunction with [ora](https://github.com/sindresorhus/ora) the elegant terminal spinner.\n\n```javascript\nconst ora = require('ora');\nconst marquee = require('marquee');\n\nconst spinner = ora({\n  text: 'This is a scrolling marquee',\n  spinner: marquee({text: 'This marquee rocks!!'})\n});\n\nspinner.start();\n\nsetTimeout(() =\u003e {\n  spinner.stop();\n}, 3000);\n```\nThis gif looks really slow, but the default interval isn't this bad, this is just the gif appearing slow\n![This marquee rocks!! Scrolling](https://github.com/joeycozza/marquee-ora/raw/master/gifs/thisMarqueeRocks.gif)\n\n```javascript\nconst ora = require('ora');\nconst marquee = require('marquee');\n\nconst spinner = ora({\n  text: 'This is a scrolling marquee',\n  spinner: marquee({\n    text: 'Pause when fully in view',\n    fullTextFrames: 15,\n    interval: 50\n  })\n});\n\nspinner.start();\n\nsetTimeout(() =\u003e {\n  spinner.stop();\n}, 3000);\n```\n\n![Pause on Full Text](https://github.com/joeycozza/marquee-ora/raw/master/gifs/fullTextPause.gif)\n\n## Options\n### text\n#### type: String *required\nRequired text to be scrolled in the marquee\n\n### fill\n#### type: String default=' '\nThe character to use for the empty space that isn't your text. Defaults to a single space, which looks pretty good.\n\n### fullTextFrames\n#### type: Integer default=1\nThe number of frames to have the full text pause in the marquee. This option isn't valid if the viewWidth is smaller than the text length. \n(It makes no sense because the full text cant be displayed in this case)\n\n### viewWidth \n#### type: Integer default=text.length\nThe character width for the marquee. If larger than text length, you will get padding of the `fill`.\nIf smaller than `text` length, then you won't be able to see the full text at one time.\n\n### interval\n#### type: Integer default=100\nNumber of milliseconds for each \"frame\" to be active. This is passed directly to ora's `interval` option\n\n## Example using All Options\n```javascript\nconst ora = require('ora');\nconst marquee = require('./index');\n\nconst spinner = ora({\n  text: 'This is a scrolling marquee',\n  spinner: marquee({\n    text: 'Using lots of options',\n    fullTextFrames: 8,\n    viewWidth: 29,\n    fill: '-',\n    interval: 20\n  })\n});\n\nspinner.start();\n\nsetTimeout(() =\u003e {\n  spinner.stop();\n}, 3000);\n```\n![Using Many Options](https://github.com/joeycozza/marquee-ora/raw/master/gifs/usingManyOptions.gif)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoeycozza%2Fmarquee-ora","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoeycozza%2Fmarquee-ora","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoeycozza%2Fmarquee-ora/lists"}