Initial plan

#2138

---------

Signed-off-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>
Co-authored-by: Shingo OKAWA <shingo.okawa.g.h.c@gmail.com>

.cliffignore

@@ -0,0 +1,115 @@
+# skip entries from <https://github.com/ratatui/ratatui/pull/1652>
+50af9a5d80ed5446f3e6cc554911f606580edde9
+272e9709c6eed45cd7e0c183624b7898f4e0ae69
+adc8fdc35aa57d6dad2ae8dd30ec2e9256576c09
+31711dbf82a4c7bb3b78692da34d9f469725dd6e
+b6356aa7a529a491d63dd6628b8985adae337f16
+885558b6f89df642317d39c5b44c94c742d1e0c8
+6440eb9d76379340953420629ab0a3d9039d6c48
+3870583ea868452191857f9bda97a3d5c35d0a4f
+487edc8399683fb8a9a66359729c015780d248f2
+250c222cc4aaab09184a28efc68f75ca03133794
+590a392ab11c1a215767614931036781f4cf6a29
+6443f7408af4a8834bc68cd35d2ba9be47e45f38
+8339cce10a51c9c951b3c9750d527d80168626eb
+ac342231c344e893f2f630ee38167aab28c736a6
+0fb103680028a6e26a1923f87b60bde51acaec4f
+4335a90a00aeeedb69a92442c7f2711727944017
+71480242a926f98e9081ed6e2dc8c381757b3a42
+e1a31db55913bd690bcaef380e9dbc3b6a5dc175
+38490ff8da6f11e309ba1bcb3e88a562f7c953c5
+a4bb143e4767137d6a9e9927d3da66562611f86f
+bc73f2dcbe5ea48fc4d1555a8e931f40d7b0e03f
+77dea441e5637b1c428c2aa71ea67fb3aac20c12
+06af14107e70e49a4cba3babb8ab0a0c57b4bdf8
+9acdab32df69517b93dd2b861b85586d47c71540
+2e684c6500be61fbe69744d183c8086564ac0051
+b7f8ec0ff9659473d936eae53a57cd9de38cec1f
+31a2c4548c304270a8c852f19baa7a4eaac5e75c
+57b681b053c019b66e0ed92959638997fea731b1
+131b9ec41751163d43d94564363247b60f031486
+8b32f82b4dd526580d00fa13f053bf507e8ea933
+76d1e5b1733d47a7f05acf563db26cb1a66b540d
+57a0a34f924e0d488c9e9f917900e677c3488dc4
+12aa58601ddd0704256c56019bd2c7139d41f7a2
+2dc81833c60951d16f9bd60f3da003edfc9a11f5
+20e41f1d1da6db8abbc2504814531d4d97bdf94b
+68b55a12a29e70ebfcc063c2d5d5845de3b5a27e
+693003314a25e792ffc5d53146b28bfb6a4582e3
+63441e259bc38b56e0369197bed14788b2cb3d54
+fa88152c808eeb6c9d9b3662361aab1e57e1b1bf
+30d9daa59b1843786cde00e25c3e69cfe818b80b
+92540b2f6ab25f3a5400aebb28af3c498ac793a4
+29edc3a7a38c512611a80cf5d8d42027558419b2
+819499d6ffc0e8453ed3220067645933a4882a74
+4756526829a4e849d9e256b6cf821eb66afe3ade
+8f35437d5ad78d31cd45c4af888f20f0b5ab4196
+39bd72b1f702dadb1ebbaf4e77ad2fada166ac49
+c6d2cee3e967c9234176c5229858512b0c79d6a9
+bd90e3d928e0f9f0b915933ebbc32c2256fe8cfa
+b820c0c7e4c576c1e39b5e482a8aac08076a039c
+74194759756bb111b4da3e9a5cdb968275a2fab0
+38b2f27efe0e1829bc503df7fd64b94b7bb80d97
+21aa3232d762d6e3f81f15fc5b66ba462385ac05
+903bb0ae32d22393783edfda96db900739864f0a
+5cee13ab6d9c49751cf9283d9099e37f0cc3632c
+0a0997702dd4cf2217160f5652f5c39cbd4a1010
+778f2f5ec511bef431b54157242b91d083ea9840
+7d23bd2ceaf96e81972b5f746fdcba0d17f6391f
+2c02a56bce31519386303571e0b66b7d4beb378e
+f33d51e7d9ccf9fe52ec3289d04d97c722d9ee17
+91cd81aaa032887bb2327bc3fe3cad6b3c9fbacf
+5d5a1ccb0b4e2f293f215ce026fba33f1c069689
+6b9417db5f2adbdc60e9dd8dc5acbbe2a1f77ba9
+dce1e4b138eb1333c9e773bacd579a8cdddd73fb
+b4aacb045e2200896b0d0136a2b8688b47828d73
+dcba0bcd5d5d6e33ddc1fa94ebb94819fdda600e
+6f52350ecfb62e3a5bac16f0824e74b757cc6cd2
+2c6f324b9aa5034771e00758b143fd8df94d859d
+bf0210602948f8d26ae323996fe7b22fb218a446
+07aff91b015b5e7e0504680c12edbce70d7dba1e
+f6d49dde14af73ed467d75d8f6ec0f502db2908f
+9a7467b30576d5cb7491ea6e09efcae97eadf9bb
+a0c35f1d7bcce10e092582b95f5b0a3f20ad7bf3
+d24747d46982192b575a40b8cc18d1c948fac3d7
+8060f7bc578b29dde6ca0c4c64569f9c73218f46
+0dc5b2d2e0aa6438ffc1b3965b1ab31c721adbcc
+8ecdd892f53d7db95bbb53a61700d36e3fcefdd4
+570c35868147a2400a13331e85d562d1ef96a011
+3855c3a84a77037aeee40dbe9e52454fb1f9afee
+93372f35c1669da0138ca776890f3ff3d38a6539
+6cf08d4a2f0398856fd593f50bf077fd59b08230
+f78d3bfec32d07c1124eee8d0249477ce3fb0884
+204307fa50aaaa373946342084f7fd3af39f3cd3
+c50b01d098e5ab405a50c3e14e858da27d606e8f
+f71d1ac73e8290f37d55a67d6a6507a3653ec174
+ae2868c0e0b1ac8b5126fd43269383fa533d87b5
+be8def963956c605bca28bcd8df673bd7ec3740b
+4ac4d9d3ab97176d71e287bcdd6d41e66f2f7ccb
+fafabb8dab84e9460a076199ea646262e51c855b
+2f97d35bd8618e8c0cc006cb1d4a9b151c1b9b4a
+39d5a745acbbd3510de707d4e7c471c17e02ae59
+a1acdcdc4c002390a76f01699cfa006a36cf3f56
+ad54cf29ad1a4335ba208fb94a8fc5dfbba260e3
+c7649575e7b199794be4252f79da80aaecdcee28
+8913e2ce1f40d451ddb4527f08ec75f198d5063c
+1b9e310300f22bfc72364f027a9caeddadf61a99
+89d7dd46031511f0556b2d29ab34035f42e3a24c
+ca4fa0b9bf5ba707aa0447ba7c38fbacdadb7eec
+8cecfdf2f6dd5b0de507f79b469517cc0fb42add
+7eeb6afb3dbc56e52f9387a74f826b186cd19137
+d0f75eb371a96f8d5f174e23de074efd840e9e44
+f8a70ea9da8e6df2bf7a5f74cce45615fc292afe
+f28b9730061bffadb9d87ad63edf7d10b245d2c1
+afc5cf2140f22fea6bd6933dd0f9c302229a1980
+b75df78cdca58d5dca0c51fb8e106067aa6cb752
+28f5a6dbd4091aa3efa86eed6767eeb44a655f0f
+345e6a1ebd853858463a33953585ce407a60378c
+c45a4de47c601554f6b981d211181468b4798e41
+bbaa9a5432ff6ad5518344123c3b56f349347e99
+f804c90f96221f334371ccd01b0e6df7b1cfc1e8
+16ba867c5877d8c97968987ecb5f8bff966d0a82
+38a1474ca12aa6a796afc1e277882d997a999e14
+92c4078413fc79fcc83f5d3d8708abb58696ff1a
+d4415204e1eb3aed2a74a722aeaaa274975dd2d7
+e48bcf5f21f14acb27996fdc02231c140f5b817c

.github/workflows/calculate-alpha-release.bash

@@ -1,52 +0,0 @@
-#!/bin/bash
-
-# Exit on error. Append "|| true" if you expect an error.
-set -o errexit
-# Exit on error inside any functions or subshells.
-set -o errtrace
-# Do not allow use of undefined vars. Use ${VAR:-} to use an undefined VAR
-set -o nounset
-# Catch the error in case mysqldump fails (but gzip succeeds) in `mysqldump |gzip`
-set -o pipefail
-# Turn on traces, useful while debugging but commented out by default
-# set -o xtrace
-
-last_release="$(git tag --sort=committerdate | grep -P "v0+\.\d+\.\d+$" | tail -1)"
-echo "🐭 Last release: ${last_release}"
-
-# detect breaking changes
-if [ -n "$(git log --oneline ${last_release}..HEAD | grep '!:')" ]; then
-    echo "🐭 Breaking changes detected since ${last_release}"
-    git log --oneline ${last_release}..HEAD | grep '!:'
-    # increment the minor version
-    minor="${last_release##v0.}"
-    minor="${minor%.*}"
-    next_minor="$((minor + 1))"
-    next_release="v0.${next_minor}.0"
-else
-    # increment the patch version
-    patch="${last_release##*.}"
-    next_patch="$((patch + 1))"
-    next_release="${last_release/%${patch}/${next_patch}}"
-fi
-echo "🐭 Next release: ${next_release}"
-
-suffix="alpha"
-last_tag="$(git tag --sort=committerdate | tail -1)"
-if [[ "${last_tag}" = "${next_release}-${suffix}"* ]]; then
-    echo "🐭 Last alpha release: ${last_tag}"
-    # increment the alpha version
-    # e.g. v0.22.1-alpha.12 -> v0.22.1-alpha.13
-    alpha="${last_tag##*-${suffix}.}"
-    next_alpha="$((alpha + 1))"
-    next_tag="${last_tag/%${alpha}/${next_alpha}}"
-else
-    # increment the patch and start the alpha version from 0
-    # e.g. v0.22.0 -> v0.22.1-alpha.0
-    next_tag="${next_release}-${suffix}.0"
-fi
-# update the crate version
-msg="# crate version"
-sed -E -i "s/^version = .* ${msg}$/version = \"${next_tag#v}\" ${msg}/" Cargo.toml
-echo "NEXT_TAG=${next_tag}" >> $GITHUB_ENV
-echo "🐭 Next alpha release: ${next_tag}"

.github/workflows/check-pr.yml

@@ -24,7 +24,7 @@ jobs:
     steps:
       - name: Check PR title
         if: github.event_name == 'pull_request_target'
-        uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017 # v5
+        uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v5
         id: check_pr_title
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -70,7 +70,7 @@ jobs:
           fi
       - name: Add label
         if: steps.check_breaking_change.outputs.breaking_change == 'true'
-        uses: actions/github-script@v7
+        uses: actions/github-script@v8
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |

.github/workflows/check-semver.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
       - name: Check semver

.github/workflows/ci.yml

@@ -29,15 +29,15 @@ jobs:
     name: Check Formatting
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+      - uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: nightly
           components: rustfmt
-      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
-      - uses: taiki-e/install-action@c99cc51b309eee71a866715cfa08c922f11cf898 # v2
+      - uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
+      - uses: taiki-e/install-action@c5b1b6f479c32f356cc6f4ba672a47f63853b13b # v2
         with:
           tool: taplo-cli
       - run: cargo xtask format --check
@@ -48,10 +48,10 @@ jobs:
     name: Check Typos
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: crate-ci/typos@392b78fe18a52790c53f42456e46124f77346842 # master
+      - uses: crate-ci/typos@80c8a4945eec0f6d464eaf9e65ed98ef085283d1 # master
 
   # Check for any disallowed dependencies in the codebase due to license / security issues.
   # See <https://github.com/EmbarkStudios/cargo-deny>
@@ -59,13 +59,13 @@ jobs:
     name: Check Dependencies
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+      - uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: stable
-      - uses: taiki-e/install-action@c99cc51b309eee71a866715cfa08c922f11cf898 # v2
+      - uses: taiki-e/install-action@c5b1b6f479c32f356cc6f4ba672a47f63853b13b # v2
         with:
           tool: cargo-deny
       - run: cargo deny --log-level info --all-features check
@@ -76,10 +76,10 @@ jobs:
     name: Check Unused Dependencies
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: bnjbvr/cargo-machete@b54422fa3319b3cac180f6030b663fe57af51635 # v0.8.0
+      - uses: bnjbvr/cargo-machete@7959c845782fed02ee69303126d4a12d64f1db18 # v0.9.1
 
   # Run cargo clippy.
   #
@@ -95,22 +95,24 @@ jobs:
         toolchain: ["stable", "beta"]
     continue-on-error: ${{ matrix.toolchain == 'beta' }}
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+      - uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: ${{ matrix.toolchain }}
           components: clippy
-      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
+      - uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
       - run: cargo xtask clippy
+        env:
+          RUSTUP_TOOLCHAIN: ${{ matrix.toolchain }}
 
   # Run markdownlint on all markdown files in the repository.
   lint-markdown:
     name: Check Markdown
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
       - uses: DavidAnson/markdownlint-cli2-action@992badcdf24e3b8eb7e87ff9287fe931bcb00c6e # v20
@@ -125,19 +127,19 @@ jobs:
     name: Coverage Report
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+      - uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: stable
           components: llvm-tools
-      - uses: taiki-e/install-action@c99cc51b309eee71a866715cfa08c922f11cf898 # v2
+      - uses: taiki-e/install-action@c5b1b6f479c32f356cc6f4ba672a47f63853b13b # v2
         with:
           tool: cargo-llvm-cov
-      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
+      - uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
       - run: cargo xtask coverage
-      - uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5
+      - uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -152,27 +154,32 @@ jobs:
         toolchain: ["1.85.0", "stable"]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+      - uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: ${{ matrix.toolchain }}
-      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
+      - uses: taiki-e/install-action@c5b1b6f479c32f356cc6f4ba672a47f63853b13b # v2
+        with:
+          tool: cargo-hack
+      - uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
       - run: cargo xtask check --all-features
+        env:
+          RUSTUP_TOOLCHAIN: ${{ matrix.toolchain }}
 
   build-no-std:
     name: Build No-Std
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+      - uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: stable
           targets: x86_64-unknown-none
-      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
+      - uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
       # This makes it easier to debug the exact versions of the dependencies
       - run: cargo tree --target x86_64-unknown-none -p ratatui-core
       - run: cargo tree --target x86_64-unknown-none -p ratatui-widgets
@@ -188,11 +195,11 @@ jobs:
     name: Check README
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
-      - uses: taiki-e/install-action@c99cc51b309eee71a866715cfa08c922f11cf898 # v2
+      - uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
+      - uses: taiki-e/install-action@c5b1b6f479c32f356cc6f4ba672a47f63853b13b # v2
         with:
           tool: cargo-rdme
       - run: cargo xtask readme --check
@@ -205,19 +212,19 @@ jobs:
     env:
       RUSTDOCFLAGS: -Dwarnings
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+      - uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: nightly
       - uses: dtolnay/install@74f735cdf643820234e37ae1c4089a08fd266d8a # master
         with:
           crate: cargo-docs-rs
-      - uses: taiki-e/install-action@c99cc51b309eee71a866715cfa08c922f11cf898 # v2
+      - uses: taiki-e/install-action@c5b1b6f479c32f356cc6f4ba672a47f63853b13b # v2
         with:
           tool: cargo-hack
-      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
+      - uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
       - run: cargo xtask docs
 
   # Run cargo test on the documentation of the crate. This will catch any code examples that don't
@@ -226,13 +233,16 @@ jobs:
     name: Test Docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+      - uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: stable
-      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
+      - uses: taiki-e/install-action@c5b1b6f479c32f356cc6f4ba672a47f63853b13b # v2
+        with:
+          tool: cargo-hack
+      - uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
       - run: cargo xtask test-docs
 
   # Run cargo test on the libraries of the crate.
@@ -244,13 +254,16 @@ jobs:
       matrix:
         toolchain: ["1.85.0", "stable"]
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+      - uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: stable
-      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
+      - uses: taiki-e/install-action@c5b1b6f479c32f356cc6f4ba672a47f63853b13b # v2
+        with:
+          tool: cargo-hack
+      - uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
       - run: cargo xtask test-libs
 
   # Run cargo test on all the backends.
@@ -267,11 +280,11 @@ jobs:
           - os: windows-latest
             backend: termion
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+      - uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: stable
-      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2
+      - uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
       - run: cargo xtask test-backend ${{ matrix.backend }}

.github/workflows/release-alpha.yml

@@ -1,57 +0,0 @@
-name: Release alpha version
-
-# Set the permissions of the github token to the minimum and only enable what is needed
-# See https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions
-permissions: {}
-
-on:
-  workflow_dispatch:
-  schedule:
-    # At 00:00 on Saturday
-    # https://crontab.guru/#0_0_*_*_6
-    - cron: "0 0 * * 6"
-
-defaults:
-  run:
-    shell: bash
-
-jobs:
-  publish-alpha:
-    name: Create an alpha release
-    runs-on: ubuntu-latest
-    if: github.repository == 'ratatui/ratatui'
-    permissions:
-      contents: write
-    steps:
-      - name: Checkout the repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-        with:
-          fetch-depth: 0
-          # probably needs to be set to true for git-cliff to work - check build
-          persist-credentials: false
-
-      - name: Calculate the next release
-        run: .github/workflows/calculate-alpha-release.bash
-
-      - name: Install Rust stable
-        uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
-        with:
-          toolchain: stable
-
-      - name: Publish
-        run: cargo publish --allow-dirty --token ${{ secrets.CARGO_TOKEN }}
-
-      - name: Generate a changelog
-        uses: orhun/git-cliff-action@4a4a951bc43fafe41cd2348d181853f52356bee7 # v4
-        with:
-          config: cliff.toml
-          args: --unreleased --tag ${{ env.NEXT_TAG }} --strip header
-        env:
-          OUTPUT: BODY.md
-
-      - name: Publish on GitHub
-        uses: ncipollo/release-action@bcfe5470707e8832e12347755757cec0eb3c22af # v1
-        with:
-          tag: ${{ env.NEXT_TAG }}
-          prerelease: true
-          bodyFile: BODY.md

.github/workflows/release-plz.yml

@@ -23,18 +23,18 @@ jobs:
     if: ${{ github.repository_owner == 'ratatui' }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           fetch-depth: 0
           persist-credentials: false
       - name: Install Rust toolchain
-        uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+        uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: stable
-      - uses: rust-lang/crates-io-auth-action@e919bc7605cde86df457cf5b93c5e103838bd879 # v1
+      - uses: rust-lang/crates-io-auth-action@041cce5b4b821e6b0ebc9c9c38b58cac4e34dcc2 # v1
         id: auth
       - name: Run release-plz
-        uses: release-plz/action@068d76d2aa32d3c9cd0b1ccdd9ac921e28ba2be9 # v0.5
+        uses: release-plz/action@d529f731ae3e89610ada96eda34e5c6ba3b12214 # v0.5
         with:
           command: release
         env:
@@ -46,6 +46,7 @@ jobs:
     name: Release-plz PR
     permissions:
       pull-requests: write
+      contents: write
     runs-on: ubuntu-latest
     if: ${{ github.repository_owner == 'ratatui' }}
     concurrency:
@@ -53,16 +54,16 @@ jobs:
       cancel-in-progress: false
     steps:
       - name: Checkout repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           fetch-depth: 0
           persist-credentials: false
       - name: Install Rust toolchain
-        uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
+        uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # master
         with:
           toolchain: stable
       - name: Run release-plz
-        uses: release-plz/action@068d76d2aa32d3c9cd0b1ccdd9ac921e28ba2be9 # v0.5
+        uses: release-plz/action@d529f731ae3e89610ada96eda34e5c6ba3b12214 # v0.5
         with:
           command: release-pr
         env:

.github/workflows/release-stable.yml

@@ -1,55 +0,0 @@
-name: Release stable version
-
-# Set the permissions of the github token to the minimum and only enable what is needed
-# See https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions
-permissions: {}
-
-on:
-  push:
-    tags:
-      - "v*.*.*"
-
-jobs:
-  publish-stable:
-    name: Create an stable release
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - name: Checkout the repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-        with:
-          fetch-depth: 0
-          # this possibly needs to be set to true for git-cliff to work - check build results
-          persist-credentials: false
-
-      - name: Generate a changelog
-        uses: orhun/git-cliff-action@4a4a951bc43fafe41cd2348d181853f52356bee7 # v4
-        with:
-          config: cliff.toml
-          args: --latest --strip header
-        env:
-          OUTPUT: BODY.md
-
-      - name: Publish on GitHub
-        uses: ncipollo/release-action@bcfe5470707e8832e12347755757cec0eb3c22af # v1
-        with:
-          prerelease: false
-          bodyFile: BODY.md
-
-  publish-crate:
-    name: Publish crate
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout the repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-        with:
-          persist-credentials: false
-
-      - name: Install Rust stable
-        uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # master
-        with:
-          toolchain: stable
-
-      - name: Publish
-        run: cargo publish --token ${{ secrets.CARGO_TOKEN }}

.github/workflows/zizmor.yml

@@ -18,9 +18,9 @@ jobs:
       security-events: write
     steps:
       - name: Checkout repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
 
       - name: Run zizmor 🌈
-        uses: zizmorcore/zizmor-action@f52a838cfabf134edcbaa7c8b3677dde20045018 # v0.1.1
+        uses: zizmorcore/zizmor-action@e673c3917a1aef3c65c972347ed84ccd013ecda4 # v0.2.0

CONTRIBUTING.md

@@ -6,6 +6,23 @@ If your contribution is not straightforward, please first discuss the change you
 creating a new issue before making the change, or starting a discussion on
 [discord](https://discord.gg/pMCEU9hNEj).
 
+## AI Generated Content
+
+We welcome high quality PRs, whether they are human generated or made with the assistance of AI
+tools, but we ask that you follow these guidelines:
+
+- **Attribution**: Tell us about your use of AI tools, don't make us guess whether you're using it.
+- **Review**: Make sure you review every line of AI generated content for correctness and relevance.
+- **Quality**: AI-generated content should meet the same quality standards as human-written content.
+- **Quantity**: Avoid submitting large amounts of AI generated content in a single PR. Remember that
+  quality is usually more important than quantity.
+- **License**: Ensure that the AI-generated content is compatible with Ratatui's
+  [License](./LICENSE).
+
+> [!IMPORTANT]
+> Remember that AI tools can assist in generating content, but you are responsible for the final
+> quality and accuracy of the contributions and communicating about it.
+
 ## Reporting issues
 
 Before reporting an issue on the [issue tracker](https://github.com/ratatui/ratatui/issues),
@@ -61,7 +78,7 @@ to be installed when running rustfmt. You can install the nightly version of Rus
 rustup install nightly
 ```
 
-> [!IMPORTANT]  
+> [!IMPORTANT]
 > Do not modify formatting configuration (`rustfmt.toml`, `.clippy.toml`) without
 > prior discussion. These changes affect all contributors and should be carefully considered.
 
@@ -118,6 +135,14 @@ Changes to project configuration files require special consideration:
 
 Please discuss these changes in an issue before implementing them.
 
+### Collaborative development
+
+We may occasionally make changes directly to your branch—such as force-pushes—to help move a PR
+forward, speed up review, or ensure it meets our quality standards. If you would prefer we do not do
+this, or if your workflow depends on us avoiding force-pushes (for example, if your app points to
+your branch in `Cargo.toml`), please mention this in your PR description and we will respect your
+preference.
+
 ## Implementation Guidelines
 
 ### Setup
@@ -156,7 +181,7 @@ good, but this can always be improved. Focus on keeping the tests simple and obv
 tests for all new or modified code. Beside the usual doc and unit tests, one of the most valuable
 test you can write for Ratatui is a test against the `TestBackend`. It allows you to assert the
 content of the output buffer that would have been flushed to the terminal after a given draw call.
-See `widgets_block_renders` in [tests/widgets_block.rs](./tests/widget_block.rs) for an example.
+See `widgets_block_renders` in [ratatui/tests/widgets_block.rs](./ratatui/tests/widgets_block.rs) for an example.
 
 When writing tests, generally prefer to write unit tests and doc tests directly in the code file
 being tested rather than integration tests in the `tests/` folder.
@@ -165,7 +190,7 @@ If an area that you're making a change in is not tested, write tests to characte
 behavior before changing it. This helps ensure that we don't introduce bugs to existing software
 using Ratatui (and helps make it easy to migrate apps still using `tui-rs`).
 
-> [!IMPORTANT]  
+> [!IMPORTANT]
 > Do not remove existing tests without clear justification. If tests need to be
 > modified due to API changes, explain why in your PR description.
 

Cargo.toml

@@ -29,33 +29,35 @@ rust-version = "1.85.0"
 
 [workspace.dependencies]
 anstyle = "1"
-bitflags = "2.9"
+bitflags = "2.10"
+clap = { version = "4.5", features = ["derive"] }
 color-eyre = "0.6"
 compact_str = { version = "0.9", default-features = false }
-criterion = { version = "0.5", features = ["html_reports"] }
+criterion = { version = "0.7", features = ["html_reports"] }
 crossterm = "0.29"
 document-features = "0.2"
 fakeit = "1"
 futures = "0.3"
-hashbrown = "0.15"
+hashbrown = "0.16"
 indoc = "2"
 instability = "0.3"
 itertools = { version = "0.14", default-features = false, features = ["use_alloc"] }
 kasuari = { version = "0.4", default-features = false }
 line-clipping = "0.3"
-lru = "0.14"
+lru = "0.16"
+octocrab = "0.47"
 palette = "0.7"
 pretty_assertions = "1"
 rand = "0.9"
 rand_chacha = "0.9"
-ratatui = { path = "ratatui", version = "0.30.0-alpha.5" }
-ratatui-core = { path = "ratatui-core", version = "0.1.0-alpha.6" }
-ratatui-crossterm = { path = "ratatui-crossterm", version = "0.1.0-alpha.5" }
-ratatui-macros = { path = "ratatui-macros", version = "0.7.0-alpha.4" }
-ratatui-termion = { path = "ratatui-termion", version = "0.1.0-alpha.5" }
-ratatui-termwiz = { path = "ratatui-termwiz", version = "0.1.0-alpha.5" }
-ratatui-widgets = { path = "ratatui-widgets", version = "0.3.0-alpha.5" }
-rstest = "0.25"
+ratatui = { path = "ratatui", version = "0.30.0-beta.0" }
+ratatui-core = { path = "ratatui-core", version = "0.1.0-beta.0" }
+ratatui-crossterm = { path = "ratatui-crossterm", version = "0.1.0-beta.0" }
+ratatui-macros = { path = "ratatui-macros", version = "0.7.0-beta.0" }
+ratatui-termion = { path = "ratatui-termion", version = "0.1.0-beta.0" }
+ratatui-termwiz = { path = "ratatui-termwiz", version = "0.1.0-beta.0" }
+ratatui-widgets = { path = "ratatui-widgets", version = "0.3.0-beta.0" }
+rstest = "0.26"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 strum = { version = "0.27", default-features = false, features = ["derive"] }
@@ -64,6 +66,7 @@ termwiz = "0.23"
 thiserror = { version = "2", default-features = false }
 time = { version = "0.3", default-features = false }
 tokio = "1"
+tokio-stream = "0.1"
 tracing = "0.1"
 tracing-appender = "0.2"
 tracing-subscriber = "0.3"
@@ -71,7 +74,7 @@ trybuild = "1"
 unicode-segmentation = "1"
 unicode-truncate = { version = "2", default-features = false }
 # See <https://github.com/ratatui/ratatui/issues/1271> for information about why we pin unicode-width
-unicode-width = ">=0.2.0, <=0.2.1"
+unicode-width = ">=0.2.0, <=0.2.2"
 
 # Improve benchmark consistency
 [profile.bench]

MAINTAINERS.md

@@ -5,7 +5,7 @@ This file documents current and past maintainers.
 - [orhun](https://github.com/orhun)
 - [joshka](https://github.com/joshka)
 - [kdheepak](https://github.com/kdheepak)
-- [Valentin271](https://github.com/Valentin271)
+- [j-g00da](https://github.com/j-g00da)
 
 ## Past Maintainers
 
@@ -13,3 +13,4 @@ This file documents current and past maintainers.
 - [mindoodoo](https://github.com/mindoodoo)
 - [sayanarijit](https://github.com/sayanarijit)
 - [EdJoPaTo](https://github.com/EdJoPaTo)
+- [Valentin271](https://github.com/Valentin271)

README.md

@@ -12,7 +12,7 @@
 
 </details>
 
-![Demo](https://github.com/ratatui/ratatui/blob/87ae72dbc756067c97f6400d3e2a58eeb383776e/examples/demo2-destroy.gif?raw=true)
+![Release header](https://github.com/ratatui/ratatui/blob/b23480adfa9430697071c906c7ba4d4f9bd37a73/assets/release-header.png?raw=true)
 
 <div align="center">
 
@@ -113,15 +113,16 @@ There is also a [Matrix](https://matrix.org/) bridge available at
 We rely on GitHub for [bugs][Report a bug] and [feature requests][Request a Feature].
 
 Please make sure you read the [contributing](./CONTRIBUTING.md) guidelines before [creating a pull
-request][Create a Pull Request].
+request][Create a Pull Request]. We accept AI generated code, but please read the [AI Contributions]
+guidelines to ensure compliance.
 
 If you'd like to show your support, you can add the Ratatui badge to your project's README:
 
 ```md
-[![Built With Ratatui](https://ratatui.rs/built-with-ratatui/badge.svg)](https://ratatui.rs/)
+[![Built With Ratatui](https://img.shields.io/badge/Built_With_Ratatui-000?logo=ratatui&logoColor=fff)](https://ratatui.rs/)
 ```
 
-[![Built With Ratatui](https://ratatui.rs/built-with-ratatui/badge.svg)](https://ratatui.rs/)
+[![Built With Ratatui](https://img.shields.io/badge/Built_With_Ratatui-000?logo=ratatui&logoColor=fff)](https://ratatui.rs/)
 
 ## Acknowledgements
 
@@ -152,6 +153,7 @@ This project is licensed under the [MIT License][License].
 [Request a Feature]: https://github.com/ratatui/ratatui/issues/new?labels=enhancement&projects=&template=feature_request.md
 [Create a Pull Request]: https://github.com/ratatui/ratatui/compare
 [Contributing]: https://github.com/ratatui/ratatui/blob/main/CONTRIBUTING.md
+[AI Contributions]: https://github.com/ratatui/ratatui/blob/main/CONTRIBUTING.md#ai-generated-content
 [Crate]: https://crates.io/crates/ratatui
 [tui-rs]: https://crates.io/crates/tui
 [Sponsors]: https://github.com/sponsors/ratatui

cliff.toml

@@ -24,7 +24,11 @@ body = """
 {%- if not version %}
 ## [unreleased]
 {% else -%}
+{%- if package -%} {# release-plz specific variable #}
 ## {{ package }} - [{{ version }}]({{ release_link }}) - {{ timestamp | date(format="%Y-%m-%d") }}
+{%- else -%}
+## [{{ version }}]({{ self::remote_url() }}/releases/tag/{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
+{%- endif %}
 {% endif -%}
 
 {% macro commit(commit) -%}
@@ -57,16 +61,36 @@ body = """
 {%- endfor -%}
 {%- endfor %}
 
+{%- if not release_link -%}
+{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
+### New Contributors
+{%- endif %}\
+{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
+* @{{ contributor.username }} made their first contribution
+{%- if contributor.pr_number %} in \
+[#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
+{%- endif %}
+{%- endfor -%}
+{%- endif -%}
+
 {% if version %}
 {% if previous.version %}
-**Full Changelog**: {{ release_link }}
+{%- if release_link -%}
+**Full Changelog**: {{ release_link }} {# release-plz specific variable #}
+{%- else -%}
+**Full Changelog**: {{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }}
+{% endif %}
 {% endif %}
 {% else -%}
   {% raw %}\n{% endraw %}
 {% endif %}
 
 {%- macro remote_url() -%}
+{%- if remote.owner -%} {# release-plz specific variable #}
 https://github.com/{{ remote.owner }}/{{ remote.repo }}\
+{%- else -%}
+https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
+{%- endif -%}
 {% endmacro %}
 """
 # remove the leading and trailing whitespace from the template
@@ -92,10 +116,15 @@ commit_preprocessors = [
   { pattern = '(Clarify README.md)', replace = "docs(readme): ${1}" },
   { pattern = '(Update README.md)', replace = "docs(readme): ${1}" },
   { pattern = '(fix typos|Fix typos)', replace = "fix: ${1}" },
-  # a small typo that squeaked through and which would otherwise trigger the typos linter.
+  # Typos that squeaked through and which would otherwise trigger the typos linter.
   # Regex obsfucation is to avoid triggering the linter in this file until there's a per file config
   # See https://github.com/crate-ci/typos/issues/724
   { pattern = '\<[d]eatil\>', replace = "detail" },
+  { pattern = '\<[f]eatuers\>', replace = "features" },
+  { pattern = '\<[s]pecically\>', replace = "specially" },
+  { pattern = '\<[g]ague\>', replace = "gauge" },
+  { pattern = '\<[i]ntructions\>', replace = "instructions" },
+  { pattern = '\<[i]mplementated\>', replace = "implemented" },
 ]
 # regex for parsing and grouping commits
 commit_parsers = [
@@ -109,14 +138,16 @@ commit_parsers = [
   { message = "^style", group = "<!-- 05 -->Styling" },
   { message = "^test", group = "<!-- 06 -->Testing" },
   { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore: release", skip = true },
   { message = "^chore\\(pr\\)", skip = true },
   { message = "^chore\\(pull\\)", skip = true },
   { message = "^chore\\(deps\\)", skip = true },
   { message = "^chore\\(changelog\\)", skip = true },
   { message = "^[cC]hore", group = "<!-- 07 -->Miscellaneous Tasks" },
-  { body = ".*security", group = "<!-- 08 -->Security" },
   { message = "^build\\(deps\\)", skip = true },
-  { message = "^build", group = "<!-- 09 -->Build" },
+  { message = "^build\\(release\\)", skip = true },
+  { message = "^build", group = "<!-- 08 -->Build" },
+  { body = ".*security", group = "<!-- 09 -->Security" },
   { message = "^ci", group = "<!-- 10 -->Continuous Integration" },
   { message = "^revert", group = "<!-- 11 -->Reverted Commits" },
   # handle some old commits styles from pre 0.4
@@ -131,9 +162,9 @@ filter_commits = false
 # glob pattern for matching git tags
 tag_pattern = "v[0-9]*"
 # regex for skipping tags
-skip_tags = "v0.1.0-rc.1"
+skip_tags = "beta|alpha|v0.1.0-rc.1"
 # regex for ignoring tags
-ignore_tags = "alpha"
+ignore_tags = "rc"
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order

examples/README.md

@@ -1,7 +1,9 @@
 # Examples
 
 This folder contains examples that are more application focused.
-There are also [widget examples] in `ratatui-widgets`.
+
+> [!TIP]
+> There are also [widget examples] in `ratatui-widgets`.
 
 [widget examples]: ../ratatui-widgets/examples
 
@@ -11,8 +13,9 @@ You can run these examples using:
 cargo run -p example-name
 ```
 
-This folder might use unreleased code. Consider viewing the examples in the `latest` branch instead
-of the `main` branch for code which is guaranteed to work with the released ratatui version.
+> [!NOTE]
+> This folder might use unreleased code. Consider viewing the examples in the `latest` branch instead
+> of the `main` branch for code which is guaranteed to work with the released Ratatui version.
 
 > [!WARNING]
 >

examples/apps/async-github/Cargo.toml

@@ -14,9 +14,9 @@ edition.workspace = true
 rust-version.workspace = true
 
 [dependencies]
-color-eyre = "0.6.5"
+color-eyre.workspace = true
 crossterm = { workspace = true, features = ["event-stream"] }
-octocrab = "0.44.0"
+octocrab.workspace = true
 ratatui.workspace = true
-tokio = { version = "1.46.1", features = ["rt-multi-thread", "macros"] }
-tokio-stream = "0.1.17"
+tokio = { workspace = true, features = ["rt-multi-thread", "macros"] }
+tokio-stream.workspace = true

examples/apps/calendar-explorer/Cargo.toml

@@ -9,7 +9,7 @@ rust-version.workspace = true
 color-eyre.workspace = true
 crossterm.workspace = true
 ratatui.workspace = true
-time = { version = "0.3.39", features = ["formatting", "parsing"] }
+time = { workspace = true, features = ["formatting", "parsing"] }
 
 [lints]
 workspace = true

examples/apps/colors-rgb/Cargo.toml

@@ -8,7 +8,7 @@ rust-version.workspace = true
 [dependencies]
 color-eyre.workspace = true
 crossterm.workspace = true
-palette = "0.7.6"
+palette.workspace = true
 ratatui.workspace = true
 
 [lints]

examples/apps/demo/Cargo.toml

@@ -12,9 +12,9 @@ termion = ["ratatui/termion", "dep:termion"]
 termwiz = ["ratatui/termwiz", "dep:termwiz"]
 
 [dependencies]
-clap = { version = "4.5.41", features = ["derive"] }
+clap.workspace = true
 crossterm = { workspace = true, optional = true }
-rand = "0.9.2"
+rand.workspace = true
 ratatui.workspace = true
 termwiz = { workspace = true, optional = true }
 

examples/apps/demo2/Cargo.toml

@@ -6,14 +6,14 @@ edition.workspace = true
 rust-version.workspace = true
 
 [dependencies]
-color-eyre = "0.6.5"
+color-eyre.workspace = true
 crossterm.workspace = true
 indoc.workspace = true
 itertools.workspace = true
-palette = "0.7.6"
-rand = "0.9.2"
-rand_chacha = "0.9.0"
+palette.workspace = true
+rand.workspace = true
+rand_chacha.workspace = true
 ratatui = { workspace = true, features = ["all-widgets"] }
 strum.workspace = true
-time = "0.3.39"
-unicode-width = "0.2.0"
+time.workspace = true
+unicode-width.workspace = true

examples/apps/inline/Cargo.toml

@@ -8,7 +8,7 @@ rust-version.workspace = true
 [dependencies]
 color-eyre.workspace = true
 crossterm.workspace = true
-rand = "0.9.2"
+rand.workspace = true
 ratatui.workspace = true
 
 [lints]

examples/apps/mouse-drawing/Cargo.toml

@@ -9,8 +9,8 @@ rust-version.workspace = true
 color-eyre.workspace = true
 crossterm.workspace = true
 ## a collection of line drawing algorithms (e.g. Bresenham's line algorithm)
-line_drawing = "1.0.1"
-rand = "0.9.2"
+line_drawing = "1"
+rand.workspace = true
 ratatui.workspace = true
 
 [lints]

examples/apps/release-header/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "release-header"
+publish = false
+license.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+
+[dependencies]
+color-eyre.workspace = true
+ratatui.workspace = true
+
+[lints]
+workspace = true

examples/apps/release-header/README.md

@@ -0,0 +1,13 @@
+# Release Header
+
+Generates a banner for Ratatui releases featuring a Ratatui logo, version info, and a list of crates.
+
+Used for README.md, documentation, and release materials. Updated for every release starting with v0.30.0 "Bryndza".
+
+## Usage
+
+```bash
+cargo run --p release-header
+```
+
+Press any key to exit. Creates a fixed 68x16 terminal viewport.

examples/apps/release-header/src/main.rs

@@ -0,0 +1,171 @@
+//! Generates a terminal banner for Ratatui releases featuring a Ratatui logo, version info, and
+//! a list of crates.
+//!
+//! Used for README.md, documentation, and release materials. Updated for every release starting
+//! with v0.30.0 "Bryndza".
+//!
+//! This example runs with the Ratatui library code in the branch that you are currently
+//! reading. See the [`latest`] branch for the code which works with the most recent Ratatui
+//! release.
+//!
+//! [`latest`]: https://github.com/ratatui/ratatui/tree/latest
+
+use std::io::stdout;
+use std::iter::zip;
+
+use ratatui::crossterm::terminal::{EnterAlternateScreen, LeaveAlternateScreen};
+use ratatui::crossterm::{event, execute};
+use ratatui::layout::{Constraint, Flex, Layout, Margin, Rect, Spacing};
+use ratatui::style::{Color, Stylize};
+use ratatui::symbols::merge::MergeStrategy;
+use ratatui::text::Line;
+use ratatui::widgets::{Block, BorderType, Padding, Paragraph, RatatuiLogo};
+use ratatui::{DefaultTerminal, Frame, TerminalOptions, Viewport};
+
+const SEMVER: &str = "0.30.0";
+const RELEASE_NAME: &str = "Bryndza";
+
+const MAIN_DISHES: [&str; 4] = [
+    "> ratatui",
+    "> ratatui-core",
+    "> ratatui-widgets",
+    "> ratatui-macros",
+];
+const BACKENDS: [&str; 3] = [
+    "> ratatui-crossterm",
+    "> ratatui-termion",
+    "> ratatui-termwiz",
+];
+
+const FG_COLOR: Color = Color::Rgb(246, 214, 187); // #F6D6BB
+const BG_COLOR: Color = Color::Rgb(20, 20, 50); // #141432
+const MENU_BORDER_COLOR: Color = Color::Rgb(255, 255, 160); // #FFFFA0
+
+enum Rainbow {
+    Red,
+    Orange,
+    Yellow,
+    Green,
+    Blue,
+    Indigo,
+    Violet,
+}
+
+fn main() -> color_eyre::Result<()> {
+    color_eyre::install()?;
+    let viewport = Viewport::Fixed(Rect::new(0, 0, 68, 16));
+    let terminal = ratatui::init_with_options(TerminalOptions { viewport });
+    execute!(stdout(), EnterAlternateScreen).expect("failed to enter alternate screen");
+    let result = run(terminal);
+    execute!(stdout(), LeaveAlternateScreen).expect("failed to leave alternate screen");
+    ratatui::restore();
+    result
+}
+
+fn run(mut terminal: DefaultTerminal) -> color_eyre::Result<()> {
+    loop {
+        terminal.draw(render)?;
+        if event::read()?.is_key_press() {
+            break Ok(());
+        }
+    }
+}
+
+fn render(frame: &mut Frame) {
+    let area = frame.area();
+    frame.buffer_mut().set_style(area, (FG_COLOR, BG_COLOR));
+
+    let logo_width = 29;
+    let menu_width = 23;
+    let padding = 2; // Padding between logo and menu
+    let menu_borders = 3;
+    let height = MAIN_DISHES.len() as u16 + BACKENDS.len() as u16 + menu_borders;
+    let width = logo_width + menu_width + padding;
+    let center_area = area.centered(Constraint::Length(width), Constraint::Length(height));
+    let layout = Layout::horizontal(Constraint::from_lengths([logo_width, padding, menu_width]));
+    let [logo_area, _, menu_area] = center_area.layout(&layout);
+
+    render_logo(frame, logo_area);
+    render_menu(frame, menu_area);
+}
+
+fn render_logo(frame: &mut Frame, area: Rect) {
+    let area = area.inner(Margin::new(1, 0));
+    let layout = Layout::vertical(Constraint::from_lengths([6, 2, 1])).flex(Flex::End);
+    let [shadow_area, logo_area, version_area] = area.layout(&layout);
+
+    // Divide the logo into letter sections for individual coloring, then render a block for each
+    // letter with a color based on the row index.
+    let letter_layout = Layout::horizontal(Constraint::from_lengths([5, 4, 4, 4, 4, 5, 1]));
+    for (row_index, row) in shadow_area.rows().enumerate() {
+        for (rainbow, letter_area) in zip(Rainbow::ROYGBIV, row.layout_vec(&letter_layout)) {
+            let color = rainbow.gradient_color(row_index);
+            frame.render_widget(Block::new().style(color), letter_area);
+        }
+        // Render the Ratatui logo truncated.
+        frame.render_widget(RatatuiLogo::small(), row);
+    }
+
+    frame.render_widget(Block::new().style(FG_COLOR), logo_area);
+    frame.render_widget(RatatuiLogo::small(), logo_area);
+    frame.render_widget(format!("v{SEMVER} \"{RELEASE_NAME}\"").dim(), version_area);
+}
+
+impl Rainbow {
+    const RED_GRADIENT: [u8; 6] = [41, 43, 50, 68, 104, 156];
+    const GREEN_GRADIENT: [u8; 6] = [24, 30, 41, 65, 105, 168];
+    const BLUE_GRADIENT: [u8; 6] = [55, 57, 62, 78, 113, 166];
+    const AMBIENT_GRADIENT: [u8; 6] = [17, 18, 20, 25, 40, 60];
+
+    const ROYGBIV: [Self; 7] = [
+        Self::Red,
+        Self::Orange,
+        Self::Yellow,
+        Self::Green,
+        Self::Blue,
+        Self::Indigo,
+        Self::Violet,
+    ];
+
+    fn gradient_color(&self, row: usize) -> Color {
+        let ambient = Self::AMBIENT_GRADIENT[row];
+        let red = Self::RED_GRADIENT[row];
+        let green = Self::GREEN_GRADIENT[row];
+        let blue = Self::BLUE_GRADIENT[row];
+        let blue_sat = Self::AMBIENT_GRADIENT[row].saturating_mul(6 - row as u8);
+        let (r, g, b) = match self {
+            Self::Red => (red, ambient, blue_sat),
+            Self::Orange => (red, green / 2, blue_sat),
+            Self::Yellow => (red, green, blue_sat),
+            Self::Green => (ambient, green, blue_sat),
+            Self::Blue => (ambient, ambient, blue.max(blue_sat)),
+            Self::Indigo => (blue, ambient, blue.max(blue_sat)),
+            Self::Violet => (red, ambient, blue.max(blue_sat)),
+        };
+        Color::Rgb(r, g, b)
+    }
+}
+
+fn render_menu(frame: &mut Frame, area: Rect) {
+    let layout = Layout::vertical(Constraint::from_lengths([
+        MAIN_DISHES.len() as u16 + 2,
+        BACKENDS.len() as u16 + 2,
+    ]))
+    .spacing(Spacing::Overlap(1)); // Overlap to merge borders
+    let [main_dishes_area, backends_area] = area.layout(&layout);
+
+    render_menu_block(frame, main_dishes_area, "Main Courses", &MAIN_DISHES);
+    render_menu_block(frame, backends_area, "Pairings", &BACKENDS);
+}
+
+fn render_menu_block(frame: &mut Frame, area: Rect, title: &str, menu_items: &[&str]) {
+    let menu_block = Block::bordered()
+        .border_type(BorderType::Rounded)
+        .border_style(MENU_BORDER_COLOR)
+        .padding(Padding::horizontal(1))
+        .merge_borders(MergeStrategy::Fuzzy)
+        .title(title);
+
+    let menu_lines: Vec<Line> = menu_items.iter().map(|&item| Line::from(item)).collect();
+    frame.render_widget(Paragraph::new(menu_lines).block(menu_block), area);
+}

examples/apps/table/Cargo.toml

@@ -8,7 +8,7 @@ rust-version.workspace = true
 [dependencies]
 color-eyre.workspace = true
 crossterm.workspace = true
-fakeit = "1.1"
+fakeit.workspace = true
 itertools.workspace = true
 ratatui.workspace = true
 unicode-width.workspace = true

examples/apps/tracing/Cargo.toml

@@ -9,9 +9,9 @@ rust-version.workspace = true
 color-eyre.workspace = true
 crossterm.workspace = true
 ratatui.workspace = true
-tracing = "0.1.40"
-tracing-appender = "0.2.3"
-tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }
+tracing.workspace = true
+tracing-appender.workspace = true
+tracing-subscriber = { workspace = true, features = ["env-filter"] }
 
 [lints]
 workspace = true

examples/apps/weather/Cargo.toml

@@ -8,7 +8,7 @@ rust-version.workspace = true
 [dependencies]
 color-eyre.workspace = true
 crossterm.workspace = true
-rand = "0.9.2"
+rand.workspace = true
 ratatui.workspace = true
 
 [lints]

examples/concepts/state/Cargo.toml

@@ -6,6 +6,6 @@ edition.workspace = true
 rust-version.workspace = true
 
 [dependencies]
-color-eyre = "0.6"
-crossterm = "0.29"
+color-eyre.workspace = true
+crossterm.workspace = true
 ratatui = { workspace = true, features = ["unstable-widget-ref"] }

examples/vhs/release-header.tape

@@ -0,0 +1,19 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./examples/vhs/release-header.tape`
+# NOTE: Requires VHS 0.6.1 or later for Screenshot support
+# The reason for this strange size is that the social preview image for this
+# demo is 1280x64 with 80 pixels of padding on each side. We want a version
+# without the padding for README.md, etc.
+Set Theme {"background": "#141432"}
+Set FontSize 25
+Set Width 1120
+Set Height 480
+Set Padding 0
+Hide
+Type "cargo run -p release-header"
+Enter
+Sleep 1s
+Show
+Sleep 1s
+Screenshot assets/release-header.png
+Sleep 1s

ratatui-core/Cargo.toml

@@ -4,7 +4,7 @@ description = """
     Core types and traits for the Ratatui Terminal UI library.
     Widget libraries should use this crate. Applications should use the main Ratatui crate.
 """
-version = "0.1.0-alpha.6"
+version = "0.1.0-beta.0"
 readme = "README.md"
 authors.workspace = true
 documentation.workspace = true
@@ -43,6 +43,9 @@ anstyle = ["dep:anstyle"]
 ## enables conversions from colors in the [`palette`] crate to [`Color`](crate::style::Color).
 palette = ["std", "dep:palette"]
 
+## enables portable-atomic integration for targets that don't support atomic types.
+portable-atomic = ["kasuari/portable-atomic"]
+
 ## enables the backend code that sets the underline color. Underline color is only supported by
 ## the Crossterm backend, and is not supported on Windows 7.
 underline-color = []

ratatui-core/src/buffer/buffer.rs

@@ -495,6 +495,38 @@ impl Buffer {
             if !current.skip && (current != previous || invalidated > 0) && to_skip == 0 {
                 let (x, y) = self.pos_of(i);
                 updates.push((x, y, &next_buffer[i]));
+
+                // If the current cell is multi-width, ensure the trailing cells are explicitly
+                // cleared when they previously contained non-blank content. Some terminals do not
+                // reliably clear the trailing cell(s) when printing a wide grapheme, which can
+                // result in visual artifacts (e.g., leftover characters). Emitting an explicit
+                // update for the trailing cells avoids this.
+                let symbol = current.symbol();
+                let cell_width = symbol.width();
+                // Work around terminals that fail to clear the trailing cell of certain
+                // emoji presentation sequences (those containing VS16 / U+FE0F).
+                // Only emit explicit clears for such sequences to avoid bloating diffs
+                // for standard wide characters (e.g., CJK), which terminals handle well.
+                let contains_vs16 = symbol.chars().any(|c| c == '\u{FE0F}');
+                if cell_width > 1 && contains_vs16 {
+                    for k in 1..cell_width {
+                        let j = i + k;
+                        // Make sure that we are still inside the buffer.
+                        if j >= next_buffer.len() || j >= previous_buffer.len() {
+                            break;
+                        }
+                        let prev_trailing = &previous_buffer[j];
+                        let next_trailing = &next_buffer[j];
+                        if !next_trailing.skip && prev_trailing != next_trailing {
+                            let (tx, ty) = self.pos_of(j);
+                            // Push an explicit update for the trailing cell.
+                            // This is expected to be a blank cell, but we use the actual
+                            // content from the next buffer to handle cases where
+                            // the user has explicitly set something else.
+                            updates.push((tx, ty, next_trailing));
+                        }
+                    }
+                }
             }
 
             to_skip = current.symbol().width().saturating_sub(1);
@@ -1248,6 +1280,9 @@ mod tests {
     // Both eye and speech bubble include a 'display as emoji' variation selector
     // Prior to unicode-width 0.2, this was incorrectly detected as width 4 for some reason
     #[case::eye_speechbubble("👁️‍🗨️", "👁️‍🗨️xxxxx")]
+    // Keyboard keycap emoji: base symbol + VS16 for emoji presentation
+    // This should render as a single grapheme with width 2.
+    #[case::keyboard_emoji("⌨️", "⌨️xxxxx")]
     fn renders_emoji(#[case] input: &str, #[case] expected: &str) {
         use unicode_width::UnicodeWidthChar;
 
@@ -1297,4 +1332,34 @@ mod tests {
         assert_eq!(buffer.index_of(255, 256), 65791);
         assert_eq!(buffer.pos_of(65791), (255, 256)); // previously (255, 0)
     }
+
+    #[test]
+    fn diff_clears_trailing_cell_for_wide_grapheme() {
+        // Reproduce: write "ab", then overwrite with a wide emoji like "⌨️"
+        let prev = Buffer::with_lines(["ab"]); // width 2 area inferred
+        assert_eq!(prev.area.width, 2);
+
+        let mut next = Buffer::with_lines(["  "]); // start with blanks
+        next.set_string(0, 0, "⌨️", Style::new());
+
+        // The next buffer contains a wide grapheme occupying cell 0 and implicitly cell 1.
+        // The debug formatting shows the hidden trailing space.
+        let expected_next = Buffer::with_lines(["⌨️"]);
+        assert_eq!(next, expected_next);
+
+        // The diff should include an update for (0,0) to draw the emoji. Depending on
+        // terminal behavior, it may or may not be necessary to explicitly clear (1,0).
+        // At minimum, ensure the first cell is updated and nothing incorrect is emitted.
+        let diff = prev.diff(&next);
+        assert!(
+            diff.iter()
+                .any(|(x, y, c)| *x == 0 && *y == 0 && c.symbol() == "⌨️")
+        );
+        // And it should explicitly clear the trailing cell (1,0) to avoid leftovers on terminals
+        // that don't automatically clear the following cell for wide characters.
+        assert!(
+            diff.iter()
+                .any(|(x, y, c)| *x == 1 && *y == 0 && c.symbol() == " ")
+        );
+    }
 }

ratatui-core/src/layout/layout.rs

@@ -130,7 +130,7 @@ impl From<i16> for Spacing {
 ///
 /// When the layout is computed, the result is cached in a thread-local cache, so that subsequent
 /// calls with the same parameters are faster. The cache is a `LruCache`, and the size of the cache
-/// can be configured using [`Layout::init_cache()`].
+/// can be configured using [`Layout::init_cache()`] when the `layout-cache` feature is enabled.
 ///
 /// # Construction
 ///
@@ -203,8 +203,8 @@ impl Layout {
     /// on my laptop's terminal (171+51 = 222) and doubling it for good measure and then adding a
     /// bit more to make it a round number. This gives enough entries to store a layout for every
     /// row and every column, twice over, which should be enough for most apps. For those that need
-    /// more, the cache size can be set with [`Layout::init_cache()`].
-    /// This const is unused if layout cache is disabled.
+    /// more, the cache size can be set with `Layout::init_cache()` (requires the `layout-cache`
+    /// feature).
     #[cfg(feature = "layout-cache")]
     pub const DEFAULT_CACHE_SIZE: usize = 500;
 
@@ -636,8 +636,8 @@ impl Layout {
     ///
     /// This method stores the result of the computation in a thread-local cache keyed on the layout
     /// and area, so that subsequent calls with the same parameters are faster. The cache is a
-    /// `LruCache`, and grows until [`Self::DEFAULT_CACHE_SIZE`] is reached by default, if the cache
-    /// is initialized with the [`Layout::init_cache()`] grows until the initialized cache size.
+    /// `LruCache`, and grows until [`Self::DEFAULT_CACHE_SIZE`] is reached by default. If the cache
+    /// is initialized with [`Layout::init_cache()`], it grows until the initialized cache size.
     ///
     /// There is a helper method that can be used to split the whole area into smaller ones based on
     /// the layout: [`Layout::areas()`]. That method is a shortcut for calling this method. It
@@ -673,8 +673,8 @@ impl Layout {
     ///
     /// This method stores the result of the computation in a thread-local cache keyed on the layout
     /// and area, so that subsequent calls with the same parameters are faster. The cache is a
-    /// `LruCache`, and grows until [`Self::DEFAULT_CACHE_SIZE`] is reached by default, if the cache
-    /// is initialized with the [`Layout::init_cache()`] grows until the initialized cache size.
+    /// `LruCache`, and grows until [`Self::DEFAULT_CACHE_SIZE`] is reached by default. If the cache
+    /// is initialized with [`Layout::init_cache()`], it grows until the initialized cache size.
     ///
     /// # Examples
     ///

ratatui-core/src/layout/rect.rs

@@ -164,8 +164,7 @@ impl Rect {
         }
     }
 
-    /// The area of the `Rect`. If the area is larger than the maximum value of `u16`, it will be
-    /// clamped to `u16::MAX`.
+    /// The area of the `Rect`.
     pub const fn area(self) -> u32 {
         (self.width as u32) * (self.height as u32)
     }
@@ -225,7 +224,7 @@ impl Rect {
 
     /// Returns a new `Rect` outside the current one, with the given margin applied on each side.
     ///
-    /// If the margin causes the `Rect`'s bounds to outsdie the range of a `u16`, the `Rect` will
+    /// If the margin causes the `Rect`'s bounds to be outside the range of a `u16`, the `Rect` will
     /// be truncated to keep the bounds within `u16`. This will cause the size of the `Rect` to
     /// change.
     ///
@@ -646,6 +645,18 @@ impl From<(Position, Size)> for Rect {
     }
 }
 
+impl From<Size> for Rect {
+    /// Creates a new `Rect` with the given size at [`Position::ORIGIN`] (0, 0).
+    fn from(size: Size) -> Self {
+        Self {
+            x: 0,
+            y: 0,
+            width: size.width,
+            height: size.height,
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use alloc::string::ToString;
@@ -956,6 +967,23 @@ mod tests {
         );
     }
 
+    #[test]
+    fn from_size() {
+        let size = Size {
+            width: 3,
+            height: 4,
+        };
+        assert_eq!(
+            Rect::from(size),
+            Rect {
+                x: 0,
+                y: 0,
+                width: 3,
+                height: 4
+            }
+        );
+    }
+
     #[test]
     fn centered_horizontally() {
         let rect = Rect::new(0, 0, 5, 5);

ratatui-core/src/lib.rs

@@ -1,7 +1,6 @@
 #![no_std]
 // show the feature flags in the generated documentation
 #![cfg_attr(docsrs, feature(doc_cfg))]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/logo.png",
     html_favicon_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/favicon.ico"

ratatui-core/src/style.rs

@@ -238,15 +238,26 @@ impl fmt::Debug for Modifier {
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Style {
     /// The foreground color.
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub fg: Option<Color>,
     /// The background color.
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub bg: Option<Color>,
     /// The underline color.
     #[cfg(feature = "underline-color")]
+    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
     pub underline_color: Option<Color>,
     /// The modifiers to add.
+    #[cfg_attr(
+        feature = "serde",
+        serde(default, skip_serializing_if = "Modifier::is_empty")
+    )]
     pub add_modifier: Modifier,
     /// The modifiers to remove.
+    #[cfg_attr(
+        feature = "serde",
+        serde(default, skip_serializing_if = "Modifier::is_empty")
+    )]
     pub sub_modifier: Modifier,
 }
 
@@ -923,4 +934,59 @@ mod tests {
                 .remove_modifier(Modifier::DIM)
         );
     }
+
+    #[cfg(feature = "serde")]
+    #[test]
+    fn serialize_then_deserialize() {
+        let style = Style {
+            fg: Some(Color::Rgb(255, 0, 255)),
+            bg: Some(Color::White),
+            #[cfg(feature = "underline-color")]
+            underline_color: Some(Color::Indexed(3)),
+            add_modifier: Modifier::UNDERLINED,
+            sub_modifier: Modifier::CROSSED_OUT,
+        };
+
+        let json_str = serde_json::to_string(&style).unwrap();
+        let json_value: serde_json::Value = serde_json::from_str(&json_str).unwrap();
+
+        let mut expected_json = serde_json::json!({
+            "fg": "#FF00FF",
+            "bg": "White",
+            "add_modifier": "UNDERLINED",
+            "sub_modifier": "CROSSED_OUT"
+        });
+
+        #[cfg(feature = "underline-color")]
+        {
+            expected_json
+                .as_object_mut()
+                .unwrap()
+                .insert("underline_color".into(), "3".into());
+        }
+
+        assert_eq!(json_value, expected_json);
+
+        let deserialized: Style = serde_json::from_str(&json_str).unwrap();
+        assert_eq!(deserialized, style);
+    }
+
+    #[cfg(feature = "serde")]
+    #[test]
+    fn deserialize_defaults() {
+        let style = Style {
+            fg: None,
+            bg: None,
+            #[cfg(feature = "underline-color")]
+            underline_color: None,
+            add_modifier: Modifier::empty(),
+            sub_modifier: Modifier::empty(),
+        };
+
+        let json_str = serde_json::to_string(&style).unwrap();
+        assert_eq!(json_str, "{}");
+
+        let deserialized: Style = serde_json::from_str(&json_str).unwrap();
+        assert_eq!(deserialized, style);
+    }
 }

ratatui-core/src/style/color.rs

@@ -655,8 +655,8 @@ mod tests {
             "abcdef0",       // 7 chars is not a color
             " bcdefa",       // doesn't start with a '#'
             "#abcdef00",     // too many chars
-            "#1🦀2",         // len 7 but on char boundaries shouldnt panic
-            "resett",        // typo
+            "#1🦀2",         // len 7 but on char boundaries shouldn't panic
+            "resets",        // typo
             "lightblackk",   // typo
         ];
 

ratatui-core/src/symbols/merge.rs

@@ -99,7 +99,7 @@ pub enum MergeStrategy {
     ///
     /// The following diagram illustrates how this would apply to several overlapping blocks where
     /// the thick bordered blocks are rendered last, merging the previous symbols into a single
-    /// composite character. All combindations of the plain and thick segments exist, so these
+    /// composite character. All combinations of the plain and thick segments exist, so these
     /// symbols can be merged into a single character:
     ///
     /// ```text
@@ -264,7 +264,7 @@ pub enum MergeStrategy {
     /// assert_eq!(strategy.merge("┃", "═"), "╬");
     /// assert_eq!(strategy.merge("═", "┃"), "╋");
     ///
-    /// // combindations of double with plain that don't exist are merged based on the second symbol
+    /// // combinations of double with plain that don't exist are merged based on the second symbol
     /// assert_eq!(strategy.merge("┐", "╔"), "╦");
     /// assert_eq!(strategy.merge("╔", "┐"), "┬");
     /// ```

ratatui-core/src/terminal/terminal.rs

@@ -128,6 +128,14 @@ where
 {
     /// Creates a new [`Terminal`] with the given [`Backend`] with a full screen viewport.
     ///
+    /// Note that unlike `ratatui::init`, this does not install a panic hook, so it is recommended
+    /// to do that manually when using this function, otherwise any panic messages will be printed
+    /// to the alternate screen and the terminal may be left in an unusable state.
+    ///
+    /// See [how to set up panic hooks](https://ratatui.rs/recipes/apps/panic-hooks/) and
+    /// [`better-panic` example](https://ratatui.rs/recipes/apps/better-panic/) for more
+    /// information.
+    ///
     /// # Example
     ///
     /// ```rust,ignore
@@ -137,6 +145,13 @@ where
     ///
     /// let backend = CrosstermBackend::new(stdout());
     /// let terminal = Terminal::new(backend)?;
+    ///
+    /// // Optionally set up a panic hook to restore the terminal on panic.
+    /// let old_hook = std::panic::take_hook();
+    /// std::panic::set_hook(Box::new(move |info| {
+    ///     ratatui::restore();
+    ///     old_hook(info);
+    /// }));
     /// # std::io::Result::Ok(())
     /// ```
     pub fn new(backend: B) -> Result<Self, B::Error> {
@@ -164,9 +179,7 @@ where
     /// ```
     pub fn with_options(mut backend: B, options: TerminalOptions) -> Result<Self, B::Error> {
         let area = match options.viewport {
-            Viewport::Fullscreen | Viewport::Inline(_) => {
-                Rect::from((Position::ORIGIN, backend.size()?))
-            }
+            Viewport::Fullscreen | Viewport::Inline(_) => backend.size()?.into(),
             Viewport::Fixed(area) => area,
         };
         let (viewport_area, cursor_pos) = match options.viewport {
@@ -190,6 +203,40 @@ where
     }
 
     /// Get a Frame object which provides a consistent view into the terminal state for rendering.
+    ///
+    /// # Note
+    ///
+    /// This exists to support more advanced use cases. Most cases should be fine using
+    /// [`Terminal::draw`].
+    ///
+    /// [`Terminal::get_frame`] should be used when you need direct access to the frame buffer
+    /// outside of draw closure, for example:
+    ///
+    /// - Unit testing widgets
+    /// - Buffer state inspection
+    /// - Cursor manipulation
+    /// - Multiple rendering passes/Buffer Manipulation
+    /// - Custom frame lifecycle management
+    /// - Buffer exporting
+    ///
+    /// # Example
+    ///
+    /// Getting the buffer and asserting on some cells after rendering a widget.
+    ///
+    /// ```rust,ignore
+    /// use ratatui::{backend::TestBackend, Terminal};
+    /// use ratatui::widgets::Paragraph;
+    /// let backend = TestBackend::new(30, 5);
+    /// let mut terminal = Terminal::new(backend).unwrap();
+    /// {
+    ///     let mut frame = terminal.get_frame();
+    ///     frame.render_widget(Paragraph::new("Hello"), frame.area());
+    /// }
+    /// // When not using `draw`, present the buffer manually:
+    /// terminal.flush().unwrap();
+    /// terminal.swap_buffers();
+    /// terminal.backend_mut().flush().unwrap();
+    /// ```
     pub const fn get_frame(&mut self) -> Frame<'_> {
         let count = self.frame_count;
         Frame {
@@ -265,7 +312,7 @@ where
     pub fn autoresize(&mut self) -> Result<(), B::Error> {
         // fixed viewports do not get autoresized
         if matches!(self.viewport, Viewport::Fullscreen | Viewport::Inline(_)) {
-            let area = Rect::from((Position::ORIGIN, self.size()?));
+            let area = self.size()?.into();
             if area != self.last_known_area {
                 self.resize(area)?;
             }

ratatui-core/src/text/line.rs

@@ -7,6 +7,7 @@ use alloc::vec::Vec;
 use core::fmt;
 
 use unicode_truncate::UnicodeTruncateStr;
+use unicode_width::UnicodeWidthStr;
 
 use crate::buffer::Buffer;
 use crate::layout::{Alignment, Rect};
@@ -435,8 +436,9 @@ impl<'a> Line<'a> {
     /// let line = Line::from(vec!["Hello".blue(), " world!".green()]);
     /// assert_eq!(12, line.width());
     /// ```
+    #[must_use]
     pub fn width(&self) -> usize {
-        self.spans.iter().map(Span::width).sum()
+        UnicodeWidthStr::width(self)
     }
 
     /// Returns an iterator over the graphemes held by this line.
@@ -562,6 +564,16 @@ impl<'a> Line<'a> {
     }
 }
 
+impl UnicodeWidthStr for Line<'_> {
+    fn width(&self) -> usize {
+        self.spans.iter().map(UnicodeWidthStr::width).sum()
+    }
+
+    fn width_cjk(&self) -> usize {
+        self.spans.iter().map(UnicodeWidthStr::width_cjk).sum()
+    }
+}
+
 impl<'a> IntoIterator for Line<'a> {
     type Item = Span<'a>;
     type IntoIter = alloc::vec::IntoIter<Span<'a>>;

ratatui-core/src/text/span.rs

@@ -269,7 +269,7 @@ impl<'a> Span<'a> {
 
     /// Returns the unicode width of the content held by this span.
     pub fn width(&self) -> usize {
-        self.content.width()
+        UnicodeWidthStr::width(self)
     }
 
     /// Returns an iterator over the graphemes held by this span.
@@ -376,6 +376,16 @@ impl<'a> Span<'a> {
     }
 }
 
+impl UnicodeWidthStr for Span<'_> {
+    fn width(&self) -> usize {
+        self.content.width()
+    }
+
+    fn width_cjk(&self) -> usize {
+        self.content.width_cjk()
+    }
+}
+
 impl<'a, T> From<T> for Span<'a>
 where
     T: Into<Cow<'a, str>>,

ratatui-core/src/text/text.rs

@@ -5,6 +5,8 @@ use alloc::vec;
 use alloc::vec::Vec;
 use core::fmt;
 
+use unicode_width::UnicodeWidthStr;
+
 use crate::buffer::Buffer;
 use crate::layout::{Alignment, Rect};
 use crate::style::{Style, Styled};
@@ -284,7 +286,7 @@ impl<'a> Text<'a> {
     /// assert_eq!(15, text.width());
     /// ```
     pub fn width(&self) -> usize {
-        self.iter().map(Line::width).max().unwrap_or_default()
+        UnicodeWidthStr::width(self)
     }
 
     /// Returns the height.
@@ -559,6 +561,25 @@ impl<'a> Text<'a> {
     }
 }
 
+impl UnicodeWidthStr for Text<'_> {
+    /// Returns the max width of all the lines.
+    fn width(&self) -> usize {
+        self.lines
+            .iter()
+            .map(UnicodeWidthStr::width)
+            .max()
+            .unwrap_or_default()
+    }
+
+    fn width_cjk(&self) -> usize {
+        self.lines
+            .iter()
+            .map(UnicodeWidthStr::width_cjk)
+            .max()
+            .unwrap_or_default()
+    }
+}
+
 impl<'a> IntoIterator for Text<'a> {
     type Item = Line<'a>;
     type IntoIter = alloc::vec::IntoIter<Self::Item>;

ratatui-core/tests/rect.rs

@@ -0,0 +1,148 @@
+//! Integration tests for Rect operations visualized with buffers.
+
+use ratatui_core::buffer::Buffer;
+use ratatui_core::layout::{Margin, Offset, Rect};
+use ratatui_core::widgets::Widget;
+
+/// A minimal widget that fills its entire area with the given symbol.
+struct Filled<'a> {
+    symbol: &'a str,
+}
+
+impl Widget for Filled<'_> {
+    fn render(self, area: Rect, buf: &mut Buffer) {
+        for y in area.top()..area.bottom() {
+            for x in area.left()..area.right() {
+                if let Some(cell) = buf.cell_mut((x, y)) {
+                    cell.set_symbol(self.symbol);
+                }
+            }
+        }
+    }
+}
+
+#[test]
+fn inner() {
+    let base = Rect::new(2, 2, 10, 6);
+    let inner = base.inner(Margin::new(2, 1));
+
+    let mut buf = Buffer::empty(Rect::new(0, 0, 15, 10));
+    Filled { symbol: "█" }.render(base, &mut buf);
+    Filled { symbol: "░" }.render(inner, &mut buf);
+
+    let expected = Buffer::with_lines([
+        "               ",
+        "               ",
+        "  ██████████   ",
+        "  ██░░░░░░██   ",
+        "  ██░░░░░░██   ",
+        "  ██░░░░░░██   ",
+        "  ██░░░░░░██   ",
+        "  ██████████   ",
+        "               ",
+        "               ",
+    ]);
+    assert_eq!(buf, expected);
+}
+
+#[test]
+fn outer() {
+    let base = Rect::new(4, 3, 6, 4);
+    let outer = base.outer(Margin::new(2, 1));
+
+    let mut buf = Buffer::empty(Rect::new(0, 0, 15, 10));
+    Filled { symbol: "░" }.render(outer, &mut buf);
+    Filled { symbol: "█" }.render(base, &mut buf);
+
+    let expected = Buffer::with_lines([
+        "               ",
+        "               ",
+        "  ░░░░░░░░░░   ",
+        "  ░░██████░░   ",
+        "  ░░██████░░   ",
+        "  ░░██████░░   ",
+        "  ░░██████░░   ",
+        "  ░░░░░░░░░░   ",
+        "               ",
+        "               ",
+    ]);
+    assert_eq!(buf, expected);
+}
+
+#[test]
+fn offset() {
+    let base = Rect::new(2, 2, 5, 3);
+    let moved = base.offset(Offset { x: 4, y: 2 });
+
+    let mut buf = Buffer::empty(Rect::new(0, 0, 15, 10));
+    Filled { symbol: "░" }.render(base, &mut buf);
+    Filled { symbol: "█" }.render(moved, &mut buf);
+
+    let expected = Buffer::with_lines([
+        "               ",
+        "               ",
+        "  ░░░░░        ",
+        "  ░░░░░        ",
+        "  ░░░░█████    ",
+        "      █████    ",
+        "      █████    ",
+        "               ",
+        "               ",
+        "               ",
+    ]);
+    assert_eq!(buf, expected);
+}
+
+#[test]
+fn intersection() {
+    let a = Rect::new(2, 2, 6, 4);
+    let b = Rect::new(5, 3, 6, 4);
+    let inter = a.intersection(b);
+
+    let mut buf = Buffer::empty(Rect::new(0, 0, 15, 10));
+    Filled { symbol: "░" }.render(a, &mut buf);
+    Filled { symbol: "▒" }.render(b, &mut buf);
+    Filled { symbol: "█" }.render(inter, &mut buf);
+
+    let expected = Buffer::with_lines([
+        "               ",
+        "               ",
+        "  ░░░░░░       ",
+        "  ░░░███▒▒▒    ",
+        "  ░░░███▒▒▒    ",
+        "  ░░░███▒▒▒    ",
+        "     ▒▒▒▒▒▒    ",
+        "               ",
+        "               ",
+        "               ",
+    ]);
+    assert_eq!(buf, expected);
+}
+
+#[test]
+fn clamp() {
+    let area = Rect::new(2, 2, 10, 6);
+    let rect = Rect::new(8, 5, 8, 4);
+    let clamped = rect.clamp(area);
+
+    let mut buf = Buffer::empty(Rect::new(0, 0, 20, 12));
+    Filled { symbol: "█" }.render(area, &mut buf);
+    Filled { symbol: "▒" }.render(rect, &mut buf);
+    Filled { symbol: "░" }.render(clamped, &mut buf);
+
+    let expected = Buffer::with_lines([
+        "                    ",
+        "                    ",
+        "  ██████████        ",
+        "  ██████████        ",
+        "  ██░░░░░░░░        ",
+        "  ██░░░░░░░░▒▒▒▒    ",
+        "  ██░░░░░░░░▒▒▒▒    ",
+        "  ██░░░░░░░░▒▒▒▒    ",
+        "        ▒▒▒▒▒▒▒▒    ",
+        "                    ",
+        "                    ",
+        "                    ",
+    ]);
+    assert_eq!(buf, expected);
+}

ratatui-crossterm/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ratatui-crossterm"
-version = "0.1.0-alpha.5"
+version = "0.1.0-beta.0"
 description = "Crossterm backend for the Ratatui Terminal UI library."
 documentation = "https://docs.rs/ratatui-crossterm/"
 readme = "README.md"
@@ -14,11 +14,31 @@ exclude.workspace = true
 edition.workspace = true
 rust-version.workspace = true
 
+[package.metadata.docs.rs]
+features = ["document-features"]
+rustdoc-args = ["--cfg", "docsrs"]
+
 [features]
-default = ["underline-color"]
+default = ["underline-color", "crossterm_0_29"]
+
+#! One of the following versions of crossterm must be enabled. By default, the latest version is
+#! enabled. This will always default to the most recent version of crossterm, but you can override
+#! this by specifying the version you want to use in your Cargo.toml file. The purpose of these
+#! features is to allow widget libraries to depend on specific versions of crossterm in a way that
+#! doesn't cause version conflicts. A compiler error will be raised if you don't enable at least one
+#! of the following features.
+
+## Enables crossterm 0.28.x
+crossterm_0_28 = ["dep:crossterm_0_28"]
+## Enables crossterm 0.29.x
+crossterm_0_29 = ["dep:crossterm_0_29"]
+
+#! The following features are optional and can be enabled to add additional functionality to the
+#! library. These features are not required for the library to function, but they may be useful in
+#! certain situations.
 
 ## Enables serde for crossterm dependency
-serde = ["crossterm/serde"]
+serde = ["crossterm_0_28?/serde", "crossterm_0_29?/serde"]
 
 ## enables the backend code that sets the underline color.
 ## Underline color is not supported on Windows 7.
@@ -37,13 +57,14 @@ unstable-backend-writer = []
 
 
 [dependencies]
-crossterm.workspace = true
+cfg-if = "1.0.1"
+crossterm_0_28 = { version = "0.28", package = "crossterm", optional = true }
+crossterm_0_29 = { version = "0.29", package = "crossterm", optional = true }
 document-features = { workspace = true, optional = true }
 instability.workspace = true
-ratatui-core = { workspace = true }
+ratatui-core.workspace = true
 
 [dev-dependencies]
-ratatui = { path = "../ratatui", features = ["crossterm"] }
 rstest.workspace = true
 
 [lints]

ratatui-crossterm/README.md

@@ -2,10 +2,41 @@
 
 <!-- cargo-rdme start -->
 
-This module provides the [`CrosstermBackend`] implementation for the [`Backend`] trait. It uses
-the [Crossterm] crate to interact with the terminal.
+This crate provides [`CrosstermBackend`], an implementation of the [`Backend`] trait for the
+[Ratatui] library. It uses the [Crossterm] library for all terminal manipulation.
 
+### Crossterm Version and Re-export
+
+`ratatui-crossterm` requires you to specify a version of the [Crossterm] library to be used.
+This is managed via feature flags. The highest enabled feature flag of the available
+`crossterm_0_xx` features (e.g., `crossterm_0_28`, `crossterm_0_29`) takes precedence. These
+features determine which version of Crossterm is compiled and used by the backend. Feature
+unification may mean that any crate in your dependency graph that chooses to depend on a
+specific version of Crossterm may be affected by the feature flags you enable.
+
+Ratatui will support at least the two most recent versions of Crossterm (though we may increase
+this if crossterm release cadence increases). We will remove support for older versions in major
+(0.x) releases of `ratatui-crossterm`, and we may add support for newer versions in minor
+(0.x.y) releases.
+
+To promote interoperability within the [Ratatui] ecosystem, the selected Crossterm crate is
+re-exported as `ratatui_crossterm::crossterm`. This re-export is essential for authors of widget
+libraries or any applications that need to perform direct Crossterm operations while ensuring
+compatibility with the version used by `ratatui-crossterm`. By using
+`ratatui_crossterm::crossterm` for such operations, developers can avoid version conflicts and
+ensure that all parts of their application use a consistent set of Crossterm types and
+functions.
+
+For example, if your application's `Cargo.toml` enables the `crossterm_0_29` feature for
+`ratatui-crossterm`, then any code using `ratatui_crossterm::crossterm` will refer to the 0.29
+version of Crossterm.
+
+For more information on how to use the backend, see the documentation for the
+[`CrosstermBackend`] struct.
+
+[Ratatui]: https://ratatui.rs
 [Crossterm]: https://crates.io/crates/crossterm
+[`Backend`]: ratatui_core::backend::Backend
 
 ## Crate Organization
 

ratatui-crossterm/src/lib.rs

@@ -1,15 +1,45 @@
 // show the feature flags in the generated documentation
 #![cfg_attr(docsrs, feature(doc_cfg))]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/logo.png",
     html_favicon_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/favicon.ico"
 )]
 #![warn(missing_docs)]
-//! This module provides the [`CrosstermBackend`] implementation for the [`Backend`] trait. It uses
-//! the [Crossterm] crate to interact with the terminal.
+//! This crate provides [`CrosstermBackend`], an implementation of the [`Backend`] trait for the
+//! [Ratatui] library. It uses the [Crossterm] library for all terminal manipulation.
 //!
+//! ## Crossterm Version and Re-export
+//!
+//! `ratatui-crossterm` requires you to specify a version of the [Crossterm] library to be used.
+//! This is managed via feature flags. The highest enabled feature flag of the available
+//! `crossterm_0_xx` features (e.g., `crossterm_0_28`, `crossterm_0_29`) takes precedence. These
+//! features determine which version of Crossterm is compiled and used by the backend. Feature
+//! unification may mean that any crate in your dependency graph that chooses to depend on a
+//! specific version of Crossterm may be affected by the feature flags you enable.
+//!
+//! Ratatui will support at least the two most recent versions of Crossterm (though we may increase
+//! this if crossterm release cadence increases). We will remove support for older versions in major
+//! (0.x) releases of `ratatui-crossterm`, and we may add support for newer versions in minor
+//! (0.x.y) releases.
+//!
+//! To promote interoperability within the [Ratatui] ecosystem, the selected Crossterm crate is
+//! re-exported as `ratatui_crossterm::crossterm`. This re-export is essential for authors of widget
+//! libraries or any applications that need to perform direct Crossterm operations while ensuring
+//! compatibility with the version used by `ratatui-crossterm`. By using
+//! `ratatui_crossterm::crossterm` for such operations, developers can avoid version conflicts and
+//! ensure that all parts of their application use a consistent set of Crossterm types and
+//! functions.
+//!
+//! For example, if your application's `Cargo.toml` enables the `crossterm_0_29` feature for
+//! `ratatui-crossterm`, then any code using `ratatui_crossterm::crossterm` will refer to the 0.29
+//! version of Crossterm.
+//!
+//! For more information on how to use the backend, see the documentation for the
+//! [`CrosstermBackend`] struct.
+//!
+//! [Ratatui]: https://ratatui.rs
 //! [Crossterm]: https://crates.io/crates/crossterm
+//! [`Backend`]: ratatui_core::backend::Backend
 //!
 //! # Crate Organization
 //!
@@ -36,7 +66,6 @@
 
 use std::io::{self, Write};
 
-pub use crossterm;
 use crossterm::cursor::{Hide, MoveTo, Show};
 #[cfg(feature = "underline-color")]
 use crossterm::style::SetUnderlineColor;
@@ -47,6 +76,19 @@ use crossterm::style::{
 };
 use crossterm::terminal::{self, Clear};
 use crossterm::{execute, queue};
+cfg_if::cfg_if! {
+    // Re-export the selected Crossterm crate making sure to choose the latest version. We do this
+    // to make it possible to easily enable all features when compiling `ratatui-crossterm`.
+    if #[cfg(feature = "crossterm_0_29")] {
+        pub use crossterm_0_29 as crossterm;
+    } else if #[cfg(feature = "crossterm_0_28")] {
+        pub use crossterm_0_28 as crossterm;
+    } else {
+        compile_error!(
+            "At least one crossterm feature must be enabled. See the crate docs for more information."
+        );
+    }
+}
 use ratatui_core::backend::{Backend, ClearType, WindowSize};
 use ratatui_core::buffer::Cell;
 use ratatui_core::layout::{Position, Size};
@@ -70,7 +112,7 @@ use ratatui_core::style::{Color, Modifier, Style};
 ///
 /// # Example
 ///
-/// ```rust,no_run
+/// ```rust,ignore
 /// use std::io::{stderr, stdout};
 ///
 /// use crossterm::ExecutableCommand;
@@ -126,7 +168,7 @@ where
     ///
     /// # Example
     ///
-    /// ```rust,no_run
+    /// ```rust,ignore
     /// use std::io::stdout;
     ///
     /// use ratatui::backend::CrosstermBackend;

ratatui-macros/CHANGELOG.md

@@ -1,9 +1,8 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+See the [top-level changelog](../CHANGELOG.md) for the latest changes.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+This file is obsolete as of 0.30.0 release. [\*](https://github.com/ratatui/ratatui/pull/1652)
 
 ## [0.6.0](https://github.com/ratatui/ratatui-macros/compare/v0.5.0...v0.6.0) - 2024-10-21
 

ratatui-macros/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ratatui-macros"
-version = "0.7.0-alpha.4"
+version = "0.7.0-beta.0"
 edition.workspace = true
 authors = ["The Ratatui Developers"]
 description = "Macros for Ratatui"

ratatui-macros/tests/ui/fails.stderr

@@ -9,9 +9,9 @@ error: No rules expected the token `,` while trying to match the end of the macr
 error: unexpected end of macro invocation
   --> tests/ui/fails.rs:8:18
    |
-8  |       let [a, b] = constraints![
+ 8 |       let [a, b] = constraints![
    |  __________________^
-9  | |       == 1/2,
+ 9 | |       == 1/2,
 10 | |       == 2,
 11 | |     ];
    | |_____^ missing tokens in macro arguments
@@ -50,9 +50,8 @@ error: argument never used
    |                   -------  ^^^^^^^^^^^^^ argument never used
    |                   |
    |                   formatting specifier missing
-
-error[E0527]: pattern requires 2 elements but array has 3
- --> tests/ui/fails.rs:8:9
-  |
-8 |     let [a, b] = constraints![
-  |         ^^^^^^ expected 3 elements
+   |
+help: format specifiers use curly braces, consider adding a format specifier
+   |
+19 |     let _ = span!("hello{}", "hello world");
+   |                         ++

ratatui-termion/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ratatui-termion"
-version = "0.1.0-alpha.5"
+version = "0.1.0-beta.0"
 description = "Termion backend for the Ratatui Terminal UI library."
 documentation = "https://docs.rs/ratatui-termion/"
 readme = "README.md"

ratatui-termion/src/lib.rs

@@ -1,6 +1,5 @@
 // show the feature flags in the generated documentation
 #![cfg_attr(docsrs, feature(doc_cfg))]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/logo.png",
     html_favicon_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/favicon.ico"
@@ -66,7 +65,7 @@ use termion::{color as tcolor, style as tstyle};
 ///
 /// # Example
 ///
-/// ```rust,no_run
+/// ```rust,ignore
 /// use std::io::{stderr, stdout};
 ///
 /// use ratatui::Terminal;
@@ -113,7 +112,7 @@ where
     ///
     /// # Example
     ///
-    /// ```rust,no_run
+    /// ```rust,ignore
     /// use std::io::stdout;
     ///
     /// use ratatui::backend::TermionBackend;

ratatui-termwiz/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ratatui-termwiz"
-version = "0.1.0-alpha.5"
+version = "0.1.0-beta.0"
 description = "Termwiz backend for the Ratatui Terminal UI library."
 documentation = "https://docs.rs/ratatui-termwiz/"
 readme = "README.md"
@@ -27,7 +27,7 @@ serde = ["termwiz/use_serde"]
 
 ## Enables the backend code that sets the underline color.
 ## Underline color is not supported on Windows 7.
-underline-color = []
+underline-color = ["ratatui-core/underline-color"]
 
 ## Use terminal scrolling regions to make Terminal::insert_before less prone to flickering.
 scrolling-regions = ["ratatui-core/scrolling-regions"]
@@ -38,7 +38,7 @@ ratatui-core = { workspace = true }
 termwiz.workspace = true
 
 [dev-dependencies]
-ratatui = { path = "../ratatui", features = ["termwiz"] }
+ratatui = { path = "../ratatui", features = ["termwiz"], default-features = false }
 rstest.workspace = true
 
 [lints]

ratatui-termwiz/src/lib.rs

@@ -1,6 +1,5 @@
 // show the feature flags in the generated documentation
 #![cfg_attr(docsrs, feature(doc_cfg))]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/logo.png",
     html_favicon_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/favicon.ico"

ratatui-widgets/Cargo.toml

@@ -3,7 +3,7 @@ name = "ratatui-widgets"
 description = "A collection of Ratatui widgets for building terminal user interfaces using Ratatui."
 # Note that this started at 0.3.0 as there was a previous crate using the name `ratatui-widgets`.
 # <https://github.com/joshka/ratatui-widgets/issues/46>
-version = "0.3.0-alpha.5"
+version = "0.3.0-beta.0"
 readme = "README.md"
 authors.workspace = true
 documentation.workspace = true

ratatui-widgets/examples/README.md

@@ -0,0 +1,101 @@
+# Widget Examples
+
+This folder contains minimal examples for Ratatui widgets.
+There are meant to provide code snippets that can be copy-pasted into your
+application.
+
+> [!TIP]
+> There are also [application examples] in the top-level `examples` folder.
+
+[application examples]: ../../examples
+
+You can run these examples using:
+
+```shell
+cargo run -p ratatui-widgets --example example-name
+```
+
+> [!NOTE]
+> This folder might use unreleased code. Consider viewing the examples in the `latest` branch instead
+> of the `main` branch for code which is guaranteed to work with the released Ratatui version.
+
+## Barchart (grouped)
+
+![Barchart (grouped)][barchart-grouped.gif]
+
+## Barchart
+
+![Barchart][barchart.gif]
+
+## Block
+
+![Block][block.gif]
+
+## Calendar
+
+![Calendar][calendar.gif]
+
+## Canvas
+
+![Canvas][canvas.gif]
+
+## Chart
+
+![Chart][chart.gif]
+
+## Collapsed Borders
+
+![Collapsed Borders][collapsed-borders.gif]
+
+## Gauge
+
+![Gauge][gauge.gif]
+
+## Line Gauge
+
+![Line Gauge][line-gauge.gif]
+
+## List
+
+![List][list.gif]
+
+## Logo
+
+![Logo][logo.gif]
+
+## Paragraph
+
+![Paragraph][paragraph.gif]
+
+## Scrollbar
+
+![Scrollbar][scrollbar.gif]
+
+## Sparkline
+
+![Sparkline][sparkline.gif]
+
+## Table
+
+![Table][table.gif]
+
+## Tabs
+
+![Tabs][tabs.gif]
+
+[barchart-grouped.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/barchart-grouped.gif?raw=true
+[barchart.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/barchart.gif?raw=true
+[block.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/block.gif?raw=true
+[calendar.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/calendar.gif?raw=true
+[canvas.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/canvas.gif?raw=true
+[chart.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/chart.gif?raw=true
+[collapsed-borders.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/collapsed-borders.gif?raw=true
+[gauge.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/gauge.gif?raw=true
+[line-gauge.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/line-gauge.gif?raw=true
+[list.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/list.gif?raw=true
+[logo.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/logo.gif?raw=true
+[paragraph.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/paragraph.gif?raw=true
+[scrollbar.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/scrollbar.gif?raw=true
+[sparkline.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/sparkline.gif?raw=true
+[table.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/table.gif?raw=true
+[tabs.gif]: https://github.com/ratatui/ratatui/blob/images/widget-examples/tabs.gif?raw=true

ratatui-widgets/examples/vhs/barchart-grouped.tape

@@ -0,0 +1,12 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/barchart-grouped.tape`
+Output "target/barchart-grouped.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 1000
+Hide
+Type "cargo run -p ratatui-widgets --example barchart-grouped"
+Enter
+Sleep 1s
+Show
+Sleep 1s

ratatui-widgets/examples/vhs/barchart.tape

@@ -0,0 +1,12 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/barchart.tape`
+Output "target/barchart.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 600
+Hide
+Type "cargo run -p ratatui-widgets --example barchart"
+Enter
+Sleep 1s
+Show
+Sleep 1s

ratatui-widgets/examples/vhs/block.tape

@@ -0,0 +1,12 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/block.tape`
+Output "target/block.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 1200
+Hide
+Type "cargo run -p ratatui-widgets --example block"
+Enter
+Sleep 2s
+Show
+Sleep 2s

ratatui-widgets/examples/vhs/calendar.tape

@@ -0,0 +1,12 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/calendar.tape`
+Output "target/calendar.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 800
+Hide
+Type "cargo run -p ratatui-widgets --example calendar"
+Enter
+Sleep 3s
+Show
+Sleep 5s

ratatui-widgets/examples/vhs/canvas.tape

@@ -0,0 +1,13 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/canvas.tape`
+Output "target/canvas.gif"
+Set Theme "Aardvark Blue"
+Set FontSize 12
+Set Width 1200
+Set Height 800
+Hide
+Type "cargo run -p ratatui-widgets --example canvas"
+Enter
+Sleep 2s
+Show
+Sleep 5s

ratatui-widgets/examples/vhs/chart.tape

@@ -0,0 +1,12 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/chart.tape`
+Output "target/chart.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 800
+Hide
+Type "cargo run -p ratatui-widgets --example chart"
+Enter
+Sleep 1s
+Show
+Sleep 5s

ratatui-widgets/examples/vhs/collapsed-borders.tape

@@ -1,5 +1,5 @@
 # This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
-# To run this script, install vhs and run `vhs ./examples/vhs/gauge.tape`
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/collapsed-borders.tape`
 Output "target/collapsed-borders.gif"
 Set Theme "Aardvark Blue"
 Set Width 1200

ratatui-widgets/examples/vhs/gauge.tape

@@ -0,0 +1,12 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/gauge.tape`
+Output "target/gauge.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 850
+Hide
+Type "cargo run -p ratatui-widgets --example gauge"
+Enter
+Sleep 2s
+Show
+Sleep 5s

ratatui-widgets/examples/vhs/line-gauge.tape

@@ -0,0 +1,12 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/line-gauge.tape`
+Output "target/line-gauge.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 850
+Hide
+Type "cargo run -p ratatui-widgets --example line-gauge"
+Enter
+Sleep 2s
+Show
+Sleep 5s

ratatui-widgets/examples/vhs/list.tape

@@ -0,0 +1,20 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/list.tape`
+Output "target/list.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 612
+Hide
+Type "cargo run -p ratatui-widgets --example list"
+Enter
+Sleep 10s
+Show
+Sleep 2s
+Down@1.5s 3
+Sleep 1.5s
+Down@1.5s 3
+Sleep 1.5s
+Up@1s 1
+Sleep 1s
+Up@1s 4
+Sleep 2s

ratatui-widgets/examples/vhs/logo.tape

@@ -0,0 +1,14 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/logo.tape`
+Output "target/logo.gif"
+Set Theme "Aardvark Blue"
+Set Width 550
+Set Height 220
+Hide
+Type "cargo run -p ratatui-widgets --example logo"
+Enter
+Sleep 2s
+Show
+Sleep 2s
+Hide
+Escape

ratatui-widgets/examples/vhs/paragraph.tape

@@ -0,0 +1,12 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/paragraph.tape`
+Output "target/paragraph.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 600
+Hide
+Type "cargo run -p ratatui-widgets --example paragraph"
+Enter
+Sleep 1s
+Show
+Sleep 5s

ratatui-widgets/examples/vhs/scrollbar.tape

@@ -0,0 +1,17 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/scrollbar.tape`
+Output "target/scrollbar.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 600
+Hide
+Type "cargo run -p ratatui-widgets --example scrollbar"
+Enter
+Sleep 1s
+Show
+Sleep 2s
+Right@1s 4
+Sleep 1s
+Left@1s 1
+Down@1s 3
+Sleep 2s

ratatui-widgets/examples/vhs/sparkline.tape

@@ -0,0 +1,12 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/sparkline.tape`
+Output "target/sparkline.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 600
+Hide
+Type "cargo run -p ratatui-widgets --example sparkline"
+Enter
+Sleep 1s
+Show
+Sleep 5s

ratatui-widgets/examples/vhs/table.tape

@@ -0,0 +1,17 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/table.tape`
+Output "target/table.gif"
+Set Theme "Aardvark Blue"
+Set Width 1400
+Set Height 768
+Hide
+Type "cargo run -p ratatui-widgets --example table"
+Enter
+Sleep 1s
+Show
+Sleep 2s
+Set TypingSpeed 1s
+Down 3
+Sleep 1s
+Right 3
+Sleep 2s

ratatui-widgets/examples/vhs/tabs.tape

@@ -0,0 +1,15 @@
+# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
+# To run this script, install vhs and run `vhs ./ratatui-widgets/examples/vhs/tabs.tape`
+Output "target/tabs.gif"
+Set Theme "Aardvark Blue"
+Set Width 1200
+Set Height 368
+Hide
+Type "cargo run -p ratatui-widgets --example tabs"
+Enter
+Sleep 2s
+Show
+Sleep 1s
+Right@2.5s 3
+Left@2.5s 3
+Sleep 2s

ratatui-widgets/src/gauge.rs

@@ -431,7 +431,7 @@ impl Widget for &LineGauge<'_> {
         }
 
         let ratio = self.ratio;
-        let default_label = Line::from(format!("{:.0}%", ratio * 100.0));
+        let default_label = Line::from(format!("{:3.0}%", ratio * 100.0));
         let label = self.label.as_ref().unwrap_or(&default_label);
         let (col, row) = buf.set_line(gauge_area.left(), gauge_area.top(), label, gauge_area.width);
         let start = col + 1;
@@ -602,7 +602,7 @@ mod tests {
         let line_gauge = LineGauge::default().ratio(0.5);
         // This should not panic, even if the buffer is too small to render the line gauge.
         line_gauge.render(buffer.area, &mut buffer);
-        assert_eq!(buffer, Buffer::with_lines(["5"]));
+        assert_eq!(buffer, Buffer::with_lines([" "]));
     }
 
     #[test]

ratatui-widgets/src/lib.rs

@@ -1,7 +1,6 @@
 #![no_std]
 // show the feature flags in the generated documentation
 #![cfg_attr(docsrs, feature(doc_cfg))]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/logo.png",
     html_favicon_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/favicon.ico"

ratatui-widgets/src/tabs.rs

@@ -8,6 +8,7 @@ use ratatui_core::style::{Style, Styled};
 use ratatui_core::symbols;
 use ratatui_core::text::{Line, Span};
 use ratatui_core::widgets::Widget;
+use unicode_width::UnicodeWidthStr;
 
 use crate::block::{Block, BlockExt};
 
@@ -446,6 +447,64 @@ where
     }
 }
 
+impl UnicodeWidthStr for Tabs<'_> {
+    /// Returns the width of the rendered tabs.
+    ///
+    /// The width includes the titles, dividers, and padding. It does not include any borders added
+    /// by the optional block.
+    ///
+    /// Characters in the Ambiguous category are considered single-width.
+    ///
+    /// ```
+    /// use ratatui::widgets::Tabs;
+    /// use unicode_width::UnicodeWidthStr;
+    ///
+    /// let tabs = Tabs::new(vec!["Tab1", "Tab2", "Tab3"]);
+    /// assert_eq!(tabs.width(), 20); // " Tab1 │ Tab2 │ Tab3 "
+    /// ```
+    fn width(&self) -> usize {
+        let titles_width = self.titles.iter().map(Line::width).sum::<usize>();
+        let title_count = self.titles.len();
+        let divider_count = title_count.saturating_sub(1);
+        let divider_width = divider_count.saturating_mul(self.divider.width());
+        let left_padding_width = title_count.saturating_mul(self.padding_left.width());
+        let right_padding_width = title_count.saturating_mul(self.padding_right.width());
+        titles_width + divider_width + left_padding_width + right_padding_width
+    }
+
+    /// Returns the width of the rendered tabs, accounting for CJK characters.
+    ///
+    /// This is probably the wrong method to use in most contexts that Ratatui applications care
+    /// about as it doesn't correlate with the visual representation of most terminals. Consider
+    /// using [`Tabs::width`] instead.
+    ///
+    /// The width includes the titles, dividers, and padding. It does not include any borders added
+    /// by the optional block.
+    ///
+    /// Characters in the Ambiguous category are considered double-width.
+    ///
+    /// ```
+    /// use ratatui::widgets::Tabs;
+    /// use unicode_width::UnicodeWidthStr;
+    ///
+    /// let tabs = Tabs::new(vec!["你", "好", "世界"]);
+    /// assert_eq!("你".width_cjk(), 2);
+    /// assert_eq!("好".width_cjk(), 2);
+    /// assert_eq!("世界".width_cjk(), 4);
+    /// assert_eq!("│".width_cjk(), 2); // this is correct for cjk
+    /// assert_eq!(tabs.width_cjk(), 18); // " 你 │ 好 │ 世界 "
+    /// ```
+    fn width_cjk(&self) -> usize {
+        let titles_width = self.titles.iter().map(Line::width_cjk).sum::<usize>();
+        let title_count = self.titles.len();
+        let divider_count = title_count.saturating_sub(1);
+        let divider_width = divider_count.saturating_mul(self.divider.width_cjk());
+        let left_padding_width = title_count.saturating_mul(self.padding_left.width_cjk());
+        let right_padding_width = title_count.saturating_mul(self.padding_right.width_cjk());
+        titles_width + divider_width + left_padding_width + right_padding_width
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use alloc::{format, vec};
@@ -697,4 +756,50 @@ mod tests {
         // This should not panic, even if the buffer has zero size.
         tabs.render(buffer.area, &mut buffer);
     }
+
+    #[test]
+    fn unicode_width_basic() {
+        let tabs = Tabs::new(vec!["A", "BB", "CCC"]);
+        let rendered = " A │ BB │ CCC ";
+        assert_eq!(tabs.width(), rendered.width());
+    }
+
+    #[test]
+    fn unicode_width_no_padding() {
+        let tabs = Tabs::new(vec!["A", "BB", "CCC"]).padding("", "");
+        let rendered = "A│BB│CCC";
+        assert_eq!(tabs.width(), rendered.width());
+    }
+
+    #[test]
+    fn unicode_width_custom_divider_and_padding() {
+        let tabs = Tabs::new(vec!["A", "BB", "CCC"])
+            .divider("--")
+            .padding("X", "YY");
+        let rendered = "XAYY--XBBYY--XCCCYY";
+        assert_eq!(tabs.width(), rendered.width());
+    }
+
+    #[test]
+    fn unicode_width_empty_titles() {
+        let tabs = Tabs::new(Vec::<&str>::new());
+        let rendered = "";
+        assert_eq!(tabs.width(), rendered.width());
+    }
+
+    #[test]
+    fn unicode_width_cjk() {
+        let tabs = Tabs::new(vec!["你", "好", "世界"]);
+        let rendered = " 你 │ 好 │ 世界 ";
+        assert_eq!(tabs.width_cjk(), UnicodeWidthStr::width_cjk(rendered));
+    }
+
+    #[test]
+    fn unicode_width_cjk_custom_padding_and_divider() {
+        let tabs = Tabs::new(vec!["你", "好", "世界"])
+            .divider("分")
+            .padding("左", "右");
+        let rendered = "左你右分左好右分左世界右";
+        assert_eq!(tabs.width_cjk(), UnicodeWidthStr::width_cjk(rendered));
+    }
 }

ratatui/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "ratatui"
 description = "A library that's all about cooking up terminal user interfaces"
-version = "0.30.0-alpha.5"
+version = "0.30.0-beta.0"
 authors.workspace = true
 documentation.workspace = true
 repository.workspace = true
@@ -59,6 +59,9 @@ layout-cache = ["std", "ratatui-core/layout-cache"]
 ## enables conversions from colors in the [`palette`] crate to [`Color`](crate::style::Color).
 palette = ["std", "ratatui-core/palette", "dep:palette"]
 
+## enables portable-atomic integration for targets that don't support atomic types.
+portable-atomic = ["ratatui-core/portable-atomic"]
+
 ## Use terminal scrolling regions to make some operations less prone to
 ## flickering. (i.e. Terminal::insert_before).
 scrolling-regions = [

ratatui/benches/main.rs

@@ -2,12 +2,14 @@ pub mod main {
     pub mod barchart;
     pub mod block;
     pub mod buffer;
+    pub mod constraints;
     pub mod line;
     pub mod list;
     pub mod paragraph;
     pub mod rect;
     pub mod sparkline;
     pub mod table;
+    pub mod text;
 }
 pub use main::*;
 
@@ -21,4 +23,6 @@ criterion::criterion_main!(
     rect::benches,
     sparkline::benches,
     table::benches,
+    text::benches,
+    constraints::benches,
 );

ratatui/benches/main/buffer.rs

@@ -1,4 +1,6 @@
-use criterion::{BenchmarkId, Criterion, black_box};
+use std::hint::black_box;
+
+use criterion::{BenchmarkId, Criterion};
 use ratatui::buffer::{Buffer, Cell};
 use ratatui::layout::Rect;
 use ratatui::text::Line;

ratatui/benches/main/constraints.rs

@@ -0,0 +1,60 @@
+use std::hint::black_box;
+use std::rc::Rc;
+
+use criterion::{Criterion, criterion_group};
+use ratatui::layout::Constraint::{Fill, Length, Max, Min, Percentage, Ratio};
+use ratatui::layout::{Layout, Rect};
+
+const SPLIT_BY: u16 = 10;
+
+fn layout_split(criterion: &mut Criterion) {
+    for size in [16, 64, 256] {
+        let mut group = criterion.benchmark_group(format!("constraints {size}x{size}"));
+        let area = Rect::new(0, 0, size, size);
+        group.bench_function("Fill", |bencher| {
+            bencher.iter(|| layout_fill(black_box(area)));
+        });
+        group.bench_function("Length", |bencher| {
+            bencher.iter(|| layout_length(black_box(area)));
+        });
+        group.bench_function("Max", |bencher| {
+            bencher.iter(|| layout_max(black_box(area)));
+        });
+        group.bench_function("Min", |bencher| {
+            bencher.iter(|| layout_min(black_box(area)));
+        });
+        group.bench_function("Percentage", |bencher| {
+            bencher.iter(|| layout_percentage(black_box(area)));
+        });
+        group.bench_function("Ratio", |bencher| {
+            bencher.iter(|| layout_ratio(black_box(area)));
+        });
+        group.finish();
+    }
+}
+
+fn layout_fill(area: Rect) -> Rc<[Rect]> {
+    Layout::vertical([Fill(1); SPLIT_BY as usize]).split(area)
+}
+
+fn layout_length(area: Rect) -> Rc<[Rect]> {
+    Layout::vertical([Length(area.width / SPLIT_BY); SPLIT_BY as usize]).split(area)
+}
+
+fn layout_max(area: Rect) -> Rc<[Rect]> {
+    Layout::vertical([Max(area.width / SPLIT_BY); SPLIT_BY as usize]).split(area)
+}
+
+fn layout_min(area: Rect) -> Rc<[Rect]> {
+    Layout::vertical([Min(area.width / SPLIT_BY); SPLIT_BY as usize]).split(area)
+}
+
+fn layout_percentage(area: Rect) -> Rc<[Rect]> {
+    Layout::vertical([Percentage(100 / SPLIT_BY); SPLIT_BY as usize]).split(area)
+}
+
+fn layout_ratio(area: Rect) -> Rc<[Rect]> {
+    Layout::vertical([Ratio(1, SPLIT_BY.into()); SPLIT_BY as usize]).split(area)
+}
+
+criterion_group!(benches, layout_split);

ratatui/benches/main/paragraph.rs

@@ -1,4 +1,6 @@
-use criterion::{BatchSize, Bencher, BenchmarkId, Criterion, black_box, criterion_group};
+use std::hint::black_box;
+
+use criterion::{BatchSize, Bencher, BenchmarkId, Criterion, criterion_group};
 use ratatui::buffer::Buffer;
 use ratatui::layout::Rect;
 use ratatui::widgets::{Paragraph, Widget, Wrap};

ratatui/benches/main/rect.rs

@@ -1,4 +1,6 @@
-use criterion::{BatchSize, Bencher, BenchmarkId, Criterion, black_box, criterion_group};
+use std::hint::black_box;
+
+use criterion::{BatchSize, Bencher, BenchmarkId, Criterion, criterion_group};
 use ratatui::layout::Rect;
 
 fn rect_iters_benchmark(c: &mut Criterion) {

ratatui/benches/main/text.rs

@@ -0,0 +1,63 @@
+use criterion::{BatchSize, Bencher, Criterion, criterion_group};
+use ratatui::buffer::Buffer;
+use ratatui::layout::Rect;
+use ratatui::style::Stylize;
+use ratatui::text::{Line, Text};
+use ratatui::widgets::Widget;
+
+/// Benchmark for rendering a text.
+fn text(c: &mut Criterion) {
+    let mut group = c.benchmark_group("text");
+    for (width, height) in [
+        (200, 50),     // 1080p fullscreen area with medium font.
+        (1, u16::MAX), // Heavily vertically skewed area.
+        (u16::MAX, 1), // Heavily horizontally skewed area.
+        (4096, 4096),  // Max sized area for benchmarking (~sqrt(u16::MAX) * 16, ~768 MB buffer).
+    ] {
+        let buffer_size = Rect::new(0, 0, width, height);
+
+        // Generates sample text content scaled to the given rendering area.
+        // The number of repeated text blocks is roughly proportional to the area size.
+        //  - Small areas produce a few lines (at least 5 x 1 lines).
+        //  - Large areas produce many lines (up to ~5 x 1000 lines).
+        let make_text = |height: u16| {
+            let repeat = (height as usize / 5).clamp(1, 1000);
+            Text::from(
+                (0..repeat)
+                    .flat_map(|_| {
+                        vec![
+                            Line::from("The quick brown fox jumps over the lazy dog. Pack my box with five dozen liquor jugs."),
+                            Line::from("🦀 Rustaceans unite! 東京・İstanbul・Sydney・San Francisco・Warsaw 🌏 RustConf連携中！").bold(),
+                            Line::from("naïve cafés ☕ serve résumé-ready developers 👩‍💻🧑🏾‍💻 testing text rendering engines.").green(),
+                            Line::from("ゼロ幅スペース\u{200B}、結合絵文字👨‍👩‍👧‍👦、全角文字ＡＢＣ、半角abcが混在。").blue(),
+                            Line::from("Emoji test: 🙂😇🤖👩🏻‍🎨🧑‍🚀 — wrapped in a buffer for layout & clipping check.").italic(),
+                        ]
+                    })
+                    .collect::<Vec<_>>(),
+            )
+        };
+
+        group.bench_with_input(
+            format!("render/{width}x{height}"),
+            &make_text(height),
+            |b, text| render(b, text, buffer_size),
+        );
+    }
+    group.finish();
+}
+
+/// Renders the text into a buffer of the given `size`
+fn render(bencher: &mut Bencher, text: &Text, size: Rect) {
+    let mut buffer = Buffer::empty(size);
+    // We use `iter_batched` to clone the value in the setup function.
+    // See https://github.com/ratatui/ratatui/pull/377.
+    bencher.iter_batched(
+        || text.to_owned(),
+        |bench_text| {
+            bench_text.render(buffer.area, &mut buffer);
+        },
+        BatchSize::SmallInput,
+    );
+}
+
+criterion_group!(benches, text);

ratatui/src/lib.rs

@@ -1,13 +1,12 @@
 #![no_std]
 // show the feature flags in the generated documentation
 #![cfg_attr(docsrs, feature(doc_cfg))]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/logo.png",
     html_favicon_url = "https://raw.githubusercontent.com/ratatui/ratatui/main/assets/favicon.ico"
 )]
 #![warn(missing_docs)]
-//! ![Demo](https://github.com/ratatui/ratatui/blob/87ae72dbc756067c97f6400d3e2a58eeb383776e/examples/demo2-destroy.gif?raw=true)
+//! ![Release header](https://github.com/ratatui/ratatui/blob/b23480adfa9430697071c906c7ba4d4f9bd37a73/assets/release-header.png?raw=true)
 //!
 //! <div align="center">
 //!

ratatui/tests/widgets_gauge.rs

@@ -233,20 +233,20 @@ fn widgets_line_gauge_renders() {
         })
         .unwrap();
     let mut expected = Buffer::with_lines([
-        "43% ────────────────",
+        " 43% ───────────────",
         "┌Gauge 2───────────┐",
-        "│21% ━━━━━━━━━━━━━━│",
+        "│ 21% ━━━━━━━━━━━━━│",
         "└──────────────────┘",
-        "50% ────────        ",
-        "80% ████████████░░░░",
+        " 50% ───────        ",
+        " 80% ████████████░░░",
     ]);
-    for col in 4..10 {
+    for col in 5..11 {
         expected[(col, 0)].set_fg(Color::Green);
     }
-    for col in 10..20 {
+    for col in 11..20 {
         expected[(col, 0)].set_fg(Color::White);
     }
-    for col in 5..7 {
+    for col in 6..8 {
         expected[(col, 2)].set_fg(Color::Green);
     }
     terminal.backend().assert_buffer(&expected);

rustfmt.toml

@@ -1,12 +1,23 @@
-# configuration for https://rust-lang.github.io/rustfmt/
+# Configuration for https://rust-lang.github.io/rustfmt/
+edition = "2024"
 
+# E.g. Foo { a, b, c }
 use_field_init_shorthand = true
 
-# unstable options
+# Unstable options. These require a nightly compiler to use (cargo +nightly fmt).
+
+# We choose a wider comment width, as this tends to make comments more readable than truncating at
+# 80 characters.
+wrap_comments = true
 comment_width = 100
 format_code_in_doc_comments = true
-format_macro_matchers = true
+
+# `#[doc = "..."]` -> `/// ...`
+normalize_doc_attributes = true
+
+# We choose module granularity for imports as this tends to have the best balance between low
+# linecount while making it simple to understand diffs
 group_imports = "StdExternalCrate"
 imports_granularity = "Module"
-normalize_doc_attributes = true
-wrap_comments = true
+
+format_macro_matchers = true

xtask/Cargo.toml

@@ -5,9 +5,9 @@ publish = false
 license.workspace = true
 
 [dependencies]
-clap = { version = "4.5.41", features = ["derive"] }
-clap-verbosity-flag = { version = "3.0.3", default-features = false, features = ["tracing"] }
-color-eyre = "0.6.5"
-duct = "1.0.0"
-tracing = "0.1.40"
-tracing-subscriber = { version = "0.3.18" }
+clap.workspace = true
+clap-verbosity-flag = { version = "3", default-features = false, features = ["tracing"] }
+color-eyre.workspace = true
+duct = "1"
+tracing.workspace = true
+tracing-subscriber.workspace = true

xtask/src/commands.rs

@@ -13,7 +13,7 @@ use self::clippy::Clippy;
 use self::docs::Docs;
 use self::format::Format;
 use self::typos::Typos;
-use crate::{ExpressionExt, Run, run_cargo};
+use crate::{CROSSTERM_COMMON_FEATURES, ExpressionExt, Run, run_cargo};
 
 mod backend;
 mod check;
@@ -22,6 +22,7 @@ mod coverage;
 mod docs;
 mod format;
 mod rdme;
+mod test_docs;
 mod typos;
 
 #[derive(Clone, Debug, Subcommand)]
@@ -110,7 +111,7 @@ impl Run for Command {
             Command::LintMarkdown => lint_markdown(),
             Command::Test => test(),
             Command::TestBackend(command) => command.run(),
-            Command::TestDocs => test_docs(),
+            Command::TestDocs => test_docs::test_docs(),
             Command::TestLibs => test_libs(),
             Command::Hack => hack(),
         }
@@ -154,18 +155,36 @@ fn test() -> Result<()> {
     for backend in [Backend::Crossterm, Backend::Termion, Backend::Termwiz] {
         TestBackend { backend }.run()?;
     }
-    test_docs()?; // run last because it's slow
+    test_docs::test_docs()?; // run last because it's slow
     Ok(())
 }
 
-/// Run doc tests for the workspace's default packages
-fn test_docs() -> Result<()> {
-    run_cargo(vec!["test", "--doc", "--all-features"])
-}
-
 /// Run lib tests for the workspace's default packages
 fn test_libs() -> Result<()> {
-    run_cargo(vec!["test", "--lib", "--all-targets", "--all-features"])
+    run_cargo(vec![
+        "hack",
+        "--ignore-private", // exclude packages that are libraries
+        "--exclude",
+        "ratatui-crossterm",
+        "test",
+        "--lib",
+        "--all-targets",
+        "--all-features",
+    ])?;
+    let crossterm_feature = CROSSTERM_COMMON_FEATURES.join(",");
+    for crossterm_version in crate::CROSSTERM_VERSION_FEATURES {
+        let features = format!("{crossterm_feature},{crossterm_version}");
+        run_cargo(vec![
+            "test",
+            "--package",
+            "ratatui-crossterm",
+            "--lib",
+            "--no-default-features",
+            "--features",
+            features.as_str(),
+        ])?;
+    }
+    Ok(())
 }
 
 /// Run cargo hack to test each feature in isolation

xtask/src/commands/check.rs

@@ -1,6 +1,6 @@
 use color_eyre::Result;
 
-use crate::{Run, run_cargo};
+use crate::{CROSSTERM_COMMON_FEATURES, CROSSTERM_VERSION_FEATURES, Run, run_cargo};
 
 /// Run cargo check
 #[derive(Clone, Debug, clap::Args)]
@@ -13,7 +13,35 @@ pub struct Check {
 impl Run for Check {
     fn run(self) -> Result<()> {
         if self.all_features {
-            run_cargo(vec!["check", "--all-targets", "--all-features"])
+            let common_features = CROSSTERM_COMMON_FEATURES.join(",");
+
+            // Run `cargo check` on `ratatui-crossterm` with specific crossterm versions
+            for crossterm_feature in CROSSTERM_VERSION_FEATURES {
+                let features = format!("{common_features},{crossterm_feature}");
+                let command = vec![
+                    "check",
+                    "--all-targets",
+                    "--package",
+                    "ratatui-crossterm",
+                    "--no-default-features",
+                    "--features",
+                    features.as_str(),
+                ];
+                run_cargo(command)?;
+            }
+
+            run_cargo(vec![
+                "hack",
+                "--exclude",
+                "ratatui-crossterm",
+                #[cfg(windows)]
+                "--exclude",
+                #[cfg(windows)]
+                "ratatui-termion",
+                "check",
+                "--all-targets",
+                "--all-features",
+            ])
         } else {
             run_cargo(vec!["check", "--all-targets"])
         }

xtask/src/commands/clippy.rs

@@ -1,6 +1,6 @@
 use color_eyre::Result;
 
-use crate::{Run, run_cargo};
+use crate::{CROSSTERM_VERSION_FEATURES, Run, run_cargo};
 
 /// Run clippy on the project
 #[derive(Clone, Debug, clap::Args)]
@@ -12,19 +12,57 @@ pub struct Clippy {
 
 impl Run for Clippy {
     fn run(self) -> Result<()> {
-        let mut args = vec![
-            "clippy",
-            "--all-targets",
+        // Arguments that go before feature flags (e.g., "clippy", "--fix")
+        let mut clippy_command = vec!["clippy"];
+        if self.fix {
+            clippy_command.push("--fix");
+        }
+
+        // Define common non-version-specific features for ratatui-crossterm. These will be enabled
+        // for both crossterm 0.28 and 0.29 runs. `underline-color`` is part of default, but with
+        // `--no-default-features``, we must add it.
+        let common_features = [
+            "serde",
+            "underline-color",
+            "scrolling-regions",
+            "unstable",
+            "unstable-backend-writer",
+        ]
+        .join(",");
+
+        let clippy_options = ["--", "-D", "warnings"];
+
+        // Run Clippy on `ratatui-crossterm` with `crossterm_0_28` and `crossterm_0_29`
+        for crossterm_feature in CROSSTERM_VERSION_FEATURES {
+            let mut command = clippy_command.clone();
+            let features = format!("{common_features},{crossterm_feature}");
+            // Note that adding --tests or --benches causes clippy to pick up the default features.
+            // I'm not sure why this is the case (JM 2025-05-10).
+            command.extend(vec![
+                "--package",
+                "ratatui-crossterm",
+                "--no-default-features",
+                "--features",
+                features.as_str(),
+            ]);
+            command.extend(clippy_options);
+            run_cargo(command)?;
+        }
+
+        // Run Clippy on all other workspace packages with --all-features
+        let mut command = clippy_command.clone();
+        command.extend(vec![
             "--all-features",
+            "--all-targets",
             "--tests",
             "--benches",
-            "--",
-            "-D",
-            "warnings",
-        ];
-        if self.fix {
-            args.push("--fix");
-        }
-        run_cargo(args)
+            "--workspace",
+            "--exclude",
+            "ratatui-crossterm",
+        ]);
+        command.extend(clippy_options);
+        run_cargo(command)?;
+
+        Ok(())
     }
 }

xtask/src/commands/coverage.rs

@@ -14,14 +14,29 @@ impl Run for Coverage {
     fn run(self) -> Result<()> {
         let mut args = vec![
             "llvm-cov",
-            "--lcov",
-            "--output-path",
-            "target/lcov.info",
+            "--workspace",
+            "--exclude",
+            "ratatui-crossterm",
             "--all-features",
+            "--no-report",
         ];
         if self.lib {
             args.push("--lib");
         }
-        run_cargo(args)
+        run_cargo(args)?;
+
+        let mut args = vec!["llvm-cov", "--package", "ratatui-crossterm", "--no-report"];
+        if self.lib {
+            args.push("--lib");
+        }
+        run_cargo(args)?;
+
+        run_cargo(vec![
+            "llvm-cov",
+            "report",
+            "--lcov",
+            "--output-path",
+            "target/lcov.info",
+        ])
     }
 }

xtask/src/commands/test_docs.rs

@@ -0,0 +1,29 @@
+use crate::{CROSSTERM_COMMON_FEATURES, CROSSTERM_VERSION_FEATURES, Result, run_cargo};
+
+/// Run doc tests for the workspace's default packages
+pub fn test_docs() -> Result<()> {
+    run_cargo(vec![
+        "hack",
+        "--workspace",
+        "--ignore-private", // exclude packages that are libraries
+        "--exclude",
+        "ratatui-crossterm",
+        "test",
+        "--doc",
+        "--all-features",
+    ])?;
+    let common_features = CROSSTERM_COMMON_FEATURES.join(",");
+    for crossterm_version in CROSSTERM_VERSION_FEATURES {
+        let features = format!("{common_features},{crossterm_version}");
+        run_cargo(vec![
+            "test",
+            "--package",
+            "ratatui-crossterm",
+            "--doc",
+            "--no-default-features",
+            "--features",
+            features.as_str(),
+        ])?;
+    }
+    Ok(())
+}

xtask/src/main.rs

@@ -16,6 +16,22 @@ use duct::cmd;
 
 mod commands;
 
+/// The available feature flags for ratatui-crossterm.
+///
+/// These will be enabled for both crossterm 0.28 and 0.29 runs. `underline-color` is part of
+/// default features for ratatui-crossterm, but with `--no-default-features`, we must add it
+/// explicitly if desired.
+const CROSSTERM_COMMON_FEATURES: &[&str] = &[
+    "serde",
+    "underline-color",
+    "scrolling-regions",
+    "unstable",
+    "unstable-backend-writer",
+];
+
+/// The available feature flags for crossterm versions.
+const CROSSTERM_VERSION_FEATURES: [&str; 2] = ["crossterm_0_28", "crossterm_0_29"];
+
 pub trait Run {
     fn run(self) -> Result<()>;
 }