import { css } from '@emotion/react';
import { theme, spacing, UndoIcon, iconSize } from '@expo/styleguide';
import React from 'react';
import ReactMarkdown from 'react-markdown';
import { InlineCode } from '~/components/base/code';
import { LI, UL } from '~/components/base/list';
import { H2, H3Code, H4, H4Code } from '~/components/plugins/Headings';
import { APIDataType } from '~/components/plugins/api/APIDataType';
import {
MethodDefinitionData,
MethodSignatureData,
PropData,
TypeSignaturesData,
} from '~/components/plugins/api/APIDataTypes';
import { APISectionDeprecationNote } from '~/components/plugins/api/APISectionDeprecationNote';
import { APISectionPlatformTags } from '~/components/plugins/api/APISectionPlatformTags';
import {
CommentTextBlock,
getMethodName,
getTagNamesList,
mdComponents,
renderParams,
resolveTypeName,
STYLES_APIBOX,
STYLES_APIBOX_NESTED,
STYLES_NESTED_SECTION_HEADER,
STYLES_NOT_EXPOSED_HEADER,
TypeDocKind,
} from '~/components/plugins/api/APISectionUtils';
export type APISectionMethodsProps = {
data: (MethodDefinitionData | PropData)[];
apiName?: string;
header?: string;
exposeInSidebar?: boolean;
};
export type RenderMethodOptions = {
apiName?: string;
header?: string;
exposeInSidebar?: boolean;
};
export const renderMethod = (
method: MethodDefinitionData | PropData,
{ apiName, exposeInSidebar = true }: RenderMethodOptions = {}
): JSX.Element[] => {
const signatures = method.signatures || (method as PropData)?.type?.declaration?.signatures || [];
const HeaderComponent = exposeInSidebar ? H3Code : H4Code;
return signatures.map(
({ name, parameters, comment, type }: MethodSignatureData | TypeSignaturesData) => (
{getMethodName(method as MethodDefinitionData, apiName, name, parameters)}
{parameters && parameters.length > 0 && renderParams(parameters)}
{resolveTypeName(type) !== 'undefined' && (
<>
Returns
{comment?.returns && (
{comment.returns}
)}
>
)}
)
);
};
const APISectionMethods = ({
data,
apiName,
header = 'Methods',
exposeInSidebar = true,
}: APISectionMethodsProps) =>
data?.length ? (
<>
{header}
{data.map((method: MethodDefinitionData | PropData) =>
renderMethod(method, { apiName, header, exposeInSidebar })
)}
>
) : null;
const returnIconStyles = css({
transform: 'rotate(180deg)',
marginRight: spacing[2],
verticalAlign: 'middle',
});
export default APISectionMethods;
export const APIMethod = ({
name,
comment,
returnTypeName,
isProperty = false,
isReturnTypeReference = false,
exposeInSidebar = false,
parameters = [],
platforms = [],
}: {
exposeInSidebar?: boolean;
name: string;
comment: string;
returnTypeName: string;
isProperty: boolean;
isReturnTypeReference: boolean;
platforms: ('Android' | 'iOS' | 'Web')[];
parameters: {
name: string;
comment?: string;
typeName: string;
isReference?: boolean;
}[];
}): JSX.Element[] => {
const parsedParameters = parameters.map(param => ({
name: param.name,
type: { name: param.typeName, type: param.isReference ? 'reference' : 'literal' },
comment: {
text: param.comment,
},
}));
return renderMethod(
{
name,
signatures: [
{
name,
parameters: parsedParameters,
comment: {
text: comment,
tags: platforms.map(text => ({
tag: 'platform',
text,
})),
},
type: { name: returnTypeName, type: isReturnTypeReference ? 'reference' : 'literal' },
},
],
kind: isProperty ? TypeDocKind.Property : TypeDocKind.Function,
},
{ exposeInSidebar }
);
};