Commit Graph

77 Commits

Author SHA1 Message Date
Mike Driscoll
8cb28b6668 Update button.md example sentence (#1988)
The example was missing a word
2023-03-09 06:46:53 +00:00
Rodrigo Girão Serrão
8b70a464d7 Add subsection to separate example. 2023-03-06 13:54:01 +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
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
e6e46d0825 Merge branch 'main' into toggle-boxen 2023-02-27 08:53:30 +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
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
Dave Pearson
4f75a395d8 Fix copy/paste-o in the checkbox reference 2023-02-23 14:35:24 +00:00
Dave Pearson
6738c5686c Correct the wording of the description of Switch.value
It's not just the default value, it's the ongoing value too and can be used
to change the switch.
2023-02-23 14:28:25 +00:00
Dave Pearson
3fd3d272ce Add the widget reference for Checkbox 2023-02-23 14:26:11 +00:00
Dave Pearson
a18685c9c8 Fix a copy/paste-o in the TextLog reference entry 2023-02-22 16:28:23 +00:00
Will McGugan
0dac83668b Merge pull request #1791 from Textualize/textual-markdown
Textual markdown
2023-02-15 09:23:19 +00:00
Will McGugan
08c3a7214e No, I repeat, no abbreviations 2023-02-14 17:28:24 +00:00
Will McGugan
df1edb087c Merge pull request #1788 from Textualize/datatable-select-headers
DataTable - Message emitted when header selected
2023-02-14 16:42:01 +00:00
Darren Burns
36a9214d7f Update reactive names in DataTable reference docs 2023-02-14 15:29:05 +00:00
Will McGugan
71d0017ef9 docs and refactor 2023-02-14 15:22:15 +00:00
Darren Burns
49b78daa04 Update docs to include DataTable.HeaderSelected 2023-02-14 15:18:32 +00:00
Will McGugan
6f1abe849f fix reference 2023-02-13 17:30:53 +00:00
Dave Pearson
decc1e2f3c Rename Checkbox to Switch
A new form of Checkbox will be arriving in Textual soon, working in
conjunction with a RadioButton. What was called Checkbox is perhaps a wee
bit heavyweight in terms of visual design, but is a style of widget that
should remain.

With this in mind we're renaming the current Checkbox to Switch. In all
other respects its workings remains the same, only the name has changed.

Things for people to watch out for:

- Imports will need to be updated.
- Queries will need to be updated; special attention will need to be paid to
  any queries that are string-based.
- CSS will need to be changed if any Checkbox styling is happening, or if
  any Checkbox component styles are being used.

See #1725 as the initial motivation and #1746 as the issue for this
particular change.
2023-02-09 11:10:30 +00:00
David Brochart
d1790caff7 Fix typo 2023-02-01 12:25:00 +01:00
Rodrigo Girão Serrão
bc729033c8 Merge branch 'main' into doc-improvements 2023-01-26 13:55:34 +00:00
Rodrigo Girão Serrão
b37517c400 Add all messages to widget references. 2023-01-26 11:53:51 +00:00
Will McGugan
211280e0be Fixed wording of tree node docs 2023-01-26 12:37:57 +01:00
Will McGugan
dc5041f1e1 update to intro page, fix for API docs 2023-01-26 12:21:49 +01:00
Rodrigo Girão Serrão
210e39488f Add template for widget reference. 2023-01-26 10:56:32 +00:00
Rodrigo Girão Serrão
ef779d71dd Add bindings and component classes to reference pages. 2023-01-25 15:19:16 +00:00
Dave Pearson
faac89fd8d Remove mention of ChildrenUpdated from the ListView docs
As pointed out in #1649, a `ChildrenUpdated` message is documented but it
doesn't exist in the code. It looks like it got added during development,
then removed after it was realised it wasn't needed, but presumably it got
left in the docs:

  https://github.com/Textualize/textual/pull/1143#discussion_r1030409026
2023-01-24 07:47:18 +00:00
Darren Burns
be45db4573 Use autodoc for DataTable Messages reference 2023-01-17 13:00:01 +00:00
Darren Burns
23eb13d12d Some DataTable doc updates, rename Coord -> Coordinate and extract to module 2023-01-17 11:06:21 +00:00
Darren Burns
f327f1d2af Small datatable docs rewording 2023-01-17 10:11:19 +00:00
Darren Burns
9bc93cd683 Small datatable docs rewording 2023-01-17 10:06:39 +00:00
Darren Burns
65223be8be Merge branch 'main' of github.com:Textualize/textual into datatable-events 2023-01-16 11:00:10 +00:00
Darren Burns
2814e1f93c Documentation updates 2023-01-16 10:50:41 +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
92391339ae Fix link typo 2022-12-16 11:49:07 +00:00
Dave Pearson
c90e4adaf8 Correct the check list for the ListItem
The checks in the list, which were unckecked, needed spaces in them to
render correctly in the docs.
2022-12-15 16:23:49 +00:00
Will McGugan
9aac3a0cca updated list view 2022-12-10 18:18:28 +00:00
Will McGugan
13a207bacc new blog post 2022-12-10 10:34:34 +00:00
Will McGugan
cebeafbb8b Merge branch 'main' into list-view 2022-12-09 10:09:07 +00:00
Will McGugan
69ed4b2e0b textlog documentation 2022-12-09 09:01:34 +00:00
Rodrigo Girão Serrão
ba5ec6b34b Merge branch 'main' of https://github.com/Textualize/Textual into placeholder 2022-12-05 15:08:01 +00:00
darrenburns
422f9bed38 Update docs/widgets/list_view.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-11-30 11:42:42 +00:00
darrenburns
4834807f36 Update docs/widgets/list_item.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2022-11-30 11:39:09 +00:00
Darren Burns
eb8c078306 Merge branch 'main' of github.com:willmcgugan/textual into list-view 2022-11-23 11:03:40 +00:00
Darren Burns
4e0c77e9f7 Ensure mkdocs.yml is up to date with listview stuff 2022-11-21 17:14:32 +00:00
Darren Burns
c57f6b9025 Fix click handler 2022-11-21 16:42:53 +00:00
Will McGugan
b7d628fca5 docs update 2022-11-20 17:32:37 +00:00
Will McGugan
f7dade5a26 new tree control 2022-11-20 15:42:35 +00:00