SchemaSettingsManager
Instance Methods
schemaSettingsManager.add()
Add SchemaSettings instance.
class SchemaSettingsManager {
add<T = any>(...schemaSettingList: SchemaSetting<T>[]): void
}
const mySchemaSettings = new SchemaSetting({
name: 'MySchemaSettings',
title: 'Add block',
items: [
{
name: 'demo',
type: 'item',
componentProps:{
title: 'Demo'
}
}
],
});
class MyPlugin extends Plugin {
async load() {
this.app.schemaSettingsManager.add(mySchemaSettings);
}
}
schemaSettingsManager.get()
Get a SchemaSettings instance.
class SchemaSettingsManager {
get<T = any>(name: string): SchemaSetting<T> | undefined
}
class MyPlugin extends Plugin {
async load() {
const mySchemaSettings = this.app.schemaSettingsManager.get('MySchemaSettings');
}
}
schemaSettingsManager.getAll()
Get all SchemaSettings instances.
class SchemaSettingsManager {
getAll(): Record<string, SchemaInitializer<any, any>>
}
class MyPlugin extends Plugin {
async load() {
const list = this.app.schemaSettingsManager.getAll();
}
}
app.schemaSettingsManager.has()
Determine if a certain SchemaSettings instance exists.
class SchemaSettingsManager {
has(name: string): boolean
}
class MyPlugin extends Plugin {
async load() {
const hasMySchemaSettings = this.app.schemaSettingsManager.has('MySchemaSettings');
}
}
schemaSettingsManager.remove()
Remove SchemaSettings instance.
class SchemaSettingsManager {
remove(name: string): void
}
class MyPlugin extends Plugin {
async load() {
this.app.schemaSettingsManager.remove('MySchemaSettings');
}
}
schemaSettingsManager.addItem()
Add Item of SchemaSettings instance. The difference from directly calling schemaInitializer.add() method is that it can ensure addition only when the instance exists.
class SchemaSettingsManager {
addItem(schemaInitializerName: string, itemName: string, data: Omit<SchemaInitializerItemType, 'name'>): void
}
class MyPlugin extends Plugin {
async load() {
// Method 1: First get, then add child item, need to ensure already registered
const mySchemaSettings = this.app.schemaSettingsManager.get('MySchemaSettings');
if (mySchemaSettings) {
mySchemaSettings.add('b', { type: 'item', componentProps:{ title: 'B' } })
}
// Method 2: Through addItem, internally ensures addition only when mySchemaSettings is registered
this.app.schemaSettingsManager.addItem('MySchemaSettings', 'b', {
type: 'item',
componentProps:{ title: 'B' }
})
}
}
schemaSettingsManager.removeItem()
Remove Item of instance. The difference from directly calling schemaInitializer.remove() method is that it can ensure removal only when the instance exists.
class SchemaSettingsManager {
removeItem(schemaInitializerName: string, itemName: string): void
}
class MyPlugin extends Plugin {
async load() {
// Method 1: First get, then delete child item, need to ensure already registered
const mySchemaSettings = this.app.schemaSettingsManager.get('MySchemaSettings');
if (mySchemaSettings) {
mySchemaSettings.remove('a')
}
// Method 2: Through addItem, internally ensures removal only when mySchemaSettings is registered
this.app.schemaSettingsManager.remove('MySchemaSettings', 'a')
}
}
