starred/opentui

Fork 0

mirror of https://github.com/anomalyco/opentui.git synced 2026-04-24 20:45:56 +03:00

[GH-ISSUE #444] Lack of documentation / onChange prop for custom Renderable #884

New issue

Open

opened 2026-03-14 08:55:51 +03:00 by kerem · 5 comments

kerem commented

2026-03-14 08:55:51 +03:00

Owner

Originally created by @Quackzoer on GitHub (Dec 27, 2025).
Original GitHub issue: https://github.com/anomalyco/opentui/issues/444

OpenTUI is amazing, I already like it more than React/INK even tho I still don't know how to use it. The biggest problem tho is poor documentation. Things are scattered around, difficult to find etc. I'm considering making a website because I really like the package and I would like to contribute somehow to it so nobody else spends over an hour trying to figure out how to add onChange prop to custom Renderable (still without any luck).

I believe fumadocs would be sufficient, allows for lots of customization, supports mdx, is still in development.

I'll gladly accept anyone who would be willing to help with it, to be fair I'm not best with design.

Off topic: I created cutom Checkbox Renderable, I based it on Select Renderable but for some reason Select accepts onChange prop and my Checkbox doesn't. I'm using React

Originally created by @Quackzoer on GitHub (Dec 27, 2025). Original GitHub issue: https://github.com/anomalyco/opentui/issues/444 OpenTUI is amazing, I already like it more than React/INK even tho I still don't know how to use it. The biggest problem tho is poor documentation. Things are scattered around, difficult to find etc. I'm considering making a website because I really like the package and I would like to contribute somehow to it so nobody else spends over an hour trying to figure out how to add onChange prop to custom Renderable (still without any luck). I believe [fumadocs](https://www.fumadocs.dev) would be sufficient, allows for lots of customization, supports mdx, is still in development. I'll gladly accept anyone who would be willing to help with it, to be fair I'm not best with design. Off topic: I created cutom Checkbox Renderable, I based it on Select Renderable but for some reason Select accepts onChange prop and my Checkbox doesn't. I'm using React

kerem added the

documentation

react

labels

2026-03-14 08:55:51 +03:00

kerem commented

2026-03-14 08:56:04 +03:00

Author

Owner

@remorses commented on GitHub (Dec 27, 2025):

I can try creating one with holocron.so based on the existing documentation in the codebase

Here is an example of how it would look like: https://docs.holocron.so/README

@remorses commented on GitHub (Dec 27, 2025): I can try creating one with holocron.so based on the existing documentation in the codebase Here is an example of how it would look like: https://docs.holocron.so/README

kerem commented

2026-03-14 08:56:09 +03:00

Author

Owner

@Quackzoer commented on GitHub (Dec 27, 2025):

I can try creating one with holocron.so based on the existing documentation in the codebase

Here is an example of how it would look like: https://docs.holocron.so/README

Why holocron and not Fumadocs? Fumadocs seems way more customizable, lacks on community tho but I watched video about it and for someone who works in React seems very nice and easy

@Quackzoer commented on GitHub (Dec 27, 2025): > I can try creating one with holocron.so based on the existing documentation in the codebase > > Here is an example of how it would look like: https://docs.holocron.so/README Why holocron and not Fumadocs? Fumadocs seems way more customizable, lacks on community tho but I watched video about it and for someone who works in React seems very nice and easy

kerem commented

2026-03-14 08:56:14 +03:00

Author

Owner

@kommander commented on GitHub (Dec 27, 2025):

@msmps would know best how to extend react with a custom Renderable like that.

@kommander commented on GitHub (Dec 27, 2025): @msmps would know best how to extend react with a custom Renderable like that.

kerem commented

2026-03-14 08:56:19 +03:00

Author

Owner

@Quackzoer commented on GitHub (Jan 2, 2026):

I found out that onChange prop used to be added by OpenTUI in host-config.ts via hard coded values. Can't find where it is now. I simply created React wrapper around my component that adds onChange, can't think of better solution

@Quackzoer commented on GitHub (Jan 2, 2026): I found out that onChange prop used to be added by OpenTUI in host-config.ts via hard coded values. Can't find where it is now. I simply created React wrapper around my component that adds onChange, can't think of better solution

kerem commented

2026-03-14 08:56:25 +03:00

Author

Owner

@kommander commented on GitHub (Jan 26, 2026):

There now is a proper documentation setup which also is deployed with the website. It's WIP. Feel free to add to the documentation if something is missing.

@kommander commented on GitHub (Jan 26, 2026): There now is a proper documentation setup which also is deployed with the website. It's WIP. Feel free to add to the documentation if something is missing.