Commit graph

516 commits

Author SHA1 Message Date
Dave Pearson
8c105fb373
Fix a broken link to the Worker class (#2816) 2023-06-21 10:44:59 +01:00
Dave Pearson
755da5e969
Merge pull request #2722 from davep/docs-auto-focus-borkage-fix
Fix various screenshots in the docs, broken by the addition of `AUTO_FOCUS`
2023-06-06 11:55:05 +01:00
claws
bfef40a806
Fix typo (#2729) 2023-06-04 12:56:20 +01:00
Dave Pearson
269f2446be
Remove tab presses from compound widgets examples post-AUTO_FOCUS
See #2720.
2023-06-02 07:14:22 +01:00
Dave Pearson
2f1422049f
Remove tab presses from input focus guide post-AUTO_FOCUS
See #2720. I'm not 100% sure about this one; I don't think it's been
modified since the AUTO_FOCUS change was made, so I believe this will be
restoring the example to its intended state.
2023-06-02 07:11:04 +01:00
Dave Pearson
955fb7363a
Remove tab presses from reactivity guide post-AUTO_FOCUS
See #2720. While there wasn't a problem here, there's no point in having
those there any more as the fields will have focus to start with.
2023-06-02 07:00:50 +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
1ea892b062
handler name in classvar (#2675)
* handler name in classvar

* fix for worker handler name

* fix custom templates, event docs

* doc tweak

* doc tweak

* restore signature
2023-05-28 14:56:18 +01:00
Dave Pearson
718760dcb1
Fix some assorted documentation cross-references
Couple or so things I noticed while working on docs.
2023-05-24 15:53:56 +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
855c90d4f0
Extend @on decorator to filter matchable attributes (#2498)
* Add tests for #2484.

* Implement @on extension.

[skip ci]
Related issues: #2484.

* Changelog.

* Add missing @on test.

* Remove debug prints.

* Document changes.

* Update tests.

Test now fully works, as of #2490.

* Cache parsed selectors.

* Streamline exit condition.

* Fix typing.

* More succint wording.

* Document 'on' kwargs.

* Update src/textual/_on.py

Co-authored-by: Will McGugan <willmcgugan@gmail.com>

* Update docs/guide/events.md

Co-authored-by: Will McGugan <willmcgugan@gmail.com>

* Change 'on' API.

* Remove example code.

* Address feedback.

* Update src/textual/_on.py

Co-authored-by: Will McGugan <willmcgugan@gmail.com>

* Address review feedback.

* Fix #2499.

* don't require control to be manually specified

* update docstring

* deleted words

---------

Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2023-05-08 17:30:07 +01:00
Will McGugan
e5c54a3683
blog post (#2465)
* blog posts

* fix typo

* word

* version bump

* changelog

* update words
2023-05-03 13:22:22 +01:00
Will McGugan
91a9d570a4
On decorator (#2453)
* Add on decorator

* decorator code

* docs for on decorator

* Examples

* test errors

* simplify listing

* words

* changelog

* Update docs/guide/events.md

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

* Update docs/guide/events.md

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

* Update docs/examples/events/on_decorator.css

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

* Update docs/guide/events.md

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

* rewording

* comment

* clarification

* Added note

---------

Co-authored-by: Dave Pearson <davep@davep.org>
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-05-02 16:17:40 +01:00
Will McGugan
e1a8f28f8d
update to log docs (#2451) 2023-05-02 10:09:32 +01:00
Will McGugan
7c696ce378
Updated docs for app.run (#2414)
* fix run app from python

* updated run

* remove function

* update help

* doc update
2023-04-28 10:47:24 +01:00
Dave Pearson
b14b3b9e39
Expand the builtin action list in the docs 2023-04-24 15:12:51 +01:00
Rodrigo Girão Serrão
bb2c31ba35
Add --port option to textual console. (#2258)
* Add --port option to textual console.

* Changelog.

* Address review feedback.

* Mark unpredictable test as xfail.

This test gets an xfail mark until #2254 is open.

* Make DEVTOOLS_PORT a constant.

Related review: https://github.com/Textualize/textual/pull/2258\#discussion_r1165210395

* Factor logic into function.

Related review: https://github.com/Textualize/textual/pull/2258\#discussion_r1165298259

* Remove dead import.
2023-04-13 11:57:35 +01:00
Will McGugan
79ebbff933 typo 2023-04-07 12:58:58 +01:00
Will McGugan
074bfd7e2f Headings 2023-04-07 11:56:00 +01:00
Will McGugan
94279ae1f9 docs fix 2023-04-07 11:35:59 +01:00
Will McGugan
e4b45ba63f
docs on await mount (#2235) 2023-04-07 09:46:27 +01:00
Alex
f3f065d147
docs: Fix some typo (#2216) 2023-04-05 10:11:27 +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
a75b7cd088 verbosity doc paragraph 2023-03-29 10:22:38 +01:00
Dave Tapley
1dc24222ff
Document log groups and console -x (#2161) (#2162)
https://github.com/Textualize/textual/discussions/2161

Groups as of:
ab0de0139c/src/textual/_log.py (L4-L15)
2023-03-29 10:20:21 +01:00
Will McGugan
73f065bbbd
Logging handler (#2151)
* logging handler

* changelog

* remove logging experiment

* handler

* fix

* docs for logging handler
2023-03-28 11:50:28 +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
04340bd0ba
new post (#2069)
* new post

* Update docs/blog/posts/await-me-maybe.md

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

* Update docs/blog/posts/await-me-maybe.md

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

* Update docs/blog/posts/await-me-maybe.md

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

* Update docs/blog/posts/await-me-maybe.md

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

* words

---------

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
Co-authored-by: Dave Pearson <davep@davep.org>
2023-03-15 16:49:12 +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
cc8f65259e Merge branch 'main' into add-containers 2023-03-13 12:00:08 +00:00
Rodrigo Girão Serrão
0e51520a2c Make docs comply with new containers. 2023-03-13 11:44:47 +00:00
Dave Pearson
e6f620db44
Remove underscore pauses from (hopefully) all snapshots
This seeks to remove the "_" from the key presses of snapshots and inline
runs in the documentation. The "_" no longer does anything, but got legacy
reasons at the moment we can't actually allow "_" to be an input to a
"faked" keypress in the docs and snapshots.

Removing these clears the way to letting "_" have the same status as any
other character.

See #1994.
2023-03-09 20:32:27 +00:00
Rodrigo Girão Serrão
8565d3cef6 Renamed 'Vertical' to 'VerticalScroll'.
Related issues: #1957.
2023-03-08 18:31:24 +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
373fc95fc1
Drop explicit sender attribute from messages (#1940)
* 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

* added aliases to radio and checkbox

* Drop sender from Message init

* drop time

* drop cast

* Added aliases
2023-03-06 10:52:34 +00:00
Dave Pearson
f9e7c80256
Highlight that the label acquires an id in the example code
While the code here isn't exactly written as a play-along tutorial, it's
reasonable to expect that some one can and will. This commit has been
written because exactly that situation happened.

The problem here is without the ID on the label the layout will end up
looking very different from that shown in the docs; which will halt the
reader's flow as they try and figure out what they did wrong.

Counterpoint: this is a guide, not a tutorial, so it seemed reasonable to
only highlight the important thing that's changing. Personally I think I'd
argue in favour of highlighting all the changes from question01 to
question02.

Addresses #1905.
2023-03-01 09:05:07 +00:00
Will McGugan
5b1cba1d85 update to copy 2023-02-26 12:31:50 +00:00
Will McGugan
bc620fd46f remove highlighted line 2023-02-26 12:24:39 +00:00
Will McGugan
da1a820565 highlight lines 2023-02-26 12:08:18 +00:00
Will McGugan
b23fbd9be8 words 2023-02-26 10:36:17 +00:00
Will McGugan
9c1f6f7fad Added docs for the new compose method 2023-02-26 10:34:30 +00:00
Will McGugan
0999114811
Update docs/guide/events.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-02-24 12:02:20 +00:00
Will McGugan
b2ab5b6886 docs 2023-02-23 21:36:33 +00:00
Will McGugan
2ee61f95db Docs 2023-02-23 14:37:47 +00:00
Dave Pearson
257fe7b30a
Add enabled and disabled pseudo-classes
Note that this doesn't touch the application of stylesheets yet, in terms of
things like specificity; this just makes sure that the classes exist and can
be seen.
2023-02-13 12:56:52 +00:00
Dave Pearson
ddb2579168
Merge branch 'main' into package-docs 2023-02-08 11:40:15 +00:00
Will McGugan
1b050ea8b7
Merge pull request #1738 from Textualize/emit-start-with-self
Change emit to post to self.
2023-02-08 11:37:43 +00:00
Rodrigo Girão Serrão
e5e7c08afe Update docs accordingly. 2023-02-08 10:53:51 +00:00
Dave Pearson
86e1997b30
Merge branch 'main' into package-docs 2023-02-08 10:40:20 +00:00
Will McGugan
29875a66fc into [skip ci] 2023-02-08 10:31:35 +00:00
Will McGugan
aabc1cc898 fix typo [skip ci] 2023-02-08 10:20:47 +00:00
Will McGugan
0a4d1c919d updated widgets docs 2023-02-07 18:10:01 +00:00
Dave Pearson
aece00e1dc
Remove the keystrokes from the dictionary example in events guide
As well as not being necessary for the example, it also had the problem of
not actually having the input in focus (there was no press of 'tab' to kick
things off) and so the other keys didn't go into the `Input` as they were
supposed to.
2023-02-06 16:06:50 +00:00
Will McGugan
fb7fd14262
Merge pull request #1710 from Textualize/line-api-docs
Documented the Line API
2023-02-06 11:42:57 +00:00
Will McGugan
f8577f79d7 review fixes 2023-02-06 11:34:37 +00:00
Will McGugan
b12c5e1cdf typo 2023-02-05 12:12:27 +01:00
Will McGugan
738837fd66 review update 2023-02-05 12:06:48 +01:00
Will McGugan
e81ac17c6c revised copy 2023-02-04 17:35:09 +01: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
8ce76f4f89 fix title update 2023-02-01 18:01:34 +01:00
Will McGugan
087654a246
Update docs/guide/app.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-02-01 17:49:33 +01:00
Will McGugan
340f7c53bc
Update docs/guide/app.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-02-01 17:49:05 +01:00
Will McGugan
259c1cc14e tip to info 2023-02-01 17:43:29 +01:00
Will McGugan
c04e387dfe title copy 2023-02-01 17:38:19 +01:00
Rodrigo Girão Serrão
2140aa52d2
Update docs/guide/app.md 2023-02-01 14:53:20 +00:00
Rodrigo Girão Serrão
476eca7a6e Shuffle sections around. 2023-02-01 11:30:56 +00:00
Rodrigo Girão Serrão
521e90488c Add context about (sub)title. 2023-02-01 11:08:13 +00:00
Rodrigo Girão Serrão
c14f635244 Document setting app (sub)title. 2023-01-31 17:31:06 +00:00
Dave Pearson
05b3ab6c78
Refine the explanation of percentage
Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2023-01-18 10:05:40 +00:00
Dave Pearson
330950e6b0
Seek to improve the explanation of what a percentage does
I've seen a couple or so folk get confused about what a percentage value for
a dimension means, often seeming to think it means that percentage of
the *remaining* space within a container as opposed to a percentage of the
space in the container (note total space, not remaining space).

I'm not sure the wording here is the final form we want (there's more
mention of "dimension" here than your average Star Trek or Doctor Who
episode!), but I think it's narrowing in on it.

Making this change to place-hold the need to improve this and perhaps gather
some input to find the best final wording.
2023-01-17 16:33:30 +00:00
Rodrigo Girão Serrão
196d430582 Style all Textual CSS as 'sass'
Textual CSS is better highlighted in SASS code blocks because the SASS parser seems to be more lenient.
2023-01-09 11:20:04 +00:00
Rodrigo Girão Serrão
710697121d Merge branch 'main' into review-styles-reference
[skip ci]
2023-01-06 10:05:16 +00:00
David Brochart
fe9a498f03 Fix typo 2022-12-27 16:23:12 +01:00
Will McGugan
93742d9d69 rewording 2022-12-22 11:51:59 +00:00
Will McGugan
14953cd1db
Update docs/guide/input.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-12-21 15:28:52 +00:00
Will McGugan
b2516c5ce3
Update docs/guide/input.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-12-21 15:27:58 +00:00
Will McGugan
611dffcbba
Update docs/guide/input.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-12-21 15:23:19 +00:00
Will McGugan
17a0d52945
Update docs/guide/input.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-12-21 15:23:05 +00:00
Will McGugan
b793b06b56
Update docs/guide/input.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-12-21 15:22:47 +00:00
Will McGugan
77eadc9fa1 words 2022-12-21 15:17:27 +00:00
Will McGugan
b04a116620
Update docs/guide/input.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-12-21 15:04:40 +00:00
Will McGugan
8b7f3c0968
Update docs/guide/input.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-12-21 15:04:29 +00:00
Will McGugan
0325c50e7a
Update docs/guide/input.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-12-21 15:04:19 +00:00
Will McGugan
95b2285172
Update docs/guide/input.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-12-21 15:04:03 +00:00
Will McGugan
7a46672d64 docs and expanded keys 2022-12-21 11:38:20 +00:00
Will McGugan
5e2e0fe566 keys refactor 2022-12-20 21:18:10 +00:00
Rodrigo Girão Serrão
6451d192a6 Reorder CSS rule by relevance. 2022-12-20 11:16:31 +00:00
Will McGugan
002cbab0d5 add pause to action 2022-12-19 11:26:42 +00:00
Dave Pearson
4ee1aba436
Add a note about priority and defaults to the binding documentation 2022-12-15 15:02:55 +00:00
Sundeep Agarwal
dffdb63e9d fixed typos 2022-11-28 10:17:26 +05:30
Will McGugan
95ec5452d1
Merge pull request #1272 from vitrioil/fix_doc
Fix correct method name reference in doc
2022-11-25 13:45:14 +08:00
vitrioil
610fff1a33 Fix correct method name reference in doc 2022-11-24 19:59:14 +05:30
Rodrigo Girão Serrão
bc1298b85b Pause so that screenshots are not empty. 2022-11-23 17:09:53 +00:00
Rodrigo Girão Serrão
e0b5722828 Pause so that programmatic style change is visible. 2022-11-23 15:27:40 +00:00
Dave Pearson
5f4a44c6c6
Fix the devtools example of how to run an app 2022-11-17 10:39:43 +00:00
Will McGugan
30b5f1d7f7
Merge pull request #1128 from Textualize/docs-blog
Added blog
2022-11-07 11:42:05 +00:00
Will McGugan
b29e2fc136
Update docs/guide/design.md
Co-authored-by: Dave Pearson <davep@davep.org>
2022-11-07 11:36:14 +00:00
Will McGugan
493d67cb69
Update docs/guide/design.md
Co-authored-by: Dave Pearson <davep@davep.org>
2022-11-07 11:34:50 +00:00
Will McGugan
5a610bda19 added social cards 2022-11-06 17:53:23 +00:00
Will McGugan
ef26795da7 words 2022-11-06 16:54:44 +00:00
Will McGugan
8676fb7017 update copy 2022-11-05 15:10:07 +00:00
Will McGugan
cb03076a97 added color docs 2022-11-05 14:52:01 +00:00
Sayandip Dutta
e2935af8d6
chore(docs): Fixed typo
follow by -> followed by
2022-11-02 21:56:38 +05:30
darrenburns
bbd811d671
Support multiple CSS files (#1079)
* Support multiple CSS paths

* Update a type to match docstring

* Ensure the demo app still works

* Use absolute paths in tests to (hopefully) appease Windows

* Notes about CSS changes in guide/docstrings, small grammar/typos fixes

* Move snapshot apps into snapshot_tests dir, improve messaging in snapshot output, add test for multiple css files interacting with classvar CSS

* Ensure consistent snapshot naming cross-platform

* Use rpartition instead of partition in import_app

* Fix handling of import_app when colon in arg

* Support paths containing Windows drive names in import_app

* Add note on new relative paths in snap_compare

* Update docs/guide/CSS.md

Co-authored-by: Will McGugan <willmcgugan@gmail.com>

* Fix formatting

* Update CHANGELOG to mention CSS_PATH supporting a list

Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2022-11-01 17:13:25 +00:00
Dave Pearson
dcf1784676
Merge pull request #1017 from UriyaHarpeness/feature/fix-some-inaccuracies-in-the-tutorial
Fix some inaccuracies in the tutorial.
2022-10-31 13:11:02 +00:00
Darren Burns
47c5a22b31
Docs change, as per code review request 2022-10-31 12:43:30 +00:00
UriyaHarpeness
ad47b9167e Fix some typos in docs. 2022-10-26 08:39:36 +03:00
Darren Burns
b6e19d5c30
Add note to docs about always_update 2022-10-25 14:39:39 +01:00
Michael Bridak
9d76c8c65e
Typo... 2022-10-24 12:30:58 -07:00
Dave Pearson
76e9654535
Merge pull request #958 from davep/toll-free
Review the use of the bell in various examples and documentation files
2022-10-19 15:56:21 +01:00
Dave Pearson
836a4e5291
Correct the file included for the second key example
Not an issue with removing the bell, actually a pre-existing mistake in the
docs. The wrong file was being included.
2022-10-19 15:24:44 +01:00
Dave Pearson
f648457c1e
action03 doesn't ring the bell on button press any more 2022-10-19 15:21:22 +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
Matt Rixman
6a47d82330
Fix typo in devtools.md
forgotten so install -->  forgotten to install
2022-10-17 09:26:38 -06:00
darrenburns
45e5658aea
Mention ordering of superpower methods in docs (#935) 2022-10-17 15:48:16 +01:00
Will McGugan
46208ef905 Merge branch 'css' into mount-wait 2022-10-17 09:36:15 +01:00
Dave Pearson
c32dbda297
Merge pull request #923 from davep/css-docs-review-screens
CSS docs review - Screens
2022-10-15 22:37:15 +01:00
Dave Pearson
a20dbbe325
Drop the
This could either be dropping `the`, as I've done here, or perhaps adding
something like `approach` after `SCREENS`. I feel one or the other is needed
to make this flow well.
2022-10-15 22:26:19 +01:00
Dave Pearson
bdbdb62fd0
Code markup Screen 2022-10-15 22:25:16 +01:00
Dave Pearson
f14f09d80a
Add 'a' and code-markup dict 2022-10-15 22:24:36 +01:00
Dave Pearson
5f97884798
associated -> associate 2022-10-15 22:21:18 +01:00
Dave Pearson
c856ab3e38
screen -> key 2022-10-15 22:20:24 +01:00
Dave Pearson
78af99e780
an -> a 2022-10-15 22:14:07 +01:00
Dave Pearson
c670fc6960
Add as 2022-10-15 22:11:26 +01:00
Dave Pearson
f898fee1d1
Remove trailing whitespace 2022-10-15 22:09:39 +01:00
Dave Pearson
799a769f3e
Add code markup to mention of the Table class 2022-10-15 22:02:19 +01:00
Dave Pearson
3992b1e7d3
intent -> intend 2022-10-15 21:57:52 +01:00
Dave Pearson
4fb9dcd257
an -> a 2022-10-15 21:57:03 +01:00
Dave Pearson
338eca9e10
it's -> its 2022-10-15 21:54:29 +01:00
Dave Pearson
237d17ff16
Remove trailing whitespace 2022-10-15 21:51:53 +01:00
Dave Pearson
67d722507b
Remove unnecessary 'the' 2022-10-15 18:25:59 +01:00
Dave Pearson
09fe0077ed
Add missing code markup marker 2022-10-15 18:23:52 +01:00
Dave Pearson
1805dd7abb
'follow' -> 'following' 2022-10-15 18:23:27 +01:00
Dave Pearson
c159b434b5
Singular attribute to attributes
If there's multiple...
2022-10-15 18:18:29 +01:00
Dave Pearson
306580ec93
'a' -> 'an'
This one could go either way, I guess. If most folk read __init__ like I
do, simply as the word "init" then this is needed; likewise if they say the
underscore, on the other hand if folk tend to go with dunder-init...)

I may recant this depending on the result of this:

  https://twitter.com/davepdotorg/status/1581331978049052672
2022-10-15 18:07:24 +01:00
Dave Pearson
0a7b7dd1fd
Remove trailing whitespace 2022-10-15 18:04:17 +01:00
Dave Pearson
bef450dc4c
Merge pull request #904 from davep/css-docs-review-styles
CSS docs review - Styles
2022-10-15 17:59:24 +01:00
Dave Pearson
fa24296fe0
Merge pull request #915 from davep/css-docs-review-input
CSS docs review - Input
2022-10-15 17:49:54 +01:00
Dave Pearson
7d782e5e31
Merge pull request #916 from davep/css-docs-review-actions
CSS docs review - Actions
2022-10-15 17:47:56 +01:00
Will McGugan
7f77e9a0a1
Update docs/guide/input.md 2022-10-15 13:10:13 +01:00
Will McGugan
8982d88f9e simplify compose 2022-10-15 13:07:15 +01:00
Dave Pearson
95a1b83160
Make the bell belong to the terminal 2022-10-15 10:09:37 +01:00
Dave Pearson
d7dc8d2203
Remove 's' from 'symbols' 2022-10-15 10:08:24 +01:00
Dave Pearson
9527248bc0
Remove 's' from 'strings' 2022-10-15 10:07:23 +01:00
Dave Pearson
b6e27ac6f7
Clean trailing whitespace 2022-10-15 10:02:34 +01:00
Dave Pearson
cc2e9f6218
Merge pull request #906 from davep/css-docs-review-CSS
CSS docs review - CSS
2022-10-15 08:41:36 +01:00
Dave Pearson
079e2a304a
Correct the names for the mouse scroll events
The links were correct, but the text for the link was wrong.
2022-10-15 08:39:36 +01:00
Dave Pearson
32f4f62587
Add 'the' before 'window'
I guess 'a' could work here too.
2022-10-15 08:37:59 +01:00
Dave Pearson
cf5cc9832f
Try and finish what looked like an unfinished line
I'm not 100% sure if it makes sense to say "pressed" or "held down" here;
I'm going with "held down" as pressed sort of suggests something a bit
different. Mostly this change here is to highlight that this thought seems
unfinished.
2022-10-15 08:34:30 +01:00
Dave Pearson
e127ee6dc5
Add code markup to a class name 2022-10-15 08:31:05 +01:00
Dave Pearson
4ec8c0016a
Add 'a' 2022-10-15 08:21:15 +01:00
Dave Pearson
58ad9cd208
Capitalise start of sentence 2022-10-15 08:20:13 +01:00
Dave Pearson
c1d21d29bd
in -> is 2022-10-15 08:18:04 +01:00
Dave Pearson
31234b104a
Merge pull request #898 from davep/css-docs-review
Reviewing CSS docs
2022-10-14 19:05:33 +01:00
Dave Pearson
b56a78ab46
Merge pull request #914 from davep/css-docs-review-events
CSS docs review - Events and Messages
2022-10-14 19:00:55 +01:00
Dave Pearson
248b12c234
Update docs/guide/devtools.md
Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2022-10-14 18:55:13 +01:00
Dave Pearson
acc5e72775
Add 'a' 2022-10-14 18:46:43 +01:00
Dave Pearson
72c99e69fb
it's -> its 2022-10-14 18:35:18 +01:00
Dave Pearson
8c5749898f
Clean up trailing whitespace 2022-10-14 18:16:30 +01:00
Dave Pearson
1354270e6c
Make the final paragraph flow a wee bit better 2022-10-14 14:42:17 +01:00
Dave Pearson
7bad3c37ce
place -> placed 2022-10-14 14:38:29 +01:00
Dave Pearson
c10e172151
Markup pseudo-selector as code
Other similar items in the surrounding text use code markup, so this feels
like it should do too.
2022-10-14 09:00:52 +01:00
Dave Pearson
185a817a30
Improve the description of has_class 2022-10-14 08:56:59 +01:00
Dave Pearson
ad5fb455c1
it's -> its 2022-10-14 08:52:29 +01:00
Dave Pearson
34e5d53cb3
Correct what is imported in an example
The main code in the example creates a `Button` from a `Static`, but the
import is importing a `Widget`. This commit makes the example code make more
sense.
2022-10-14 08:48:06 +01:00
Dave Pearson
d324f1cd56
Add a missing word 2022-10-14 08:42:11 +01:00
Dave Pearson
e46c51d61c
Fix whitespace
Includes pre-commit hook changes.
2022-10-14 08:41:02 +01:00
Dave Pearson
e280719816
Singular style 2022-10-13 22:14:14 +01:00
Dave Pearson
e583d21165
it's -> its 2022-10-13 22:10:46 +01:00
Dave Pearson
c37c5569d7
Add what appears to be a missing "at" 2022-10-13 22:01:16 +01:00
Dave Pearson
bfed4a6bf9
Fix the mention of an example to be singular 2022-10-13 22:00:17 +01:00
Dave Pearson
19c29bdb11
Add code markup to string constants
Elsewhere in the document colour names as strings have been marked up as
text, so this is in keeping with that.
2022-10-13 21:57:08 +01:00
Dave Pearson
279b043c81
Add missing plural 2022-10-13 21:55:49 +01:00
Dave Pearson
bd21a255ad
Add missing "we" 2022-10-13 21:53:16 +01:00
Dave Pearson
8b45cd5324
Remove trailing whitespace 2022-10-13 21:49:46 +01:00
Dave Pearson
31a1ebbe8f
s/you/your/ 2022-10-13 16:36:30 +01:00
Dave Pearson
7182c79814
Lets to let's 2022-10-13 15:46:17 +01:00
Dave Pearson
c4a43c3f52
s/Mypy/mypy/ 2022-10-13 15:44:46 +01:00
Dave Pearson
ffbccd5d5d
Add code markup to the mention of class names 2022-10-13 15:42:01 +01:00
Dave Pearson
4569a77d54
Add code markup to the mention of a class name 2022-10-13 15:40:55 +01:00
Dave Pearson
da49d19cb7
s/fledge/fledged/ 2022-10-13 15:40:03 +01:00
Dave Pearson
e736611b55
Remove trailing whitespace 2022-10-13 15:34:10 +01:00
Dave Pearson
25fcf26a30
Add code markup to the mention of a class names 2022-10-13 15:31:34 +01:00
Dave Pearson
4a6e4ff025
Reword the details of how textual run finds an app
It seems the docs are lagging behind the code here, so this commit attempts
to update them so they're more in line with how `textual run` works.
2022-10-13 15:26:54 +01:00
Dave Pearson
ceb531e535
Add code markup to the mention of a class name 2022-10-13 14:46:39 +01:00
Dave Pearson
7676a6cf4c
Trailing whitespace cleanup 2022-10-13 14:45:54 +01:00
Dave Pearson
bf1ad06edb
Merge pull request #888 from davep/css-docs-screen-import
Modify the screen examples to import Screen from textual.screen
2022-10-13 11:12:07 +01:00
Dave Pearson
7360e226c1
Correct the highlighted lines
I'd not realised that
78ea2cd9f8
would have a visible knock-on effect in the docs, because the docs specify
which lines should be highlighted. As per this comment
https://github.com/Textualize/textual/pull/888#issuecomment-1277298383 this
corrects that.
2022-10-13 11:03:53 +01:00
Dave Pearson
f127506e60
Remove some trailing whitespace 2022-10-13 11:03:17 +01:00
Aaron Stephens
b9493ae6ff docs: typos 2022-10-12 17:34:29 -07:00
Will McGugan
1da5c297ad
Merge pull request #859 from davep/layout-typo-squish
Typo fix: `styles` belong to a widget
2022-10-11 15:00:25 +01:00
Will McGugan
47effaddbb
Merge pull request #853 from Textualize/document-comma-separated-bindings
Documenting comma-separated bindings in docstring and guide
2022-10-10 10:05:31 +01:00
Dave Pearson
3f08e50261
Typo fix: styles belong to a widget 2022-10-09 21:11:30 +01:00
Dave Pearson
2275129752
Fix typo of 'a' for 'an' 2022-10-09 20:36:13 +01:00
Dave Pearson
4df4da2455
Fix typo of 'which' for 'with' 2022-10-09 20:35:11 +01:00
Dave Pearson
dfa05466e8
Add missing 'to' 2022-10-09 20:34:03 +01:00
Dave Pearson
37e9982348
Trailing whitespace trimming
As a commit of its own so it doesn't obscure any real change.
2022-10-09 20:32:23 +01:00
Will McGugan
9c7a48fc13 words 2022-10-09 16:11:16 +01:00
Will McGugan
d4db0ea4e0 queries docs 2022-10-08 22:27:47 +01:00
Will McGugan
23bc50e625 fix title 2022-10-07 21:56:54 +01:00
Will McGugan
cf14b812ed words 2022-10-07 21:05:20 +01:00
Will McGugan
f2f13eacf0 proof reading 2022-10-07 18:00:35 +01:00
Will McGugan
66a4e08955 words 2022-10-07 17:20:26 +01:00
Darren Burns
cbfa1e7a69
Fix typo 2022-10-07 12:38:23 +01:00
Darren Burns
c7e8fe3502
Fix typo 2022-10-07 12:37:43 +01:00
Darren Burns
79c5abca4a
Documenting comma-separated bindings in docstring and guide 2022-10-07 12:33:13 +01:00
Will McGugan
989ded28a4 grammer 2022-10-06 16:02:02 +01:00
Will McGugan
58ed906ed5 simplified animator docs 2022-10-06 15:59:42 +01:00
Darren Burns
8bd1dcd7dd
Small correction 2022-10-06 14:17:53 +01:00
Darren Burns
0428b8ff4c
Small typo fixes 2022-10-06 14:15:11 +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
ded9d39054
Add short inline delay example 2022-10-06 10:55:37 +01:00
Darren Burns
c299479ed5
Add note on delaying animations and custom easing functions 2022-10-06 10:28:30 +01:00
Darren Burns
21ee43325d Animator docs, wait syntax in app.run keys 2022-10-05 17:24:03 +01:00
Will McGugan
d93b9c7a66 wording 2022-10-05 10:54:52 +01:00
Will McGugan
f6e3cc6517 screens api 2022-10-04 17:48:25 +01:00
Will McGugan
94ff417e1f fix line highlight 2022-10-04 08:55:25 +01:00
Will McGugan
86a7bef71f replace references to TextInput 2022-10-03 17:38:10 +01:00
Will McGugan
f43366abfb update dependancies 2022-10-03 17:23:47 +01:00
Will McGugan
9de1a87024 more docs and compute example 2022-10-03 16:55:40 +01:00
Will McGugan
cb9d777bbc words 2022-09-29 17:31:13 +01:00
Will McGugan
7bfe178c69 actions docs 2022-09-29 17:19:07 +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
ba18a80eed links and widgets docs 2022-09-22 17:14:40 +01:00
Will McGugan
e4dd71655f links 2022-09-22 16:19:45 +01:00
Will McGugan
9ab01d3c54 widgets docs 2022-09-21 17:18:50 +01:00
Will McGugan
f70232ca5c
Merge pull request #789 from Textualize/css-path
changed to CSS_PATH
2022-09-20 14:34:59 +01:00
Will McGugan
916a9d02ac
Merge pull request #787 from Textualize/docs-events
Docs events
2022-09-20 14:34:45 +01:00
Will McGugan
5ff12ddb4b
Update docs/guide/events.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-09-20 14:28:22 +01:00
Will McGugan
8685567abd
Update docs/guide/events.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-09-20 14:28:16 +01:00
Will McGugan
d5051d35b5
Merge pull request #774 from Textualize/dont-render-zero-opacity-text
Minimise rendering when text-opacity/opacity is zero
2022-09-20 10:50:53 +01:00
Will McGugan
d0293c2c89 changed to CSS_PATH 2022-09-18 22:02:08 +01:00
Will McGugan
f2c5e6ce78 docs and reference 2022-09-18 19:14:46 +01:00
Will McGugan
4e732ce309 dictionary example 2022-09-18 15:43:47 +01:00
Will McGugan
9838d3b34e fluid rendering 2022-09-18 11:25:16 +01:00
Will McGugan
614b29e222 event docs 2022-09-18 09:10:22 +01:00
Will McGugan
1013f84ffc diagrams 2022-09-17 10:31:21 +01:00
Will McGugan
bf90f7032d text log widget 2022-09-16 16:14:28 +01:00