{"id":16113212,"url":"https://github.com/joshka/tui-big-text","last_synced_at":"2025-03-18T09:31:15.271Z","repository":{"id":192763063,"uuid":"687308248","full_name":"joshka/tui-big-text","owner":"joshka","description":"A rust crate for rendering large text to the terminal using font8x8 and ratatui.","archived":false,"fork":false,"pushed_at":"2024-04-12T19:10:18.000Z","size":114,"stargazers_count":13,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-14T13:24:38.701Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joshka.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE","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":"2023-09-05T05:04:25.000Z","updated_at":"2024-05-28T10:10:00.484Z","dependencies_parsed_at":null,"dependency_job_id":"52201db3-2511-42b2-b2f8-4c028bf647e3","html_url":"https://github.com/joshka/tui-big-text","commit_stats":null,"previous_names":["joshka/tui-big-text"],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshka%2Ftui-big-text","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshka%2Ftui-big-text/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshka%2Ftui-big-text/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshka%2Ftui-big-text/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joshka","download_url":"https://codeload.github.com/joshka/tui-big-text/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243911237,"owners_count":20367649,"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":[],"created_at":"2024-10-09T20:10:34.182Z","updated_at":"2025-03-18T09:31:14.673Z","avatar_url":"https://github.com/joshka.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tui-big-text\n\n\u003e [!IMPORTANT]\n\u003e This repo has been consolidated into \u003chttps://github.com/joshka/tui-widgets\u003e. All future work will\n\u003e happen there. The crate will remain available as tui-big-text, but this repo is now archived.\n\n\u003c!-- cargo-rdme start --\u003e\n\n[tui-big-text] is a rust crate that renders large pixel text as a [Ratatui] widget using the\nglyphs from the [font8x8] crate.\n\n![Demo](https://vhs.charm.sh/vhs-35FZxQa32pCZdRW7pmpqf6.gif)\n\n[![Crate badge]][tui-big-text]\n[![Docs.rs Badge]][API Docs]\n[![Deps.rs Badge]][Dependency Status]\u003cbr\u003e\n[![License Badge]](./LICENSE-MIT)\n[![Codecov.io Badge]][Code Coverage]\n[![Discord Badge]][Ratatui Discord]\n\n[GitHub Repository] · [API Docs] · [Examples] · [Changelog] · [Contributing]\n\n## Installation\n\n```shell\ncargo add ratatui tui-big-text\n```\n\n## Usage\n\nCreate a [`BigText`] widget using [`BigText::builder`] and pass it to [`render_widget`] to\nrender be rendered. The builder allows you to customize the [`Style`] of the widget and the\n[`PixelSize`] of the glyphs.\n\n## Examples\n\n```rust\nuse anyhow::Result;\nuse ratatui::prelude::*;\nuse tui_big_text::{BigText, PixelSize};\n\nfn render(frame: \u0026mut Frame) -\u003e Result\u003c()\u003e {\n    let big_text = BigText::builder()\n        .pixel_size(PixelSize::Full)\n        .style(Style::new().blue())\n        .lines(vec![\n            \"Hello\".red().into(),\n            \"World\".white().into(),\n            \"~~~~~\".into(),\n        ])\n        .build()?;\n    frame.render_widget(big_text, frame.size());\n    Ok(())\n}\n```\n\nThe [`PixelSize`] can be used to control how many character cells are used to represent a single\npixel of the 8x8 font. It has six variants:\n\n- `Full` (default) - Each pixel is represented by a single character cell.\n- `HalfHeight` - Each pixel is represented by half the height of a character cell.\n- `HalfWidth` - Each pixel is represented by half the width of a character cell.\n- `Quadrant` - Each pixel is represented by a quarter of a character cell.\n- `ThirdHeight` - Each pixel is represented by a third of the height of a character cell.\n- `Sextant` - Each pixel is represented by a sixth of a character cell.\n\n```rust\nBigText::builder().pixel_size(PixelSize::Full);\nBigText::builder().pixel_size(PixelSize::HalfHeight);\nBigText::builder().pixel_size(PixelSize::Quadrant);\n```\n\n![Pixel Size](https://vhs.charm.sh/vhs-2nLycKO16vHzqg3TxDNvq4.gif)\n\nText can be aligned to the Left / Right / Center using the `alignment` method.\n\n```rust\nuse ratatui::layout::Alignment;\nBigText::builder().alignment(Alignment::Left);\nBigText::builder().alignment(Alignment::Right);\nBigText::builder().alignment(Alignment::Center);\n```\n\n![Alignment Example](https://vhs.charm.sh/vhs-1Yyr7BJ5vfmOmjYNywCNH3.gif)\n\n[tui-big-text]: https://crates.io/crates/tui-big-text\n[Ratatui]: https://crates.io/crates/ratatui\n[font8x8]: https://crates.io/crates/font8x8\n\n\u003c!-- Note that these links are sensitive to breaking with cargo-rdme --\u003e\n[`BigText`]: https://docs.rs/tui-big-text/latest/tui_big_text/big_text/struct.BigText.html\n[`BigText::builder`]: https://docs.rs/tui-big-text/latest/tui_big_text/big_text/struct.BigText.html#method.builder\n[`PixelSize`]: https://docs.rs/tui-big-text/latest/tui_big_text/pixel_size/enum.PixelSize.html\n[`render_widget`]: https://docs.rs/ratatui/latest/ratatui/struct.Frame.html#method.render_widget\n[`Style`]: https://docs.rs/ratatui/latest/ratatui/style/struct.Style.html\n\n[Crate badge]: https://img.shields.io/crates/v/tui-big-text?logo=rust\u0026style=for-the-badge\n[Docs.rs Badge]: https://img.shields.io/docsrs/tui-big-text?logo=rust\u0026style=for-the-badge\n[Deps.rs Badge]: https://deps.rs/repo/github/joshka/tui-big-text/status.svg?style=for-the-badge\n[License Badge]: https://img.shields.io/crates/l/tui-big-text?style=for-the-badge\n[Codecov.io Badge]: https://img.shields.io/codecov/c/github/joshka/tui-big-text?logo=codecov\u0026style=for-the-badge\u0026token=BAQ8SOKEST\n[Discord Badge]: https://img.shields.io/discord/1070692720437383208?label=ratatui+discord\u0026logo=discord\u0026style=for-the-badge\n\n[API Docs]: https://docs.rs/crate/tui-big-text/\n[Dependency Status]: https://deps.rs/repo/github/joshka/tui-big-text\n[Code Coverage]: https://app.codecov.io/gh/joshka/tui-big-text\n[Ratatui Discord]: https://discord.gg/pMCEU9hNEj\n\n[GitHub Repository]: https://github.com/joshka/tui-big-text\n[Examples]: https://github.com/joshka/tui-big-text/tree/main/examples\n[Changelog]: https://github.com/joshka/tui-big-text/blob/main/CHANGELOG.md\n[Contributing]: https://github.com/joshka/tui-big-text/blob/main/CONTRIBUTING.md\n\n\u003c!-- cargo-rdme end --\u003e\n\n## License\n\nCopyright (c) 2023 Josh McKinney\n\nThis project is licensed under either of\n\n- Apache License, Version 2.0\n   ([LICENSE-APACHE](LICENSE-APACHE) or \u003chttp://www.apache.org/licenses/LICENSE-2.0\u003e)\n- MIT license\n   ([LICENSE-MIT](LICENSE-MIT) or \u003chttp://opensource.org/licenses/MIT\u003e)\n\nat your option.\n\n## Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall be\ndual licensed as above, without any additional terms or conditions.\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshka%2Ftui-big-text","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoshka%2Ftui-big-text","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshka%2Ftui-big-text/lists"}