Style Manager

A singleton instance of this class available via inkdrop.styles, which you can use to globally query and observe the set of active style sheets. The StyleManager doesn't add any style elements to the DOM on its own, but is instead subscribed to by individual <inkdrop-styles> elements, which clone and attach style elements in different contexts.


observeStyleElements(callback)

Style Elements Observation

Invoke the provided callback for all current and future style elements.

Parameters

  • Name
    callback(styleElement)
    Type
    function
    Required
    Description

    An HTMLStyleElement instance. The .sheet property will be null because this element isn't attached to the DOM. If you want to attach this element to the DOM, be sure to clone it first by calling .cloneNode(true) on it. The style element will also have the following non-standard properties:

      styleElement object
    • Name
      sourcePath
      Type
      string
      Description

      A String containing the path from which the style element was loaded.

    • Name
      context
      Type
      string
      Description

      A String indicating the target context of the style element.

Returns

Returns a Disposable on which .dispose() can be called to unsubscribe.


onDidAddStyleElement(callback)

Style Element Addition Subscription

Invoke the provided callback when a style element is added.

Parameters

  • Name
    callback(styleElement)
    Type
    function
    Required
    Description

    Function called with each added HTMLStyleElement instance.

Returns

Returns a Disposable on which .dispose() can be called to unsubscribe.


onDidRemoveStyleElement(callback)

Style Element Removal Subscription

Invoke the provided callback when a style element is removed.

Parameters

  • Name
    callback(styleElement)
    Type
    function
    Required
    Description

    Function called with each removed HTMLStyleElement instance.

Returns

Returns a Disposable on which .dispose() can be called to unsubscribe.


onDidUpdateStyleElement(callback)

Style Element Update Subscription

Invoke the provided callback when an existing style element is updated.

Parameters

  • Name
    callback(styleElement)
    Type
    function
    Required
    Description

    Function called with each updated HTMLStyleElement instance.

Returns

Returns a Disposable on which .dispose() can be called to unsubscribe.


getStyleElements()

Get Style Elements

Retrieve all loaded style elements.

Returns

Returns an array of HTMLStyleElement instances.


getUserStyleSheetPath()

Get User StyleSheet Path

Obtain the path of the user style sheet.

Returns

Returns the path of the user style sheet located in the config path.

Can you help us improve the docs? 🙏

The source of these docs is here on GitHub. If you see a way these docs can be improved, please fork us!