{"_id":"@brightkyefoo/terminal-ui","_rev":"4-010c7f6761a0816fec6e012f6d58c538","name":"@brightkyefoo/terminal-ui","dist-tags":{"latest":"1.1.3"},"versions":{"1.0.0":{"name":"@brightkyefoo/terminal-ui","version":"1.0.0","_id":"@brightkyefoo/terminal-ui@1.0.0","maintainers":[{"name":"brightkyefoo","email":"brightefoo@gmail.com"}],"dist":{"shasum":"52d09c9b2b578701530d283ebba7cf3357d568e8","tarball":"https://registry.npmjs.org/@brightkyefoo/terminal-ui/-/terminal-ui-1.0.0.tgz","fileCount":11,"integrity":"sha512-0VgC794DewvUVlUwZqQwBp941rMDhKORfl+lUExLrcrKHpPfRHKexmK5l4DVgEE/dxCjv9qqT7LYkadOGGRtKQ==","signatures":[{"sig":"MEYCIQC9JjPG4YMD1/3nomdpqVHDGkEjTftz9n4jKsMBl7uFzwIhAMlCj5RymgZsYAV6mEiUx97XN8fBoJt/ABDE6NrC8ni4","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":9759},"main":"dist/index.js","private":false,"scripts":{"build":"tsc","start":"node dist/index.js"},"_npmUser":{"name":"brightkyefoo","email":"brightefoo@gmail.com"},"_npmVersion":"10.8.1","directories":{},"_nodeVersion":"20.16.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.5.3","@types/node":"^22.7.5"},"_npmOperationalInternal":{"tmp":"tmp/terminal-ui_1.0.0_1728474893916_0.9338645685750295","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"@brightkyefoo/terminal-ui","version":"1.1.0","_id":"@brightkyefoo/terminal-ui@1.1.0","maintainers":[{"name":"brightkyefoo","email":"brightefoo@gmail.com"}],"homepage":"https://github.com/BrightkyEfoo/terminal-ui#readme","bugs":{"url":"https://github.com/BrightkyEfoo/terminal-ui/issues"},"dist":{"shasum":"93e1fd4a292f4b0e02de85d2ef5c7be918d2d563","tarball":"https://registry.npmjs.org/@brightkyefoo/terminal-ui/-/terminal-ui-1.1.0.tgz","fileCount":29,"integrity":"sha512-iRzrg5QFxNLVyrHLRAw0eSzPkFCWJSZbnaATzlvmWtUtEO5AC0rILSR5wYD8c43l7FFVO/zZqst3BTofc9kudA==","signatures":[{"sig":"MEYCIQDVHtLdmmaUiTOswt9v+P8GbbxcjakVmZ769JmvSo/wAgIhALj5/jboleLubsbimd5JqcpYvrqpXhBtb0WZL43vWK3Y","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49674},"main":"dist/index.js","gitHead":"f6b40dc7b062bd896f810b75c0abe958f3535d45","private":false,"scripts":{"build":"tsc","start":"node dist/index.js"},"_npmUser":{"name":"brightkyefoo","email":"brightefoo@gmail.com"},"repository":{"url":"git+https://github.com/BrightkyEfoo/terminal-ui.git","type":"github"},"_npmVersion":"10.8.1","description":"A simple library of ui components for terminal","directories":{},"_nodeVersion":"20.16.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.5.3","@types/node":"^22.7.5"},"_npmOperationalInternal":{"tmp":"tmp/terminal-ui_1.1.0_1728478083379_0.7347249499791617","host":"s3://npm-registry-packages"}},"1.1.1":{"name":"@brightkyefoo/terminal-ui","version":"1.1.1","keywords":["terminal","CLI","UI","components"],"_id":"@brightkyefoo/terminal-ui@1.1.1","maintainers":[{"name":"brightkyefoo","email":"brightefoo@gmail.com"}],"homepage":"https://github.com/BrightkyEfoo/terminal-ui#readme","bugs":{"url":"https://github.com/BrightkyEfoo/terminal-ui/issues"},"dist":{"shasum":"475bbf064a94392134f0e1be1e1fd3ce9f34dfe7","tarball":"https://registry.npmjs.org/@brightkyefoo/terminal-ui/-/terminal-ui-1.1.1.tgz","fileCount":29,"integrity":"sha512-bYPWsjnsUmzpYo4kQ5FwHS7Pogii91bx+JT1AONt0+EPHkG9Mk9gjaoTyUwM5z6uJ3B8xceOMcOyPtp/HZ3xdA==","signatures":[{"sig":"MEUCIDj5sBUTsGpw5zs9Pw1JJVh1g4aatnN1B1PvXgrL/3agAiEAxq4LC7ixmuSzHHNEM+LIkOCDXtoFk1/9QeKGQVdBEBM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49747},"main":"dist/index.js","gitHead":"b83ccddbe36d59a97eb7875c636d4de7c55b690e","private":false,"scripts":{"test":"node dist/test.js","build":"tsc"},"_npmUser":{"name":"brightkyefoo","email":"brightefoo@gmail.com"},"repository":{"url":"git+https://github.com/BrightkyEfoo/terminal-ui.git","type":"github"},"_npmVersion":"10.8.1","description":"A simple library of ui components for terminal","directories":{},"_nodeVersion":"20.16.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.5.3","@types/node":"^22.7.5"},"_npmOperationalInternal":{"tmp":"tmp/terminal-ui_1.1.1_1728478254851_0.16910280957164092","host":"s3://npm-registry-packages"}},"1.1.2":{"name":"@brightkyefoo/terminal-ui","version":"1.1.2","keywords":["terminal","CLI","UI","components"],"_id":"@brightkyefoo/terminal-ui@1.1.2","maintainers":[{"name":"brightkyefoo","email":"brightefoo@gmail.com"}],"homepage":"https://github.com/BrightkyEfoo/terminal-ui#readme","bugs":{"url":"https://github.com/BrightkyEfoo/terminal-ui/issues"},"dist":{"shasum":"c1ddf98292dee0229e1386fdd550712e6c0e0fe5","tarball":"https://registry.npmjs.org/@brightkyefoo/terminal-ui/-/terminal-ui-1.1.2.tgz","fileCount":41,"integrity":"sha512-i4+z8qkeoEbyqsUdotLYsZOtaGmey8OuV60QCeijOZqdpeothquCXcZHONS7QSwjOIopot0zGAlgfBDTDdYrmQ==","signatures":[{"sig":"MEQCID7Xgxu/c03tcASclWwBp6iSJ2cTOV20BqMd/9k+ckbSAiAHm3dd9BEdTB9ForhYoV6e2wW01keCVmZLQ8gAuAp0Rw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":52132},"main":"dist/index.js","gitHead":"e8913806e222c5fdfd121cebe2d96860b6264080","private":false,"scripts":{"test":"node dist/test.js","build":"tsc"},"_npmUser":{"name":"brightkyefoo","email":"brightefoo@gmail.com"},"repository":{"url":"git+https://github.com/BrightkyEfoo/terminal-ui.git","type":"github"},"_npmVersion":"10.8.1","description":"A simple library of ui components for terminal","directories":{},"_nodeVersion":"20.16.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.5.3","@types/node":"^22.7.5"},"_npmOperationalInternal":{"tmp":"tmp/terminal-ui_1.1.2_1728478573442_0.06659799011722001","host":"s3://npm-registry-packages"}},"1.1.3":{"name":"@brightkyefoo/terminal-ui","version":"1.1.3","description":"A simple library of ui components for terminal","main":"dist/index.js","scripts":{"build":"tsc","test":"node dist/test.js"},"repository":{"type":"github","url":"git+https://github.com/BrightkyEfoo/terminal-ui.git"},"devDependencies":{"@types/node":"^22.7.5","typescript":"^5.5.3"},"private":false,"keywords":["terminal","CLI","UI","components"],"_id":"@brightkyefoo/terminal-ui@1.1.3","gitHead":"c9f6495049d2f412f6b3e89f9b5c84e542317c1e","types":"./dist/index.d.ts","bugs":{"url":"https://github.com/BrightkyEfoo/terminal-ui/issues"},"homepage":"https://github.com/BrightkyEfoo/terminal-ui#readme","_nodeVersion":"20.16.0","_npmVersion":"10.8.1","dist":{"integrity":"sha512-UgDvAspNciGs67xpIN36brLanSm2uuXX9n8ClicKOfqlD+EsG00B3iVqb63OspfFSeK5RyigN0Lz1EbzAlh8LQ==","shasum":"7fb03a1cd7ef26fd6aca2420df648a2adc2f388d","tarball":"https://registry.npmjs.org/@brightkyefoo/terminal-ui/-/terminal-ui-1.1.3.tgz","fileCount":40,"unpackedSize":49674,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGPPvoiHDwAvp3cb/KkrbyX7eKX4EN2lQ+qtX3k5t1ujAiBtzq2laONxaxlRVCnA7XnLTGSBGcaB5rgGI9eisDBHIg=="}]},"_npmUser":{"name":"brightkyefoo","email":"brightefoo@gmail.com"},"directories":{},"maintainers":[{"name":"brightkyefoo","email":"brightefoo@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/terminal-ui_1.1.3_1728478819670_0.29037627135934097"},"_hasShrinkwrap":false}},"time":{"created":"2024-10-09T11:54:53.776Z","modified":"2024-10-09T13:00:19.978Z","1.0.0":"2024-10-09T11:54:54.106Z","1.1.0":"2024-10-09T12:48:03.662Z","1.1.1":"2024-10-09T12:50:55.152Z","1.1.2":"2024-10-09T12:56:13.652Z","1.1.3":"2024-10-09T13:00:19.830Z"},"bugs":{"url":"https://github.com/BrightkyEfoo/terminal-ui/issues"},"homepage":"https://github.com/BrightkyEfoo/terminal-ui#readme","keywords":["terminal","CLI","UI","components"],"repository":{"type":"github","url":"git+https://github.com/BrightkyEfoo/terminal-ui.git"},"description":"A simple library of ui components for terminal","maintainers":[{"name":"brightkyefoo","email":"brightefoo@gmail.com"}],"readme":"# Terminal UI\n\nBienvenue dans **Terminal UI** ! 🎉 Un ensemble de composants interactifs pour vos applications en ligne de commande, vous permettant de créer des interfaces utilisateur dynamiques et engageantes. Que vous construisiez une application simple ou un outil complexe, Terminal UI vous simplifie la tâche. \n\n## Table des matières\n\n- [Installation](#installation)\n- [Utilisation](#utilisation)\n- [Composants](#composants)\n- [API](#api)\n- [Contributeurs](#contributeurs)\n\n## Installation\n\nPour commencer avec Terminal UI, il vous suffit d'installer le package :\n\n```bash\nnpm i @brightkyefoo/terminal-ui\n```\n\n## Utilisation\n\nPour utiliser les composants de Terminal UI, vous pouvez simplement les importer dans votre projet comme suit :\n\n```typescript\nimport { Menu, Checkbox, ToggleSwitch, Select, Notification, ProgressBar, Spinner, Form } from '@brightkyefoo/terminal-ui';\n```\n\nEnsuite, vous pouvez appeler ces composants dans votre logique d'application. Voici un exemple simple :\n\n```typescript\nconst menu = new Menu('Main Menu', ['Option 1', 'Option 2']);\nconst selectedOption = await menu.display();\nconsole.log(`Vous avez sélectionné : ${selectedOption}`);\n```\n\n## Composants\n\n### 1. Menu\n\n**Menu** est un composant qui affiche une liste d'options que l'utilisateur peut sélectionner.\n\n**Paramètres :**\n- `title` (string) : Le titre du menu.\n- `options` (string[]) : Un tableau d'options à afficher.\n\n### 2. Checkbox\n\n**Checkbox** permet à l'utilisateur de sélectionner plusieurs options à l'aide de cases à cocher.\n\n**Paramètres :**\n- `options` (string[]) : Un tableau d'options à cocher.\n\n### 3. ToggleSwitch\n\n**ToggleSwitch** est un composant binaire qui permet à l'utilisateur de basculer entre deux états (ON/OFF).\n\n**Paramètres :** Aucun.\n\n### 4. Select\n\n**Select** permet à l'utilisateur de choisir une option parmi une liste déroulante.\n\n**Paramètres :**\n- `options` (string[]) : Un tableau d'options à sélectionner.\n\n### 5. Notification\n\n**Notification** affiche un message d'information, d'avertissement ou d'erreur.\n\n**Paramètres :**\n- `message` (string) : Le message à afficher.\n- `type` ('info' | 'warning' | 'error') : Le type de notification, qui détermine la couleur du texte.\n\n### 6. ProgressBar\n\n**ProgressBar** affiche une barre de progression pour indiquer l'avancement d'une tâche.\n\n**Paramètres :**\n- `total` (number) : La valeur totale de la progression.\n\n### 7. Spinner\n\n**Spinner** affiche un indicateur de chargement animé.\n\n**Paramètres :**\n- `message` (string) : Le message à afficher pendant le chargement.\n\n### 8. Form\n\n**Form** permet de recueillir des données utilisateur via des questions interactives.\n\n**Paramètres :**\n- `questions` (string[]) : Un tableau de questions à poser à l'utilisateur.\n\n## API\n\nVoici une explication détaillée des paramètres de chaque composant :\n\n### Menu\n```typescript\nnew Menu(title: string, options: string[]): Menu\n```\n- `title`: Le titre affiché en haut du menu.\n- `options`: Les options disponibles à l'utilisateur.\n\n### Checkbox\n```typescript\nnew Checkbox(options: string[]): Checkbox\n```\n- `options`: Les options à cocher.\n\n### ToggleSwitch\n```typescript\nnew ToggleSwitch(): ToggleSwitch\n```\n- Aucun paramètre requis.\n\n### Select\n```typescript\nnew Select(options: string[]): Select\n```\n- `options`: Les options à choisir.\n\n### Notification\n```typescript\nnew Notification(message: string, type: 'info' | 'warning' | 'error'): Notification\n```\n- `message`: Le message à afficher.\n- `type`: Le type de notification qui détermine la couleur et le style.\n\n### ProgressBar\n```typescript\nnew ProgressBar(total: number): ProgressBar\n```\n- `total`: La valeur totale à atteindre pour la progression.\n\n### Spinner\n```typescript\nnew Spinner(): Spinner\n```\n- Aucun paramètre requis.\n\n### Form\n```typescript\nnew Form(questions: string[]): Form\n```\n- `questions`: Les questions posées à l'utilisateur pour recueillir des réponses.\n\n## Contributeurs\n\nNous aimons les contributions ! 💖 Si vous souhaitez améliorer Terminal UI, n'hésitez pas à forker le projet, à apporter des modifications et à soumettre une pull request. Chaque contribution est précieuse pour nous !\n\nMerci d'avoir consulté Terminal UI. Amusez-vous bien à créer des interfaces utilisateurs incroyables en ligne de commande ! 🚀\n\n[brightkyefoo](https://github.com/BrightkyEfoo)","readmeFilename":"readme.md"}