-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
128 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
import React from "react"; | ||
import clsx from "clsx"; | ||
// eslint-disable-next-line import/no-unresolved | ||
import Link from "@docusaurus/Link"; | ||
import { | ||
findFirstCategoryLink, | ||
useDocById, | ||
} from "@docusaurus/theme-common/internal"; | ||
// import isInternalUrl from "@docusaurus/isInternalUrl"; | ||
// eslint-disable-next-line import/no-unresolved | ||
import { translate } from "@docusaurus/Translate"; | ||
import styles from "./styles.module.css"; | ||
function CardContainer({ href, children }) { | ||
return ( | ||
<Link | ||
href={href} | ||
className={clsx("card padding--lg", styles.cardContainer)} | ||
> | ||
{children} | ||
</Link> | ||
); | ||
} | ||
function CardLayout({ href, icon, title, description }) { | ||
return ( | ||
<CardContainer href={href}> | ||
<h2 className={clsx("text--truncate", styles.cardTitle)} title={title}> | ||
{icon} {title} | ||
</h2> | ||
{description && ( | ||
<p | ||
className={clsx("text--truncate", styles.cardDescription)} | ||
title={description} | ||
> | ||
{description} | ||
</p> | ||
)} | ||
</CardContainer> | ||
); | ||
} | ||
function CardCategory({ item }) { | ||
const href = findFirstCategoryLink(item); | ||
// Unexpected: categories that don't have a link have been filtered upfront | ||
if (!href) { | ||
return null; | ||
} | ||
return ( | ||
<CardLayout | ||
href={href} | ||
icon={null} | ||
title={item.label} | ||
description={ | ||
item.description ?? | ||
translate( | ||
{ | ||
message: "{count} items", | ||
id: "theme.docs.DocCard.categoryDescription", | ||
description: | ||
"The default description for a category card in the generated index about how many items this category includes", | ||
}, | ||
{ count: item.items.length }, | ||
) | ||
} | ||
/> | ||
); | ||
} | ||
function CardLink({ item }) { | ||
// const icon = isInternalUrl(item.href) ? '📄️' : '🔗'; | ||
const doc = useDocById(item.docId ?? undefined); | ||
return ( | ||
<CardLayout | ||
href={item.href} | ||
icon={null} | ||
title={item.label} | ||
description={item.description ?? doc?.description} | ||
/> | ||
); | ||
} | ||
export default function DocCard({ item }) { | ||
switch (item.type) { | ||
case "link": | ||
return <CardLink item={item} />; | ||
case "category": | ||
return <CardCategory item={item} />; | ||
default: | ||
throw new Error(`unknown item type ${JSON.stringify(item)}`); | ||
} | ||
} |
27 changes: 27 additions & 0 deletions
27
@stellar/design-system-website/src/theme/DocCard/styles.module.css
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
.cardContainer { | ||
--ifm-link-color: var(--ifm-color-emphasis-800); | ||
--ifm-link-hover-color: var(--ifm-color-emphasis-700); | ||
--ifm-link-hover-decoration: none; | ||
|
||
box-shadow: 0 1.5px 3px 0 rgb(0 0 0 / 15%); | ||
border: 1px solid var(--ifm-color-emphasis-200); | ||
transition: all var(--ifm-transition-fast) ease; | ||
transition-property: border, box-shadow; | ||
} | ||
|
||
.cardContainer:hover { | ||
border-color: var(--ifm-color-primary); | ||
box-shadow: 0 3px 6px 0 rgb(0 0 0 / 20%); | ||
} | ||
|
||
.cardContainer *:last-child { | ||
margin-bottom: 0; | ||
} | ||
|
||
.cardTitle { | ||
font-size: 1.2rem; | ||
} | ||
|
||
.cardDescription { | ||
font-size: 0.8rem; | ||
} |