2019-12-30 23:12:17 +00:00
This document explains why [tview ](https://github.com/rivo/tview ) was forked to
2020-02-20 17:48:15 +00:00
create [cview ](https://gitlab.com/tslocum/cview ). It also explains any
differences between the projects and tracks which tview pull requests have been
merged into cview.
2019-12-30 23:12:17 +00:00
# Why fork?
[rivo ](https://github.com/rivo ), the creator and sole maintainer of tview,
2020-02-16 18:12:55 +00:00
explains his reviewing and merging process in a [GitHub comment ](https://github.com/rivo/tview/pull/298#issuecomment-559373851 ).
2019-12-30 23:12:17 +00:00
He states that he does not have the necessary time or interest to review,
discuss and merge pull requests:
>this project is quite low in priority. It doesn't generate any income for me
>and, unfortunately, reviewing issues and PRs is also not much "fun".
>But some other people submitted large PRs which will cost me many hours to
>review. (I had to chuckle a bit when I saw [this comment ](https://github.com/rivo/tview/pull/363#issuecomment-555484734 ).)
>Lastly, I'm the one who ends up maintaining this code. I have to be 100%
>behind it, understand it 100%, and be able to make changes to it later if
> necessary.
cview aims to solve these issues by increasing the number of project
maintainers and allowing code changes which may be outside of tview's scope.
2020-02-20 17:48:15 +00:00
# Differences
2020-10-07 23:34:21 +00:00
## Primitive methods do not return the primitive they belong to
When chaining multiple method calls on a primitive together, application
developers might accidentally end the chain with a different return type than
the first method call. This could result in unexpected return types. For
example, ending a chain with `SetTitle` would result in a `Box` rather than the
original primitive.
2020-05-26 22:28:31 +00:00
## cview is [thread-safe](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#hdr-Concurrency)
2020-03-25 14:32:57 +00:00
tview [is not thread-safe ](https://godoc.org/github.com/rivo/tview#hdr-Concurrency ).
2020-05-26 22:28:31 +00:00
## [Application.QueueUpdate](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#Application.QueueUpdate) and [Application.QueueUpdateDraw](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#Application.QueueUpdateDraw) do not block
2020-02-20 17:48:15 +00:00
tview [blocks until the queued function returns ](https://github.com/rivo/tview/blob/fe3052019536251fd145835dbaa225b33b7d3088/application.go#L510 ).
2020-04-14 16:46:24 +00:00
## Double clicks are not handled by default
All clicks are handled as single clicks until an interval is set with [Application.SetDoubleClickInterval ](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#Application.SetDoubleClickInterval ).
2020-09-04 02:23:56 +00:00
## Tables are sorted when a fixed row is clicked by default
2020-10-06 20:55:51 +00:00
Call [Table.SetSortClicked ](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#Table.SetSortClicked )
to disable this behavior.
2020-09-04 02:23:56 +00:00
2020-02-22 18:14:57 +00:00
## Lists and Forms do not wrap around by default
2020-10-06 20:55:51 +00:00
Call [List.SetWrapAround ](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#List.SetWrapAround )
to wrap around when navigating.
2020-10-08 03:39:16 +00:00
## Tables do not wrap around when selecting a cell
Attempting to move outside of the range of the table results in the selection
remaining unchanged.
2020-10-07 23:34:21 +00:00
## Setting a primitive's background color to `tcell.ColorDefault` does not result in transparency
Call [Box.SetBackgroundTransparent ](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#Box.SetBackgroundTransparent )
to enable background transparency.
2020-10-06 20:55:51 +00:00
## TextViews store their text as []byte instead of string
This greatly improves buffer efficiency. [TextView.Write ](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#TextView.Write )
is 90% faster and [TextView.Draw ](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#TextView.Draw )
is 50% faster.
2020-02-22 18:14:57 +00:00
2020-10-15 16:36:14 +00:00
## `Pages` has been renamed as `Panels`
This is in preparation for supporting tabbed panels.
2020-10-08 04:27:30 +00:00
## `Application.ForceDraw` has been removed
2020-10-15 16:36:14 +00:00
Because cview is [thread-safe ](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#hdr-Concurrency ),
forcing an application draw is no longer possible, nor required.
2020-10-08 04:27:30 +00:00
2019-12-30 23:12:17 +00:00
# Merged pull requests
2020-01-01 16:00:22 +00:00
The following tview pull requests have been merged into cview:
- [#378 Throttle resize handling ](https://github.com/rivo/tview/pull/378 )
2020-01-05 17:41:15 +00:00
- [#368 Add support for displaying text next to a checkbox ](https://github.com/rivo/tview/pull/368 )
2020-01-01 16:00:22 +00:00
- [#353 Add window size change handler ](https://github.com/rivo/tview/pull/353 )
2020-01-02 03:43:18 +00:00
- [#347 Handle ANSI code 39 and 49 ](https://github.com/rivo/tview/pull/347 )
2020-01-05 17:14:15 +00:00
- [#336 Don't skip regions at end of line ](https://github.com/rivo/tview/pull/336 )
2020-01-02 03:43:18 +00:00
- [#296 Fixed TextView's reset [-] setting the wrong color ](https://github.com/rivo/tview/pull/296 )
