r3bl_core

Crates.ior3bl_core
lib.rsr3bl_core
version
sourcesrc
created_at2024-10-20 22:36:37.620065
updated_at2024-10-20 22:36:37.620065
descriptionHelper crate for r3bl_tui and r3bl_tuify crates. Used by workspace in https://github.com/r3bl-org/r3bl-open-core.
homepagehttps://r3bl.com
repositoryhttps://github.com/r3bl-org/r3bl-open-core/tree/main/core
max_upload_size
id1416702
Cargo.toml error:TOML parse error at line 21, column 1 | 21 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size0
Nazmul Idris (nazmulidris)

documentation

https://docs.rs/r3bl_core/

README

r3bl_core

Why R3BL?

R3BL TUI library & suite of apps focused on developer productivity

We are working on building command line apps in Rust which have rich text user interfaces (TUI). We want to lean into the terminal as a place of productivity, and build all kinds of awesome apps for it.

  1. 🔮 Instead of just building one app, we are building a library to enable any kind of rich TUI development w/ a twist: taking concepts that work really well for the frontend mobile and web development world and re-imagining them for TUI & Rust.

    • Taking inspiration from things like React, SolidJS, Elm, iced-rs, Jetpack Compose, JSX, CSS, but making everything async (so they can be run in parallel & concurrent via Tokio).
    • Even the thread running the main event loop doesn't block since it is async.
    • Using proc macros to create DSLs to implement something inspired by CSS & JSX.

  2. 🌎 We are building apps to enhance developer productivity & workflows.

    • The idea here is not to rebuild tmux in Rust (separate processes mux'd onto a single terminal window). Rather it is to build a set of integrated "apps" (or "tasks") that run in the same process that renders to one terminal window.
    • Inside of this terminal window, we can implement things like "app" switching, routing, tiling layout, stacking layout, etc. so that we can manage a lot of TUI apps (which are tightly integrated) that are running in the same process, in the same window. So you can imagine that all these "app"s have shared application state (that is in a Redux store). Each "app" may also have its own Redux store.
    • Here are some examples of the types of "app"s we want to build:
      1. multi user text editors w/ syntax highlighting
      2. integrations w/ github issues
      3. integrations w/ calendar, email, contacts APIs

All the crates in the r3bl-open-core repo provide lots of useful functionality to help you build TUI (text user interface) apps, along w/ general niceties & ergonomics that all Rustaceans 🦀 can enjoy 🎉.

Table of contents

Introduction

This crate provides lots of low level functionality like Unicode strings (that support emoji), text styling, and more.

It is a dependency of the following crates:

  1. r3bl_tui
  2. r3bl_tuify
  3. r3bl_terminal_async
  4. r3bl_cmdr
  5. r3bl_macro (procedural macros)

Due to the requirements of proc macros being in a separate crate, this breakdown of one crate into multiple crates is necessary:

  1. Put some code in a separate crate (r3bl_core) that is used by other crates.
  2. Put the proc macros in a separate crate (r3bl_macro). This crate also depends on the r3bl_core crate.
  3. Finally, make your crate depend on the other two.

All the modules tend to be re-exported, making them available from the "main" or top-level crate; more info on this here.

Changelog

Please check out the changelog to see how the library has evolved over time.

Learn how these crates are built, provide feedback

To learn how we built this crate, please take a look at the following resources.

  • If you like consuming video content, here's our YT channel. Please consider subscribing.
  • If you like consuming written content, here's our developer site. Please consider subscribing to our newsletter.
  • If you have questions, please join our discord server.

License: Apache-2.0

Commit count: 1178

cargo fmt