Skip to content

Commit 67cfc70

Browse files
authored
Merge pull request #2118 from immutable-js/sidebar-v5
2 parents f156f14 + 1d6fd8f commit 67cfc70

28 files changed

+367
-125
lines changed

website/src/app/browser-extension/page.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { Metadata } from 'next';
22
import { DocSearch } from '../../DocSearch';
3-
import { SideBar } from '../../Sidebar';
3+
import { Sidebar } from '../../sidebar';
44

55
export async function generateMetadata(): Promise<Metadata> {
66
return {
@@ -13,7 +13,7 @@ export default async function BrowserExtensionPage() {
1313

1414
return (
1515
<>
16-
<SideBar />
16+
<Sidebar />
1717
<div key="Overview" className="docContents">
1818
<DocSearch />
1919

website/src/Defs.tsx renamed to website/src/app/docs/[version]/Defs.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export function CallSigDef({
9696
);
9797
}
9898

99-
export function TypeDef({ type, prefix }: { type: Type; prefix?: number }) {
99+
function TypeDef({ type, prefix }: { type: Type; prefix?: number }) {
100100
switch (type.k) {
101101
case TypeKind.Never:
102102
return wrap('primitive', 'never');

website/src/DocOverview.tsx renamed to website/src/app/docs/[version]/DocOverview.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import Link from 'next/link';
2-
import { MarkdownContent } from './MarkdownContent';
2+
import { MarkdownContent } from '../../../MarkdownContent';
33
import type { TypeDefs, TypeDoc } from './TypeDefs';
44

5-
export type OverviewData = {
5+
type OverviewData = {
66
doc: TypeDoc | null;
77
api: Array<APIMember>;
88
};

website/src/MemberDoc.tsx renamed to website/src/app/docs/[version]/MemberDoc.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Link from 'next/link';
22
import { Fragment } from 'react';
33
import { CallSigDef, MemberDef } from './Defs';
4-
import { MarkdownContent } from './MarkdownContent';
4+
import { MarkdownContent } from '../../../MarkdownContent';
55
import type { MemberDefinition } from './TypeDefs';
66

77
export function MemberDoc({ member }: { member: MemberDefinition }) {

website/src/Sidebar.tsx renamed to website/src/app/docs/[version]/SidebarV4.tsx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@ import Link from 'next/link';
44
import { Fragment, useEffect, useState } from 'react';
55
import type { TypeDefinition } from './TypeDefs';
66
import { collectMemberGroups } from './collectMemberGroups';
7-
import { ArrowDown } from './ArrowDown';
8-
import { SIDEBAR_LINKS } from './app/docs/currentVersion';
9-
10-
export type SidebarLinks = Array<{ label: string; url: string }>;
7+
import { ArrowDown } from '../../../ArrowDown';
8+
import { SIDEBAR_LINKS } from '../currentVersion';
9+
import { SidebarLinks } from '../../../sidebar';
1110

1211
function Links({
1312
links,
@@ -130,7 +129,7 @@ function Focus({
130129
);
131130
}
132131

133-
export function SideBar({
132+
export function SideBarV4({
134133
links = SIDEBAR_LINKS,
135134
focus,
136135
toggleShowInherited,
File renamed without changes.

website/src/TypeDocumentation.tsx renamed to website/src/app/docs/[version]/[type]/TypeDocumentation.tsx

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22

33
import { Fragment, useReducer } from 'react';
44

5-
import { InterfaceDef, CallSigDef } from './Defs';
6-
import { SideBar, SidebarLinks } from './Sidebar';
7-
import { MemberDoc } from './MemberDoc';
8-
import { MarkdownContent } from './MarkdownContent';
9-
import { collectMemberGroups } from './collectMemberGroups';
10-
import type { TypeDefinition, MemberDefinition } from './TypeDefs';
11-
import { DocSearch } from './DocSearch';
5+
import { InterfaceDef, CallSigDef } from '../Defs';
6+
import { SidebarLinks } from '../../../../sidebar';
7+
import { SideBarV4 } from '../SidebarV4';
8+
import { MemberDoc } from '../MemberDoc';
9+
import { MarkdownContent } from '../../../../MarkdownContent';
10+
import { collectMemberGroups } from '../collectMemberGroups';
11+
import type { TypeDefinition, MemberDefinition } from '../TypeDefs';
12+
import { DocSearch } from '../../../../DocSearch';
1213

1314
const typeDefURL =
1415
'https://github.com/immutable-js/immutable-js/blob/main/type-definitions/immutable.d.ts';
@@ -46,7 +47,7 @@ export function TypeDocumentation({
4647

4748
return (
4849
<>
49-
<SideBar
50+
<SideBarV4
5051
links={sidebarLinks}
5152
focus={def}
5253
toggleShowInherited={toggleShowInherited}

website/src/app/docs/[version]/[type]/page.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import { getSidebarLinks } from '../../../../getSidebarLinks';
2-
import { getTypeDefs } from '../../../../static/getTypeDefs';
1+
import { getSidebarLinks } from '../getSidebarLinks';
2+
import { getTypeDefs } from '../getTypeDefs';
33
import { getVersionFromGitTag } from '../../../../static/getVersions';
4-
import { TypeDocumentation } from '../../../../TypeDocumentation';
5-
import { getVersionFromParams } from '../../../getVersionFromParams';
4+
import { TypeDocumentation } from './TypeDocumentation';
5+
import { getVersionFromParams } from '../getVersionFromParams';
66
import { VERSION } from '../../currentVersion';
77

88
export async function generateStaticParams() {

website/src/getSidebarLinks.tsx renamed to website/src/app/docs/[version]/getSidebarLinks.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type { TypeDefs } from './TypeDefs';
2-
import { SidebarLinks } from './Sidebar';
2+
import { SidebarLinks } from '../../../sidebar';
33

44
export function getSidebarLinks(defs: TypeDefs): SidebarLinks {
55
return Object.values(defs.types).map(({ label, url }) => ({ label, url }));

0 commit comments

Comments
 (0)