Commit Graph

1088 Commits

Author SHA1 Message Date
Will McGugan
b9977812f7 added static 2023-03-07 14:05:40 +00:00
Will McGugan
1c91c3dba2 tweaked heights [skip ci] 2023-03-07 11:17:15 +00:00
Will McGugan
419e46b668 updated copy 2023-03-07 10:50:00 +00:00
Will McGugan
94cc12fc72 Add widget gallery 2023-03-07 10:47:02 +00:00
Dave Pearson
fcc16c0e59 Correct the example Python code for the border style (#1956)
To the best of my knowledge, and in testing myself, border and border_* are
properties of a widget's `styles` property, they're not a property of the
widget itself.
2023-03-07 09:28:02 +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
Rodrigo Girão Serrão
8b70a464d7 Add subsection to separate example. 2023-03-06 13:54:01 +00:00
Rodrigo Girão Serrão
294213e0a1 Update radio_set_changed.py (#1947)
In the aftermath of #1935 and #1940 this fell through the cracks.
2023-03-06 12:04:22 +00:00
Dave Pearson
623b70d4ac Add an example of using a RadioSet.Changed message (#1935)
Unlike a few other widgets, the RadioSet is pretty much all about reacting
to the selection result; the question of how you go about it has already
come up and while the message is documented, complete with all properties,
it can't hurt to have an illustrative example of code that uses it.

Here I add an extra RadioSet example that sits with the message in the
reference. This should help the reader better follow how to use it, and also
gives something to link to if someone hasn't got that far into the
documentation yet but is attempting to use the RadioSet.
2023-03-06 10:53:12 +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
0df17fc8f0 Tidy up some Button documentation
Adds missing documentation for disabled to each of the button variant
constructors, and also pulls in a couple more public-visible Button-related
types into the docs.
2023-03-01 16:46:47 +00:00
Dave Pearson
cf34e5e7fa Merge branch 'main' into widget-doc-sweep 2023-03-01 14:32:47 +00:00
Dave Pearson
80fd76f1f2 Document TreeDataType 2023-03-01 13:45:32 +00:00
Dave Pearson
dbb52637c5 Document NodeID
It's in the public interface for tree, so it should be documented.
2023-03-01 13:23:28 +00:00
Dave Pearson
ac35c1d1d5 Document TreeNode via Tree itself
There's a couple of other types in the public interface of Tree that should
be teased out, and it feels odd to have one type in one file and a bunch of
others in another. So this sets us up for having them all the same place.
This should make it easier for the reader to find related information.
2023-03-01 13:21:45 +00:00
Dave Pearson
a837cd1d85 Ensure PlaceholderVariant gets included in the docs 2023-03-01 13:08:40 +00:00
Dave Pearson
87f216980d Add the Welcome widget to the documentation
While it's arguably not the most useful widget, it's in the code, exported,
and can be seen by people; I feel it should be in the documentation. I've
ensured that it also links to Placeholder given it sort of is a Placeholder
and so people might arrive at it first and it makes sense to redirect them
to something more comprehensive.
2023-03-01 10:39:30 +00:00
Dave Pearson
7101010fb0 Merge pull request #1906 from davep/question02-doc-tweak
Highlight that the label acquires an id in the example code
2023-03-01 09:43:05 +00:00
Dave Pearson
99d482491b A warning from the future
Add a warning to my first blog post, letting the attentive reader know that
`emit_no_wait` doesn't exist any more, and linking them to what they should
be using if they want to do their own custom messages.
2023-03-01 09:14:27 +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
Dave Pearson
ce5b02522e Document AwaitRemove 2023-02-28 12:50:41 +00:00
Dave Pearson
8d2336a02e Increase the coverage of API documentation
See #1364 -- rather than pull in specific classes, this pulls in every
publicly-documented item (function, class, type, "constant", etc) that can
be found in each of the modules.

This should help improve the linkage of types within the documentation.
2023-02-28 12:27:22 +00:00
Dave Pearson
b5c028c36d Fix a docstring typo
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-02-27 13:35:33 +00:00
Dave Pearson
6d0fc0489f Rework the layout of the checkbox example
Time to start to show off the new compose method.
2023-02-27 09:11:18 +00:00
Dave Pearson
23c0587efb Rework the layout of the radio button example
Time to start to show off the new compose method.
2023-02-27 09:10:10 +00:00
Dave Pearson
f436489efa Rework the layout of the radio set example
Time to start to show off the new compose method.
2023-02-27 09:08:40 +00:00
Dave Pearson
e6e46d0825 Merge branch 'main' into toggle-boxen 2023-02-27 08:53:30 +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
461abc7fbe missing bracket 2023-02-24 17:19:55 +00:00
Will McGugan
01a4ed97e1 update blog 2023-02-24 17:12:29 +00:00
Will McGugan
e3976155fd Update docs/blog/posts/release0-12-0.md
Co-authored-by: Dave Pearson <davep@davep.org>
2023-02-24 17:12:14 +00:00
Will McGugan
8a5e5f29e0 Update docs/blog/posts/release0-12-0.md
Co-authored-by: Dave Pearson <davep@davep.org>
2023-02-24 17:12:04 +00:00
Will McGugan
661990f6e4 new blog post 2023-02-24 17:01:02 +00:00
Will McGugan
5f1ca95f8a Merge pull request #1866 from Textualize/prevent-event
Add a "prevent" context manager
2023-02-24 12:36:46 +00:00
Will McGugan
63438f170d Update docs/examples/events/prevent.py
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-02-24 12:02:56 +00:00
Will McGugan
217956bbdf Update docs/examples/events/prevent.py
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-02-24 12:02:46 +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
Dave Pearson
f0a6771533 Update the ChangeLog and the roadmap 2023-02-23 22:14:41 +00:00
Will McGugan
b2ab5b6886 docs 2023-02-23 21:36:33 +00:00
Dave Pearson
307b1789a1 Give radio button its own example code now
Still within a RadioSet, but this time only the code that uses RadioSet; not
the code that just uses strings.
2023-02-23 16:00:14 +00:00
Dave Pearson
316faf9e45 Add width reference documentation for radio set 2023-02-23 15:31:32 +00:00
Dave Pearson
a821b2f8f6 Add width reference documentation for radio buttons
A large part of the code to go with this is to show off a radio set; I feel
it makes sense to use the same code for both bits of documentation given
that a radio button only really makes sense inside a radio set.
2023-02-23 15:14:25 +00:00
Dave Pearson
a3d50d90f6 Revert example code to composing the old way
We've not documented it yet so, until we do...
2023-02-23 15:09:45 +00:00
Dave Pearson
87bd610eec Swap the checkbox example to the newer compose approach 2023-02-23 14:45:24 +00:00
Will McGugan
da9e28d4d6 Add example 2023-02-23 14:41:44 +00:00
Will McGugan
dc4421e76a Merge pull request #1867 from davep/fix-switch-wording
Correct the wording of the description of `Switch.value`
2023-02-23 14:41:08 +00:00