Class Completer

A widget that enables text completion.

Notes

The completer is intended to be absolutely positioned on the page and hover over any other content, so it should be attached directly to document.body, or a node that is the full size of document.body. Attaching it to other nodes may incorrectly locate the completer.

Hierarchy

Widget
- Completer

Constructors

constructor

new Completer(options: Completer.IOptions): Completer
Construct a text completer menu widget.
Parameters
- options: Completer.IOptions
Returns Completer
Overrides Widget.constructor
- Defined in packages/completer/src/widget.ts:61

Properties

`Readonly`node

node: HTMLElement

Get the DOM node owned by the widget.

`Readonly`sanitizer

sanitizer: IRenderMime.ISanitizer

The sanitizer used to sanitize untrusted HTML inputs.

suppressIfInlineCompleterActive

suppressIfInlineCompleterActive: boolean

Whether to suppress the tab completer when inline completions are presented.

Accessors

activeIndex

get activeIndex(): number
The active index.

Returns number
- Defined in packages/completer/src/widget.ts:103

dataset

get dataset(): DOMStringMap
The dataset for the widget's DOM node.

Returns DOMStringMap
Inherited from Widget.dataset
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:88

disposed

get disposed(): ISignal<this, void>
A signal emitted when the widget is disposed.

Returns ISignal<this, void>
Inherited from Widget.disposed
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:33

editor

get editor(): undefined | null | CodeEditor.IEditor
The editor used by the completion widget.

Returns undefined | null | CodeEditor.IEditor
- Defined in packages/completer/src/widget.ts:110
set editor(newValue: undefined | null | CodeEditor.IEditor): void
Parameters
- newValue: undefined | null | CodeEditor.IEditor
Returns void
- Defined in packages/completer/src/widget.ts:113

hiddenMode

get hiddenMode(): HiddenMode
Get the method for hiding the widget.

Returns HiddenMode
Inherited from Widget.hiddenMode
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:92
set hiddenMode(value: HiddenMode): void
Set the method for hiding the widget.
Parameters
- value: HiddenMode
Returns void
Inherited from Widget.hiddenMode
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:96

id

get id(): string
Get the id of the widget's DOM node.

Returns string
Inherited from Widget.id
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:80
set id(value: string): void
Set the id of the widget's DOM node.
Parameters
- value: string
Returns void
Inherited from Widget.id
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:84

indexChanged

get indexChanged(): ISignal<this, number>
A signal emitted when the active index changes.

Returns ISignal<this, number>
- Defined in packages/completer/src/widget.ts:138

isAttached

get isAttached(): boolean
Test whether the widget's node is attached to the DOM.

Returns boolean
Inherited from Widget.isAttached
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:45

isDisposed

get isDisposed(): boolean
Test whether the widget has been disposed.

Returns boolean
Inherited from Widget.isDisposed
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:41

isHidden

get isHidden(): boolean
Test whether the widget is explicitly hidden.

Notes
You should prefer !{@link isVisible} over {@link isHidden} if you want to know if the widget is hidden as this does not test if the widget is hidden because one of its ancestors is hidden.

Returns boolean
Inherited from Widget.isHidden
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:53

isVisible

get isVisible(): boolean
Test whether the widget is visible.

Notes
A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

Since 2.7.0, this does not rely on the Widget.Flag.IsVisible flag. It recursively checks the visibility of all parent widgets.

Returns boolean
Inherited from Widget.isVisible
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:64

layout

get layout(): null | Layout
Get the layout for the widget.

Returns null | Layout
Inherited from Widget.layout
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:116
set layout(value: null | Layout): void
Set the layout for the widget.

Notes
The layout is single-use only. It cannot be changed after the first assignment.

The layout is disposed automatically when the widget is disposed.
Parameters
- value: null | Layout
Returns void
Inherited from Widget.layout
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:126

model

get model(): null | Completer.IModel
The model used by the completer widget.

Returns null | Completer.IModel
- Defined in packages/completer/src/widget.ts:145
set model(model: null | Completer.IModel): void
Parameters
- model: null | Completer.IModel
Returns void
- Defined in packages/completer/src/widget.ts:148

parent

get parent(): null | Widget
Get the parent of the widget.

Returns null | Widget
Inherited from Widget.parent
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:100
set parent(value: null | Widget): void
Set the parent of the widget.

Notes
Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

The widget will be automatically removed from its old parent.

This is a no-op if there is no effective parent change.
Parameters
- value: null | Widget
Returns void
Inherited from Widget.parent
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:112

renderer

get renderer(): Completer.IRenderer<ICompletionItem>
The completer used by the completer widget.

Returns Completer.IRenderer<ICompletionItem>
- Defined in packages/completer/src/widget.ts:166
set renderer(renderer: Completer.IRenderer<ICompletionItem>): void
Parameters
- renderer: Completer.IRenderer<ICompletionItem>
Returns void
- Defined in packages/completer/src/widget.ts:169

selected

get selected(): ISignal<this, string>
A signal emitted when a selection is made from the completer menu.

Returns ISignal<this, string>
- Defined in packages/completer/src/widget.ts:120

showDocsPanel

get showDocsPanel(): boolean
Returns boolean
- Defined in packages/completer/src/widget.ts:180
set showDocsPanel(showDoc: boolean): void
Enable/disable the document panel.
Parameters
- showDoc: boolean
Returns void
- Defined in packages/completer/src/widget.ts:176

`Protected`sizeCache

get sizeCache(): undefined | IDimensions
Get cached dimensions of the completer box.

Returns undefined | IDimensions
- Defined in packages/completer/src/widget.ts:375

title

get title(): Title<Widget>
The title object for the widget.

Notes
The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

Since not all widgets will use the title, it is created on demand.

The owner property of the title is set to this widget.

Returns Title<Widget>
Inherited from Widget.title
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:76

visibilityChanged

get visibilityChanged(): ISignal<this, void>
A signal emitted when the completer widget's visibility changes.

Notes
This signal is useful when there are multiple floating widgets that may contend with the same space and ought to be mutually exclusive.

Returns ISignal<this, void>
- Defined in packages/completer/src/widget.ts:131

Methods

`Protected`_updateConstraints

_updateConstraints(): void
Cache style constraints from CSS.

Returns void
- Defined in packages/completer/src/widget.ts:77

activate

activate(): void
Post an 'activate-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from Widget.activate
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:211

addClass

addClass(name: string): void
Add a class name to the widget's DOM node.
Parameters
- name: string
  The class name to add to the node.
  
  Notes
  If the class name is already added to the node, this is a no-op.
  
  The class name must not contain whitespace.
Returns void
Inherited from Widget.addClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:164

children

children(): IterableIterator<Widget>
Create an iterator over the widget's children.

Returns IterableIterator<Widget>
A new iterator over the children of the widget.

Notes
The widget must have a populated layout in order to have children.

If a layout is not installed, the returned iterator will be empty.
Inherited from Widget.children
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:137

clearFlag

clearFlag(flag: Flag): void
Clear the given widget flag.

Notes
This will not typically be called directly by user code.

Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
Parameters
- flag: Flag
Returns void
Inherited from Widget.clearFlag
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:275

close

close(): void
Send a 'close-request' message to the widget.

Notes
This is a simple convenience method for sending the message.

Returns void
Inherited from Widget.close
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:218

contains

contains(widget: Widget): boolean
Test whether a widget is a descendant of this widget.
Parameters
- widget: Widget
  The descendant widget of interest.
Returns boolean
true if the widget is a descendant, false otherwise.
Inherited from Widget.contains
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:145

dispose

dispose(): void
Dispose of the resources held by the completer widget.

Returns void
Overrides Widget.dispose
- Defined in packages/completer/src/widget.ts:192

fit

fit(): void
Post a 'fit-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from Widget.fit
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:204

handleEvent

handleEvent(event: Event): void
Handle the DOM events for the widget.
Parameters
- event: Event
  The DOM event sent to the widget.
  
  Notes
  This method implements the DOM EventListener interface and is called in response to events on the dock panel's node. It should not be called directly by user code.
Returns void
- Defined in packages/completer/src/widget.ts:208

hasClass

hasClass(name: string): boolean
Test whether the widget's DOM node has the given class name.
Parameters
- name: string
  The class name of interest.
Returns boolean
true if the node has the class, false otherwise.
Inherited from Widget.hasClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:153

hide

hide(): void
Hide the widget and make it hidden to its parent widget.

Notes
This causes the isHidden property to be true.

If the widget is explicitly hidden, this is a no-op.

Returns void
Inherited from Widget.hide
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:236

`Protected`notifyLayout

notifyLayout(msg: Message): void
Invoke the message processing routine of the widget's layout.
Parameters
- msg: Message
  The message to dispatch to the layout.
  
  Notes
  This is a no-op if the widget does not have a layout.
  
  This will not typically be called directly by user code.
Returns void
Inherited from Widget.notifyLayout
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:295

`Protected`onActivateRequest

onActivateRequest(msg: Message): void
A message handler invoked on an 'activate-request' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onActivateRequest
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:330

`Protected`onAfterAttach

onAfterAttach(msg: Message): void
Handle after-attach messages for the widget.
Parameters
- msg: Message
Returns void
Overrides Widget.onAfterAttach
- Defined in packages/completer/src/widget.ts:258

`Protected`onAfterDetach

onAfterDetach(msg: Message): void
A message handler invoked on an 'after-detach' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onAfterDetach
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:386

`Protected`onAfterHide

onAfterHide(msg: Message): void
A message handler invoked on an 'after-hide' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onAfterHide
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:358

`Protected`onAfterShow

onAfterShow(msg: Message): void
A message handler invoked on an 'after-show' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onAfterShow
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:344

`Protected`onBeforeAttach

onBeforeAttach(msg: Message): void
A message handler invoked on a 'before-attach' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onBeforeAttach
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:365

`Protected`onBeforeDetach

onBeforeDetach(msg: Message): void
Handle before-detach messages for the widget.
Parameters
- msg: Message
Returns void
Overrides Widget.onBeforeDetach
- Defined in packages/completer/src/widget.ts:267

`Protected`onBeforeHide

onBeforeHide(msg: Message): void
A message handler invoked on a 'before-hide' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onBeforeHide
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:351

`Protected`onBeforeShow

onBeforeShow(msg: Message): void
A message handler invoked on a 'before-show' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onBeforeShow
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:337

`Protected`onChildAdded

onChildAdded(msg: ChildMessage): void
A message handler invoked on a 'child-added' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: ChildMessage
Returns void
Inherited from Widget.onChildAdded
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:393

`Protected`onChildRemoved

onChildRemoved(msg: ChildMessage): void
A message handler invoked on a 'child-removed' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: ChildMessage
Returns void
Inherited from Widget.onChildRemoved
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:400

`Protected`onCloseRequest

onCloseRequest(msg: Message): void
A message handler invoked on a 'close-request' message.

Notes
The default implementation unparents or detaches the widget.
Parameters
- msg: Message
Returns void
Inherited from Widget.onCloseRequest
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:302

`Protected`onFitRequest

onFitRequest(msg: Message): void
A message handler invoked on a 'fit-request' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onFitRequest
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:323

`Protected`onModelQueryChanged

onModelQueryChanged(model: Completer.IModel, queryChange: IQueryChange): void
Handle model query changes.
Parameters
- model: Completer.IModel
- queryChange: IQueryChange
Returns void
- Defined in packages/completer/src/widget.ts:287

`Protected`onModelStateChanged

onModelStateChanged(): void
Handle model state changes.

Returns void
- Defined in packages/completer/src/widget.ts:276

`Protected`onResize

onResize(msg: ResizeMessage): void
A message handler invoked on a 'resize' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: ResizeMessage
Returns void
Inherited from Widget.onResize
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:309

`Protected`onUpdateRequest

onUpdateRequest(msg: Message): void
Handle update-request messages.
Parameters
- msg: Message
Returns void
Overrides Widget.onUpdateRequest
- Defined in packages/completer/src/widget.ts:313

processMessage

processMessage(msg: Message): void
Process a message sent to the widget.
Parameters
- msg: Message
  The message sent to the widget.
  
  Notes
  Subclasses may reimplement this method as needed.
Returns void
Inherited from Widget.processMessage
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:284

removeClass

removeClass(name: string): void
Remove a class name from the widget's DOM node.
Parameters
- name: string
  The class name to remove from the node.
  
  Notes
  If the class name is not yet added to the node, this is a no-op.
  
  The class name must not contain whitespace.
Returns void
Inherited from Widget.removeClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:175

reset

reset(): void
Reset the widget.

Returns void
- Defined in packages/completer/src/widget.ts:230

selectActive

selectActive(): void
Emit the selected signal for the current active item and reset.

Returns void
- Defined in packages/completer/src/widget.ts:245

setFlag

setFlag(flag: Flag): void
Set the given widget flag.

Notes
This will not typically be called directly by user code.

Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
Parameters
- flag: Flag
Returns void
Inherited from Widget.setFlag
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:265

setHidden

setHidden(hidden: boolean): void
Show or hide the widget according to a boolean value.
Parameters
- hidden: boolean
  true to hide the widget, or false to show it.
  
  Notes
  This is a convenience method for hide() and show().
Returns void
Inherited from Widget.setHidden
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:245

show

show(): void
Show the widget and make it visible to its parent widget.

Notes
This causes the isHidden property to be false.

If the widget is not explicitly hidden, this is a no-op.

Returns void
Inherited from Widget.show
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:227

testFlag

testFlag(flag: Flag): boolean
Test whether the given widget flag is set.

Notes
This will not typically be called directly by user code.

Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
Parameters
- flag: Flag
Returns boolean
Inherited from Widget.testFlag
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:255

toggleClass

toggleClass(name: string, force?: boolean): boolean
Toggle a class name on the widget's DOM node.
Parameters
- name: string
  The class name to toggle on the node.
- Optionalforce: boolean
  Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.
Returns boolean
true if the class is now present, false otherwise.

Notes
The class name must not contain whitespace.
Inherited from Widget.toggleClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:190

update

update(): void
Post an 'update-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from Widget.update
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:197

Class Completer

Notes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Completer

Properties

Readonlynode

Readonlysanitizer

suppressIfInlineCompleterActive

Accessors

activeIndex

Returns number

dataset

Returns DOMStringMap

disposed

Returns ISignal<this, void>

editor

Returns undefined | null | CodeEditor.IEditor

Parameters

Returns void

hiddenMode

Returns HiddenMode

Parameters

Returns void

id

Returns string

Parameters

Returns void

indexChanged

Returns ISignal<this, number>

isAttached

Returns boolean

isDisposed

Returns boolean

isHidden

Notes

Returns boolean

isVisible

Notes

Returns boolean

layout

Returns null | Layout

Notes

Parameters

Returns void

model

Returns null | Completer.IModel

Parameters

Returns void

parent

Returns null | Widget

Notes

Parameters

Returns void

renderer

Returns Completer.IRenderer<ICompletionItem>

Parameters

Returns void

selected

Returns ISignal<this, string>

showDocsPanel

Returns boolean

Parameters

Returns void

ProtectedsizeCache

Returns undefined | IDimensions

title

Notes

Returns Title<Widget>

visibilityChanged

Notes

Returns ISignal<this, void>

Methods

`Readonly`node

`Readonly`sanitizer

`Protected`sizeCache

`Protected`_updateConstraints

`Protected`notifyLayout

`Protected`onActivateRequest

`Protected`onAfterAttach

`Protected`onAfterDetach

`Protected`onAfterHide

`Protected`onAfterShow

`Protected`onBeforeAttach

`Protected`onBeforeDetach

`Protected`onBeforeHide