component.json

Web component file

Type object
File match component.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/component-json/latest.json
Source https://www.schemastore.org/component.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

private boolean

Indicates whether the component should be treated as private and not published to public registries.

Default: false
name string

The name of the component. Must be lowercase, can contain hyphens and underscores.

pattern=^[0-9a-z-_]+$
type string

Type of the component (e.g., 'component', 'block', 'template').

url string

URL to the component.

repo string

The repository location in the format 'username/repository'.

description string

A brief description of the component's purpose and functionality.

version string

The semantic version number of the component (e.g., '1.0.0').

framework string

Framework compatibility (e.g., 'react', 'vue', 'angular', 'svelte', 'alpinejs', 'laravel', 'web-components').

keywords string[]

An array of keywords that describe the component, used for search and categorization.

minItems=1
main string

The primary entry point file of the component.

scripts string | object[] | object

Scripts that are part of the component. Can be specified as an array of files or an object with named entries.

styles string | object[] | object

Styles that are part of the component. Can be specified as an array of files or an object with named entries.

json string | object[] | object

Json data that are part of the component. Can be specified as an array of files or an object with named entries.

images string | object[] | object

Image assets that are part of the component. Can be specified as an array of files or an object with named entries.

fonts string | object[] | object

Fonts that are part of the component. Can be specified as an array of files or an object with named entries.

files string | object[] | object

Additional files that are part of the component. Can be specified as an array of files or an object with named entries.

dependencies string | object[] | object

Dependencies that are required by the component. Can be specified as an array of files or an object with named entries.

locals string | object[] | object

Local dependencies that are required by the component. Can be specified as an array of files or an object with named entries.

remotes string | object[] | object

Remote dependencies that are required by the component. Can be specified as an array of files or an object with named entries.

paths string | object[] | object

Custom file paths configuration for the component.

templates string | object[] | object

Templates that can be imported to be used within the component.

demo string

Path to or URL of a demonstration of the component.

development

Development-specific configuration that extends the main configuration.

license string

The license identifier under which the component is distributed (e.g., 'MIT', 'Apache-2.0').