CustomCSS

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:18

Extends

Component

Properties

_children

_children: Component[]

Defined in: src/obsidian/augmentations/Components/Component.d.ts:13

Child Components attached to current component, will be unloaded on unloading parent component.

Inherited from

Component._children

_events

_events: EventRef[]

Defined in: src/obsidian/augmentations/Components/Component.d.ts:20

Events that are attached to the current component, will be detached on unloading parent component.

Inherited from

Component._events

_loaded

_loaded: boolean

Defined in: src/obsidian/augmentations/Components/Component.d.ts:27

Whether the component and its children are loaded.

Inherited from

Component._loaded

app

app: App

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:22

Reference to App.

csscache

csscache: Map<string, string>

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:27

Cache of CSS snippet filepath (relative to vault root) to CSS snippet contents.

enabledSnippets

enabledSnippets: Set<string>

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:32

Set of enabled snippet, given by filenames.

extraStyleEls

extraStyleEls: HTMLStyleElement[]

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:37

Contains references to Style elements containing custom CSS snippets.

oldThemes

oldThemes: string[]

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:42

List of theme names not fully updated to post v1.0.0 theme guidelines.

queue

queue: PromisedQueue

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:45

requestLoadSnippets

requestLoadSnippets: Debouncer<[], void>

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:48

requestLoadTheme

requestLoadTheme: Debouncer<[], void>

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:51

requestReadThemes

requestReadThemes: Debouncer<[], void>

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:54

snippets

snippets: string[]

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:59

List of snippets detected by Obsidian, given by their filenames.

theme

theme: string

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:66

Currently active theme, given by its name.

themes

themes: CustomCSSThemesRecord

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:71

Mapping of theme names to their manifest.

updates

updates: CustomCSSUpdatesRecord

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:74

Methods

addChild()

Call Signature

addChild<T>(component): T

Defined in: obsidian.d.ts:911

Adds a child component, loading it if this component is loaded

Type Parameters

T

T extends Component

Parameters

component

T

Returns

T

Inherited from

Component.addChild

Call Signature

addChild<T>(component): T

Defined in: src/obsidian/augmentations/Components/Component.d.ts:41

Adds a child component, loading it if this component is loaded.

Type Parameters

T

T extends Component

The type of the component to add.

Parameters

component

T

The component to add.

Returns

T

The added component.

Example

component.addChild(childComponent);

Inherited from

Component.addChild

boundRaw()

boundRaw(themeName): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:77

Parameters

themeName

string

Returns

void

checkForUpdate()

checkForUpdate(themeName): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:84

Check whether a specific theme can be updated.

Parameters

themeName

string

Name of the theme to check.

Returns

void

checkForUpdates()

checkForUpdates(): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:89

Check all themes for updates.

Returns

void

disableTranslucency()

disableTranslucency(): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:94

Disable translucency of application background.

Returns

void

downloadLegacyTheme()

downloadLegacyTheme(options): Promise<string>

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:101

Fetch legacy theme CSS using the pre-v1.0.0 theme download pipeline.

Parameters

options

DownloadLegacyThemeOptions

Returns

Promise<string>

String obsidian.css contents.

enableTranslucency()

enableTranslucency(): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:106

Enable translucency of application background.

Returns

void

getManifest()

getManifest(repoUrl): Promise<ThemeManifest>

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:113

Fetch a theme’s manifest using repository URL.

Parameters

repoUrl

string

Returns

Promise<ThemeManifest>

getSnippetPath()

getSnippetPath(snippetName): string

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:120

Convert snippet name to its corresponding filepath (relative to vault root).

Parameters

snippetName

string

Returns

string

String .obsidian/snippets/${snippetName}.css.

getSnippetsFolder()

getSnippetsFolder(): string

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:125

Returns the folder path where snippets are stored (relative to vault root).

Returns

string

getThemeFolder()

getThemeFolder(): string

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:130

Returns the folder path where themes are stored (relative to vault root).

Returns

string

getThemePath()

getThemePath(themeName): string

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:137

Convert theme name to its corresponding filepath (relative to vault root).

Parameters

themeName

string

Returns

string

String .obsidian/themes/${themeName}/theme.css.

hasUpdates()

hasUpdates(): boolean

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:142

Returns whether there are themes that can be updated.

Returns

boolean

installLegacyTheme()

installLegacyTheme(options): Promise<void>

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:150

Install a legacy theme using the pre-v1.0.0 theme download pipeline
Will create a corresponding. dummy manifest for the theme.

Parameters

options

InstallThemeOptions

Returns

Promise<void>

installTheme()

installTheme(options, version): Promise<void>

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:155

Install a theme using the regular theme download pipeline.

Parameters

options

InstallThemeOptions

version

string

Returns

Promise<void>

isThemeInstalled()

isThemeInstalled(themeName): boolean

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:160

Check whether a specific theme is installed by theme name.

Parameters

themeName

string

Returns

boolean

load()

Call Signature

load(): void

Defined in: obsidian.d.ts:889

Load this component and its children

Returns

void

Inherited from

Component.load

Call Signature

load(): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:48

Load this component and its children.

Returns

void

Inherited from

Component.load

loadCss()

loadCss(arg1): Promise<unknown>

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:163

Parameters

arg1

unknown

Returns

Promise<unknown>

loadData()

loadData(): unknown

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:166

Returns

unknown

loadSnippets()

loadSnippets(): unknown

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:169

Returns

unknown

loadTheme()

loadTheme(arg1): unknown

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:172

Parameters

arg1

unknown

Returns

unknown

onload()

onload(): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:175

Returns

void

Overrides

Component.onload

onRaw()

onRaw(themeName): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:178

Parameters

themeName

string

Returns

void

onunload()

onunload(): void

Defined in: obsidian.d.ts:906

Override this to unload your component

Returns

void

Inherited from

Component.onunload

readSnippets()

readSnippets(): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:181

Returns

void

readThemes()

readThemes(): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:184

Returns

void

register()

Call Signature

register(cb): void

Defined in: obsidian.d.ts:921

Registers a callback to be called when unloading

Parameters

cb

() => any

Returns

void

Inherited from

Component.register

Call Signature

register(cb): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:78

Registers a callback to be called when unloading.

Parameters

cb

() => any

The callback to be called when unloading.

Returns

void

Example

component.register(() => {
  console.log('MyComponent unloaded');
});

Inherited from

Component.register

registerDomEvent()

Call Signature

registerDomEvent<K>(el, type, callback, options?): void

Defined in: obsidian.d.ts:931

Registers an DOM event to be detached when unloading

Type Parameters

K

K extends keyof WindowEventMap

Parameters

el

Window

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

Call Signature

registerDomEvent<K>(el, type, callback, options?): void

Defined in: obsidian.d.ts:936

Registers an DOM event to be detached when unloading

Type Parameters

K

K extends keyof DocumentEventMap

Parameters

el

Document

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

Call Signature

registerDomEvent<K>(el, type, callback, options?): void

Defined in: obsidian.d.ts:941

Registers an DOM event to be detached when unloading

Type Parameters

K

K extends keyof HTMLElementEventMap

Parameters

el

HTMLElement

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

Call Signature

registerDomEvent<K>(el, type, callback, options?): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:96

Registers an DOM event to be detached when unloading.

Type Parameters

K

K extends keyof DocumentEventMap

The type of the event to register.

Parameters

el

Document

The element to register the event on.

type

K

The type of the event to register.

callback

(this, ev) => any

The callback to be called when the event is triggered.

options?

The options for the event.

boolean | AddEventListenerOptions

Returns

void

Example

component.registerDomEvent(document, 'click', () => {
  console.log('Document clicked');
});

Inherited from

Component.registerDomEvent

Call Signature

registerDomEvent<K>(el, type, callback, options?): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:119

Registers an DOM event to be detached when unloading.

Type Parameters

K

K extends keyof HTMLElementEventMap

The type of the event to register.

Parameters

el

HTMLElement

The element to register the event on.

type

K

The type of the event to register.

callback

(this, ev) => any

The callback to be called when the event is triggered.

options?

The options for the event.

boolean | AddEventListenerOptions

Returns

void

Example

component.registerDomEvent(document.body, 'click', () => {
  console.log('Body clicked');
});

Inherited from

Component.registerDomEvent

Call Signature

registerDomEvent<K>(el, type, callback, options?): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:142

Registers an DOM event to be detached when unloading.

Type Parameters

K

K extends keyof WindowEventMap

The type of the event to register.

Parameters

el

Window

The element to register the event on.

type

K

The type of the event to register.

callback

(this, ev) => any

The callback to be called when the event is triggered.

options?

The options for the event.

boolean | AddEventListenerOptions

Returns

void

Example

component.registerDomEvent(window, 'click', () => {
  console.log('Window clicked');
});

Inherited from

Component.registerDomEvent

registerEvent()

Call Signature

registerEvent(eventRef): void

Defined in: obsidian.d.ts:926

Registers an event to be detached when unloading

Parameters

eventRef

EventRef

Returns

void

Inherited from

Component.registerEvent

Call Signature

registerEvent(eventRef): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:159

Registers an event to be detached when unloading.

Parameters

eventRef

EventRef

The event to be registered.

Returns

void

Example

component.registerEvent(eventRef);

Inherited from

Component.registerEvent

registerInterval()

Call Signature

registerInterval(id): number

Defined in: obsidian.d.ts:948

Registers an interval (from setInterval) to be cancelled when unloading Use setInterval instead of setInterval to avoid TypeScript confusing between NodeJS vs Browser API

Parameters

id

number

Returns

number

Inherited from

Component.registerInterval

Call Signature

registerInterval(id): number

Defined in: src/obsidian/augmentations/Components/Component.d.ts:175

Registers an interval (from setInterval) to be cancelled when unloading. Use setInterval instead of setInterval to avoid TypeScript confusing between NodeJS vs Browser API

Parameters

id

number

The id of the interval to register.

Returns

number

The id of the interval.

Example

component.registerInterval(window.setInterval(() => {
  console.log('Interval');
}, 1000));

Inherited from

Component.registerInterval

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:181

Parameters

keymapEventHandler

KeymapEventHandler

Returns

void

Inherited from

Component.registerScopeEvent

removeChild()

Call Signature

removeChild<T>(component): T

Defined in: obsidian.d.ts:916

Removes a child component, unloading it

Type Parameters

T

T extends Component

Parameters

component

T

Returns

T

Inherited from

Component.removeChild

Call Signature

removeChild<T>(component): T

Defined in: src/obsidian/augmentations/Components/Component.d.ts:195

Removes a child component, unloading it.

Type Parameters

T

T extends Component

The type of the component to remove.

Parameters

component

T

The component to remove.

Returns

T

The removed component.

Example

component.removeChild(childComponent);

Inherited from

Component.removeChild

removeTheme()

removeTheme(themeName): Promise<void>

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:189

Remove a theme by theme name.

Parameters

themeName

string

Returns

Promise<void>

setCssEnabledStatus()

setCssEnabledStatus(snippetName, enabled): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:194

Set the activation status of a snippet by snippet name.

Parameters

snippetName

string

enabled

boolean

Returns

void

setTheme()

setTheme(themeName): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:199

Set the active theme by theme name.

Parameters

themeName

string

Returns

void

setTranslucency()

setTranslucency(translucency): void

Defined in: src/obsidian/internals/CustomCSS/CustomCSS.d.ts:204

Set the translucency of application background.

Parameters

translucency

boolean

Returns

void

unload()

Call Signature

unload(): void

Defined in: obsidian.d.ts:900

Unload this component and its children

Returns

void

Inherited from

Component.unload

Call Signature

unload(): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:211

Override this to unload your component.

Returns

void

Example

class MyComponent extends Component {
  public override onunload(): void {
    console.log('MyComponent unloaded');
  }
}

Inherited from

Component.unload