From ec43c184fe6406e6622807e691ad578965ab3628 Mon Sep 17 00:00:00 2001
From: Suneet Tipirneni <77477100+suneettipirneni@users.noreply.github.com>
Date: Thu, 28 Jul 2022 10:26:06 -0400
Subject: [PATCH] feat(website): add icons for sections (#8377)

* feat(website): add icons for sections

* chore: make requested changes

* fix: add icon for function parameters
---
 .../website/src/components/DocContainer.tsx   | 10 ++-
 .../website/src/components/ListSidebar.tsx    | 88 ++++++++-----------
 packages/website/src/components/Section.tsx   | 32 ++++---
 packages/website/src/components/Sections.tsx  |  7 +-
 .../website/src/components/model/Enum.tsx     |  3 +-
 5 files changed, 70 insertions(+), 70 deletions(-)

diff --git a/packages/website/src/components/DocContainer.tsx b/packages/website/src/components/DocContainer.tsx
index fada37bbe..381cc591d 100644
--- a/packages/website/src/components/DocContainer.tsx
+++ b/packages/website/src/components/DocContainer.tsx
@@ -1,4 +1,5 @@
 import type { ReactNode } from 'react';
+import { VscListSelection, VscSymbolParameter } from 'react-icons/vsc';
 import { PrismAsyncLight as SyntaxHighlighter } from 'react-syntax-highlighter';
 import { vscDarkPlus } from 'react-syntax-highlighter/dist/cjs/styles/prism';
 import { CodeListingSeparatorType } from './CodeListing';
@@ -48,11 +49,16 @@ export function DocContainer({ name, kind, excerpt, summary, typeParams, childre
 					</div>
 				) : null}
 				<div className="space-y-10">
-					<Section title="Summary" className="dark:text-white">
+					<Section iconElement={<VscListSelection />} title="Summary" className="dark:text-white">
 						<p className="text-dark-100 dark:text-gray-300 m-0">{summary ?? 'No summary provided.'}</p>
 					</Section>
 					{typeParams?.length ? (
-						<Section title="Type Parameters" className="dark:text-white" defaultClosed>
+						<Section
+							iconElement={<VscSymbolParameter />}
+							title="Type Parameters"
+							className="dark:text-white"
+							defaultClosed
+						>
 							<TypeParamTable data={typeParams} />
 						</Section>
 					) : null}
diff --git a/packages/website/src/components/ListSidebar.tsx b/packages/website/src/components/ListSidebar.tsx
index fe81bdd2d..0a6408045 100644
--- a/packages/website/src/components/ListSidebar.tsx
+++ b/packages/website/src/components/ListSidebar.tsx
@@ -1,8 +1,14 @@
-import { AnimatePresence, motion } from 'framer-motion';
 import Link from 'next/link';
-import { useState } from 'react';
-import { VscChevronDown, VscChevronRight } from 'react-icons/vsc';
+import {
+	VscSymbolClass,
+	VscSymbolEnum,
+	VscSymbolField,
+	VscSymbolInterface,
+	VscSymbolMethod,
+	VscSymbolVariable,
+} from 'react-icons/vsc';
 import type { ItemListProps } from './ItemSidebar';
+import { Section } from './Section';
 
 export type Members = ItemListProps['data']['members'];
 
@@ -57,39 +63,32 @@ function groupMembers(members: Members): GroupedMembers {
 	return { Classes, Functions, Enums, Interfaces, Types, Variables };
 }
 
-export function ListSidebarSection({ members, selectedMember, title }: ListSidebarSectionProps) {
-	const [showList, setShowList] = useState(true);
+function resolveIcon(item: keyof GroupedMembers) {
+	switch (item) {
+		case 'Classes':
+			return <VscSymbolClass />;
+		case 'Enums':
+			return <VscSymbolEnum />;
+		case 'Interfaces':
+			return <VscSymbolInterface />;
+		case 'Types':
+			return <VscSymbolField />;
+		case 'Variables':
+			return <VscSymbolVariable />;
+		case 'Functions':
+			return <VscSymbolMethod />;
+	}
+}
+
+export function ListSidebar({ members, selectedMember }: ListSidebarSectionProps) {
+	const groupItems = groupMembers(members);
 
 	return (
-		<div>
-			<h3
-				className="flex items-center dark:text-white m-0 py-3 font-semibold gap-2 cursor-pointer"
-				onClick={() => setShowList(!showList)}
-			>
-				{showList ? <VscChevronDown size={20} /> : <VscChevronRight size={20} />}
-				{title}
-			</h3>
-			<AnimatePresence exitBeforeEnter initial={false}>
-				{showList ? (
-					<motion.div
-						className="ml-7 space-y-3"
-						transition={{ duration: 0.5, ease: [0.04, 0.62, 0.23, 0.98] }}
-						key="content"
-						initial="collapsed"
-						animate="open"
-						exit="collapsed"
-						variants={{
-							open: {
-								opacity: 1,
-								height: 'auto',
-							},
-							collapsed: {
-								opacity: 0,
-								height: 0,
-							},
-						}}
-					>
-						{members.map((member, i) => (
+		<>
+			{(Object.keys(groupItems) as (keyof GroupedMembers)[]).map((group, i) => (
+				<Section iconElement={resolveIcon(group)} key={i} title={group} showSeparator={false}>
+					<div className="space-y-2">
+						{groupItems[group].map((member, i) => (
 							<div
 								key={i}
 								className="flex gap-2 whitespace-pre-wrap no-underline break-all text-blue-500 dark:text-blue-300"
@@ -107,25 +106,8 @@ export function ListSidebarSection({ members, selectedMember, title }: ListSideb
 								</Link>
 							</div>
 						))}
-					</motion.div>
-				) : null}
-			</AnimatePresence>
-		</div>
-	);
-}
-
-export function ListSidebar({ members, selectedMember }: ListSidebarSectionProps) {
-	const groupItems = groupMembers(members);
-
-	return (
-		<>
-			{Object.keys(groupItems).map((group, i) => (
-				<ListSidebarSection
-					key={i}
-					members={groupItems[group as keyof GroupedMembers]}
-					selectedMember={selectedMember}
-					title={group}
-				/>
+					</div>
+				</Section>
 			))}
 		</>
 	);
diff --git a/packages/website/src/components/Section.tsx b/packages/website/src/components/Section.tsx
index e6c6553e1..f17fab7cb 100644
--- a/packages/website/src/components/Section.tsx
+++ b/packages/website/src/components/Section.tsx
@@ -8,24 +8,35 @@ export interface SectionProps {
 	title: string;
 	className?: string | undefined;
 	defaultClosed?: boolean;
+	iconElement?: JSX.Element;
+	showSeparator?: boolean;
 }
 
-export function Section({ title, children, className, defaultClosed }: SectionProps) {
+export function Section({
+	title,
+	children,
+	className,
+	defaultClosed,
+	iconElement,
+	showSeparator = true,
+}: SectionProps) {
 	const [collapsed, setCollapsed] = useState(defaultClosed ?? false);
 
 	return (
 		<div className={className}>
-			<AnimatePresence initial={false}>
-				<h3
-					className="flex gap-2 whitespace-pre-wrap font-semibold dark:text-white cursor-pointer"
-					onClick={() => setCollapsed(!collapsed)}
-				>
-					{collapsed ? <VscChevronRight size={20} /> : <VscChevronDown size={20} />}
-					{title}
-				</h3>
+			<h3
+				className="flex gap-2 whitespace-pre-wrap font-semibold dark:text-white cursor-pointer"
+				onClick={() => setCollapsed(!collapsed)}
+			>
+				{collapsed ? <VscChevronRight size={20} /> : <VscChevronDown size={20} />}
+				{iconElement ?? null}
+				{title}
+			</h3>
+			<AnimatePresence initial={false} exitBeforeEnter>
 				{collapsed ? null : (
 					<>
 						<motion.div
+							className="ml-7 mb-5"
 							transition={{ duration: 0.5, ease: [0.04, 0.62, 0.23, 0.98] }}
 							key="content"
 							initial="collapsed"
@@ -37,14 +48,13 @@ export function Section({ title, children, className, defaultClosed }: SectionPr
 									height: 'auto',
 									paddingLeft: '1.75rem',
 									paddingRight: '1.75rem',
-									paddingBottom: '2.5rem',
 								},
 								collapsed: { opacity: 0, height: 0, paddingLeft: '1.75rem', paddingRight: '1.75rem', paddingBottom: 0 },
 							}}
 						>
 							{children}
 						</motion.div>
-						<Separator />
+						{showSeparator && <Separator />}
 					</>
 				)}
 			</AnimatePresence>
diff --git a/packages/website/src/components/Sections.tsx b/packages/website/src/components/Sections.tsx
index 93268512d..0ce208fb1 100644
--- a/packages/website/src/components/Sections.tsx
+++ b/packages/website/src/components/Sections.tsx
@@ -1,3 +1,4 @@
+import { VscSymbolConstant, VscSymbolMethod, VscSymbolProperty } from 'react-icons/vsc';
 import { MethodList } from './MethodList';
 import { ParameterTable } from './ParameterTable';
 import { PropertyList } from './PropertyList';
@@ -11,7 +12,7 @@ export interface PropertiesSectionProps {
 
 export function PropertiesSection({ data }: PropertiesSectionProps) {
 	return data.length ? (
-		<Section title="Properties" className="dark:text-white">
+		<Section iconElement={<VscSymbolProperty />} title="Properties" className="dark:text-white">
 			<PropertyList data={data} />
 		</Section>
 	) : null;
@@ -23,7 +24,7 @@ export interface MethodsSectionProps {
 
 export function MethodsSection({ data }: MethodsSectionProps) {
 	return data.length ? (
-		<Section title="Methods" className="dark:text-white">
+		<Section iconElement={<VscSymbolMethod />} title="Methods" className="dark:text-white">
 			<MethodList data={data} />
 		</Section>
 	) : null;
@@ -35,7 +36,7 @@ export interface ParametersSectionProps {
 
 export function ParametersSection({ data }: ParametersSectionProps) {
 	return data.length ? (
-		<Section title="Parameters" className="dark:text-white">
+		<Section iconElement={<VscSymbolConstant />} title="Parameters" className="dark:text-white">
 			<ParameterTable data={data} />
 		</Section>
 	) : null;
diff --git a/packages/website/src/components/model/Enum.tsx b/packages/website/src/components/model/Enum.tsx
index 2e332d9b0..0f668cb96 100644
--- a/packages/website/src/components/model/Enum.tsx
+++ b/packages/website/src/components/model/Enum.tsx
@@ -1,3 +1,4 @@
+import { VscSymbolEnumMember } from 'react-icons/vsc';
 import { CodeListing, CodeListingSeparatorType } from '../CodeListing';
 import { DocContainer } from '../DocContainer';
 import { Section } from '../Section';
@@ -10,7 +11,7 @@ export interface EnumProps {
 export function Enum({ data }: EnumProps) {
 	return (
 		<DocContainer name={data.name} kind={data.kind} excerpt={data.excerpt} summary={data.summary}>
-			<Section title="Members" className="dark:text-white">
+			<Section iconElement={<VscSymbolEnumMember />} title="Members" className="dark:text-white">
 				<div className="flex flex-col gap-5">
 					{data.members.map((member) => (
 						<CodeListing