Class MonacoContextKeyService

constructor

• new MonacoContextKeyService(): MonacoContextKeyService

  Returns MonacoContextKeyService

OptionalactiveContext

contextKeyService

• get contextKeyService(): AbstractContextKeyService

  Returns AbstractContextKeyService

onDidChange

• get onDidChange(): Event<ContextKeyChangeEvent>

  Returns Event<ContextKeyChangeEvent>

createKey

• createKey<T extends ContextKeyValue>(
      key: string,
      defaultValue: undefined | T,
  ): ContextKey<T>

  Type Parameters

  • T extends ContextKeyValue

  Parameters

  • key: string
  • defaultValue: undefined | T

  Returns ContextKey<T>

createOverlay

• createOverlay(overlay: Iterable<[string, unknown]>): ContextMatcher

  Parameters

  • overlay: Iterable<[string, unknown]>

    values to be used in the new ContextKeyService. These values will be static. Creates a child service with a separate context and a set of fixed values to override parent values.

  Returns ContextMatcher

createScoped

• createScoped(target: HTMLElement): ScopedValueStore

  Creates a child service with a separate context scoped to the HTML element passed in. Useful for e.g. setting the {view} context value for particular widgets.

  Parameters

  • target: HTMLElement

  Returns ScopedValueStore

dispose

• dispose(): void

  Returns void

getLocalContextKeys

• getLocalContextKeys(element: HTMLElement): Set<string>

  Gets the context keys that are locally defined (not inherited from parent contexts) at or above the given element. This is useful for determining which context keys are specific to a particular DOM element's scope.

  Parameters

  • element: HTMLElement

    The DOM element to get local context keys for

  Returns Set<string>

  A Set of context key names that are locally defined, or an empty Set if none

match

• match(expression: string, context?: HTMLElement): boolean

  Whether the expression is satisfied. If context provided, the service will attempt to retrieve a context object associated with that element.

  Parameters

  • expression: string
  • Optionalcontext: HTMLElement

  Returns boolean

parse

• parse(when: string): undefined | ContextKeyExpression

  Parameters

  • when: string

  Returns undefined | ContextKeyExpression

parseKeys

• parseKeys(expression: string): undefined | Set<string>

  Parameters

  • expression: string

  Returns undefined | Set<string>

  a Set of the keys used by the given expression or undefined if none are used or the expression cannot be parsed.

setContext

• setContext(key: string, value: unknown): void

  Set or modify a value in the service's context.

  Parameters

  • key: string
  • value: unknown

  Returns void

with

• with<T>(values: Record<string, unknown>, callback: () => T): T

  Creates a temporary context that will use the values passed in when evaluating callback. The callback must be synchronous.

  Type Parameters

  • T

  Parameters

  • values: Record<string, unknown>
  • callback: () => T

  Returns T

withContext

• withContext<T>(context: Context, callback: () => T): T

  Type Parameters

  • T

  Parameters

  • context: Context
  • callback: () => T

  Returns T