@stoplight/elements/containers/API.d.ts

UI components for composing beautiful developer documentation.

import { RoutingProps } from '@stoplight/elements-core';
import { ExtensionAddonRenderer } from '@stoplight/elements-core/components/Docs';
import * as React from 'react';
export declare type APIProps = APIPropsWithDocument | APIPropsWithUrl;
export declare type APIPropsWithUrl = {
    apiDescriptionUrl: string;
} & CommonAPIProps;
export declare type APIPropsWithDocument = {
    apiDescriptionDocument: string | object;
    apiDescriptionUrl?: string;
} & CommonAPIProps;
export interface CommonAPIProps extends RoutingProps {
    layout?: 'sidebar' | 'stacked' | 'responsive';
    logo?: string;
    hideTryIt?: boolean;
    hideSamples?: boolean;
    hideTryItPanel?: boolean;
    hideSecurityInfo?: boolean;
    hideServerInfo?: boolean;
    hideSchemas?: boolean;
    hideInternal?: boolean;
    hideExport?: boolean;
    tryItCredentialsPolicy?: 'omit' | 'include' | 'same-origin';
    tryItCorsProxy?: string;
    maxRefDepth?: number;
    renderExtensionAddon?: ExtensionAddonRenderer;
    outerRouter?: boolean;
}
export declare const APIImpl: React.FC<APIProps>;
export declare const API: React.FC<APIProps>;