component.json
Web component file
component.json
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
component.json and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
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. |
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 | array<string> | An array of keywords that describe the component, used for search and categorization. |
main | string | The primary entry point file of the component. |
scripts | oneOf | Scripts that are part of the component. Can be specified as an array of files or an object with named entries. |
styles | oneOf | Styles that are part of the component. Can be specified as an array of files or an object with named entries. |
json | oneOf | Json data that are part of the component. Can be specified as an array of files or an object with named entries. |
images | oneOf | Image assets that are part of the component. Can be specified as an array of files or an object with named entries. |
fonts | oneOf | Fonts that are part of the component. Can be specified as an array of files or an object with named entries. |
files | oneOf | Additional files that are part of the component. Can be specified as an array of files or an object with named entries. |
dependencies | oneOf | Dependencies that are required by the component. Can be specified as an array of files or an object with named entries. |
locals | oneOf | Local dependencies that are required by the component. Can be specified as an array of files or an object with named entries. |
remotes | oneOf | Remote dependencies that are required by the component. Can be specified as an array of files or an object with named entries. |
paths | oneOf | Custom file paths configuration for the component. |
templates | oneOf | Templates that can be imported to be used within the component. |
demo | string | Path to or URL of a demonstration of the component. |
development | object | — |
development.private | boolean | Indicates whether the component should be treated as private and not published to public registries. default: false |
development.name | string | The name of the component. Must be lowercase, can contain hyphens and underscores. |
development.type | string | Type of the component (e.g., 'component', 'block', 'template'). |
development.url | string | URL to the component. |
development.repo | string | The repository location in the format 'username/repository'. |
development.description | string | A brief description of the component's purpose and functionality. |
development.version | string | The semantic version number of the component (e.g., '1.0.0'). |
development.framework | string | Framework compatibility (e.g., 'react', 'vue', 'angular', 'svelte', 'alpinejs', 'laravel', 'web-components'). |
development.keywords | array<string> | An array of keywords that describe the component, used for search and categorization. |
development.main | string | The primary entry point file of the component. |
development.scripts | oneOf | Scripts that are part of the component. Can be specified as an array of files or an object with named entries. |
development.styles | oneOf | Styles that are part of the component. Can be specified as an array of files or an object with named entries. |
development.json | oneOf | Json data that are part of the component. Can be specified as an array of files or an object with named entries. |
development.images | oneOf | Image assets that are part of the component. Can be specified as an array of files or an object with named entries. |
development.fonts | oneOf | Fonts that are part of the component. Can be specified as an array of files or an object with named entries. |
development.files | oneOf | Additional files that are part of the component. Can be specified as an array of files or an object with named entries. |
development.dependencies | oneOf | Dependencies that are required by the component. Can be specified as an array of files or an object with named entries. |
development.locals | oneOf | Local dependencies that are required by the component. Can be specified as an array of files or an object with named entries. |
development.remotes | oneOf | Remote dependencies that are required by the component. Can be specified as an array of files or an object with named entries. |
development.paths | oneOf | Custom file paths configuration for the component. |
development.templates | oneOf | Templates that can be imported to be used within the component. |
development.demo | string | Path to or URL of a demonstration of the component. |
development.development | object | — |
development.development.private | boolean | Indicates whether the component should be treated as private and not published to public registries. default: false |
development.development.name | string | The name of the component. Must be lowercase, can contain hyphens and underscores. |
development.development.type | string | Type of the component (e.g., 'component', 'block', 'template'). |
development.development.url | string | URL to the component. |
development.development.repo | string | The repository location in the format 'username/repository'. |
development.development.description | string | A brief description of the component's purpose and functionality. |
development.development.version | string | The semantic version number of the component (e.g., '1.0.0'). |
development.development.framework | string | Framework compatibility (e.g., 'react', 'vue', 'angular', 'svelte', 'alpinejs', 'laravel', 'web-components'). |
development.development.keywords | array<string> | An array of keywords that describe the component, used for search and categorization. |
development.development.main | string | The primary entry point file of the component. |
development.development.scripts | oneOf | Scripts that are part of the component. Can be specified as an array of files or an object with named entries. |
development.development.styles | oneOf | Styles that are part of the component. Can be specified as an array of files or an object with named entries. |
development.development.json | oneOf | Json data that are part of the component. Can be specified as an array of files or an object with named entries. |
development.development.images | oneOf | Image assets that are part of the component. Can be specified as an array of files or an object with named entries. |
development.development.fonts | oneOf | Fonts that are part of the component. Can be specified as an array of files or an object with named entries. |
development.development.files | oneOf | Additional files that are part of the component. Can be specified as an array of files or an object with named entries. |
development.development.dependencies | oneOf | Dependencies that are required by the component. Can be specified as an array of files or an object with named entries. |
development.development.locals | oneOf | Local dependencies that are required by the component. Can be specified as an array of files or an object with named entries. |
development.development.remotes | oneOf | Remote dependencies that are required by the component. Can be specified as an array of files or an object with named entries. |
development.development.paths | oneOf | Custom file paths configuration for the component. |
development.development.templates | oneOf | Templates that can be imported to be used within the component. |
development.development.demo | string | Path to or URL of a demonstration of the component. |
development.development.development | object | — |
development.development.license | string | The license identifier under which the component is distributed (e.g., 'MIT', 'Apache-2.0'). |
development.license | string | The license identifier under which the component is distributed (e.g., 'MIT', 'Apache-2.0'). |
license | string | The license identifier under which the component is distributed (e.g., 'MIT', 'Apache-2.0'). |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 24 properties, 100% carrying a description, max nesting depth 8.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
minItems | JSON Schema Validation, draft 2020-12 | §6.4.2 — "minItems" |
minProperties | JSON Schema Validation, draft 2020-12 | §6.5.2 — "minProperties" |
oneOf | JSON Schema Core, draft 2020-12 | §10.2.1.3 — "oneOf" |
pattern | JSON Schema Validation, draft 2020-12 | §6.3.3 — "pattern" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.