fix(layout_columns): Remove use of enum for breakpoints #912
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cpsievert
approved these changes
Dec 15, 2023
jcheng5
reviewed
Dec 15, 2023
jcheng5
reviewed
Dec 15, 2023
shiny/ui/_layout_columns.py
Outdated
| lg = "lg" | ||
| xl = "xl" | ||
| xxl = "xxl" | ||
| def bs_breakpoints() -> Iterable[Breakpoints]: |
There was a problem hiding this comment.
I can't tell if this is for public use. If so, can we do without the bs_ prefix? If not, maybe just make this a variable instead of a function.
There was a problem hiding this comment.
It's not for public use, so I made it a variable and removed the prefix.
schloerke
added a commit
that referenced
this pull request
Dec 18, 2023
* main: (24 commits) docs: Use definition lists for parameter descriptions to enable full markdown support (#901) docs(layout_columns): Add example app (#903) fix(layout_columns): Remove use of enum for breakpoints (#912) Express: don't automatically put strings in a `<pre>` block (#905) Deprecate `nav()` in favor of `nav_panel()` (#876) chore: Remove unused import refactor(layout_column_wrap): Use helper for wrapping children (#910) fix(layout_columns): Don't apply fillable class to layout container (#909) Add output to React template (#908) fix(layout_columns): Add missing `bslib-mb-spacing` class (#906) Custom component template updates (#874) fix(layout_columns): If the breakpoint name is an enum, need to collect the value (#902) chore: exclude `_dev/` folder (#897) feat: Add `ui.layout_columns()` (#856) Update VS Code settings file Express: change default page function to page_fixed (#892) Better messages for `AttributeError` in Shiny Express (#888) Fix 0.6.0 release date Fix failing express tests (#887) Explain why function is called twice ...
schloerke
added a commit
that referenced
this pull request
Dec 19, 2023
* main: (76 commits) Add shiny/templates to MANIFEST.in files (#926) docs: Function Reference Proofreads (#919) Fix failing deploy tests (#925) Add GitHub sources to shiny create Make changelog styling more consistent Function reference edits (#857) docs: Use definition lists for parameter descriptions to enable full markdown support (#901) docs(layout_columns): Add example app (#903) fix(layout_columns): Remove use of enum for breakpoints (#912) Express: don't automatically put strings in a `<pre>` block (#905) Deprecate `nav()` in favor of `nav_panel()` (#876) chore: Remove unused import refactor(layout_column_wrap): Use helper for wrapping children (#910) fix(layout_columns): Don't apply fillable class to layout container (#909) Add output to React template (#908) fix(layout_columns): Add missing `bslib-mb-spacing` class (#906) Custom component template updates (#874) fix(layout_columns): If the breakpoint name is an enum, need to collect the value (#902) chore: exclude `_dev/` folder (#897) feat: Add `ui.layout_columns()` (#856) ...
schloerke
added a commit
that referenced
this pull request
Dec 19, 2023
* main: (36 commits) Add shiny/templates to MANIFEST.in files (#926) docs: Function Reference Proofreads (#919) Fix failing deploy tests (#925) Add GitHub sources to shiny create Make changelog styling more consistent Function reference edits (#857) docs: Use definition lists for parameter descriptions to enable full markdown support (#901) docs(layout_columns): Add example app (#903) fix(layout_columns): Remove use of enum for breakpoints (#912) Express: don't automatically put strings in a `<pre>` block (#905) Deprecate `nav()` in favor of `nav_panel()` (#876) chore: Remove unused import refactor(layout_column_wrap): Use helper for wrapping children (#910) fix(layout_columns): Don't apply fillable class to layout container (#909) Add output to React template (#908) fix(layout_columns): Add missing `bslib-mb-spacing` class (#906) Custom component template updates (#874) fix(layout_columns): If the breakpoint name is an enum, need to collect the value (#902) chore: exclude `_dev/` folder (#897) feat: Add `ui.layout_columns()` (#856) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It turns out that using an enum is over-engineering and annoying as a user. With an enum the following code gives a type warning
because
"md"isn't literally theBreakpoints.mdvalue. Unless I'm missing something, you'd have to useassuming we export
Breakpoints. Currently you'd have toui._layout_columns.Breakpoints.md.value, which is just too much.This PR goes back to a typed
Breakpointsliteral type and adds abs_breakpoints()helper function.