Commit graph

116 commits

Author SHA1 Message Date
Sepehr Shirkhanlu
9c4858a7b3
Fix typo (#2869) 2023-07-02 17:22:56 +01:00
Will McGugan
5ad64a315c
satisfy pyright (#2793) 2023-06-19 09:53:41 +01:00
TomJGooding
ead005d8bc
docs: import message from message not messages (#2747) 2023-06-06 16:13:07 +01:00
Will McGugan
149c39c86c
Tooltips (#2670)
* inflect

* diagram

* tooltip render

* tooltip property

* add guard

* tooltip docs

* docs

* tidy, fix horizontal

* words, removed comment

* fix screenshot render

* simplify

* simfplify

* changelog

* simplify optimize

* inflect tests

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* docstring

* disable auto focus

* should be fraction

* optimization

* snapshot update

* Update tests/snapshot_tests/snapshot_apps/scroll_to_center.py

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

---------

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-05-30 16:14:31 +01:00
Will McGugan
faa67a8293
Screen docs (#2579)
* screen docs

* docstrings

* modal example

* docstring

* docstrings

* Apply suggestions from code review

Co-authored-by: Dave Pearson <davep@davep.org>

---------

Co-authored-by: Dave Pearson <davep@davep.org>
2023-05-16 13:44:06 +01:00
Rodrigo Girão Serrão
e5033d7d23
Remove hanging lines from docstrings. (#2349)
* Remove hanging lines from docstrings.

Deleted hanging blank lines at the end of docstrings.

Regex pattern:
 - find `\n\n( *)"""`
 - replace with `\n$1"""`
2023-04-24 11:21:38 +01:00
Will McGugan
af93a82fb1 fix byte example 2023-04-10 17:25:13 +01:00
Will McGugan
b5689b1f69
Worker API (#2182)
* worker class

* worker API tests

* tidy

* Decorator and more tests

* type fix

* error order

* more tests

* remove active message

* move worker manager to app

* cancel nodes

* typing fix

* revert change

* typing fixes and cleanup

* revert typing

* test fix

* cancel group

* Added test for worker

* comment

* workers docs

* Added exit_on_error

* changelog

* svg

* refactor test

* remove debug tweaks

* docstrings

* worker test

* fix typing in run

* fix 3.7 tests

* blog post

* fix deadlock test

* words

* words

* words

* workers docs

* blog post

* Apply suggestions from code review

Co-authored-by: Dave Pearson <davep@davep.org>

* docstring

* fix and docstring

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Update src/textual/widgets/_markdown.py

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Update src/textual/worker.py

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Fix black

* docstring

* merge

* changelog

---------

Co-authored-by: Dave Pearson <davep@davep.org>
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-04-04 13:12:51 +01:00
Will McGugan
0940546aab
compositor refactor and transparent screens (#2139)
* compositor refactor and trasparent screens

* multuple layers

* catch screen stack error

* refinement

* error messages

* capture screen stack

* new border type

* Background screen

* borders and bindings

* snapshot

* screen docs

* fix for missing screens

* screens docs

* fix for non updating transparent screens

* fix background resize

* changelog

* copy

* superfluous function

* update diagram

* inline code

* Update CHANGELOG.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Update docs/guide/screens.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* superfluous file

* Explicit None

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* docstring

* update docstring

* docstring make property private

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* docstring

* update docstring

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* docstrings

* remove comment, add docstring

* Apply suggestions from code review

Co-authored-by: Dave Pearson <davep@davep.org>

---------

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
Co-authored-by: Dave Pearson <davep@davep.org>
2023-03-27 16:44:58 +01:00
Rodrigo Girão Serrão
2a810f8c87
Implement border (sub)title. (#2064)
* Add Widget.border_title and border_subtitle.

Related issues: #1864

* Test setting border_(sub)title.

* Add border (sub)title references to StylesCache.

These internal references will make it easier for the instance of 'StylesCache' to know which border (sub)title to use, if/when needed.

* Add method to render border label.

* Add styles to align border (sub)title.

* Render border labels.

* Update styles template.

* Make new 'render_row' parameters optional.

* Add (sub)title border snapshot tests.

* Document border (sub)title and styles.

* Pass (sub)title directly as arguments.

Get rid of the watchers to make data flow easier to follow.
Related comment: https://github.com/Textualize/textual/pull/2064/files\#r1137746697

* Tweak example.

* Fix render_border_label.

This was wrong because border labels can be composed of multiple segments if they contain multiple styles. Additionally, we want to render a single blank space of padding around the title.

* Ensure we get no label when there's no space.

* Add tests for border label rendering.

* 'render_border_label' now returns iterable of segments.

* Add label to render_row.

* Fix calling signature in tests.

* Add padding to snapshot tests.

* Fix changelog.

* Update snapshot tests.

* Update snapshot tests.

* Border labels expand if there's no corners.

* Update CHANGELOG.md

* Fix docs.

* Remove irrelevant line.

* Fix snapshot tests.

* Don't share Console among tests.

* Simplify example in styles guide.

* Avoid expensive function call when possible.

* rewording

* positive branch first

* remove wasteful indirection

* fix changelog

---------

Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2023-03-22 11:07:38 +00:00
Will McGugan
2a6368754a fix screenshot 2023-03-18 17:02:46 +00:00
Rodrigo Girão Serrão
f9a1e27c6f Merge branch 'main' into add-containers
[skip ci]
2023-03-13 16:21:46 +00:00
Will McGugan
b0f5c35782
tabs widget (#2020)
* tabs widget

* click underline

* color tweak

* docs

* docs update

* expose Tab

* added remove_tab and clear

* fix cycling

* add animation

* docs

* changelog

* remove recompose

* docstrings

* Update docs/guide/actions.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Rodrigoed the tabs

* Update docs/widgets/tabs.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Update docs/widgets/tabs.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* copy

* docstrings

* docstring

* docstring

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* stop click

* docstring

* auto assign consistent IDs

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Document bindings

* document bindings

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

---------

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-03-13 14:39:15 +00:00
Rodrigo Girão Serrão
0e51520a2c Make docs comply with new containers. 2023-03-13 11:44:47 +00:00
Rodrigo Girão Serrão
be41797a8d Merge branch 'main' into add-containers 2023-03-09 15:19:43 +00:00
Rodrigo Girão Serrão
8565d3cef6 Renamed 'Vertical' to 'VerticalScroll'.
Related issues: #1957.
2023-03-08 18:31:24 +00:00
TomJGooding
e95a65fa56
docs(compound example): fix typo (#1984) 2023-03-08 17:42:25 +00:00
Will McGugan
864931e94b
Compound docs (#1952)
* compound example

* update bit switch

* prevent

* no css

* compound widget example

* more diagrams

* more diagrams

* diagrams

* words

* words

* remove sender

* removed priority post

* timer fix

* test fixes

* drop async version of post_message

* extended docs

* fix no app

* Added control properties

* changelog

* changelog

* changelog

* fix for stopping timers

* changelog

* docs update

* last byte example

* new section

* update of byte03

* updae to docs

* Added compound examples

* Rewording

* Use set sender

* don't need this

* hyphens

* Update docs/guide/widgets.md

Co-authored-by: Dave Pearson <davep@davep.org>

* Update docs/guide/widgets.md

Co-authored-by: Dave Pearson <davep@davep.org>

* Update docs/guide/widgets.md

Co-authored-by: Dave Pearson <davep@davep.org>

* Update docs/guide/widgets.md

Co-authored-by: Dave Pearson <davep@davep.org>

* Update docs/guide/widgets.md

Co-authored-by: Dave Pearson <davep@davep.org>

* Update docs/guide/widgets.md

Co-authored-by: Dave Pearson <davep@davep.org>

* Update docs/guide/widgets.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Update docs/guide/widgets.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Update docs/guide/widgets.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Update docs/guide/widgets.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* parenthesis

* stack diagram

---------

Co-authored-by: Dave Pearson <davep@davep.org>
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-03-06 16:56:24 +00:00
Will McGugan
9c1f6f7fad Added docs for the new compose method 2023-02-26 10:34:30 +00:00
Will McGugan
a37e7fcb2b fix modal example 2023-02-11 15:37:24 +00:00
Will McGugan
f8577f79d7 review fixes 2023-02-06 11:34:37 +00:00
Will McGugan
fb7c1642bc Checker example 4, docs and diagram 2023-02-04 15:40:36 +01:00
Will McGugan
25b498896d checker 4 and diagram 2023-02-04 11:28:07 +01:00
Will McGugan
a5808db8b8 more docs and diagrams 2023-02-03 19:10:03 +01:00
Will McGugan
2ff278874b docs examples and diagrams 2023-02-03 11:23:14 +01:00
Will McGugan
806c80b8fe simplify 2023-02-01 17:14:53 +01:00
Will McGugan
0a5838d964 checker example 2023-02-01 16:26:55 +01:00
Darren Burns
ad6a716d09 Fix mouse01 example background transparency 2023-01-07 09:35:00 +00:00
Rodrigo Girão Serrão
6451d192a6 Reorder CSS rule by relevance. 2022-12-20 11:16:31 +00:00
Will McGugan
7ba70ada96 fix examples 2022-12-08 17:24:34 +00:00
Will McGugan
dd8a9562d0 fix for container height change 2022-12-07 16:02:51 +00:00
Kim, Jang-hwan
d58a072dfc
FIX css link
This is the part where the [guide](https://textual.textualize.io/guide/widgets/#default-css) explains the `DEFAULT_CSS` feature, leaving a small amount of css in `hello04.css`. However, the App class still links to the css file from the previous version (`hello03.css`). This PR fixes that and updates to the recent one.
2022-11-22 07:59:02 +09:00
Will McGugan
39a764f49f call later 2022-11-09 17:23:28 +00:00
Dave Pearson
f8bda04d90
Remove the on_space from key01 in the docs
While in this part of the docs we do want to keep the bell (see key02), it
was an error in the code that it included this event in key01. Removing it
from here because adding this bit of code for key02 is a key (no pun) part
of the docs.
2022-10-19 15:05:18 +01:00
Dave Pearson
ce0c6c49a2
Remove the bell from the actions05 documentation example 2022-10-19 14:59:59 +01:00
Dave Pearson
f76e472096
Remove the bell from the actions04 documentation example 2022-10-19 14:57:50 +01:00
Dave Pearson
aa8580bee7
Remove the bell from the actions03 documentation example 2022-10-19 14:54:57 +01:00
Dave Pearson
5c5ca3316f
Remove the bell from the actions02 documentation example 2022-10-19 14:43:37 +01:00
Dave Pearson
f5ce603d43
Remove the bell from the actions01 documentation example 2022-10-19 14:41:13 +01:00
Dave Pearson
78ea2cd9f8
Modify the screen examples to import Screen from textual.screen
The surrounding text in the documentation states that Screen is imported
from textual.screen, but the code was importing the class from textual.app.
Further, I was getting warnings from pyright that I was using a class that
wasn't exported from the module I was importing from.
2022-10-13 09:10:40 +01:00
Will McGugan
58ed906ed5 simplified animator docs 2022-10-06 15:59:42 +01:00
Darren Burns
99aa17214e
Merge branch 'css' of github.com:Textualize/textual into docs-animator 2022-10-06 14:11:19 +01:00
Darren Burns
533ec72029
Finish up Animator docs first pass 2022-10-06 14:11:08 +01:00
Darren Burns
21ee43325d Animator docs, wait syntax in app.run keys 2022-10-05 17:24:03 +01:00
Will McGugan
f6e3cc6517 screens api 2022-10-04 17:48:25 +01:00
Will McGugan
9de1a87024 more docs and compute example 2022-10-03 16:55:40 +01:00
Will McGugan
5f97bbd33f actions docs 2022-09-29 16:33:19 +01:00
Will McGugan
d962dcd49c new align 2022-09-27 16:35:40 +01:00
Will McGugan
28d395f774 code in events 2022-09-26 10:41:36 +01:00
Will McGugan
3f0955cbe5 fix tests 2022-09-26 09:51:33 +01:00
Will McGugan
53d8e02d0d input docs an exampels 2022-09-24 17:04:00 +01:00
Will McGugan
bb0e754329 fizzbuzz examples 2022-09-23 13:25:04 +01:00
Will McGugan
4437c7b640 hello examples 2022-09-22 18:16:02 +01:00
Will McGugan
9ab01d3c54 widgets docs 2022-09-21 17:18:50 +01:00
Will McGugan
d0293c2c89 changed to CSS_PATH 2022-09-18 22:02:08 +01:00
darrenburns
5ef98aac90
Initial layout guide stuff (#748)
* Initial layout guide stuff

* More docs on layout - grid

* Continuing grid docs

* Grid gutter and spans guide

* Improvements to layout docs for horizontal, vertical, dock, and begin describing layers

* Update center layout example to reflect new yield order

* More updates to layout guide, mostly offset stuff

* More layout guide, "Putting it all together"

* Updates to layout guide page

* Small rewording of dock layout in guide

* Apostrophe

* Typo

* Small design tweak to combining layouts example

* Typos, tidying up

* Small reword

* Some updates to docs/guide/layout/grid

* calc fix

Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2022-09-15 15:28:23 +01:00
Will McGugan
8a31523e09 doc fixes 2022-09-14 17:54:27 +01:00
Will McGugan
9816c2643f more docs and diagrams 2022-09-14 17:09:38 +01:00
Will McGugan
e85f9dc045 dimensions 2022-09-14 13:19:45 +01:00
Will McGugan
4a459dbd20 Added compose event, more color docs 2022-09-12 12:47:14 +01:00
Will McGugan
269960ad8a fix styles examples, box model docs 2022-09-10 16:45:13 +01:00
Will McGugan
e555b8512f Default css 2022-09-02 09:56:04 +01:00
Will McGugan
c1ba3a56b4 comment 2022-08-14 15:46:00 +01:00
Will McGugan
538e5d4701 lots more docs 2022-08-14 15:43:00 +01:00
Will McGugan
a1c0b173bd more docs and diagrams 2022-08-13 21:39:31 +01:00
Will McGugan
f7ff893de8 more docs 2022-08-10 17:49:45 +01:00