@shopify/cli-kit
Version:
A set of utilities, interfaces, and models that are common across all the platform features
25 lines (24 loc) • 719 B
TypeScript
import { InlineToken, TokenItem } from './TokenizedText.js';
import { TextProps } from 'ink';
import { FunctionComponent } from 'react';
export interface CustomListItem {
type?: string;
item: TokenItem<InlineToken>;
bullet?: string;
color?: TextProps['color'];
}
type ListItem = TokenItem<InlineToken> | CustomListItem;
interface ListProps {
title?: TokenItem<InlineToken>;
items: ListItem[];
ordered?: boolean;
margin?: boolean;
color?: TextProps['color'];
bullet?: string;
}
/**
* `List` displays an unordered or ordered list with text aligned with the bullet point
* and wrapped to the container width.
*/
declare const List: FunctionComponent<ListProps>;
export { List };