@mintlify/models
Version:
Mintlify models
21 lines (20 loc) • 792 B
TypeScript
import { PageMetaTags } from '../types/pageMetaTags.js';
import { IconType } from './iconTypes.js';
export type Navigation = NavigationGroup[];
export type BaseNavigationGroup = {
group: string;
public?: boolean;
version?: string;
icon?: string;
iconType?: IconType;
};
export type NavigationGroup = BaseNavigationGroup & {
pages: NavigationEntry[];
};
export type NavigationEntry = NavigationGroup | string;
export type DecoratedNavigationGroup = BaseNavigationGroup & {
pages: DecoratedNavigationEntry[];
};
export type DecoratedNavigationEntry = DecoratedNavigationGroup | DecoratedNavigationPage;
export type DecoratedNavigationPage = PageMetaTags & Required<Pick<PageMetaTags, 'href' | 'title'>>;
export type DecoratedNavigation = DecoratedNavigationGroup[];