Skip to content

docs: Component method display #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexkaduk merged 2 commits into from
Aug 11, 2026
Merged

docs: Component method display #270

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31e5843
adjustment for method display
lzeiml Jul 29, 2026
d022f4e
fix
lzeiml Jul 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 38 additions & 17 deletions src/components/ApiTable/ApiFunction.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,16 @@ function ApiFunction({
children,
}: ApiFunctionProps) {
const signature = `${name}(${parameters
.map((p) => `${p.name}${p.optional ? '?' : ''}: ${decodeHTMLEntities(p.type)}`)
.map(
(p) => `${p.name}${p.optional ? '?' : ''}: ${decodeHTMLEntities(p.type)}`
)
.join(', ')})`;

return (
<BrowserOnly>
{() => (
<div className="api-table container ml-0 mb-8" id={`function-${name}`}>
<div className="bg-[transparent] rounded-lg overflow-hidden border-solid border-[1px] border-[var(--theme-color-soft-bdr)]">

<AnchorHeader
anchorName={`function-${name}`}
anchorLabel={`Direct link to ${name}`}
Expand All @@ -55,33 +56,54 @@ function ApiFunction({
</AnchorHeader>

{children && (
<div className={clsx(styles.ApiTableText, 'api-row border-solid border-0 border-b border-[var(--theme-color-soft-bdr)]')}>
<div className="px-8 py-4 font-bold w-auto min-w-[150px] border-solid border-0 border-r border-[var(--theme-color-soft-bdr)]">
<div
className={clsx(
styles.ApiTableText,
'api-row border-solid border-0 border-b border-[var(--theme-color-soft-bdr)]'
)}
>
<div className="px-8 py-4 font-bold w-auto border-solid border-0 border-r border-[var(--theme-color-soft-bdr)] break-words">
Description
</div>
<div className="w-auto p-4 flex items-center">
{children}
</div>
<div className="w-auto p-4 break-words">{children}</div>
</div>
)}

{parameters.length > 0 && (
<>
{parameters.map((param, idx) => (
<div key={idx} className={clsx(styles.ApiTableText, 'api-row border-solid border-0 border-b border-[var(--theme-color-soft-bdr)]')}>
<div className="px-8 py-4 font-bold w-auto min-w-[150px] border-solid border-0 border-r border-[var(--theme-color-soft-bdr)]">
<div
key={idx}
className={clsx(
styles.ApiTableText,
'api-row border-solid border-0 border-b border-[var(--theme-color-soft-bdr)]'
)}
>
<div className="px-8 py-4 font-bold w-auto border-solid border-0 border-r border-[var(--theme-color-soft-bdr)]">
<div>{param.name}</div>
{param.optional && <div className="font-normal text-xs opacity-70">(optional)</div>}
{param.optional && (
<div className="font-normal text-xs opacity-70">
(optional)
</div>
)}
</div>
<div className="w-auto p-4 flex flex-col justify-center">
<div>
<span className="opacity-70 text-xs uppercase tracking-wider mr-2">Type:</span>
<code className="p-1 text-sm">{decodeHTMLEntities(param.type)}</code>
<span className="opacity-70 text-xs uppercase tracking-wider mr-2">
Type:
</span>
<code className="p-1 text-sm">
{decodeHTMLEntities(param.type)}
</code>
</div>
{param.defaultValue && (
<div className="mt-1">
<span className="opacity-70 text-xs uppercase tracking-wider mr-2">Default:</span>
<code className="p-1 text-sm">{decodeHTMLEntities(param.defaultValue)}</code>
<span className="opacity-70 text-xs uppercase tracking-wider mr-2">
Default:
</span>
<code className="p-1 text-sm">
{decodeHTMLEntities(param.defaultValue)}
</code>
Comment thread
lzeiml marked this conversation as resolved.
</div>
)}
</div>
Expand All @@ -91,19 +113,18 @@ function ApiFunction({
)}

<div className={clsx(styles.ApiTableText, 'api-row')}>
<div className="px-8 py-4 font-bold w-auto min-w-[150px] border-solid border-0 border-r border-[var(--theme-color-soft-bdr)]">
<div className="px-8 py-4 font-bold w-auto border-solid border-0 border-r border-[var(--theme-color-soft-bdr)]">
Returns
</div>
<div className="w-auto p-4 flex items-center">
<code className="p-1 text-sm">{returnType}</code>
</div>
</div>

</div>
</div>
)}
</BrowserOnly>
);
}

export default ApiFunction;
export default ApiFunction;
Loading