Interface CoreSmartSnippetQuestionsList

The CoreSmartSnippetQuestionsList controller allows to manage additional queries for which a SmartSnippet model can provide relevant excerpts.

interface CoreSmartSnippetQuestionsList {
    state: CoreSmartSnippetQuestionsListState;
    collapse(identifier: string): void;
    expand(identifier: string): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- CoreSmartSnippetQuestionsList
  - SmartSnippetQuestionsList

Index

Properties

Methods

collapse expand subscribe

Properties

state

state: CoreSmartSnippetQuestionsListState

The state of the SmartSnippetQuestionsList controller.

Methods

collapse

collapse(identifier: string): void
Collapse the specified snippet suggestion.
Parameters
- identifier: string
  The questionAnswerId of the smart snippet to collapse.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.d.ts:39

expand

expand(identifier: string): void
Expand the specified snippet suggestion.
Parameters
- identifier: string
  The questionAnswerId of the smart snippet to expand.
Returns void
- Defined in packages/headless/dist/definitions/controllers/core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.d.ts:33

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/dist/definitions/controllers/controller/headless-controller.d.ts:10