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

Refactor ReactiveHTML docs #5448

Merged
merged 29 commits into from
Jan 20, 2024
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
c2d2c50
start reactive-html docs refactor
Aug 26, 2023
3bbbcb1
minor fixes
Aug 26, 2023
90d694f
more reactive html docs
Aug 27, 2023
f0846cf
more ReactiveHTML docs refactor
Aug 28, 2023
3b145cd
work on reactive html docs
Aug 30, 2023
437c8e8
add reactivehtml dataframe how to
Aug 31, 2023
ca1a44b
add reactivehtml panes
Sep 1, 2023
67ad253
wip
Sep 7, 2023
bd53e0e
wip reactivehtml docs
Sep 8, 2023
f7dcf62
wip reactivehtml docs
Sep 10, 2023
4a7843d
reactivehtml - loop with .doc
Sep 10, 2023
ca5e535
add _dom_events description
Sep 10, 2023
6e05969
update reactive_html_components
MarcSkovMadsen Sep 23, 2023
0f48349
fix after read
MarcSkovMadsen Sep 23, 2023
26a0ae8
fix test issues
MarcSkovMadsen Sep 23, 2023
f5d9f1b
fix test issues
MarcSkovMadsen Sep 23, 2023
37be2ac
test examples
MarcSkovMadsen Sep 23, 2023
c2c9530
add missing links
MarcSkovMadsen Sep 23, 2023
905c8b7
Merge branch 'main' of https://github.com/holoviz/panel into enhancem…
MarcSkovMadsen Sep 23, 2023
4396451
fix resolve issue
MarcSkovMadsen Sep 23, 2023
78423a6
add anywidget comparison
MarcSkovMadsen Sep 23, 2023
a004366
remove failing description
MarcSkovMadsen Sep 23, 2023
3e938b1
make links work. improve
MarcSkovMadsen Sep 24, 2023
e78c722
comment on react etc.
MarcSkovMadsen Sep 24, 2023
3471493
fix cards layout
MarcSkovMadsen Sep 24, 2023
a99bad6
fix reactivehtml issues
MarcSkovMadsen Sep 25, 2023
5f5e330
Update doc/explanation/components/reactive_html_components.md
MarcSkovMadsen Jan 14, 2024
6976b72
apply feedback from thomascsantos
MarcSkovMadsen Jan 14, 2024
c3f4be7
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 20, 2024
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
391 changes: 0 additions & 391 deletions doc/explanation/components/components_custom.md

This file was deleted.

635 changes: 635 additions & 0 deletions doc/explanation/components/reactive_html_components.md

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions doc/explanation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@ Learn the pros and cons of Panel's different APIs.
::::{grid} 1 2 2 3
:gutter: 1 1 1 2

:::{grid-item-card} {octicon}`rows;2.5em;sd-mr-1 sd-animate-grow50` Components overview
:::{grid-item-card} {octicon}`rows;2.5em;sd-mr-1 sd-animate-grow50` Built in components
:link: components/components_overview
:link-type: doc

Deepen your understanding about Panel's visible objects and layout types.
Deepen your understanding about Panel's built in components.
:::

:::{grid-item-card} {octicon}`plus-circle;2.5em;sd-mr-1 sd-animate-grow50` Custom components
:link: components/components_custom
:::{grid-item-card} {octicon}`plus-circle;2.5em;sd-mr-1 sd-animate-grow50` ReactiveHTML components
:link: components/reactive_html_components
:link-type: doc

Deepen your understanding about building custom Panel components.
Deepen your understanding about custom `ReactiveHTML` components
:::

::::
Expand Down
182 changes: 0 additions & 182 deletions doc/how_to/custom_components/custom_reactiveHTML.md

This file was deleted.

103 changes: 84 additions & 19 deletions doc/how_to/custom_components/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I feel like this "big" topic of custom components and ReactiveHTML is very much hidden because its several clicks down

image

Also I believe that it would make navigation easier of the sections and cards where aligned as much as possible between how-to and explanation pages. That would make navigation easier as you don't have to remember seperately where to find ReactiveHTML components material for how-to guides and for explanation.

image

Copy link
Collaborator Author

@MarcSkovMadsen MarcSkovMadsen Sep 24, 2023

Choose a reason for hiding this comment

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

I would recommend restructering the how-to navigation by having a Components section and moving the following cards there

  • construct components
  • arrange components
  • style components
  • build custom components

Copy link
Member

Choose a reason for hiding this comment

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

Sounds reasonable to me.

These How-to pages provide solutions for common tasks related to extending Panel with custom components.

## `Viewer` Components

Build custom components by combining existing components.

::::{grid} 1 2 2 3
:gutter: 1 1 1 2

Expand All @@ -12,20 +16,97 @@ These How-to pages provide solutions for common tasks related to extending Panel
How to build custom components that are combinations of existing components.
:::

:::{grid-item-card} {octicon}`plus-circle;2.5em;sd-mr-1 sd-animate-grow50` Build Components from Scratch
:link: custom_reactiveHTML
::::

## `ReactiveHTML` Components
MarcSkovMadsen marked this conversation as resolved.
Show resolved Hide resolved

Build custom components using HTML, CSS and Javascript and without Javascript build tools.

::::{grid} 1 2 2 3
:gutter: 1 1 1 2

:::{grid-item-card} {octicon}`columns-2;2.5em;sd-mr-1 sd-animate-grow50` Layouts
:link: reactive_html/reactive_html_layout
:link-type: doc

How to create layouts using `ReactiveHTML`
:::

:::{grid-item-card} {octicon}`brush;2.5em;sd-mr-1 sd-animate-grow50` Styling
:link: reactive_html/reactive_html_styling
:link-type: doc

How to style `ReactiveHTML` components
:::

:::{grid-item-card} {octicon}`image;2.5em;sd-mr-1 sd-animate-grow50` Panes
:link: reactive_html/reactive_html_panes
:link-type: doc

How to build custom components from scratch.
How to create panes using `ReactiveHTML`
:::

:::{grid-item-card} {octicon}`issue-draft;2.5em;sd-mr-1 sd-animate-grow50` Indicators
:link: reactive_html/reactive_html_indicators
:link-type: doc

How to create indicators using `ReactiveHTML`
:::

:::{grid-item-card} {octicon}`bolt;2.5em;sd-mr-1 sd-animate-grow50` Callbacks
:link: reactive_html/reactive_html_callbacks
:link-type: doc

How to add Python and JS callbacks to `ReactiveHTML`
:::

:::{grid-item-card} {octicon}`select;2.5em;sd-mr-1 sd-animate-grow50` Widgets
:link: reactive_html/reactive_html_widgets
:link-type: doc

How to create input widgets using `ReactiveHTML`
:::

:::{grid-item-card} {octicon}`border-all;2.5em;sd-mr-1 sd-animate-grow50` DataFrame
:link: reactive_html/reactive_html_dataframe
:link-type: doc

How to create components using `ReactiveHTML` and a DataFrame parameter
:::

::::

```{toctree}
:titlesonly:
:hidden:
:maxdepth: 2

reactive_html_layout
reactive_html_styling
reactive_html_widgets
```

## Examples

::::{grid} 1 2 2 3
:gutter: 1 1 1 2

:::{grid-item-card} Build a Plot Viewer
:img-top: https://assets.holoviz.org/panel/how_to/custom_components/plot_viewer.png
:link: examples/plot_viewer
:link-type: doc

Build a custom component wrapping a bokeh plot and some widgets using the `Viewer` pattern.
:::

:::{grid-item-card} Build a Table Viewer
:img-top: https://assets.holoviz.org/panel/how_to/custom_components/table_viewer.png
:link: examples/table_viewer
:link-type: doc

Build a custom component wrapping a table and some widgets using the `Viewer` pattern.
:::

:::{grid-item-card} Build a Canvas component
:img-top: https://assets.holoviz.org/panel/how_to/custom_components/canvas_draw.png
:link: examples/canvas_draw
Expand Down Expand Up @@ -58,22 +139,6 @@ Build custom components wrapping material UI using `ReactiveHTML`.
Build custom component wrapping a Vue.js app using `ReactiveHTML`.
:::

:::{grid-item-card} Build a Plot Viewer
:img-top: https://assets.holoviz.org/panel/how_to/custom_components/plot_viewer.png
:link: examples/plot_viewer
:link-type: doc

Build custom component wrapping a bokeh plot and some widgets using the `Viewer` pattern.
:::

:::{grid-item-card} Build a Table Viewer
:img-top: https://assets.holoviz.org/panel/how_to/custom_components/table_viewer.png
:link: examples/table_viewer
:link-type: doc

Build custom component wrapping a table and some widgets using the `Viewer` pattern.
:::

::::

```{toctree}
Expand Down
Loading
Loading