|
| 1 | +import React, {type ReactNode} from 'react'; |
| 2 | +import clsx from 'clsx'; |
| 3 | +import Link from '@docusaurus/Link'; |
| 4 | +import { |
| 5 | + findFirstSidebarItemLink, |
| 6 | + useDocById, |
| 7 | +} from '@docusaurus/theme-common/internal'; |
| 8 | +import isInternalUrl from '@docusaurus/isInternalUrl'; |
| 9 | +import {translate} from '@docusaurus/Translate'; |
| 10 | + |
| 11 | +import type {Props} from '@theme/DocCard'; |
| 12 | +import Heading from '@theme/Heading'; |
| 13 | +import type { |
| 14 | + PropSidebarItemCategory, |
| 15 | + PropSidebarItemLink, |
| 16 | +} from '@docusaurus/plugin-content-docs'; |
| 17 | + |
| 18 | +import styles from './styles.module.css'; |
| 19 | +import { Icon } from '@iconify/react'; |
| 20 | + |
| 21 | +function CardContainer({ |
| 22 | + href, |
| 23 | + children, |
| 24 | +}: { |
| 25 | + href: string; |
| 26 | + children: ReactNode; |
| 27 | +}): JSX.Element { |
| 28 | + return ( |
| 29 | + <Link |
| 30 | + href={href} |
| 31 | + className={clsx('card padding--lg', styles.cardContainer)}> |
| 32 | + {children} |
| 33 | + </Link> |
| 34 | + ); |
| 35 | +} |
| 36 | + |
| 37 | +function CardLayout({ |
| 38 | + href, |
| 39 | + icon, |
| 40 | + title, |
| 41 | + description, |
| 42 | +}: { |
| 43 | + href: string; |
| 44 | + icon: ReactNode; |
| 45 | + title: string; |
| 46 | + description?: string; |
| 47 | +}): JSX.Element { |
| 48 | + return ( |
| 49 | + <CardContainer href={href}> |
| 50 | + <Heading |
| 51 | + as="h2" |
| 52 | + className={clsx('text--truncate', styles.cardTitle)} |
| 53 | + title={title}> |
| 54 | + {icon} {title} |
| 55 | + </Heading> |
| 56 | + {description && ( |
| 57 | + <p |
| 58 | + className={clsx('text--truncate', styles.cardDescription)} |
| 59 | + title={description}> |
| 60 | + {description} |
| 61 | + </p> |
| 62 | + )} |
| 63 | + </CardContainer> |
| 64 | + ); |
| 65 | +} |
| 66 | + |
| 67 | +function CardCategory({ |
| 68 | + item, |
| 69 | +}: { |
| 70 | + item: PropSidebarItemCategory; |
| 71 | +}): JSX.Element | null { |
| 72 | + const href = findFirstSidebarItemLink(item); |
| 73 | + |
| 74 | + // Unexpected: categories that don't have a link have been filtered upfront |
| 75 | + if (!href) { |
| 76 | + return null; |
| 77 | + } |
| 78 | + |
| 79 | + return ( |
| 80 | + <CardLayout |
| 81 | + href={href} |
| 82 | + icon="🗃️" |
| 83 | + title={item.label} |
| 84 | + description={ |
| 85 | + item.description ?? |
| 86 | + translate( |
| 87 | + { |
| 88 | + message: '{count} items', |
| 89 | + id: 'theme.docs.DocCard.categoryDescription', |
| 90 | + description: |
| 91 | + 'The default description for a category card in the generated index about how many items this category includes', |
| 92 | + }, |
| 93 | + {count: item.items.length}, |
| 94 | + ) |
| 95 | + } |
| 96 | + /> |
| 97 | + ); |
| 98 | +} |
| 99 | + |
| 100 | +type EmojiPropsSidebarItemLink = PropSidebarItemLink & { |
| 101 | + customEmoji?: string; |
| 102 | +}; |
| 103 | + |
| 104 | +function CardLink({item}: {item: EmojiPropsSidebarItemLink}): JSX.Element { |
| 105 | + const icon = item.customEmoji ? |
| 106 | + <Icon style={{paddingRight: "3px"}} icon={item.customEmoji} height={25}/> : |
| 107 | + (isInternalUrl(item.href) ? '📄️' : '🔗'); |
| 108 | + const doc = useDocById(item.docId ?? undefined); |
| 109 | + return ( |
| 110 | + <CardLayout |
| 111 | + href={item.href} |
| 112 | + icon={icon} |
| 113 | + title={item.label} |
| 114 | + description={item.description ?? doc?.description} |
| 115 | + /> |
| 116 | + ); |
| 117 | +} |
| 118 | + |
| 119 | +export default function DocCard({item}: Props): JSX.Element { |
| 120 | + switch (item.type) { |
| 121 | + case 'link': |
| 122 | + return <CardLink item={item} />; |
| 123 | + case 'category': |
| 124 | + return <CardCategory item={item} />; |
| 125 | + default: |
| 126 | + throw new Error(`unknown item type ${JSON.stringify(item)}`); |
| 127 | + } |
| 128 | +} |
0 commit comments