APIReference

Displays type documentation for all types exported from a file path or types related to a collection export source.

Examples

  • File Path

    View Source
    ({ fill, ...props }: React.SVGProps<SVGSVGElement>) => React.JSX.Element | undefined

    Renders a logo for the configured Git provider.

    Returns
    Element | undefined
    ({ css: cssProp, className, style, children, }: { css?: CSSObject; className?: string; style?: React.CSSProperties; children?: React.ReactNode; }) => React.JSX.Element

    A link to the configured Git provider source code repository.

    Parameters
    Properties

    css

    CSSObject | undefined

    className

    string | undefined

    style

    React.CSSProperties | undefined

    children

    React.ReactNode
    Returns
    Element
    export function FilePath() {
  return (
    <APIReference
      source="./GitProvider.tsx"
      workingDirectory={import.meta.url}
    />
  )
}

API Reference

APIReference

(props: APIReferenceProps) => JSX.Element

Displays type documentation for all types exported from a file path or types related to a collection export source.

Parameters
APIReferenceProps
Returns
Element

APIReferenceProps

APIReferenceProps
Properties

source *

string

The file path to the source code.

workingDirectory

string | undefined

The working directory to resolve the file path from. Will use the base URL if a URL is provided.

filter

SymbolFilter | undefined

A filter to apply to the exported types.

Properties

source *

JavaScriptFile<any, string, string> | JavaScriptFileExport<any>

The export source from a collection export source to get types from.

filter

SymbolFilter | undefined

A filter to apply to the exported types.

Last updated