adev/shared-docs/pipeline/api-gen/rendering/templates/parameter.tsx - main - githubmirror/angular

adev/shared-docs/pipeline/api-gen/rendering/templates/parameter.tsx

30 строк1 KB

Matthieu Riegler

docs(docs-infra): Show function args

18 май 2026, 23:22

18 май 2026, 23:22872853f

/*!
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.dev/license
 */

import {h} from 'preact';
import {ParameterEntryRenderable} from '../entities/renderables.mjs';
import {PARAM_GROUP_CLASS_NAME} from '../styling/css-classes.mjs';
import {CodeSymbol} from './code-symbols';
import {RawHtml} from './raw-html';

/** Component to render a function or method parameter reference doc fragment. */
export function Parameter(props: {param: ParameterEntryRenderable}) {
  const param = props.param;

  return (
    <div className={PARAM_GROUP_CLASS_NAME}>
      {/*TODO: isOptional, isRestParam*/}
      <span class="docs-param-keyword">@param</span>
      <span class="docs-param-name">{param.name}</span>
      <span class="docs-param-type">
        <CodeSymbol code={param.type} />
      </span>
      <RawHtml value={param.htmlDescription} className="docs-parameter-description" />
    </div>
  );
}