The tag name of the web component.
This is the custom element tag name used in HTML (e.g., 'sales-dashboard').
It must match the tag defined in the component's @Component decorator.
Tag names must follow custom element naming rules:
import { WebComponentMetadata } from '@limetech/lime-web-components';
// Everything a dashboard widget can declare
const widgetMetadata: WebComponentMetadata = {
name: 'revenue-chart',
title: 'Revenue Chart',
description: 'Monthly revenue trends with year-over-year comparison',
icon: 'chart-area',
tags: ['start-page', 'card-widget'],
configComponent: {
name: 'revenue-chart-config',
props: {
timeRange: '12months',
includeComparison: true,
},
},
};
// Only `name` is required
const simpleMetadata: WebComponentMetadata = {
name: 'hello-world',
title: 'Hello World Widget',
};
Metadata describing a registered web component.
This type extends ConfigMetadata to include the component's tag name, providing a complete description of a web component for discovery and configuration purposes within the Lime CRM platform.
The metadata combines: