Skip to content

Commit f676837

Browse files
jderochervlkjderochervlk
committed
more cleanup
1 parent 7d7bbdf commit f676837

17 files changed

+126
-141
lines changed

‎app/routes/MdxRoute.res‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ type loaderData = {
88
blogPost?: BlogApi.post,
99
mdxSources?: array<SyntaxLookup.item>,
1010
activeSyntaxItem?: SyntaxLookup.item,
11+
breadcrumbs?: list<Url.breadcrumb>,
1112
}
1213

1314
/**
@@ -205,11 +206,31 @@ let loader: Loader.t<loaderData> = async ({request}) => {
205206
})
206207
->Array.slice(~start=2) // skip first two entries which are the document entry and the H1 title for the page, we just want the h2 sections
207208

209+
let breadcrumbs =
210+
pathname->String.includes("docs/manual")
211+
? Some(list{
212+
{Url.name: "Docs", href: "/docs/"},
213+
{
214+
Url.name: "Language Manual",
215+
href: "/docs/manual/" ++ "introduction",
216+
},
217+
})
218+
: pathname->String.includes("docs/react")
219+
? Some(list{
220+
{Url.name: "Docs", href: "/docs/"},
221+
{
222+
Url.name: "rescript-react",
223+
href: "/docs/react/" ++ "introduction",
224+
},
225+
})
226+
: None
227+
208228
let res: loaderData = {
209229
__raw: mdx.__raw,
210230
attributes: mdx.attributes,
211231
entries,
212232
categories,
233+
?breadcrumbs,
213234
}
214235

215236
res
@@ -239,7 +260,12 @@ let default = () => {
239260
(pathname :> string)->String.includes("docs/manual") ||
240261
(pathname :> string)->String.includes("docs/react")
241262
) {
242-
<DocsLayout metaTitleCategory categories activeToc={title: "Introduction", entries}>
263+
<DocsLayout
264+
metaTitleCategory
265+
categories
266+
activeToc={title: "Introduction", entries}
267+
breadcrumbs=?loaderData.breadcrumbs
268+
>
243269
<di1v className="markdown-body"> {component()} </di1v>
244270
</DocsLayout>
245271
} else if (pathname :> string)->String.includes("community") {

‎app/routes/MdxRoute.resi‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ type loaderData = {
55
blogPost?: BlogApi.post,
66
mdxSources?: array<SyntaxLookup.item>,
77
activeSyntaxItem?: SyntaxLookup.item,
8+
breadcrumbs?: list<Url.breadcrumb>,
89
}
910

1011
let loader: ReactRouter.Loader.t<loaderData>

‎src/ApiDocs.res‎

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -189,24 +189,18 @@ module SidebarTree = {
189189

190190
let preludeSection =
191191
<div className="flex justify-between text-fire font-medium items-baseline">
192-
{switch url {
193-
| Some(url) =>
194-
let version = url->Url.getVersionString
195-
196-
<VersionSelect version={"v12"} availableVersions=["v12", "older versions"] />
197-
198-
| None => React.null
199-
}}
192+
<VersionSelect />
200193
</div>
201194

202195
<div
196+
id="sidebar"
203197
className={(
204198
isOpen ? "fixed w-full left-0 h-full z-20 min-w-320" : "hidden "
205-
) ++ " md:block md:w-48 md:-ml-4 lg:w-1/5 md:h-auto md:relative overflow-y-visible bg-white"}
199+
) ++ " md:block md:w-48 md:-ml-4 lg:w-1/5 h-auto md:relative overflow-y-visible bg-white mt-28 md:mt-0"}
206200
>
207201
<aside
208-
id="sidebar-content"
209-
className="relative top-0 px-4 w-full block md:top-28 md:pt-10 md:sticky border-r border-gray-20 overflow-y-auto pb-24 h-[calc(100vh-7rem)]"
202+
id="sidebar-content-api-docs"
203+
className="w-80 h-full relative top-12 px-4 w-full block md:top-28 md:sticky border-r border-gray-20 overflow-y-auto pb-24 max-h-[calc(100vh-7rem)]"
210204
>
211205
<div className="flex justify-between">
212206
<div className="w-3/4 md:w-full"> React.null </div>
@@ -220,8 +214,6 @@ module SidebarTree = {
220214
<Icon.Close />
221215
</button>
222216
</div>
223-
// TODO rr7: add some type of version select here?
224-
// Do we want to use the existing one with the dropdown, or do something new?
225217
{preludeSection}
226218
<div className="my-10">
227219
<div className="hl-overline block text-gray-80 mt-5 mb-2" dataTestId="overview">
@@ -354,7 +346,7 @@ let make = (props: props) => {
354346
| Ok({module_: {items}}) if Array.length(items) > 0 =>
355347
<div className="hidden xl:block lg:w-1/5 md:h-auto md:relative overflow-y-visible bg-white">
356348
<aside
357-
className="relative top-0 pl-4 w-full block md:top-28 md:pt-4 md:sticky border-l border-gray-20 overflow-y-auto pb-24 h-[calc(100vh-7rem)]"
349+
className="relative pl-4 w-full block md:top-28 md:pt-4 md:sticky border-l border-gray-20 overflow-y-auto pb-24 h-[calc(100vh-7rem)]"
358350
>
359351
<div className="hl-overline block text-gray-80 mt-16 mb-2">
360352
{"Types and values"->React.string}

‎src/Packages.res‎

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -450,26 +450,24 @@ let make = (props: props) => {
450450
<div
451451
className="flex justify-between min-w-320 px-4 pt-16 lg:align-center w-full lg:px-8 pb-48"
452452
>
453-
<MdxProvider components=MarkdownComponents.default>
454-
<main className="max-w-1280 w-full flex justify-center">
455-
<div className="w-full max-w-176.25">
456-
<H1> {React.string("Libraries & Bindings")} </H1>
457-
<SearchBox
458-
placeholder="Enter a search term, name, keyword, etc"
459-
onValueChange
460-
onClear
461-
value={searchValue}
462-
/>
463-
<div className="mt-12 space-y-8">
464-
officialCategory
465-
communityCategory
466-
</div>
453+
<main className="max-w-1280 w-full flex justify-center">
454+
<div className="w-full max-w-176.25">
455+
<H1> {React.string("Libraries & Bindings")} </H1>
456+
<SearchBox
457+
placeholder="Enter a search term, name, keyword, etc"
458+
onValueChange
459+
onClear
460+
value={searchValue}
461+
/>
462+
<div className="mt-12 space-y-8">
463+
officialCategory
464+
communityCategory
467465
</div>
468-
</main>
469-
<div className="hidden lg:block h-full ">
470-
<InfoSidebar filter setFilter />
471466
</div>
472-
</MdxProvider>
467+
</main>
468+
<div className="hidden lg:block h-full ">
469+
<InfoSidebar filter setFilter />
470+
</div>
473471
</div>
474472
</div>
475473
<Footer />

‎src/SyntaxLookup.res‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -383,11 +383,9 @@ let make = (
383383
<Navigation isOverlayOpen setOverlayOpen />
384384
<div className="flex xs:justify-center overflow-hidden pb-48">
385385
<main className="mt-24 min-w-320 lg:align-center w-full px-4 md:px-8 max-w-1280">
386-
<MdxProvider components=MarkdownComponents.default>
387-
<div className="flex justify-center">
388-
<div className="max-w-740 w-full"> content </div>
389-
</div>
390-
</MdxProvider>
386+
<div className="flex justify-center">
387+
<div className="max-w-740 w-full"> content </div>
388+
</div>
391389
</main>
392390
</div>
393391
<Footer />

‎src/bindings/MdxProvider.res‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎src/bindings/Next.res‎

Lines changed: 0 additions & 69 deletions
This file was deleted.

‎src/components/VersionSelect.res‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,20 @@ module SectionHeader = {
1818
<option disabled=true key=value className="py-4"> {React.string(value)} </option>
1919
}
2020

21+
// This is the current version
22+
let version = "v12"
23+
2124
@react.component
22-
let make = (~version: string, ~availableVersions: array<string>) => {
25+
let make = () => {
2326
let children = Array.map(olderVersions, ver => {
2427
<a className="py-0.5 block hover:underline" key=ver.label href=ver.link>
2528
{React.string(ver.label)}
2629
</a>
2730
})
28-
// TODO: RR7 this margin is wrong
29-
<div className="wrapper mt-4">
31+
<div className="wrapper mt-4 block w-full" dataTestId="version-select">
3032
<div id="older-versions" popover=Auto />
3133
<button
32-
className="trigger text-12 border border-gray-20 bg-gray-10 text-gray-80 inline-block rounded px-4 py-1 font-semibold"
34+
className="trigger text-12 border border-gray-20 bg-gray-10 text-gray-80 inline-block rounded px-4 py-1 font-semibold whitespace-nowrap"
3335
name="versionSelection"
3436
value=version
3537
popoverTarget="older-versions"

‎src/components/VersionSelect.resi‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ module SectionHeader: {
33
let make: (~value: string) => Jsx.element
44
}
55
@react.component
6-
let make: (~version: string, ~availableVersions: array<string>) => Jsx.element
6+
let make: unit => Jsx.element

‎src/layouts/ApiLayout.res‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ let make = (
6969
~title="",
7070
~version: option<string>=?,
7171
~activeToc: option<TableOfContents.t>=?,
72-
~components=ApiMarkdown.default,
7372
~children,
7473
) => {
7574
let {pathname: route} = ReactRouter.useLocation()
@@ -115,7 +114,7 @@ let make = (
115114
("/" ++ (version ++ ("/" ++ Array.join(url.pagepath, "/")))))
116115
navigate(targetUrl)
117116
}
118-
<VersionSelect version={"v12"} availableVersions=["v12", "pre v12"] />
117+
<VersionSelect />
119118
| None => React.null
120119
}}
121120
</div>

0 commit comments

Comments
 (0)