Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove classic footer #4921

Merged
merged 2 commits into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Keys such as escape and space are now displayed in lower case in footer https://github.com/Textualize/textual/pull/4876
- Changed default command palette binding to `ctrl+p` https://github.com/Textualize/textual/pull/4867
- Removed `ctrl_to_caret` and `upper_case_keys` from Footer. These can be implemented in `App.get_key_display`.
- Breaking change: Removed ClassicFooter (please use new Footer widget) https://github.com/Textualize/textual/pull/4921

### Fixed

Expand Down
25 changes: 0 additions & 25 deletions docs/examples/widgets/classic_footer.py

This file was deleted.

14 changes: 0 additions & 14 deletions docs/widget_gallery.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,6 @@ A classic checkbox control.
```{.textual path="docs/examples/widgets/checkbox.py"}
```

## ClassicFooter

The original Footer widget.

!!! warning

This has been replaced by [`Footer`](#footer), and will be removed in Textual v1.0

[ClassicFooter reference](./widgets/classic_footer.md){ .md-button .md-button--primary }

```{.textual path="docs/examples/widgets/classic_footer.py" columns="70" lines="12"}
```



## Collapsible

Expand Down
64 changes: 0 additions & 64 deletions docs/widgets/classic_footer.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/widgets/footer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@

!!! tip "Added in version 0.63.0"

This is a second iteration of the Footer.
The version prior to 0.63.0 is available as [ClassicFooter](./classic_footer.md) to help with backwards compatibility, but will be removed in v1.0.

A simple footer widget which is docked to the bottom of its parent container. Displays
available keybindings for the currently focused widget.

Expand Down
1 change: 0 additions & 1 deletion mkdocs-nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,6 @@ nav:
- Widgets:
- "widgets/button.md"
- "widgets/checkbox.md"
- "widgets/classic_footer.md"
- "widgets/collapsible.md"
- "widgets/content_switcher.md"
- "widgets/data_table.md"
Expand Down
2 changes: 0 additions & 2 deletions src/textual/widgets/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
from ..widget import Widget
from ._button import Button
from ._checkbox import Checkbox
from ._classic_footer import ClassicFooter
from ._collapsible import Collapsible
from ._content_switcher import ContentSwitcher
from ._data_table import DataTable
Expand Down Expand Up @@ -52,7 +51,6 @@
__all__ = [
"Button",
"Checkbox",
"ClassicFooter",
"Collapsible",
"ContentSwitcher",
"DataTable",
Expand Down
161 changes: 0 additions & 161 deletions src/textual/widgets/_classic_footer.py

This file was deleted.

2 changes: 0 additions & 2 deletions src/textual/widgets/_footer.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,6 @@ def __init__(
id: The ID of the widget in the DOM.
classes: The CSS classes for the widget.
disabled: Whether the widget is disabled or not.
upper_case_keys: Show the keys in upper case.
ctrl_to_caret: Show `ctrl+` as `^`.
show_command_palette: Show key binding to command palette, on the right of the footer.
"""
super().__init__(
Expand Down
2 changes: 1 addition & 1 deletion tests/snapshot_tests/snapshot_apps/auto_width_input.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from textual.app import App, ComposeResult
from textual.widgets import Header, Footer, Input, ClassicFooter
from textual.widgets import Header, Footer, Input


class InputWidthAutoApp(App[None]):
Expand Down
5 changes: 0 additions & 5 deletions tests/snapshot_tests/snapshot_apps/footer_classic_styling.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,6 @@ class ClassicFooterStylingApp(App):
def compose(self) -> ComposeResult:
yield Footer()

def on_mount(self) -> None:
footer = self.query_one(Footer)
footer.upper_case_keys = True
footer.ctrl_to_caret = False


if __name__ == "__main__":
app = ClassicFooterStylingApp()
Expand Down
Loading