mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-10 00:23:30 +01:00
64 lines
2.6 KiB
TypeScript
64 lines
2.6 KiB
TypeScript
import { ActionIcon, Badge, Group, Stack, Title } from '@mantine/core';
|
|
import { useMediaQuery } from '@mantine/hooks';
|
|
import { FiLink } from 'react-icons/fi';
|
|
import { HyperlinkedText } from './HyperlinkedText';
|
|
import { InheritanceText } from './InheritanceText';
|
|
import { ParameterTable } from './ParameterTable';
|
|
import { TSDoc } from './tsdoc/TSDoc';
|
|
import type { ApiMethodJSON, ApiMethodSignatureJSON } from '~/DocModel/ApiNodeJSONEncoder';
|
|
import { Visibility } from '~/DocModel/Visibility';
|
|
|
|
function getShorthandName(data: ApiMethodJSON | ApiMethodSignatureJSON) {
|
|
return `${data.name}${data.optional ? '?' : ''}(${data.parameters.reduce((prev, cur, index) => {
|
|
if (index === 0) {
|
|
return `${prev}${cur.isOptional ? `${cur.name}?` : cur.name}`;
|
|
}
|
|
|
|
return `${prev}, ${cur.isOptional ? `${cur.name}?` : cur.name}`;
|
|
}, '')})`;
|
|
}
|
|
|
|
export function MethodItem({ data }: { data: ApiMethodJSON | ApiMethodSignatureJSON }) {
|
|
const matches = useMediaQuery('(max-width: 768px)', true, { getInitialValueInEffect: false });
|
|
const method = data as ApiMethodJSON;
|
|
const key = `${data.name}${data.overloadIndex && data.overloadIndex > 1 ? `:${data.overloadIndex}` : ''}`;
|
|
|
|
return (
|
|
<Stack id={key} className="scroll-mt-30" spacing="xs">
|
|
<Group>
|
|
<Stack>
|
|
<Group ml={matches ? 0 : -45}>
|
|
<ActionIcon component="a" href={`#${key}`} variant="transparent">
|
|
<FiLink size={20} />
|
|
</ActionIcon>
|
|
{data.deprecated ? (
|
|
<Badge variant="filled" color="red">
|
|
Deprecated
|
|
</Badge>
|
|
) : null}
|
|
{data.kind === 'Method' && method.visibility === Visibility.Protected ? (
|
|
<Badge variant="filled">Protected</Badge>
|
|
) : null}
|
|
{data.kind === 'Method' && method.static ? <Badge variant="filled">Static</Badge> : null}
|
|
<Title sx={{ wordBreak: 'break-all' }} order={4} className="font-mono">{`${getShorthandName(data)}`}</Title>
|
|
<Title order={4}>:</Title>
|
|
<Title sx={{ wordBreak: 'break-all' }} order={4} className="font-mono">
|
|
<HyperlinkedText tokens={data.returnTypeTokens} />
|
|
</Title>
|
|
</Group>
|
|
</Stack>
|
|
</Group>
|
|
<Group sx={{ display: data.summary || data.parameters.length ? 'block' : 'none' }} mb="lg">
|
|
<Stack>
|
|
{data.deprecated ? <TSDoc node={data.deprecated} /> : null}
|
|
{data.summary ? <TSDoc node={data.summary} /> : null}
|
|
{data.remarks ? <TSDoc node={data.remarks} /> : null}
|
|
{data.comment ? <TSDoc node={data.comment} /> : null}
|
|
{data.parameters.length ? <ParameterTable data={data.parameters} /> : null}
|
|
{data.inheritanceData ? <InheritanceText data={data.inheritanceData} /> : null}
|
|
</Stack>
|
|
</Group>
|
|
</Stack>
|
|
);
|
|
}
|