mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
* fix(ExceptText): don't display import("d..-types/v10"). in return type
* Squashed 'packages/api-extractor-model/' content from commit 39ecb196c
git-subtree-dir: packages/api-extractor-model
git-subtree-split: 39ecb196ca210bdf84ba6c9cadb1bb93571849d7
* Squashed 'packages/api-extractor/' content from commit 341ad6c51
git-subtree-dir: packages/api-extractor
git-subtree-split: 341ad6c51b01656d4f73b74ad4bdb3095f9262c4
* feat(api-extractor): add api-extractor and -model
* fix: package.json docs script
* fix(SourcLink): use <> instead of function syntax
* fix: make packages private
* fix: rest params showing in docs, added labels
* fix: missed two files
* feat: merge docs.json from docgen and docs.api.json
* fix: cpy-cli & pnpm-lock
* fix: increase icon size
* fix: icon size again
* feat: run both docs on mainlib
* chore: website fixes
* fix: more website fixes
* fix: tests and dev database script
* chore: comment out old docs
* fix: increase max fetch cache
* fix: env should always be a string
* fix: try to reapply patches
* fix: remove prepare for docgen
* fix: temporary cosmetic fixes
* fix: horizontal scroll
* feat: generate index for new docs
---------
Co-authored-by: Noel <buechler.noel@outlook.com>
50 lines
1.5 KiB
TypeScript
50 lines
1.5 KiB
TypeScript
import type {
|
|
ApiDeclaredItem,
|
|
ApiItemContainerMixin,
|
|
ApiProperty,
|
|
ApiPropertySignature,
|
|
} from '@discordjs/api-extractor-model';
|
|
import type { PropsWithChildren } from 'react';
|
|
import { Badges } from './Badges';
|
|
import { CodeHeading } from './CodeHeading';
|
|
import { ExcerptText } from './ExcerptText';
|
|
import { InheritanceText } from './InheritanceText';
|
|
import { TSDoc } from './documentation/tsdoc/TSDoc';
|
|
|
|
export function Property({
|
|
item,
|
|
children,
|
|
inheritedFrom,
|
|
}: PropsWithChildren<{
|
|
readonly inheritedFrom?: (ApiDeclaredItem & ApiItemContainerMixin) | undefined;
|
|
readonly item: ApiProperty | ApiPropertySignature;
|
|
}>) {
|
|
const hasSummary = Boolean(item.tsdocComment?.summarySection);
|
|
|
|
return (
|
|
<div className="flex flex-col scroll-mt-30 gap-4" id={item.displayName}>
|
|
<div className="flex flex-col gap-2 md:-ml-9">
|
|
<Badges item={item} />
|
|
<CodeHeading
|
|
href={`#${item.displayName}`}
|
|
sourceURL={item.sourceLocation.fileUrl}
|
|
sourceLine={item.sourceLocation.fileLine}
|
|
>
|
|
{`${item.displayName}${item.isOptional ? '?' : ''}`}
|
|
<span>:</span>
|
|
{item.propertyTypeExcerpt.text ? (
|
|
<ExcerptText excerpt={item.propertyTypeExcerpt} model={item.getAssociatedModel()!} />
|
|
) : null}
|
|
</CodeHeading>
|
|
</div>
|
|
{hasSummary || inheritedFrom ? (
|
|
<div className="mb-4 w-full flex flex-col gap-4">
|
|
{item.tsdocComment ? <TSDoc item={item} tsdoc={item.tsdocComment} /> : null}
|
|
{inheritedFrom ? <InheritanceText parent={inheritedFrom} /> : null}
|
|
{children}
|
|
</div>
|
|
) : null}
|
|
</div>
|
|
);
|
|
}
|