feat: update IPublicTypeComponentMetadata interface

This commit is contained in:
liujuping 2023-03-24 16:59:27 +08:00 committed by 林熠
parent affdfbbb1c
commit 3fea312906
3 changed files with 23 additions and 2 deletions

View File

@ -63,7 +63,7 @@ export class Material implements IPublicApiMaterial {
*
* @returns
*/
getAssets() {
getAssets(): IPublicTypeAssetsJson | undefined {
return this[editorSymbol].get('assets');
}

View File

@ -22,7 +22,7 @@ export interface IPublicApiMaterial {
* get AssetsJson data
* @returns IPublicTypeAssetsJson
*/
getAssets(): IPublicTypeAssetsJson;
getAssets(): IPublicTypeAssetsJson | undefined;
/**
*

View File

@ -5,74 +5,95 @@ import { IPublicTypeIconType, IPublicTypeNpmInfo, IPublicTypeFieldConfig, IPubli
*/
export interface IPublicTypeComponentMetadata {
/** 其他扩展协议 */
[key: string]: any;
/**
*
*/
componentName: string;
/**
* unique id
*/
uri?: string;
/**
* title or description
*/
title?: IPublicTypeTitleContent;
/**
* svg icon for component
*/
icon?: IPublicTypeIconType;
/**
*
*/
tags?: string[];
/**
*
*/
description?: string;
/**
*
*/
docUrl?: string;
/**
*
*/
screenshot?: string;
/**
*
*/
devMode?: 'proCode' | 'lowCode';
/**
* npm
*/
npm?: IPublicTypeNpmInfo;
/**
*
*/
props?: IPublicTypePropConfig[];
/**
*
*/
configure?: IPublicTypeFieldConfig[] | IPublicTypeConfigure;
/**
* @deprecated, use advanced instead
*/
experimental?: IPublicTypeAdvanced;
/**
* @todo
*/
schema?: IPublicTypeComponentSchema;
/**
*
*/
snippets?: IPublicTypeSnippet[];
/**
*
*/
group?: string | IPublicTypeI18nData;
/**
*
*/
category?: string | IPublicTypeI18nData;
/**
*
*/