Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-12 01:23:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(website): add extends clauses, enum members and automatic -types links (#8270)

Browse Source 
* feat(website): add extends clauses, enum members and automatic -types links

* chore: remove vscode settings

* refactor: remove util file
This commit is contained in:
Suneet Tipirneni
2022-07-12 16:42:32 -04:00
committed by GitHub
parent 787654816d
commit 1ed605eaa4
21 changed files with 234 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
packages/website/src/components/model/Class.tsx
View File

@@ -1,7 +1,5 @@
import { DocContainer } from '../DocContainer';
import { MethodList } from '../MethodList';
import { PropertyList } from '../PropertyList';
import { Separator } from '../Seperator';
import { MethodsSection, PropertiesSection } from '../Sections';
import type { DocClass } from '~/DocModel/DocClass';
export interface ClassProps {
@@ -16,22 +14,10 @@ export function Class({ data }: ClassProps) {
excerpt={data.excerpt}
summary={data.summary}
typeParams={data.typeParameterData}
extendsTokens={data.extendsTokens}
>
<>
{data.properties.length ? (
<>
<PropertyList data={data.properties} />
<Separator />
</>
) : null}
{data.methods.length ? (
<>
<MethodList data={data.methods} />
<Separator />
</>
) : null}
</>
<PropertiesSection data={data.properties} />
<MethodsSection data={data.methods} />
</DocContainer>
);
}

19
packages/website/src/components/model/Enum.tsx
View File

@@ -1,4 +1,6 @@
import { CodeListing, CodeListingSeparatorType } from '../CodeListing';
import { DocContainer } from '../DocContainer';
import { Section } from '../Section';
import type { DocEnum } from '~/DocModel/DocEnum';
export interface EnumProps {
@@ -8,14 +10,19 @@ export interface EnumProps {
export function Enum({ data }: EnumProps) {
return (
<DocContainer name={data.name} kind={data.kind} excerpt={data.excerpt} summary={data.summary}>
<>
<h3>Members</h3>
<ul>
<Section title="Members">
<div className="flex flex-col">
{data.members.map((member) => (
<li key={member.name}>{member.name}</li>
<CodeListing
key={member.name}
name={member.name}
separator={CodeListingSeparatorType.Value}
typeTokens={member.initializerTokens}
summary={member.summary}
/>
))}
</ul>
</>
</div>
</Section>
</DocContainer>
);
}

5
packages/website/src/components/model/Function.tsx
View File

@@ -1,5 +1,5 @@
import { DocContainer } from '../DocContainer';
import { ParameterTable } from '../ParameterTable';
import { ParametersSection } from '../Sections';
import type { DocFunction } from '~/DocModel/DocFunction';
export interface FunctionProps {
@@ -15,8 +15,7 @@ export function Function({ data }: FunctionProps) {
summary={data.summary}
typeParams={data.typeParameterData}
>
<h2>Parameters</h2>
<ParameterTable data={data.parameters} />
<ParametersSection data={data.parameters} />
</DocContainer>
);
}

9
packages/website/src/components/model/Interface.tsx
View File

@@ -1,6 +1,5 @@
import { DocContainer } from '../DocContainer';
import { MethodList } from '../MethodList';
import { PropertyList } from '../PropertyList';
import { MethodsSection, PropertiesSection } from '../Sections';
import type { DocInterface } from '~/DocModel/DocInterface';
export interface InterfaceProps {
@@ -16,10 +15,8 @@ export function Interface({ data }: InterfaceProps) {
summary={data.summary}
typeParams={data.typeParameterData}
>
<>
{data.properties.length ? <PropertyList data={data.properties} /> : null}
{data.methods.length ? <MethodList data={data.methods} /> : null}
</>
<PropertiesSection data={data.properties} />
<MethodsSection data={data.methods} />
</DocContainer>
);
}