Commit graph

516 commits

Author SHA1 Message Date
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
Will McGugan
dfdb20d66e reference 2022-09-15 21:56:57 +01:00
Will McGugan
0cdf1010ed events copy 2022-09-15 21:41:23 +01:00
darrenburns
9e883d3e45
Document styles (#785)
* Add docs for CSS variables

* Add ref docs for various styles, fix some typos in places
2022-09-15 16:32:23 +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
darrenburns
e2ff19e1f3
Fix broken text in docs (#781)
* Add docs for CSS variables

* Fix broken text
2022-09-15 13:55:33 +01:00
darrenburns
1e9ebf0c73
Add docs for CSS variables (#780)
* Add docs for CSS variables

* Update docs/guide/CSS.md

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

* Update docs/guide/CSS.md

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

* Update docs/guide/CSS.md

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

* Update docs/guide/CSS.md

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

Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2022-09-15 13:45:49 +01:00
Darren Burns
0762fff6bf
Inline some properties, pull condition outside loop 2022-09-15 12:19:05 +01:00
Will McGugan
43de22e3b3 tabs for content-box etc 2022-09-15 12:11:02 +01:00
Will McGugan
0276f54e9b
Update docs/guide/styles.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-09-15 11:21:21 +01:00
Will McGugan
b617878067 link to diagram 2022-09-15 11:15:28 +01:00
Will McGugan
9d7e58cfd3
Update docs/guide/styles.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-09-15 11:15:00 +01:00
Will McGugan
09dcab081f
Update docs/guide/styles.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-09-15 11:11:03 +01:00
Will McGugan
54bcb2b4ed
Update docs/guide/styles.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-09-15 11:10:40 +01:00
Will McGugan
9718d38323
Update docs/guide/styles.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-09-15 11:10:10 +01:00
Will McGugan
fe500f9a94 words 2022-09-15 11:09:11 +01:00
Will McGugan
41b3ff6855 fix examples 2022-09-15 11:08:47 +01:00
Will McGugan
0624fb8507
Update docs/guide/styles.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-09-15 11:07:35 +01:00
Will McGugan
950477b9ff
Update docs/guide/styles.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-09-15 11:06:40 +01:00
Will McGugan
095b0dfcac
Update docs/guide/styles.md
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-09-15 11:04:40 +01:00
Will McGugan
855be4481a edits 2022-09-15 09:31:12 +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
32079fc8f7 color docs 2022-09-11 10:25:51 +01:00
Will McGugan
b6341ddb50 added color reference and docs 2022-09-10 22:00:51 +01:00
Will McGugan
b1fa3c0a2a words 2022-09-10 17:00:43 +01:00
Will McGugan
269960ad8a fix styles examples, box model docs 2022-09-10 16:45:13 +01:00
Will McGugan
39c6dee84f styles docs 2022-09-10 16:12:35 +01:00
Will McGugan
11fea02833 animator 2022-09-06 16:09:15 +01:00
Will McGugan
e4c16b6d6d added grid layout 2022-09-06 16:06:01 +01:00
Will McGugan
d9d5791925 todos 2022-09-06 15:39:41 +01:00
Will McGugan
4a7f601205 indexes and tweaks 2022-09-06 13:26:55 +01:00
Will McGugan
9aa7228fda added doc indexes 2022-09-06 13:11:06 +01:00
Will McGugan
3e41e14714 box diagram 2022-09-06 10:50:12 +01:00
Will McGugan
e8a4f2e806 rename table to gird, diagrams for layout 2022-09-06 10:16:52 +01:00
Will McGugan
6d6e385313 added styles 2022-09-05 22:58:15 +01:00
Will McGugan
e7d57a4aa2 renamed introduction to tutorial 2022-09-05 21:30:29 +01:00
Will McGugan
7db856d404 return types and buttons 2022-09-05 10:51:19 +01:00
Will McGugan
d945029b9a mounting 2022-09-04 21:10:15 +01:00
Will McGugan
432db21512 app basics and doc structure 2022-09-04 20:40:12 +01:00
Will McGugan
ca9492ac56 layout docs 2022-09-04 15:05:44 +01:00
Will McGugan
2fedbaf3dd tweak 2022-08-26 11:02:14 +01:00
Will McGugan
ff579ea526 Review changes 2022-08-26 10:58:50 +01:00
Will McGugan
732af87936
Apply suggestions from code review
Co-authored-by: darrenburns <darrenburns@users.noreply.github.com>
2022-08-26 10:40:04 +01:00
Will McGugan
a09f5726ec
Apply suggestions from code review
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-08-25 15:37:52 +01:00
Will McGugan
a15cb4413d
Update docs/guide/CSS.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-08-25 10:30:22 +01:00
Will McGugan
df2d12510a
Update docs/guide/CSS.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-08-25 10:30:11 +01:00
Will McGugan
0cc48076c7 rephrase 2022-08-25 10:29:31 +01:00
Will McGugan
9d4ec4bd0f
Update docs/guide/CSS.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-08-25 10:28:51 +01:00
Will McGugan
81202d15eb
Update docs/guide/CSS.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-08-25 10:28:38 +01:00
Will McGugan
1ee962516a
Update docs/guide/CSS.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-08-25 10:25:46 +01:00
Will McGugan
8f51d2a52e docstring for log 2022-08-25 09:27:30 +01:00
Will McGugan
c0a631ac49 faster screenshots, docstrings 2022-08-24 14:00:05 +01:00
Will McGugan
6ee4d41bb7 docs 2022-08-24 11:19:29 +01:00
Will McGugan
23fcf46ce8 console screenshot 2022-08-23 12:17:11 +01:00
Will McGugan
5491b41346 words 2022-08-15 07:51:14 +01:00
Will McGugan
eeb6729bcf words 2022-08-14 22:06:27 +01:00
Will McGugan
ddcef6e7d5 words 2022-08-14 16:28:14 +01:00
Will McGugan
9af8c8214a words 2022-08-14 16:24:33 +01:00
Will McGugan
48a4ec92a0 specificity docs 2022-08-14 15:47:52 +01:00
Will McGugan
f19076ea57 words 2022-08-14 15:43:29 +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
Will McGugan
3030557060 refactor of docs 2022-05-26 17:02:30 +01:00