UNPKG

1.2 kBTypeScriptView Raw
1import React, { FC } from 'react';
2import { ArgTypes, Args } from './types';
3export declare const TableWrapper: import("@emotion/styled-base").StyledComponent<React.DetailedHTMLProps<React.TableHTMLAttributes<HTMLTableElement>, HTMLTableElement>, {
4 compact?: boolean;
5 inAddonPanel?: boolean;
6}, import("@storybook/theming").Theme>;
7export declare enum ArgsTableError {
8 NO_COMPONENT = "No component found.",
9 ARGS_UNSUPPORTED = "Args unsupported. See Args documentation for your framework."
10}
11export declare type SortType = 'alpha' | 'requiredFirst' | 'none';
12export interface ArgsTableRowProps {
13 rows: ArgTypes;
14 args?: Args;
15 updateArgs?: (args: Args) => void;
16 resetArgs?: (argNames?: string[]) => void;
17 compact?: boolean;
18 inAddonPanel?: boolean;
19 initialExpandedArgs?: boolean;
20 sort?: SortType;
21}
22export interface ArgsTableErrorProps {
23 error: ArgsTableError;
24}
25export declare type ArgsTableProps = ArgsTableRowProps | ArgsTableErrorProps;
26/**
27 * Display the props for a component as a props table. Each row is a collection of
28 * ArgDefs, usually derived from docgen info for the component.
29 */
30export declare const ArgsTable: FC<ArgsTableProps>;