Class ComponentSchema

Provides methods to access the components schema

Index

Internal

Other

getDefaultData getFieldsOfType list

Internal

constructor

new ComponentSchema(schema: Schema): ComponentSchema
Creates new instance of API
Parameters
- schema: Schema
  The schema API
Returns ComponentSchema
- Defined in submodules/editor-api/src/schema/components.ts:18

Other

getDefaultData

getDefaultData(component: string): Record<string, any>
Gets default data for a component
Parameters
- component: string
  The component name
Returns Record<string, any>
The default data
Example
```
const modelData = editor.schema.components.getDefaultData('model');
```
- Defined in submodules/editor-api/src/schema/components.ts:46

getFieldsOfType

getFieldsOfType(componentName: string, type: string): string[]
Gets a list of fields of a particular type for a component
Parameters
- componentName: string
  The component name
- type: string
  The desired type
Returns string[]
A list of fields
Example
```
const buttonEntityFields = editor.schema.components.getFieldsOfType('button', 'entity');
```
- Defined in submodules/editor-api/src/schema/components.ts:72

list

list(): string[]
Gets a list of all the available components

Returns string[]
The components
- Defined in submodules/editor-api/src/schema/components.ts:106