An open source design system that's fully customizable and agent ready
TypeScript
// Copyright (c) Meta Platforms, Inc. and affiliates.
/**
* @file FunctionDoc for the synchronous bundled-theme compatibility API.
*/
/** @type {import('@astryxdesign/cli/authoring').FunctionDoc} */
export const doc = {
type: 'function',
kind: 'api',
name: 'themeList',
namespace: 'cli/api',
displayName: 'themeList()',
summary: 'List themes bundled with this CLI build.',
description:
'Synchronous list of the themes bundled with the CLI. It does not include themes from installed integrations; use themeListAvailable() for the list `{@command theme list}` shows.',
importPath: '@astryxdesign/cli/api',
signature: 'themeList(): ThemeListResponse',
keywords: ['theme', 'list', 'themes', 'bundled', 'available'],
params: [],
returns: [
{
type: 'theme.list',
description:
'Every bundled theme as ThemeListEntry[]: slug, displayName, description, and maintained flag.',
},
],
throws: [
{
code: 'ERR_NO_SOURCE',
when: 'the bundled theme descriptors cannot be read or parsed',
},
],
examples: [
{label: 'List bundled themes', code: 'const {data} = themeList();'},
],
related: ['themeListAvailable', 'themeAdd', 'listThemes'],
};