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

docs(layout_columns): Add example app #903

Merged
merged 6 commits into from
Dec 18, 2023
Merged

Conversation

gadenbuie
Copy link
Collaborator

@gadenbuie gadenbuie commented Dec 12, 2023

Fixes #898

Adds an example app for ui.layout_columns()

image

Comment on lines 40 to 53
card_loss = ui.card(
ui.card_header("Loss Over Time"),
ui.output_plot("loss_over_time"),
)

card_acc = ui.card(
ui.card_header("Accuracy Over Time"),
ui.output_plot("accuracy_over_time"),
)

card_feat = ui.card(
ui.card_header("Feature Importance"),
ui.output_plot("feature_importance"),
)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe worth adding full_screen = True?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It'll also be interesting to see how this example renders in the docs, I'm specifically curious whether the viewer will have a height large enough to make this a good experience. Partially for that reason, we may want to turn down the heights on the plots (or maybe use page_fillable()?) and/or tweak shinylive's viewer height?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, I'm also worried about how this will render in the docs. It's hard to know in advance; I don't think I can preview it locally. I specifically used page_fluid() because of this; in very small containers, like the docs, page_fillable() will squish the plots and cards to be too small.

So that they effect is visible in the inline preview
@gadenbuie
Copy link
Collaborator Author

It turns out that the examples in the docs are below the md breakpoint, so I set col_widths={"sm": (5, 7, 12)} so that the layout is activated.

This revealed the issue that will be resolved by #912.

@cpsievert feel free to merge #912 and then this PR tomorrow.

@cpsievert cpsievert merged commit 8ad1817 into main Dec 18, 2023
26 checks passed
@cpsievert cpsievert deleted the examples/layout-columns branch December 18, 2023 15:30
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ui.layout_columns() example
2 participants