@local-civics/hub-ui 0.1.208 → 0.1.209

package/dist/index.d.ts

@@ -456,6 +456,11 @@ type CardProps = {
  */
 declare const Card: (props: CardProps) => JSX.Element;
 
+/**
+ * A component for the page footer.
+ */
+declare const Footer: () => JSX.Element;
+
 /**
  * Home
  * @constructor
@@ -879,6 +884,40 @@ type LogServiceButtonProps = {
  */
 declare const LogServiceButton: (props: LogServiceButtonProps) => JSX.Element;
 
+/**
+ * The name of a sidebar tab.
+ */
+type SidebarTabName = "profile" | "pathways" | "badges" | "file-locker" | "transcript" | "portfolio";
+/**
+ * A tab's live destination. Tabs with no entry here render disabled.
+ */
+type SidebarLinks = Partial<Record<SidebarTabName, {
+    href: string;
+}>>;
+/**
+ * The signed-in student shown above the nav.
+ */
+type SidebarIdentity = {
+    avatarURL?: string;
+    name: string;
+    subtitle?: string;
+};
+/**
+ * The properties for the sidebar.
+ */
+type SidebarProps = {
+    active?: SidebarTabName;
+    links: SidebarLinks;
+    identity?: SidebarIdentity;
+    settingsHref?: string;
+    disabled?: boolean;
+    onLogout?: () => void;
+};
+/**
+ * A component for navigating between the student's home page sections.
+ */
+declare const Sidebar: (props: SidebarProps) => JSX.Element;
+
 /**
  * StopwatchProps
  */
@@ -1091,8 +1130,9 @@ declare const PathwayButton: (props: PathwayButtonProps) => JSX.Element;
 type AuthLayoutProps = {
     isLoading?: boolean;
     pathname?: string;
-    page?: "profile" | "explore" | "calendar";
+    page?: "profile";
     disabled?: boolean;
+    topNav?: boolean;
     header?: React__default.ReactNode;
     subheader?: React__default.ReactNode;
     sidebar?: React__default.ReactNode;
@@ -1101,12 +1141,7 @@ type AuthLayoutProps = {
     children?: React__default.ReactNode;
     onHome?: () => void;
     onProfile?: () => void;
-    onExplore?: () => void;
-    onCalendar?: () => void;
     onLogout?: () => void;
-    onFAQ?: () => void;
-    onPrivacy?: () => void;
-    onTerms?: () => void;
     onSwitchAccount?: () => void;
 };
 /**
@@ -1136,4 +1171,24 @@ type HomeLayoutProps = {
  */
 declare const HomeLayout: (props: HomeLayoutProps) => JSX.Element;
 
-export { AboutWidget, AboutWidgetProps, AchievementWidget, AchievementWidgetProps, ActivityCard, ActivityCardProps, ActivityItem, ActivityItemProps, ActivityList, ActivityListProps, ActivityReflection, ActivityReflectionProps, AuthLayout, AuthLayoutProps, Badge, BadgeActivityMenu, BadgeActivityMenuProps, BadgeFilterOption, BadgeProps, BadgeSection, BadgeSectionProps, BadgeSuccessDialog, BadgeSuccessDialogProps, Board, BoardProps, Button, ButtonBorder, ButtonColor, ButtonFilter, ButtonJustify, ButtonProps, ButtonSize, ButtonSpacing, ButtonTheme, Card, CardProps, CtaListProps, DateSelection, DateSelectionProps, DaySelectionOptionProps, EventItem, EventItemProps, EventList, EventListProps, Home, HomeLayout, HomeLayoutProps, Icon, IconName, IconProps, ImpactWidget, ImpactWidgetProps, LearningForm, LearningFormProps, Loader, LoaderProps, LogServiceButton, LogServiceButtonProps, Logo, Modal, ModalProps, NavBar, NavBarProps, NavLink, NavLinkName, NavLinkProps, NotFound, NotFoundProps, Onboarding, OnboardingProps, Overlay, OverlayProps, Pathway, PathwayButton, PathwayButtonProps, PathwayFilter, PathwayFilterOption, PathwayFilterProps, PathwayProgress, PathwayProgressHeight, PathwayProgressProps, PathwayProps, PathwaySection, PathwaySectionProps, PathwayWidget, PathwayWidgetProps, ProfileWidget, Progress, ProgressProps, ResidentWidgetProps, Search, SearchButton, SearchButtonProps, SearchProps, SearchResult, SearchResultProps, SettingsCard, SettingsCardProps, Stopwatch, StopwatchProps, Tab, TabProps, TagFilter, TagFilterProps, TaskItem, TaskItemProps, TaskList, TaskListProps, Widget, WidgetBody, WidgetBodyProps, WidgetHeader, WidgetHeaderLink, WidgetHeaderLinkProps, WidgetHeaderProps, WidgetProps, WidgetTitle, WidgetTitleProps };
+/**
+ * SidebarLayoutProps
+ */
+type SidebarLayoutProps = Omit<AuthLayoutProps, "sidebar" | "children" | "topNav" | "page" | "onProfile"> & {
+    active?: SidebarTabName;
+    links: SidebarLinks;
+    identity?: SidebarIdentity;
+    settingsHref?: string;
+    sidebarExtra?: React__default.ReactNode;
+};
+/**
+ * SidebarLayout
+ *
+ * AuthLayout with the student home-page Sidebar pre-wired into its sidebar slot.
+ * Reused by every page that adopts the new left nav, not just one page - the
+ * caller still supplies header/subheader/main the same way it would for AuthLayout directly.
+ * @constructor
+ */
+declare const SidebarLayout: (props: SidebarLayoutProps) => JSX.Element;
+
+export { AboutWidget, AboutWidgetProps, AchievementWidget, AchievementWidgetProps, ActivityCard, ActivityCardProps, ActivityItem, ActivityItemProps, ActivityList, ActivityListProps, ActivityReflection, ActivityReflectionProps, AuthLayout, AuthLayoutProps, Badge, BadgeActivityMenu, BadgeActivityMenuProps, BadgeFilterOption, BadgeProps, BadgeSection, BadgeSectionProps, BadgeSuccessDialog, BadgeSuccessDialogProps, Board, BoardProps, Button, ButtonBorder, ButtonColor, ButtonFilter, ButtonJustify, ButtonProps, ButtonSize, ButtonSpacing, ButtonTheme, Card, CardProps, CtaListProps, DateSelection, DateSelectionProps, DaySelectionOptionProps, EventItem, EventItemProps, EventList, EventListProps, Footer, Home, HomeLayout, HomeLayoutProps, Icon, IconName, IconProps, ImpactWidget, ImpactWidgetProps, LearningForm, LearningFormProps, Loader, LoaderProps, LogServiceButton, LogServiceButtonProps, Logo, Modal, ModalProps, NavBar, NavBarProps, NavLink, NavLinkName, NavLinkProps, NotFound, NotFoundProps, Onboarding, OnboardingProps, Overlay, OverlayProps, Pathway, PathwayButton, PathwayButtonProps, PathwayFilter, PathwayFilterOption, PathwayFilterProps, PathwayProgress, PathwayProgressHeight, PathwayProgressProps, PathwayProps, PathwaySection, PathwaySectionProps, PathwayWidget, PathwayWidgetProps, ProfileWidget, Progress, ProgressProps, ResidentWidgetProps, Search, SearchButton, SearchButtonProps, SearchProps, SearchResult, SearchResultProps, SettingsCard, SettingsCardProps, Sidebar, SidebarIdentity, SidebarLayout, SidebarLayoutProps, SidebarLinks, SidebarProps, SidebarTabName, Stopwatch, StopwatchProps, Tab, TabProps, TagFilter, TagFilterProps, TaskItem, TaskItemProps, TaskList, TaskListProps, Widget, WidgetBody, WidgetBodyProps, WidgetHeader, WidgetHeaderLink, WidgetHeaderLinkProps, WidgetHeaderProps, WidgetProps, WidgetTitle, WidgetTitleProps };