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.

Sign up for GitHub

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

update sidebar structure #318

Merged
merged 5 commits into from
Nov 29, 2023
Merged

update sidebar structure #318

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
756a7c3
update sidebar structure
Nov 17, 2023
3ff3f01
fix conflicts
Nov 28, 2023
28a93e1
minor bug fix
Nov 28, 2023
c575db6
minor naming change
Nov 29, 2023
11a3b67
minor naming change2
Nov 29, 2023
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
125 changes: 93 additions & 32 deletions pcweb/components/sidebar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,17 +122,11 @@ def get_sidebar_items_learn():
return items


def get_sidebar_items_concepts():
def get_sidebar_items_frontend():
from pcweb.pages.docs import (
advanced_guide,
components,
database,
hosting,
state,
styling,
wrapping_react,
)

items = [
create_item(
components,
Expand All @@ -144,6 +138,25 @@ def get_sidebar_items_concepts():
components.library,
],
),
create_item(
styling,
children=[
styling.styling_overview,
styling.responsive,
styling.custom_stylesheets,
styling.theming,
],
),
]
return items

def get_sidebar_items_backend():
from pcweb.pages.docs import (
state,
database,
)

items = [
create_item(
state,
children=[
Expand All @@ -154,15 +167,6 @@ def get_sidebar_items_concepts():
state.utility_methods,
],
),
create_item(
styling,
children=[
styling.styling_overview,
styling.responsive,
styling.custom_stylesheets,
styling.theming,
],
),
create_item(
database,
children=[
Expand All @@ -172,6 +176,17 @@ def get_sidebar_items_concepts():
database.relationships,
],
),
]
return items

def get_sidebar_items_other():
from pcweb.pages.docs import (
advanced_guide,
hosting,
wrapping_react,
)

items = [
create_item(
hosting,
children=[
Expand Down Expand Up @@ -343,7 +358,7 @@ def sidebar_item_comp(
rx.text(
item.names,
font_family=styles.SANS,
font_weight="600",
font_weight="500",
),
_hover={
"color": styles.ACCENT_COLOR,
Expand Down Expand Up @@ -394,13 +409,15 @@ def calculate_index(sidebar_items, url):


learn = get_sidebar_items_learn()
concepts = get_sidebar_items_concepts()
reference = get_sidebar_items_reference()
frontend = get_sidebar_items_frontend()
backend = get_sidebar_items_backend()
other = get_sidebar_items_other()


def get_prev_next(url):
"""Get the previous and next links in the sidebar."""
sidebar_items = learn + concepts + reference
sidebar_items = learn + frontend + backend + other + reference
# Flatten the list of sidebar items
flat_items = []

Expand Down Expand Up @@ -432,8 +449,10 @@ def append_to_items(items):
def sidebar_comp(
url: str,
learn_index: list[int],
concepts_index: list[int],
reference_index: list[int],
frontend_index: list[int],
backend_index: list[int],
other_index: list[int],
):
from pcweb.pages.docs.gallery import gallery

Expand Down Expand Up @@ -468,7 +487,7 @@ def sidebar_comp(
rx.tab_panel(
rx.heading(
rx.span("[ ", color="#DACEEE"),
"Learn",
"Onboarding",
rx.span(" ]", color="#DACEEE"),
style=heading_style3,
),
Expand All @@ -486,9 +505,31 @@ def sidebar_comp(
default_index=learn_index if learn_index is not None else [],
width="100%",
),

rx.heading(
rx.span("[ ", color="#DACEEE"),
"Frontend",
rx.span(" ]", color="#DACEEE"),
style=heading_style3,
margin_top="1em",
),
rx.accordion(
*[
sidebar_item_comp(
item=item,
index=[-1],
url=url,
first=True,
)
for item in frontend
],
allow_multiple=True,
default_index=frontend_index if frontend_index is not None else [],
),

rx.heading(
rx.span("[ ", color="#DACEEE"),
"Concepts",
"Backend",
rx.span(" ]", color="#DACEEE"),
style=heading_style3,
margin_top="1em",
Expand All @@ -501,12 +542,31 @@ def sidebar_comp(
url=url,
first=True,
)
for item in concepts
for item in backend
],
allow_multiple=True,
default_index=concepts_index
if concepts_index is not None
else [],
default_index=backend_index if backend_index is not None else [],
),

rx.heading(
rx.span("[ ", color="#DACEEE"),
"Other",
rx.span(" ]", color="#DACEEE"),
style=heading_style3,
margin_top="1em",
),
rx.accordion(
*[
sidebar_item_comp(
item=item,
index=[-1],
url=url,
first=True,
)
for item in other
],
allow_multiple=True,
default_index=other_index if other_index is not None else [],
),
padding_x="0em",
width="100%",
Expand All @@ -520,9 +580,7 @@ def sidebar_comp(
for item in reference
],
allow_multiple=True,
default_index=reference_index
if reference_index is not None
else [],
default_index=reference_index if reference_index is not None else [],
),
padding_x="0em",
width="100%",
Expand Down Expand Up @@ -550,15 +608,18 @@ def sidebar_comp(
def sidebar(url=None) -> rx.Component:
"""Render the sidebar."""
learn_index = calculate_index(learn, url)
concepts_index = calculate_index(concepts, url)
reference_index = calculate_index(reference, url)

frontend_index = calculate_index(frontend, url)
backend_index = calculate_index(backend, url)
other_index = calculate_index(other, url)
return rx.box(
sidebar_comp(
url=url,
learn_index=learn_index,
concepts_index=concepts_index,
reference_index=reference_index,
frontend_index=frontend_index,
backend_index=backend_index,
other_index=other_index,
),
)

Expand Down