Josh McKinney
3b002fdcab
docs: update incompatible code warning in examples readme ( #1013 )
...
Co-authored-by: EdJoPaTo <rfc-conform-git-commit-email@funny-long-domain-label-everyone-hates-as-it-is-too-long.edjopato.de>
2024-04-01 13:34:03 -07:00
Josh McKinney
6e76729ce8
chore: move example vhs tapes to a folder ( #867 )
2024-01-24 08:22:46 -08:00
Emirhan TALA
330a899eac
docs(examples): update table example and table.tape ( #840 )
...
In table.rs
- added scrollbar to the table
- colors changed to use style::palette::tailwind
- now colors can be changed with keys (l or →) for the next color, (h or
←) for the previous color
- added a footer for key info
For table.tape
- typing speed changed to 0.75s from 0.5s
- screen size changed to fit
- pushed keys changed to show the current example better
Fixes: https://github.com/ratatui-org/ratatui/issues/800
2024-01-19 03:26:09 -08:00
Josh McKinney
41de8846fd
docs(examples): document incompatible examples better ( #844 )
...
Examples often take advantage of unreleased API changes, which makes
them not copy-paste friendly.
2024-01-18 01:56:06 -08:00
Dheepak Krishnamurthy
2b4aa46a6a
docs: GitHub admonition syntax for examples README.md ( #791 )
...
* docs: GitHub admonition syntax for examples README.md
* docs: Add link to stable release
2024-01-11 21:08:54 -05:00
Josh McKinney
34648941d4
docs(examples): add warning about examples matching the main branch ( #778 )
2024-01-11 08:44:23 +01:00
Akiomi Kamakura
49df5d4626
docs(example): fix markdown syntax for note ( #730 )
2024-01-02 17:20:50 -08:00
Josh McKinney
1b8b6261e2
docs(examples): add animation and FPS counter to colors_rgb ( #583 )
2023-12-17 01:34:59 -08:00
Josh McKinney
2169a0da01
docs(examples): Add example of half block rendering ( #687 )
...
This is a fun example of how to render big text using half blocks
2023-12-13 18:25:21 -08:00
isinstance
9f37100096
Update README.md and fix the bug that demo2 cannot run ( #595 )
...
Fixes https://github.com/ratatui-org/ratatui/issues/594
2023-10-25 14:01:04 -07:00
Josh McKinney
ad2dc5646d
docs(examples): update examples readme ( #576 )
...
remove VHS bug info, tweak colors_rgb image, update some of the instructions. add demo2
2023-10-20 21:41:36 +02:00
Dheepak Krishnamurthy
089f8ba66a
docs: Add double quotes to instructions for features ( #560 )
2023-10-05 04:06:28 -04:00
Josh McKinney
be55a5fbcd
feat(examples): add demo2 example ( #500 )
2023-09-21 01:47:23 -07:00
Josh McKinney
6b8725f091
docs(examples): add colors_rgb example ( #476 )
2023-09-09 17:30:41 -07:00
Josh McKinney
5c785b2270
docs(examples): move example gifs to github ( #460 )
...
- A new orphan branch named "images" is created to store the example
images
2023-09-02 14:15:07 -07:00
Josh McKinney
ca9bcd3156
docs(examples): add descriptions and update theme ( #460 )
...
- Use the OceanicMaterial consistently in examples
2023-09-02 14:15:03 -07:00
Josh McKinney
8c55158822
chore: use vhs to create demo.gif ( #390 )
...
The bug that prevented braille rendering is fixed, so switch to VHS for
rendering the demo gif
2023-08-13 16:21:00 +00:00
Josh McKinney
10dbd6f207
docs(examples): show layout constraints ( #393 )
...
Shows the way that layout constraints interact visually
2023-08-13 07:38:43 +00:00
Josh McKinney
6ad4bd4cf2
docs(examples): Add color and modifiers examples ( #345 )
...
The intent of these examples is to show the available colors and
modifiers.
- added impl Display for Color
2023-08-11 01:36:12 +00:00
Josh McKinney
e82521ea79
docs(examples): regen block.gif in readme ( #365 )
2023-08-04 10:12:13 +00:00
Josh McKinney
554805d6cb
docs(examples): Update block example ( #351 )
...
2023-08-04 07:46:37 +00:00
Josh McKinney
add578a7d6
docs(examples): Add examples readme with gifs ( #303 )
...
This commit adds a readme to the examples directory with gifs of each
example. This should make it easier to see what each example does
without having to run it.
I modified the examples to fit better in the gifs. Mostly this was just
removing the margins, but for the block example I cleaned up the code a
bit to make it more readable and changed it so the background bug is not
triggered.
For the table example, the combination of Min, Length, and Percent
constraints was causing the table to panic when the terminal was too
small. I changed the example to use the Max constraint instead of the
Length constraint.
The layout example now shows information about how the layout is
constrained on each block (which is now a paragraph with a block).
2023-07-24 19:05:37 +00:00
