diff --git a/docs/styles/max_height.md b/docs/styles/max_height.md index e80d996fe..b483200f4 100644 --- a/docs/styles/max_height.md +++ b/docs/styles/max_height.md @@ -4,18 +4,48 @@ The `max-height` rule sets a maximum height for a widget. ## Syntax -``` -max-height: ; -``` +--8<-- "docs/snippets/syntax_block_start.md" +max-height: <scalar>; +--8<-- "docs/snippets/syntax_block_end.md" + +The `max-height` rule accepts a [``](../css_types/scalar.md) that defines an upper bound for the [`height`](./height.md) of a widget. +That is, the height of a widget is never allowed to exceed `max-height`. + +### Values + +--8<-- "docs/snippets/type_syntax/scalar.md" + +## Example + +The example below shows some placeholders that were defined to span vertically from the top edge of the terminal to the bottom edge. +Then, we set `max-height` individually on each placeholder. + +=== "Output" + + ```{.textual path="docs/examples/styles/max_height.py"} + ``` + +=== "max_height.py" + + ```py + --8<-- "docs/examples/styles/max_height.py" + ``` + +=== "max_height.css" + + ```css + --8<-- "docs/examples/styles/max_height.css" + ``` + + 1. This won't affect the placeholder because its height is less than the maximum height. ## CSS ```sass - -/* Set a maximum height of 10 rows */ +/* Set the maximum height to 10 rows */ max-height: 10; -/* Set a maximum height of 25% of the screen height */ +/* Set the maximum height to 25% of the viewport height */ max-height: 25vh; ``` @@ -25,7 +55,6 @@ max-height: 25vh; # Set the maximum height to 10 rows widget.styles.max_height = 10 -# Set the maximum height to 25% of the screen height +# Set the maximum height to 25% of the viewport height widget.styles.max_height = "25vh" - ``` diff --git a/docs/styles/max_width.md b/docs/styles/max_width.md index c6ce4ef67..1682c5301 100644 --- a/docs/styles/max_width.md +++ b/docs/styles/max_width.md @@ -4,27 +4,57 @@ The `max-width` rule sets a maximum width for a widget. ## Syntax -``` -max-width: ; -``` +--8<-- "docs/snippets/syntax_block_start.md" +max-width: <scalar>; +--8<-- "docs/snippets/syntax_block_end.md" + +The `max-width` rule accepts a [``](../css_types/scalar.md) that defines an upper bound for the [`width`](./width.md) of a widget. +That is, the width of a widget is never allowed to exceed `max-width`. + +### Values + +--8<-- "docs/snippets/type_syntax/scalar.md" + +## Example + +The example below shows some placeholders that were defined to span horizontally from the top edge of the terminal to the bottom edge. +Then, we set `max-width` individually on each placeholder. + +=== "Output" + + ```{.textual path="docs/examples/styles/max_width.py"} + ``` + +=== "max_width.py" + + ```py + --8<-- "docs/examples/styles/max_width.py" + ``` + +=== "max_width.css" + + ```scss + --8<-- "docs/examples/styles/max_width.css" + ``` + + 1. This won't affect the placeholder because its width is less than the maximum width. ## CSS ```sass - -/* Set a maximum width of 10 cells */ +/* Set the maximum width to 10 rows */ max-width: 10; -/* Set a maximum width of 25% of the screen width */ -max-width: 25vw; +/* Set the maximum width to 25% of the viewport width */ +max-width: 25vh; ``` ## Python ```python -# Set the maximum width to 10 cells +# Set the maximum width to 10 rows widget.styles.max_width = 10 -# Set the maximum width to 25% of the screen width -widget.styles.max_width = "25vw" +# Set the maximum width to 25% of the viewport width +widget.styles.max_width = "25vh" ``` diff --git a/docs/styles/min_height.md b/docs/styles/min_height.md index b110e190e..1279f92fb 100644 --- a/docs/styles/min_height.md +++ b/docs/styles/min_height.md @@ -4,18 +4,48 @@ The `min-height` rule sets a minimum height for a widget. ## Syntax -``` -min-height: ; -``` +--8<-- "docs/snippets/syntax_block_start.md" +min-height: <scalar>; +--8<-- "docs/snippets/syntax_block_end.md" + +The `min-height` rule accepts a [``](../css_types/scalar.md) that defines a lower bound for the [`height`](./height.md) of a widget. +That is, the height of a widget is never allowed to be under `min-height`. + +### Values + +--8<-- "docs/snippets/type_syntax/scalar.md" + +## Example + +The example below shows some placeholders with their height set to `50%`. +Then, we set `min-height` individually on each placeholder. + +=== "Output" + + ```{.textual path="docs/examples/styles/min_height.py"} + ``` + +=== "min_height.py" + + ```py + --8<-- "docs/examples/styles/min_height.py" + ``` + +=== "min_height.css" + + ```css hl_lines="13" + --8<-- "docs/examples/styles/min_height.css" + ``` + + 1. This won't affect the placeholder because its height is larger than the minimum height. ## CSS ```sass - -/* Set a minimum height of 10 rows */ +/* Set the minimum height to 10 rows */ min-height: 10; -/* Set a minimum height of 25% of the screen height */ +/* Set the minimum height to 25% of the viewport height */ min-height: 25vh; ``` @@ -23,9 +53,8 @@ min-height: 25vh; ```python # Set the minimum height to 10 rows -self.styles.min_height = 10 - -# Set the minimum height to 25% of the screen height -self.styles.min_height = "25vh" +widget.styles.min_height = 10 +# Set the minimum height to 25% of the viewport height +widget.styles.min_height = "25vh" ``` diff --git a/docs/styles/min_width.md b/docs/styles/min_width.md index 81331469a..cd4d1899e 100644 --- a/docs/styles/min_width.md +++ b/docs/styles/min_width.md @@ -1,30 +1,60 @@ # Min-width -The `min-width` rules sets a minimum width for a widget. +The `min-width` rule sets a minimum width for a widget. ## Syntax -``` -min-width: ; -``` +--8<-- "docs/snippets/syntax_block_start.md" +min-width: <scalar>; +--8<-- "docs/snippets/syntax_block_end.md" + +The `min-width` rule accepts a [``](../css_types/scalar.md) that defines a lower bound for the [`width`](./width.md) of a widget. +That is, the width of a widget is never allowed to be under `min-width`. + +### Values + +--8<-- "docs/snippets/type_syntax/scalar.md" + +## Example + +The example below shows some placeholders with their width set to `50%`. +Then, we set `min-width` individually on each placeholder. + +=== "Output" + + ```{.textual path="docs/examples/styles/min_width.py"} + ``` + +=== "min_width.py" + + ```py + --8<-- "docs/examples/styles/min_width.py" + ``` + +=== "min_width.css" + + ```css hl_lines="13" + --8<-- "docs/examples/styles/min_width.css" + ``` + + 1. This won't affect the placeholder because its width is larger than the minimum width. ## CSS ```sass - -/* Set a minimum width of 10 cells */ +/* Set the minimum width to 10 rows */ min-width: 10; -/* Set a minimum width of 25% of the screen width */ -min-width: 25vw; +/* Set the minimum width to 25% of the viewport width */ +min-width: 25vh; ``` ## Python ```python -# Set the minimum width to 10 cells +# Set the minimum width to 10 rows widget.styles.min_width = 10 -# Set the minimum width to 25% of the screen width -widget.styles.min_width = "25vw" +# Set the minimum width to 25% of the viewport width +widget.styles.min_width = "25vh" ```