TypeDoc Example

    Function CardB

    • Renders a card around some content.

      <CardB variant="secondary">
      <h5>My Title</h5>
      <p>My content</p>
      </CardB>

      The props type is written directly in the function definition:

      export function CardB({
      children,
      variant = "primary",
      }: PropsWithChildren<{
      variant: "primary" | "secondary" | "success" | "danger" | "light" | "dark";
      }>): ReactElement {
      // ...
      }

      This can make the TypeDoc documentation a bit cleaner for very simple components, but it makes your code less readable.

      Parameters

      • __namedParameters: PropsWithChildren<
            {
                variant: | "primary"
                | "secondary"
                | "success"
                | "danger"
                | "light"
                | "dark";
            },
        >

      Returns ReactElement

    MMNEPVFCICPMFPCPTTAAATR