Member Junction
    Preparing search index...

    Class SearchCompositeComponent

    Implements

    • OnInit
    • OnDestroy
    Index

    Constructors

    constructor

    Properties

    AvailableScopes DebounceMs EnablePreview EnableRecent EnableScopeSelector HasScopes IsPreviewLoading IsSuggestOpen MaxPreviewResults MinQueryLength Placeholder PreviewResults PreviewTotalCount PromoAccepted PromoActionLabel PromoDismissed PromoText Query RecentRecords RecentRecordSelected RecentSearches ResultSelected searchInputRef searchService SearchSubmitted searchSuggestRef SeeAllRequested SelectedScopeIDs ShowPromo ShowShortcutHint

    Accessors

    MinRelevancePercent

    Methods

    Focus ngOnDestroy ngOnInit OnClearRecentRequested OnDocumentMousedown OnHostKeydown OnInputCleared OnInputEscaped OnInputFocused OnQueryChange OnQuerySubmit OnRecentRecordSelected OnRecentSelected OnResultSelected OnScopeSelectionChange OnSeeAllRequested

    Constructors

    Properties

    AvailableScopes: SearchScopeInfo[] = []

    Scopes the current user can see. Populated by SearchService.LoadScopes() on init. When empty, the scope selector is not rendered (unscoped-as-before UX).

    DebounceMs: number = 400

    Debounce time in milliseconds for query changes

    EnablePreview: boolean = true

    Whether to enable live preview search on typing

    EnableRecent: boolean = true

    Whether to enable recent searches display

    EnableScopeSelector: boolean = true

    Whether to show the scope selector inline with the search input. When true (default), the composite lazy-loads the list of scopes the current user can see and renders the selector only if at least one scope exists. When zero scopes are visible the selector stays hidden and the UX is identical to the pre-scope unscoped behavior.

    HasScopes: boolean = false

    Whether any scope is visible to the current user — drives selector visibility.

    IsPreviewLoading: boolean = false
    IsSuggestOpen: boolean = false
    MaxPreviewResults: number = 8

    Maximum number of preview results to show in the dropdown

    MinQueryLength: number = 2

    Minimum query length before preview results are fetched

    Placeholder: string = 'Search...'

    Placeholder text for the search input

    PreviewResults: SearchResultItem[] = []
    PreviewTotalCount: number = 0
    PromoAccepted: EventEmitter<string> = ...

    Promo pass-throughs (accept carries the current query).

    PromoActionLabel: string = 'Turn on'
    PromoDismissed: EventEmitter<void> = ...
    PromoText: string = ''
    Query: string = ''
    RecentRecords: RecentRecordItem[] = []

    Recently opened records for the dropdown's idle state (max 3 shown).

    RecentRecordSelected: EventEmitter<RecentRecordItem> = ...

    Emitted when the user selects a recently opened record from the dropdown

    RecentSearches: RecentSearch[] = []
    ResultSelected: EventEmitter<SearchResultItem> = ...

    Emitted when a result is selected from the preview dropdown

    searchInputRef: SearchInputComponent
    searchService: SearchService = ...
    SearchSubmitted: EventEmitter<string> = ...

    Emitted when the user presses Enter or selects a recent search (full search)

    searchSuggestRef: SearchSuggestComponent
    SeeAllRequested: EventEmitter<string> = ...

    Emitted when the user clicks "See all N results"

    SelectedScopeIDs: string[] = []

    Currently selected scope IDs. Empty array means "Global" / unscoped. Read by the shell (or any parent) on submit via the exposed getter, and mirrored to the server through SearchRequest.ScopeIDs on the full submitted search.

    ShowPromo: boolean = false

    Promo row pass-throughs — see SearchSuggestComponent for semantics.

    ShowShortcutHint: boolean = true

    Whether to show keyboard shortcut hint on the input

    Accessors

    Methods

    • A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

      Returns void

    • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

      Returns void

    • Relay a selection change from the embedded scope selector to local state. Parents read SelectedScopeIDs directly on submit; no output event is needed because scope selection doesn't alter the inline preview (preview stays global for speed).

      Parameters

      • scopeIDs: string[]

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods