Merge pull request #785 from ilesinge/reference_parameters

Add function params in reference tab
This commit is contained in:
Felix Roos 2023-11-05 16:46:06 +01:00 committed by GitHub
commit a05d3a47c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,6 +3,12 @@ const visibleFunctions = jsdocJson.docs
.filter(({ name, description }) => name && !name.startsWith('_') && !!description)
.sort((a, b) => /* a.meta.filename.localeCompare(b.meta.filename) + */ a.name.localeCompare(b.name));
const getInnerText = (html) => {
var div = document.createElement('div');
div.innerHTML = html;
return div.textContent || div.innerText || '';
};
export function Reference() {
return (
<div className="flex h-full w-full pt-2 text-foreground overflow-hidden">
@ -24,8 +30,14 @@ export function Reference() {
<section key={i}>
<h3 id={`doc-${i}`}>{entry.name}</h3>
{/* <small>{entry.meta.filename}</small> */}
<p dangerouslySetInnerHTML={{ __html: entry.description }}></p>
<ul>
{entry.params?.map(({ name, type, description }, i) => (
<li key={i}>
{name} : {type.names?.join(' | ')} {description ? <> - {getInnerText(description)}</> : ''}
</li>
))}
</ul>
{entry.examples?.map((example, j) => (
<pre key={j}>{example}</pre>
))}